fix: invalid sketch name error detection on win32

Signed-off-by: Akos Kitta <[email protected]>

Author: Akos Kitta

arduino-ide-extension/package.json

@@ -45,6 +45,7 @@
     "@types/deepmerge": "^2.2.0",
     "@types/glob": "^7.2.0",
     "@types/google-protobuf": "^3.7.2",
+    "@types/is-valid-path": "^0.1.0",
     "@types/js-yaml": "^3.12.2",
     "@types/keytar": "^4.4.0",
     "@types/lodash.debounce": "^4.0.6",

arduino-ide-extension/src/electron-main/theia/electron-main-application.ts

@@ -27,6 +27,7 @@ import {
   CLOSE_PLOTTER_WINDOW,
   SHOW_PLOTTER_WINDOW,
 } from '../../common/ipc-communication';
+import isValidPath = require('is-valid-path');
 
 app.commandLine.appendSwitch('disable-http-cache');
 
@@ -143,10 +144,12 @@ export class ElectronMainApplication extends TheiaElectronMainApplication {
       app.on('open-file', async (event, path) => {
         event.preventDefault();
         const resolvedPath = await this.resolvePath(path, cwd);
-        const sketchFolderPath = await this.isValidSketchPath(resolvedPath);
-        if (sketchFolderPath) {
-          this.openFilePromise.reject(new InterruptWorkspaceRestoreError());
-          await this.openSketch(sketchFolderPath);
+        if (resolvedPath) {
+          const sketchFolderPath = await this.isValidSketchPath(resolvedPath);
+          if (sketchFolderPath) {
+            this.openFilePromise.reject(new InterruptWorkspaceRestoreError());
+            await this.openSketch(sketchFolderPath);
+          }
         }
       });
       setTimeout(() => this.openFilePromise.resolve(), 500);
@@ -198,11 +201,25 @@ export class ElectronMainApplication extends TheiaElectronMainApplication {
     }
   }
 
-  private async resolvePath(path: string, cwd: string): Promise<string> {
-    if (isAbsolute(path)) {
-      return path;
+  private async resolvePath(
+    maybePath: string,
+    cwd: string
+  ): Promise<string | undefined> {
+    if (!isValidPath(maybePath)) {
+      return undefined;
+    }
+    if (isAbsolute(maybePath)) {
+      return maybePath;
+    }
+    try {
+      const resolved = await fs.realpath(resolve(cwd, maybePath));
+      return resolved;
+    } catch (err) {
+      if ('code' in err && err.code === 'ENOENT') {
+        return undefined;
+      }
+      throw err;
     }
-    return fs.realpath(resolve(cwd, path));
   }
 
   protected override async launch(
@@ -236,6 +253,9 @@ export class ElectronMainApplication extends TheiaElectronMainApplication {
       );
       for (const workspace of workspaces) {
         const resolvedPath = await this.resolvePath(workspace.file, params.cwd);
+        if (!resolvedPath) {
+          continue;
+        }
         const sketchFolderPath = await this.isValidSketchPath(resolvedPath);
         if (sketchFolderPath) {
           workspace.file = sketchFolderPath;
@@ -264,6 +284,9 @@ export class ElectronMainApplication extends TheiaElectronMainApplication {
     let path: string | undefined;
     for (const maybePath of argCopy) {
       const resolvedPath = await this.resolvePath(maybePath, params.cwd);
+      if (!resolvedPath) {
+        continue;
+      }
       const sketchFolderPath = await this.isValidSketchPath(resolvedPath);
       if (sketchFolderPath) {
         path = sketchFolderPath;

arduino-ide-extension/src/node/sketches-service-impl.ts

@@ -668,22 +668,19 @@ function isNotFoundError(err: unknown): err is ServiceError {
  * Nothing guarantees that the invalid existing main sketch file still exits by the time client performs the sketch move.
  */
 async function isInvalidSketchNameError(
-  err: unknown,
+  cliErr: unknown,
   requestSketchPath: string
 ): Promise<string | undefined> {
-  if (isNotFoundError(err)) {
+  if (isNotFoundError(cliErr)) {
     const ino = requestSketchPath.endsWith('.ino');
     if (ino) {
       const sketchFolderPath = path.dirname(requestSketchPath);
       const sketchName = path.basename(sketchFolderPath);
-      if (
-        new RegExp(
-          `${invalidSketchNameErrorRegExpPrefix}${path.join(
-            sketchFolderPath,
-            `${sketchName}.ino`
-          )}`
-        ).test(err.details)
-      ) {
+      const pattern = `${invalidSketchNameErrorRegExpPrefix}${path.join(
+        sketchFolderPath,
+        `${sketchName}.ino`
+      )}`.replace(/\\/g, '\\\\'); // make windows path separator with \\ to have a valid regexp.
+      if (new RegExp(pattern, 'i').test(cliErr.details)) {
         try {
           await fs.access(requestSketchPath);
           return requestSketchPath;

yarn.lock

@@ -3139,6 +3139,11 @@
   resolved "https://registry.yarnpkg.com/@types/http-cache-semantics/-/http-cache-semantics-4.0.1.tgz#0ea7b61496902b95890dc4c3a116b60cb8dae812"
   integrity sha512-SZs7ekbP8CN0txVG2xVRH6EgKmEm31BOxA07vkFaETzZz1xh+cbt8BcI0slpymvwhx5dlFnQG2rTlPVQn+iRPQ==
 
+"@types/is-valid-path@^0.1.0":
+  version "0.1.0"
+  resolved "https://registry.yarnpkg.com/@types/is-valid-path/-/is-valid-path-0.1.0.tgz#d5c6e96801303112c9626d44268c6fabc72d272f"
+  integrity sha512-2ontWtpN8O2nf5S7EjDDJ0DwrRa2t7wmS3Wmo322yWYG6yFBYC1QCaLhz4Iz+mzJy8Kf4zP5yVyEd1ANPDmOFQ==
+
 "@types/js-yaml@^3.12.2":
   version "3.12.7"
   resolved "https://registry.yarnpkg.com/@types/js-yaml/-/js-yaml-3.12.7.tgz#330c5d97a3500e9c903210d6e49f02964af04a0e"