Fetch release tags from releaseTags.json

Author: will-v-pi

data/0.17.0/releaseTags.json

@@ -0,0 +1,16 @@
+{
+  "tools": {
+    "1.5.1": "v1.5.1-0",
+    "2.0.0": "v2.0.0-5",
+    "2.1.0": "v2.1.0-0",
+    "2.1.1": "v2.1.1-1"
+  },
+  "picotool": {
+    "2.0.0": "v2.0.0-5",
+    "2.1.0": "v2.1.0-0",
+    "2.1.1": "v2.1.1-1"
+  },
+  "openocd": {
+    "0.12.0+dev": "v2.0.0-5"
+  }
+} 

src/extension.mts

@@ -78,6 +78,7 @@ import NewExampleProjectCommand from "./commands/newExampleProject.mjs";
 import SwitchBoardCommand from "./commands/switchBoard.mjs";
 import UninstallPicoSDKCommand from "./commands/uninstallPicoSDK.mjs";
 import FlashProjectSWDCommand from "./commands/flashProjectSwd.mjs";
+import ReleaseTagsLoader from "./utils/releaseTags.mjs";
 // eslint-disable-next-line max-len
 import { NewMicroPythonProjectPanel } from "./webview/newMicroPythonProjectPanel.mjs";
 import type { Progress as GotProgress } from "got";
@@ -92,6 +93,7 @@ export async function activate(context: ExtensionContext): Promise<void> {
     context.extension.packageJSON as PackageJSON
   );
   GithubApiCache.createInstance(context);
+  ReleaseTagsLoader.createInstance(context.extensionUri);
 
   const picoProjectActivityBarProvider = new PicoProjectActivityBar();
   const ui = new UI(picoProjectActivityBarProvider);

src/utils/download.mts

@@ -47,6 +47,7 @@ import {
   WINDOWS_X86_PYTHON_DOWNLOAD_URL,
 } from "./sharedConstants.mjs";
 import { compareGe } from "./semverUtil.mjs";
