Fix #215 and #209, Failed to switch stubs / use stubs on external drive

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

Author: paulober

src/activator.mts

@@ -66,7 +66,7 @@ export default class Activator {
     );
 
     this.stubs = new Stubs();
-    await this.stubs.update();
+    await this.stubs.update(settings);
 
     this.comDevice = await settings.getComDevice();
 
@@ -354,6 +354,14 @@ export default class Activator {
             frozen = true;
           }
           if (data.includes("!!ERR!!")) {
+            this.logger.error(
+              "Exception occured (maybe a connection loss). " +
+                `Message dump: ${data}`
+            );
+            console.log(
+              "Exception occured (maybe a connection loss). " +
+                `Message dump: ${data}`
+            );
             // write red text into terminal
             terminal?.write(
               "\x1b[31mException occured (maybe a connection loss)\x1b[0m\r\n"
@@ -1113,7 +1121,7 @@ export default class Activator {
         }
 
         if (version.toLowerCase() === "included") {
-          await installIncludedStubs();
+          await installIncludedStubs(settings);
 
           void vscode.window.showInformationMessage("Included stubs selected.");
         } else {
@@ -1131,7 +1139,8 @@ export default class Activator {
               // TODO: implement cancellation
               const result = await installStubsByVersion(
                 versionParts[1],
-                displayStringToStubPort(versionParts[0])
+                displayStringToStubPort(versionParts[0]),
+                settings
               );
 
               if (result) {

src/api.mts

@@ -1,5 +1,6 @@
 import { homedir } from "os";
 import { join } from "path";
+import { join as joinPosix } from "path/posix";
 import { TextDecoder } from "util";
 import {
   commands,
@@ -75,6 +76,34 @@ export function getVsCodeUserPath(): string {
   return join(folder, "Code", "User");
 }
 
+export function getStubsBasePath(): string {
+  return join(homedir(), ".micropico-stubs");
+}
+
+export function getStubsBasePathPosix(): string {
+  return joinPosix(homedir(), ".micropico-stubs");
+}
+
+export function getIncludedStubsPath(): string {
+  return join(getStubsBasePath(), "included");
+}
+
+export function settingsStubsBasePath(): string {
+  return joinPosix("~", ".micropico-stubs");
+}
+
+export function getStubsPathForVersion(version: string): string {
+  return join(getStubsBasePath(), version);
+}
+
+export function getStubsPathForVersionPosix(version: string): string {
+  return joinPosix(getStubsBasePathPosix(), version);
+}
+
+export function settingsStubsPathForVersion(version: string): string {
+  return join(settingsStubsBasePath(), version);
+}
+
 /**
  * Returns the path to the currently opened project (aka first workspace folder)
  *

src/settings.mts

@@ -1,7 +1,7 @@
 import type { Memento, Uri, WorkspaceConfiguration } from "vscode";
 import { window, workspace as vsWorkspace } from "vscode";
 import { PyboardRunner } from "@paulober/pyboard-serial-com";
-import { extName, getProjectPath } from "./api.mjs";
+import { extName, getProjectPath, settingsStubsBasePath } from "./api.mjs";
 import { join, relative } from "path";
 
 export enum SettingsKey {
@@ -24,10 +24,12 @@ export type Setting = string | boolean | string[] | null | undefined;
 
 export default class Settings {
   private config: WorkspaceConfiguration;
+  private pythonConfig: WorkspaceConfiguration;
   public context: Memento;
 
   constructor(context: Memento) {
     this.config = vsWorkspace.getConfiguration(extName);
+    this.pythonConfig = vsWorkspace.getConfiguration("python.analysis");
 
     this.context = context;
   }
@@ -36,7 +38,11 @@ export default class Settings {
     this.config = vsWorkspace.getConfiguration(extName);
   }
 
-  public get(key: SettingsKey): Setting {
+  public reloadPython(): void {
+    this.pythonConfig = vsWorkspace.getConfiguration("python.analysis");
+  }
+
+  public get(key: SettingsKey | string): Setting {
     return this.config.get(key);
   }
 
@@ -58,10 +64,20 @@ export default class Settings {
     return Array.isArray(value) ? value : undefined;
   }
 
-  public update<T>(key: SettingsKey, value: T): Thenable<void> {
+  public getArrayPython(key: string): string[] | undefined {
+    const value = this.pythonConfig.get(key);
+
+    return Array.isArray(value) ? value : undefined;
+  }
+
+  public update<T>(key: SettingsKey | string, value: T): Thenable<void> {
     return this.config.update(key, value, true);
   }
 
+  public updatePython<T>(key: string, value: T): Thenable<void> {
+    return this.pythonConfig.update(key, value, null);
+  }
+
   // helpers
   /**
    * Get the COM port to connect to.
@@ -200,6 +216,40 @@ export default class Settings {
   public getIngoredSyncItems(): string[] {
     return this.getArray(SettingsKey.pyIgnore) || [];
   }
+
+  public async updateStubsPath(newStubs: string): Promise<boolean> {
+    // catch if stubs where updated before after starting the extension
+    this.reloadPython();
+
+    const typeshedPaths = this.getArrayPython("typeshedPaths");
+    const extraPaths = this.getArrayPython("extraPaths");
+
+    if (typeshedPaths === undefined || extraPaths === undefined) {
+      return false;
+    }
+
+    // Remove paths starting with '~/.micropico-stubs'
+    const filteredTypeshedPaths = typeshedPaths.filter(
+      path =>
+        !path.startsWith(settingsStubsBasePath()) &&
+        !path.includes("Pico-W-Stub")
+    );
+    const filteredExtraPaths = extraPaths.filter(
+      path =>
+        !path.startsWith(settingsStubsBasePath()) &&
+        !path.includes("Pico-W-Stub")
+    );
+
+    // Add newStubs to both arrays
+    filteredTypeshedPaths.push(newStubs);
+    filteredExtraPaths.push(newStubs);
+
+    // Update the settings with the modified arrays
+    await this.updatePython("typeshedPaths", filteredTypeshedPaths);
+    await this.updatePython("extraPaths", filteredExtraPaths);
+
+    return true;
+  }
 }
 
 /**

src/stubs.mts

@@ -1,12 +1,14 @@
 import { commands, window } from "vscode";
-import { join, resolve } from "path";
+import { join } from "path";
 import {
   getProjectPath,
-  getVsCodeUserPath,
+  getStubsPathForVersion,
+  getStubsPathForVersionPosix,
   recommendedExtensions,
+  settingsStubsPathForVersion,
   shouldRecommendExtensions,
 } from "./api.mjs";
-import { mkdir, readdir, symlink } from "fs/promises";
+import { mkdir, readdir } from "fs/promises";
 import {
   pathExists,
   readJsonFile,
@@ -19,6 +21,7 @@ import _ from "lodash";
 import which from "which";
 import { execSync } from "child_process";
 import axios, { HttpStatusCode } from "axios";
+import type Settings from "./settings.mjs";
 
 export default class Stubs {
   private logger: Logger;
@@ -27,13 +30,17 @@ export default class Stubs {
     this.logger = new Logger("Stubs");
   }
 
-  public async update(): Promise<void> {
-    const configFolder = getVsCodeUserPath();
-    const installedStubsFolder = join(configFolder, "Pico-W-Stub");
+  /**
+   * Update localy installed included stubs to the latest version.
+   *
+   * @returns
+   */
+  public async update(settings: Settings): Promise<void> {
+    const installedStubsFolder = getStubsPathForVersion("included");
 
     if (!(await pathExists(join(installedStubsFolder, "version.json")))) {
       // ensure config folder exists
-      await mkdir(configFolder, { recursive: true });
+      await mkdir(installedStubsFolder, { recursive: true });
 
       let installedVersion = "";
       let currentVersion = "";
@@ -64,6 +71,12 @@ export default class Stubs {
       if (installedVersion === currentVersion) {
         this.logger.info("Installed stubs are already up to date!");
 
+        // TODO: remove in future versions, only to convert legacy projects
+        const workspace = getProjectPath();
+        if (workspace) {
+          await this.removeLegacyStubs(join(workspace, ".vscode"), settings);
+        }
+
         return;
       }
     }
@@ -74,6 +87,12 @@ export default class Stubs {
       await copy(join(__dirname, "..", "mpy_stubs"), installedStubsFolder);
 
       this.logger.info("Updated stubs successfully!");
+
+      // TODO: remove in future versions, only to convert legacy projects
+      const workspace = getProjectPath();
+      if (workspace) {
+        await this.removeLegacyStubs(join(workspace, ".vscode"), settings);
+      }
     } catch (error) {
       const msg: string =
         typeof error === "string" ? error : (error as Error).message;
@@ -104,7 +123,7 @@ export default class Stubs {
       await mkdir(vsc);
     }
 
-    await this.addStubs(vsc);
+    await this.removeLegacyStubs(vsc);
     await this.addExtensions(vsc);
     await this.addSettings(vsc);
     await this.addProjectFile(workspace);
@@ -119,19 +138,21 @@ export default class Stubs {
   }
 
   /**
-   * Add stubs to the VS Code user folder
+   * Remove stubs junction from the VS Code workspace folder
    *
    * @param vsc The path to the vscode config folder in current workspace
    */
-  private async addStubs(vsc: string): Promise<void> {
+  private async removeLegacyStubs(
+    vsc: string,
+    settings: Settings | undefined = undefined
+  ): Promise<void> {
     const stubsPath = join(vsc, "Pico-W-Stub");
-    if (!(await pathExists(stubsPath))) {
-      const configFolder = getVsCodeUserPath();
-      await symlink(
-        resolve(join(configFolder, "Pico-W-Stub")),
-        stubsPath,
-        "junction"
-      );
+    if (await pathExists(stubsPath)) {
+      await removeJunction(stubsPath);
+
+      if (settings) {
+        await installIncludedStubs(settings);
+      }
     }
   }
 
@@ -155,7 +176,7 @@ export default class Stubs {
     justUpdate: boolean = false
   ): Promise<void> {
     const settingsFilePath = join(vsc, "settings.json");
-    const stubsPath = join(".vscode", "Pico-W-Stub");
+    const stubsPath = settingsStubsPathForVersion("included");
     const defaultSettings: { [key: string]: string | boolean | object } = {
       // eslint-disable-next-line @typescript-eslint/naming-convention
       "python.linting.enabled": true,
@@ -214,22 +235,8 @@ export default class Stubs {
  *
  * @returns
  */
-export async function installIncludedStubs(): Promise<void> {
-  const workspaceFolder = getProjectPath();
-  if (workspaceFolder === undefined) {
-    return;
-  }
-  const vsc = join(workspaceFolder, ".vscode");
-  const stubsPath = join(vsc, "Pico-W-Stub");
-  if (await pathExists(stubsPath)) {
-    await removeJunction(stubsPath);
-  }
-  const configFolder = getVsCodeUserPath();
-  await symlink(
-    resolve(join(configFolder, "Pico-W-Stub")),
-    stubsPath,
-    "junction"
-  );
+export async function installIncludedStubs(settings: Settings): Promise<void> {
+  await settings.updateStubsPath(settingsStubsPathForVersion("included"));
 }
 
 enum StubPorts {
@@ -269,7 +276,8 @@ export function displayStringToStubPort(displayString: string): string {
 // TODO: option to choose stubs distrbution
 export async function installStubsByVersion(
   version: string,
-  port: string
+  port: string,
+  settings: Settings
 ): Promise<boolean> {
   // check if pip is available
   const pip: string | null = await which("pip", { nothrow: true });
@@ -283,35 +291,21 @@ export async function installStubsByVersion(
     return false;
   }
 
-  const configFolder = getVsCodeUserPath();
-  const target = resolve(
-    join(configFolder, "MicroPico-Stubs", `${port}==${version}`)
-  );
+  const folderName = `${port}==${version}`;
+  const target = getStubsPathForVersionPosix(folderName);
   mkdirpSync(target);
 
   // install stubs with pip vscode user directory
   const result = execSync(
-    `&"${pip}" install ${port}==${version} ` + `--target "${target}" --no-user`,
+    `${
+      process.platform === "win32" ? "&" : ""
+    }"${pip}" install ${port}==${version} ` + `--target "${target}" --no-user`,
     process.platform === "win32" ? { shell: "powershell" } : {}
   );
 
   // check result
   if (result.toString("utf-8").includes("Successfully installed")) {
-    const workspaceFolder = getProjectPath();
-    if (workspaceFolder === undefined) {
-      return false;
-    }
-    const vsc = join(workspaceFolder, ".vscode");
-    const stubsPath = join(vsc, "Pico-W-Stub");
-    // delete stubsPath folder if it exists
-    if (await pathExists(stubsPath)) {
-      await removeJunction(stubsPath);
-    }
-
-    // relink
-    await symlink(target, stubsPath, "junction");
-
-    return true;
+    return settings.updateStubsPath(settingsStubsPathForVersion(folderName));
   }
 
   return false;