Merge pull request #585 from fendor/fix/convert-release-metadata

Properly convert release metadata from json

Author: fendor

Changelog.md

@@ -1,5 +1,10 @@
 # Changelog for vscode-haskell
 
+## 2.1.3 (Pre-release)
+
+- Ignore missing entries in Release Metadata
+  ([#585](https://github.com/haskell/vscode-haskell/pull/585)) by @fendor
+
 ## 2.1.2 (Pre-release)
 
 - Ignore missing entries in Release Metadata

package.json

@@ -2,7 +2,7 @@
   "name": "haskell",
   "displayName": "Haskell",
   "description": "Haskell language support powered by the Haskell Language Server",
-  "version": "2.1.2",
+  "version": "2.1.3",
   "license": "MIT",
   "publisher": "haskell",
   "engines": {

src/hlsBinaries.ts

@@ -726,7 +726,7 @@ async function toolInstalled(
  *
  * consult [ghcup metadata repo](https://github.com/haskell/ghcup-metadata/) for details.
  */
- export type ReleaseMetadata = Map<string, Map<string, Map<string, string[]>>>;
+export type ReleaseMetadata = Map<string, Map<string, Map<string, string[]>>>;
 
 /**
  * Compute Map of supported HLS versions for this platform.
@@ -829,13 +829,29 @@ async function getReleaseMetadata(
 
   const offlineCache = path.join(storagePath, 'ghcupReleases.cache.json');
 
+  /**
+   * Convert a json value to ReleaseMetadata.
+   * Assumes the json is well-formed and a valid Release-Metadata.
+   * @param obj Release Metadata without any typing information but well-formed.
+   * @returns Typed ReleaseMetadata.
+   */
+  const objectToMetadata = (obj: any): ReleaseMetadata => {
+    const hlsMetaEntries = Object.entries(obj).map(([hlsVersion, archMap]) => {
+      const archMetaEntries = Object.entries(archMap as any).map(([arch, supportedGhcVersionsPerOs]) => {
+        return [arch, new Map(Object.entries(supportedGhcVersionsPerOs as any))] as [string, Map<string, string[]>];
+      });
+      return [hlsVersion, new Map(archMetaEntries)] as [string, Map<string, Map<string, string[]>>];
+    });
+    return new Map(hlsMetaEntries);
+  };
+
   async function readCachedReleaseData(): Promise<ReleaseMetadata | null> {
     try {
       logger.info(`Reading cached release data at ${offlineCache}`);
       const cachedInfo = await promisify(fs.readFile)(offlineCache, { encoding: 'utf-8' });
       // export type ReleaseMetadata = Map<string, Map<string, Map<string, string[]>>>;
-      const value: ReleaseMetadata = JSON.parse(cachedInfo);
-      return value;
+      const value: any = JSON.parse(cachedInfo);
+      return objectToMetadata(value);
     } catch (err: any) {
       // If file doesn't exist, return null, otherwise consider it a failure
       if (err.code === 'ENOENT') {
@@ -852,7 +868,7 @@ async function getReleaseMetadata(
 
     // Cache the latest successfully fetched release information
     await promisify(fs.writeFile)(offlineCache, JSON.stringify(releaseInfoParsed), { encoding: 'utf-8' });
-    return releaseInfoParsed;
+    return objectToMetadata(releaseInfoParsed);
   } catch (githubError: any) {
     // Attempt to read from the latest cached file
     try {