+import ReleaseTagsLoader from "./releaseTags.mjs";
 
 /// Translate nodejs platform names to ninja platform names
 const NINJA_PLATFORMS: { [key: string]: string } = {
@@ -62,34 +63,6 @@ const TOOLS_PLATFORMS: { [key: string]: string } = {
   win32: "x64-win",
 };
 
-/// Release tags for the sdk tools
-const TOOLS_RELEASES: { [key: string]: string } = {
-  // eslint-disable-next-line @typescript-eslint/naming-convention
-  "1.5.1": "v1.5.1-0",
-  // eslint-disable-next-line @typescript-eslint/naming-convention
-  "2.0.0": "v2.0.0-5",
-  // eslint-disable-next-line @typescript-eslint/naming-convention
-  "2.1.0": "v2.1.0-0",
-  // eslint-disable-next-line @typescript-eslint/naming-convention
-  "2.1.1": "v2.1.1-1",
-};
-
-/// Release tags for picotool
-const PICOTOOL_RELEASES: { [key: string]: string } = {
-  // eslint-disable-next-line @typescript-eslint/naming-convention
-  "2.0.0": "v2.0.0-5",
-  // eslint-disable-next-line @typescript-eslint/naming-convention
-  "2.1.0": "v2.1.0-0",
-  // eslint-disable-next-line @typescript-eslint/naming-convention
-  "2.1.1": "v2.1.1-1",
-};
-
-/// Release tags for openocd
-const OPENOCD_RELEASES: { [key: string]: string } = {
-  // eslint-disable-next-line @typescript-eslint/naming-convention
-  "0.12.0+dev": "v2.0.0-5",
-};
-
 /// Translate nodejs platform names to cmake platform names
 const CMAKE_PLATFORMS: { [key: string]: string } = {
   darwin: "macos",
@@ -100,6 +73,26 @@ const CMAKE_PLATFORMS: { [key: string]: string } = {
 // Compute and cache the home directory
 const homeDirectory: string = homedir();
 
+// Cache for release tags loader
+let releaseTagsLoader: ReleaseTagsLoader | undefined;
+
+/**
+ * Get the release tag for a specific version of a component
+ * @param component The component to get the release tag for (tools, picotool, or openocd)
+ * @param version The version to get the release tag for
+ * @returns The release tag or undefined if not found
+ */
+async function getReleaseTag(
+  component: "tools" | "picotool" | "openocd",
+  version: string
+): Promise<string | undefined> {
+  if (!releaseTagsLoader) {
+    releaseTagsLoader = ReleaseTagsLoader.getInstance();
+  }
+
+  return releaseTagsLoader.getReleaseTag(component, version);
+}
+
 export function buildToolchainPath(version: string): string {
   return joinPosix(homeDirectory, ".pico-sdk", "toolchain", version);
 }
@@ -882,11 +875,20 @@ export async function downloadAndInstallTools(
         : "-x86_64"
       : ""
   }-${TOOLS_PLATFORMS[process.platform]}.${assetExt}`;
-  const releaseVersion = TOOLS_RELEASES[version] ?? "v" + version + "-0";
+  
+  const releaseTag = await getReleaseTag("tools", version);
+  if (!releaseTag) {
+    Logger.error(
+      LoggerSource.downloader,
+      `Could not find release tag for SDK tools version ${version}`
+    );
+
+    return false;
+  }
 
   return downloadAndInstallGithubAsset(
     version,
-    releaseVersion,
+    releaseTag,
     GithubRepository.tools,
     targetDirectory,
     archiveFileName,
@@ -912,11 +914,20 @@ export async function downloadAndInstallPicotool(
         : "-x86_64"
       : ""
   }-${TOOLS_PLATFORMS[process.platform]}.${assetExt}`;
-  const releaseVersion = PICOTOOL_RELEASES[version] ?? "v" + version + "-0";
+  
+  const releaseTag = await getReleaseTag("picotool", version);
+  if (!releaseTag) {
+    Logger.error(
+      LoggerSource.downloader,
+      `Could not find release tag for picotool version ${version}`
+    );
+
+    return false;
+  }
 
   return downloadAndInstallGithubAsset(
     version,
-    releaseVersion,
+    releaseTag,
     GithubRepository.tools,
     targetDirectory,
     archiveFileName,
@@ -1061,9 +1072,19 @@ export async function downloadAndInstallOpenOCD(
     }
   };
 
+  const releaseTag = await getReleaseTag("openocd", version);
+  if (!releaseTag) {
+    Logger.error(
+      LoggerSource.downloader,
+      `Could not find release tag for OpenOCD version ${version}`
+    );
+
+    return false;
+  }
+
   return downloadAndInstallGithubAsset(
     version,
-    OPENOCD_RELEASES[version],
+    releaseTag,
     GithubRepository.tools,
     targetDirectory,
     archiveFileName,

src/utils/releaseTags.mts

@@ -0,0 +1,128 @@
+import { readFileSync } from "fs";
+import { Uri } from "vscode";
+import { isInternetConnected } from "./downloadHelpers.mjs";
+import { get } from "https";
+import Logger from "../logger.mjs";
+import { CURRENT_DATA_VERSION } from "./sharedConstants.mjs";
+
+const releaseTagsUrl =
+  "https://raspberrypi.github.io/pico-vscode/" +
+  `${CURRENT_DATA_VERSION}/releaseTags.json`;
+
+export interface ReleaseTags {
+  tools: { [key: string]: string };
+  picotool: { [key: string]: string };
+  openocd: { [key: string]: string };
+}
+
+export default class ReleaseTagsLoader {
+  private static instance: ReleaseTagsLoader | undefined;
+  private tags?: ReleaseTags;
+
+  private constructor(private readonly _extensionUri: Uri) {}
+
+  public static createInstance(extensionUri: Uri): ReleaseTagsLoader {
+    if (!ReleaseTagsLoader.instance) {
+      ReleaseTagsLoader.instance = new ReleaseTagsLoader(extensionUri);
+    }
+
+    return ReleaseTagsLoader.instance;
+  }
+
+  public static getInstance(): ReleaseTagsLoader {
+    if (!ReleaseTagsLoader.instance) {
+      throw new Error("ReleaseTagsLoader not initialized");
+    }
+
+    return ReleaseTagsLoader.instance;
+  }
+
+  private async loadTags(): Promise<void> {
+    try {
+      if (!(await isInternetConnected())) {
+        throw new Error("No internet connection");
+      }
+
+      const result = await new Promise<ReleaseTags>((resolve, reject) => {
+        get(releaseTagsUrl, response => {
+          if (response.statusCode !== 200) {
+            reject(
+              new Error(
+                "Error while downloading release tags. " +
+                  `Status code: ${response.statusCode}`
+              )
+            );
+          }
+          let data = "";
+
+          // Append data as it arrives
+          response.on("data", chunk => {
+            data += chunk;
+          });
+
+          // Parse the JSON data when the download is complete
+          response.on("end", () => {
+            try {
+              // Resolve with the array of ReleaseTags
+              resolve(JSON.parse(data) as ReleaseTags);
+            } catch (error) {
+              reject(
+                new Error(
+                  `Failed to parse release tags JSON: ${
+                    error instanceof Error ? error.message : (error as string)
+                  }`
+                )
+              );
+            }
+          });
+
+          // Handle errors
+          response.on("error", error => {
+            reject(error);
+          });
+        });
+      });
+
+      this.tags = result;
+    } catch (error) {
+      Logger.log(
+        "Failed to download release tags:",
+        error instanceof Error ? error.message : (error as string)
+      );
+
+      try {
+        const tags = readFileSync(
+          Uri.joinPath(
+            this._extensionUri,
+            "data",
+            CURRENT_DATA_VERSION,
+            "releaseTags.json"
+          ).fsPath,
+          "utf8"
+        );
+        this.tags = JSON.parse(tags) as ReleaseTags;
+      } catch (e) {
+        Logger.log(
+          "Failed to load release tags from local file:",
+          e instanceof Error ? e.message : (e as string)
+        );
+        this.tags = {
+          tools: {},
+          picotool: {},
+          openocd: {}
+        };
+      }
+    }
+  }
+
+  public async getReleaseTag(
+    component: keyof ReleaseTags,
+    version: string
+  ): Promise<string | undefined> {
+    if (this.tags === undefined) {
+      await this.loadTags();
+    }
+
+    return this.tags?.[component]?.[version];
+  }
+} 

src/utils/versionBundles.mts

@@ -55,9 +55,9 @@ export default class VersionBundlesLoader {
             data += chunk;
           });
 
-          // Parse the INI data when the download is complete
+          // Parse the JSON data when the download is complete
           response.on("end", () => {
-            // Resolve with the array of SupportedToolchainVersion
+            // Resolve with the array of VersionBundles
             resolve(JSON.parse(data) as VersionBundles);
           });
 
@@ -88,7 +88,7 @@ export default class VersionBundlesLoader {
         this.bundles = JSON.parse(bundles) as VersionBundles;
       } catch (e) {
         Logger.log(
-          "Faild to load version bundles from local file:",
+          "Failed to load version bundles from local file:",
           e instanceof Error ? e.message : (e as string)
         );
         this.bundles = {};