refactor: enhance release asset validation

Author: alandefreitas

lib/extension.js

@@ -318,34 +318,73 @@ class CppReferenceExtension {
         const isDevelopOnly = this.config.version === 'develop'
 
         // Sort the releases by the date of their latest asset
-        releasesInfo.sort((a, b) => {
-            // check if at least one asset exists
-            if (!a.assets) {
-                return 1
-            }
-            if (!b.assets) {
-                return -1
+        const releasesArray = Array.isArray(releasesInfo) ? releasesInfo : []
+        if (!Array.isArray(releasesInfo)) {
+            this.logger.warn('GitHub releases response is not an array. Skipping malformed response.')
+            return
+        }
+
+        const sanitizedReleases = []
+        releasesArray.forEach((release, releaseIndex) => {
+            if (!release || typeof release !== 'object') {
+                this.logger.debug(`Skipping release at index ${releaseIndex} because it is not an object.`)
+                return
             }
-            // check if at least one asset has an updated_at field
-            if (!a.assets.some(asset => asset.updated_at)) {
-                return 1
+
+            const releaseTag = typeof release.tag_name === 'string' && release.tag_name.trim()
+                ? release.tag_name.trim()
+                : null
+            if (!releaseTag) {
+                this.logger.debug(`Skipping release at index ${releaseIndex} because tag_name is missing or invalid.`)
+                return
             }
-            if (!b.assets.some(asset => asset.updated_at)) {
-                return -1
+
+            const rawAssets = Array.isArray(release.assets) ? release.assets : []
+            if (!Array.isArray(release.assets)) {
+                this.logger.debug(`Skipping release ${releaseTag} because assets is not an array.`)
+                return
             }
 
-            // Find the latest asset in each release
-            const latestAssetA = a.assets.reduce((latest, asset) => {
-                return new Date(asset.updated_at) > new Date(latest.updated_at) ? asset : latest;
-            }, a.assets[0]);
+            const validAssets = []
+            rawAssets.forEach((asset, assetIndex) => {
+                if (!asset || typeof asset !== 'object') {
+                    this.logger.debug(`Skipping asset ${releaseTag}#${assetIndex} because it is not an object.`)
+                    return
+                }
+
+                const downloadUrl = typeof asset.browser_download_url === 'string' && asset.browser_download_url.trim()
+                    ? asset.browser_download_url.trim()
+                    : null
+                if (!downloadUrl) {
+                    this.logger.debug(`Skipping asset ${releaseTag}#${assetIndex} because browser_download_url is missing or invalid.`)
+                    return
+                }
+
+                const updatedAtRaw = asset.updated_at
+                if (!updatedAtRaw) {
+                    this.logger.debug(`Skipping asset ${downloadUrl} because updated_at is missing.`)
+                    return
+                }
+
+                const updatedAt = new Date(updatedAtRaw)
+                if (Number.isNaN(updatedAt.getTime())) {
+                    this.logger.debug(`Skipping asset ${downloadUrl} because updated_at "${updatedAtRaw}" is not a valid date.`)
+                    return
+                }
+
+                validAssets.push({asset, updatedAt, downloadUrl})
+            })
 
-            const latestAssetB = b.assets.reduce((latest, asset) => {
-                return new Date(asset.updated_at) > new Date(latest.updated_at) ? asset : latest;
-            }, b.assets[0]);
+            if (!validAssets.length) {
+                this.logger.debug(`Skipping release ${releaseTag} because it has no valid assets.`)
+                return
+            }
 
-            // Sort the releases by the date of their latest asset
-            return new Date(latestAssetB.updated_at) - new Date(latestAssetA.updated_at);
-        });
+            validAssets.sort((a, b) => b.updatedAt - a.updatedAt)
+            sanitizedReleases.push({tag: releaseTag, assets: validAssets})
+        })
+
+        sanitizedReleases.sort((a, b) => b.assets[0].updatedAt - a.assets[0].updatedAt)
 
         // Determine the appropriate suffix for the current platform
         let platformSuffix;
@@ -363,7 +402,7 @@ class CppReferenceExtension {
                 throw new Error(`Unsupported platform: ${process.platform}. Supported platforms are win32, linux, and darwin.`);
         }
 
-        function isReleaseMatch(releaseTag, logger) {
+        const isReleaseMatch = (releaseTag, logger) => {
             if (isMatchAny) {
                 logger.debug(`Matching any version. Found a release that satisfies the version requirement: ${releaseTag}`)
                 return true;
@@ -405,34 +444,21 @@ class CppReferenceExtension {
         }
 
         // Iterate over the releases
-        for (const release of releasesInfo) {
-            if (!isReleaseMatch(release.tag_name, this.logger)) {
+        for (const release of sanitizedReleases) {
+            if (!isReleaseMatch(release.tag, this.logger)) {
                 continue
             }
 
-            if (!release.assets) {
-                this.logger.debug(`Skipping release ${release.tag_name} as it has no assets`)
-                continue
-            }
-
-            if (!release.assets.every(asset => asset.updated_at)) {
-                this.logger.debug(`Skipping release ${release.tag_name} as it has assets without an updated_at field`)
-                continue
-            }
-
-            // Sort release assets descending by updated_at
-            release.assets.sort((a, b) => new Date(b.updated_at) - new Date(a.updated_at));
-
             // Iterate over the assets of the release
-            for (const asset of release.assets) {
+            for (const {asset, downloadUrl} of release.assets) {
                 // Check if the asset URL ends with the appropriate suffix for the platform
-                if (asset.browser_download_url.endsWith(platformSuffix)) {
+                if (downloadUrl.endsWith(platformSuffix)) {
                     // Return the URL of the asset and the tag name of the release
-                    this.MrDocsVersion = release.tag_name
-                    this.logger.debug(`Found asset ${asset.browser_download_url} for platform ${process.platform}`)
-                    return {downloadUrl: asset.browser_download_url, downloadTag: release.tag_name};
+                    this.MrDocsVersion = release.tag
+                    this.logger.debug(`Found asset ${downloadUrl} for platform ${process.platform}`)
+                    return {downloadUrl, downloadTag: release.tag};
                 }
-                this.logger.debug(`Skipping asset ${asset.browser_download_url} as it doesn't match the platform suffix ${platformSuffix}`)
+                this.logger.debug(`Skipping asset ${downloadUrl} as it doesn't match the platform suffix ${platformSuffix}`)
             }
         }
 
@@ -630,11 +656,16 @@ class CppReferenceExtension {
             'User-Agent': 'request'
         }
         const releasesResponse = await axios.get('https://api.github.com/repos/cppalliance/mrdocs/releases', {headers: apiHeaders})
-        const releasesInfo = releasesResponse.data
+        const releasesInfo = Array.isArray(releasesResponse && releasesResponse.data)
+            ? releasesResponse.data
+            : []
+        if (!Array.isArray(releasesResponse && releasesResponse.data)) {
+            this.logger.warn('GitHub releases API did not return an array. Continuing with an empty list.')
+        }
         this.logger.debug(`Found ${releasesInfo.length} MrDocs releases`)
         const { downloadUrl, downloadTag } = this.findDownloadUrl(releasesInfo)
-        if (!downloadUrl) {
-            this.logger.error(`Could not find MrDocs binaries for ${process.platform}`)
+        if (!downloadUrl || !downloadTag) {
+            this.logger.error(`Could not find MrDocs binaries for ${process.platform}.`)
             process.exit(1)
         }
         const mrdocsDownloadDir = path.join(mrDocsTreeDir, process.platform)
@@ -1861,4 +1892,4 @@ class CppReferenceExtension {
     }
 }
 
-module.exports = CppReferenceExtension
+module.exports = CppReferenceExtension