fix: escape rsync special characters in filenames on windows (#4434)

Co-authored-by: Steffen Neubauer <[email protected]>

core/src/util/sync.ts

@@ -52,8 +52,13 @@ export async function syncWithOptions({
       // Workaround for this issue: https://stackoverflow.com/questions/1813907
       opts.push("--include-from=-", "--exclude=*", "--delete-excluded")
 
-      // -> Make sure the file list is anchored (otherwise filenames are matched as patterns)
-      files = files.map((f) => "/" + f)
+      files = files.map((f) => {
+        // -> Make sure the file list is anchored (otherwise filenames are matched as patterns)
+        let filename = "/" + f
+        // -> Escape rsync include/exclude wildcard characters https://linux.die.net/man/1/rsync
+        filename = filename.replaceAll(/(\[|\?|\*)/g, "\\$1")
+        return filename
+      })
 
       input = "/**/\n" + files.join("\n")
     }

core/test/unit/src/build-staging/build-staging.ts

@@ -656,5 +656,51 @@ function commonSyncTests(legacyBuildSync: boolean) {
 
       expect(await listFiles(targetRoot)).to.eql(["subdir/a"])
     })
+
+    it("correctly handles special characters in the file name, withDelete true", async () => {
+      const specialFilenames = ["[id].vue", "*foo", "bla?"]
+      const a = join(tmpPath, "a")
+      const b = join(tmpPath, "b")
+      await ensureDir(a)
+      for (const filename of specialFilenames) {
+        await writeFile(join(a, filename), "foo")
+      }
+      await ensureDir(b)
+      await sync({
+        log,
+        sourceRoot: tmpPath,
+        sourceRelPath: "a/",
+        files: specialFilenames,
+        targetRoot: b,
+        withDelete: true,
+      })
+      for (const filename of specialFilenames) {
+        const data = (await readFile(join(b, filename))).toString()
+        expect(data).to.equal("foo")
+      }
+    })
+
+    it("correctly handles special characters in the file name, withDelete false", async () => {
+      const specialFilenames = ["[id].vue", "*foo", "bla?"]
+      const a = join(tmpPath, "a")
+      const b = join(tmpPath, "b")
+      await ensureDir(a)
+      for (const filename of specialFilenames) {
+        await writeFile(join(a, filename), "foo")
+      }
+      await ensureDir(b)
+      await sync({
+        log,
+        sourceRoot: tmpPath,
+        sourceRelPath: "a/",
+        files: specialFilenames,
+        targetRoot: b,
+        withDelete: false,
+      })
+      for (const filename of specialFilenames) {
+        const data = (await readFile(join(b, filename))).toString()
+        expect(data).to.equal("foo")
+      }
+    })
   })
 }