fix(project-access): refreshSpecificationDistTags - prevent caching specification-dist-tags.json if an error is returned in the JSON from npm view @sap/ux-specification dist-tags --json

.changeset/itchy-seahorses-compare.md

@@ -0,0 +1,5 @@
+---
+'@sap-ux/project-access': patch
+---
+
+Improve function `refreshSpecificationDistTags` - prevent caching `specification-dist-tags.json` if an error is returned in the JSON from `npm view @sap/ux-specification dist-tags --json`

packages/project-access/src/project/specification.ts

@@ -107,6 +107,10 @@ export async function refreshSpecificationDistTags(options?: { logger?: Logger }
             logger
         });
         const distTags = JSON.parse(distTagsString) as Record<string, string>;
+        if ('error' in distTags) {
+            // Abort writing cache: received error in dist-tags response
+            throw new Error(distTagsString);
+        }
         await writeFile(specificationDistTagPath, JSON.stringify(distTags, null, 4));
         const uniqueVersions = new Set(Object.values(distTags));
 

packages/project-access/test/project/specification.test.ts

@@ -151,6 +151,16 @@ describe('Test refreshSpecificationDistTags()', () => {
         await refreshSpecificationDistTags({ logger });
         expect(logger.error).toHaveBeenCalledWith(expect.stringContaining('NPM_ERROR'));
     });
+
+    test('Refresh specification dist tags - error in response. Contains code and summary.', async () => {
+        const refreshResponse = '{"error": {"code": "ENOTFOUND", "summary": "Request to uri failed."}}';
+        jest.spyOn(commandMock, 'execNpmCommand').mockResolvedValueOnce(refreshResponse);
+        const logger = getMockLogger();
+        await refreshSpecificationDistTags({ logger });
+        expect(logger.error).toHaveBeenCalledWith(
+            `Error refreshing specification dist-tags: Error: ${refreshResponse}`
+        );
+    });
 });
 
 function getMockLogger(): Logger {