Fix #185, Silent fail on example cp fail

Signed-off-by: paulober <[email protected]>

Author: paulober

src/utils/examplesUtil.mts

@@ -14,6 +14,7 @@ import { get } from "https";
 import { isInternetConnected, getDataRoot } from "./downloadHelpers.mjs";
 import { unknownErrorToString } from "./errorHelper.mjs";
 import { CURRENT_DATA_VERSION } from "./sharedConstants.mjs";
+import { window } from "vscode";
 
 const EXAMPLES_REPOSITORY_URL =
   "https://github.com/raspberrypi/pico-examples.git";
@@ -181,21 +182,40 @@ export async function setupExample(
           process.env.ComSpec === "powershell.exe" ? "&" : ""
         }"${gitPath}" rev-parse HEAD`
       );
-      Logger.log(`Examples git ref is ${ref.stdout}\n`);
+      Logger.debug(
+        LoggerSource.examples,
+        `Examples git ref is ${ref.stdout}\n`
+      );
       if (ref.stdout.trim() !== EXAMPLES_GITREF) {
-        Logger.log(`Removing old examples repo\n`);
+        Logger.debug(LoggerSource.examples, `Removing old examples repo\n`);
         rmSync(examplesRepoPath, { recursive: true, force: true });
       }
       // eslint-disable-next-line @typescript-eslint/no-unused-vars
     } catch (error) {
       // Corrupted examples directory
-      Logger.log(`Removing corrupted examples repo\n`);
-      rmSync(examplesRepoPath, { recursive: true, force: true });
+      Logger.debug(LoggerSource.examples, `Removing corrupted examples repo\n`);
+      try {
+        rmSync(examplesRepoPath, { recursive: true, force: true });
+      } catch (error) {
+        Logger.warn(
+          LoggerSource.examples,
+          "Failed to remove corrupted examples repo.",
+          unknownErrorToString(error)
+        );
+      }
     }
   } else if (existsSync(examplesRepoPath)) {
     // Examples path exists, but does not contain a git repository
-    Logger.log(`Removing empty examples repo\n`);
-    rmSync(examplesRepoPath, { recursive: true, force: true });
+    Logger.debug(LoggerSource.examples, `Removing empty examples repo\n`);
+    try {
+      rmSync(examplesRepoPath, { recursive: true, force: true });
+    } catch (error) {
+      Logger.warn(
+        LoggerSource.examples,
+        "Failed to remove empty examples repo.",
+        unknownErrorToString(error)
+      );
+    }
   }
 
   if (!existsSync(examplesRepoPath)) {
@@ -211,43 +231,115 @@ export async function setupExample(
     }
   }
 
-  Logger.log(`Sparse-checkout selected example: ${example.name}`);
+  Logger.debug(
+    LoggerSource.examples,
+    `Sparse-checkout selected example: ${example.name}`
+  );
   const result = await sparseCheckout(examplesRepoPath, example.path, gitPath);
   if (!result) {
+    Logger.error(
+      LoggerSource.examples,
+      `Failed to checkout example '${example.name}':`,
+      unknownErrorToString(result)
+    );
+    void window.showErrorMessage(
+      `Failed to checkout example: ${example.name}. ` +
+        "Please check the output window for more details."
+    );
+
     return result;
   }
 
   for (const libPath of example.libPaths) {
-    Logger.log(`Sparse-checkout selected example required path: ${libPath}`);
+    Logger.debug(
+      LoggerSource.examples,
+      `Sparse-checkout selected example required path: ${libPath}`
+    );
     const result = await sparseCheckout(examplesRepoPath, libPath, gitPath);
     if (!result) {
+      Logger.error(
+        LoggerSource.examples,
+        `Failed to checkout example required path '${libPath}':`,
+        unknownErrorToString(result)
+      );
+      void window.showErrorMessage(
+        `Failed to checkout example required path '${libPath}'. ` +
+          "Please check the output window for more details."
+      );
+
       return result;
     }
   }
 
-  Logger.log(`Copying example from ${absoluteExamplePath} to ${targetPath}`);
+  Logger.debug(
+    LoggerSource.examples,
+    `Copying example from ${absoluteExamplePath} to ${targetPath}`
+  );
   // TODO: use example.name or example.search key for project folder name?
-  await cp(absoluteExamplePath, joinPosix(targetPath, example.searchKey), {
-    recursive: true,
-  });
+  try {
+    await cp(absoluteExamplePath, joinPosix(targetPath, example.searchKey), {
+      recursive: true,
+    });
+  } catch (error) {
+    const msg = unknownErrorToString(error);
+    if (
+      msg.includes("EACCESS") ||
+      msg.includes("EPERM") ||
+      msg.includes("access denied")
+    ) {
+      Logger.error(
+        LoggerSource.examples,
+        "Failed to copy example. " +
+          "Please check if the target path is writable.",
+        msg
+      );
+      void window.showErrorMessage(
+        "Failed to copy example. " +
+          "Please check if the target path is writable."
+      );
+    } else {
+      Logger.error(LoggerSource.examples, "Failed to copy example.", msg);
+      void window.showErrorMessage(
+        "Failed to copy example. " +
+          "Please check the output window for more details."
+      );
+    }
+
+    return false;
+  }
 
   for (let i = 0; i < example.libPaths.length; i++) {
     const libPath = example.libPaths[i];
     const libName = example.libNames[i];
     const absoluteLibPath = joinPosix(examplesRepoPath, libPath);
-    Logger.log(
+    Logger.debug(
+      LoggerSource.examples,
       `Copying example required path from ${absoluteLibPath} ` +
         `to ${targetPath}/${example.searchKey}/${libName}`
     );
     // TODO: use example.name or example.search key for project folder name?
-    await cp(
-      absoluteLibPath,
-      joinPosix(targetPath, example.searchKey, libName),
-      { recursive: true }
-    );
+    try {
+      await cp(
+        absoluteLibPath,
+        joinPosix(targetPath, example.searchKey, libName),
+        { recursive: true }
+      );
+    } catch (error) {
+      Logger.error(
+        LoggerSource.examples,
+        `Failed to copy example requirement '${libName}':`,
+        unknownErrorToString(error)
+      );
+      void window.showErrorMessage(
+        `Failed to copy example requirement '${libName}'. ` +
+          "Please check the output window for more details."
+      );
+
+      return false;
+    }
   }
 
-  Logger.log("Done copying example.");
+  Logger.info(LoggerSource.examples, "Done copying example.");
 
   return result;
 }

src/webview/newProjectPanel.mts

@@ -650,9 +650,10 @@ export class NewProjectPanel {
               this.dispose();
 
               // required to support backslashes in macOS/Linux folder names
-              const targetPath = process.platform !== "win32"
-                ? this._projectRoot.fsPath
-                : this._projectRoot.fsPath.replaceAll("\\", "/");
+              const targetPath =
+                process.platform !== "win32"
+                  ? this._projectRoot.fsPath
+                  : this._projectRoot.fsPath.replaceAll("\\", "/");
 
               const result = await window.withProgress(
                 {
@@ -662,34 +663,38 @@ export class NewProjectPanel {
                 },
                 async progress => {
                   // download and install selected example
-                  const result = await setupExample(
-                    example,
-                    targetPath
-                  );
-          
+                  const result = await setupExample(example, targetPath);
+
                   if (result) {
-                    this._logger.debug(`Successfully downloaded ${example.name} example.`);
-          
+                    this._logger.debug(
+                      `Successfully downloaded ${example.name} example.`
+                    );
+
                     progress.report({
                       increment: 100,
                       message: `Successfully downloaded ${example.name} example.`,
                     });
-          
+
                     return true;
                   }
-          
-                  this._logger.error(`Failed to download ${example.name} example.`);
-          
+
+                  this._logger.error(
+                    `Failed to download ${example.name} example.`
+                  );
+
                   progress.report({
                     increment: 100,
                   });
-          
+
                   return false;
                 }
               );
 
               if (!result) {
-                await window.showErrorMessage("Failed to setup example.");
+                void window.setStatusBarMessage(
+                  `Failed to setup example ${example.name}. Please check the output window for more details.`,
+                  5000
+                );
 
                 return;
               }
@@ -769,7 +774,7 @@ export class NewProjectPanel {
               );
             }
             break;
-          case 'updateSetting':
+          case "updateSetting":
             {
               const key = message.key as string;
               const value = message.value as boolean;
@@ -1511,7 +1516,8 @@ export class NewProjectPanel {
       window.activeColorTheme.kind === ColorThemeKind.HighContrast
         ? "dark"
         : "light";
-    const riscvDefaultSvgUri = defaultTheme === "dark" ? riscvWhiteSvgUri : riscvBlackSvgUri;
+    const riscvDefaultSvgUri =
+      defaultTheme === "dark" ? riscvWhiteSvgUri : riscvBlackSvgUri;
 
     this._versionBundlesLoader = new VersionBundlesLoader(this._extensionUri);
 
@@ -1706,7 +1712,9 @@ export class NewProjectPanel {
           const riscvColorSvgUri = "${riscvColorSvgUri.toString()}";
         </script>
       </head>
-      <body class="scroll-smooth w-screen${defaultTheme === "dark" ? " dark" : ""}">
+      <body class="scroll-smooth w-screen${
+        defaultTheme === "dark" ? " dark" : ""
+      }">
         <div id="above-nav" class="container max-w-6xl mx-auto flex justify-between items-center w-full sticky top-0 z-10 pl-5 h-5">
         </div>
         <div id="nav-overlay" class="overlay hidden md:hidden inset-y-0 right-0 w-auto z-50 overflow-y-auto ease-out bg-slate-400 dark:bg-slate-800 drop-shadow-lg">
@@ -2186,10 +2194,8 @@ export class NewProjectPanel {
                   <div class="flex items-stretch space-x-4">
                       <div class="flex items-center px-4 py-2 border border-gray-200 rounded dark:border-gray-700">
                           <input id="use-cmake-tools-cb" type="checkbox" class="w-4 h-4 text-blue-600 bg-gray-100 border-gray-300 outline-none focus:ring-0 focus:ring-offset-5 dark:bg-gray-700 dark:border-gray-600" ${
-                            defaultUseCmakeTools
-                              ? 'checked'
-                              : ''
-                            }>
+                            defaultUseCmakeTools ? "checked" : ""
+                          }>
                           <label for="use-cmake-tools-cb" class="w-full py-4 ml-2 text-sm font-medium text-gray-900 dark:text-gray-300">Enable CMake-Tools extension integration</label>
                       </div>
                   </div>