Remove hardcoded mentions of CJS 5.0.0

LinkedSoftwareDependencies · Mar 4, 2024 · 017aa58 · 017aa58
1 parent 0d5c097
commit 017aa58
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 13 deletions.
diff --git a/lib/rdf/PrefetchedDocumentLoader.ts b/lib/rdf/PrefetchedDocumentLoader.ts
@@ -1,27 +1,36 @@
 import type { IJsonLdContext } from 'jsonld-context-parser';
 import { FetchDocumentLoader } from 'jsonld-context-parser';
+import semverMajor = require('semver/functions/major');
 import type { Logger } from 'winston';
 
 /**
  * A document loader that first loads from a precomputed set of contexts,
  * and only then does an HTTP(S) lookup for the context.
  */
 export class PrefetchedDocumentLoader extends FetchDocumentLoader {
+  public static readonly CJS_MAJOR_VERSION: number = semverMajor(require('../../package.json').version);
   public static readonly CONTEXT_URL: string =
-  'https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld';
+  `https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^${PrefetchedDocumentLoader.CJS_MAJOR_VERSION}.0.0/components/context.jsonld`;
+
+  public static readonly CONTEXT_PATTERN: RegExp =
+    /https:\/\/linkedsoftwaredependencies.org\/bundles\/npm\/componentsjs\/\^([0-9]+).0.0\/components\/context.jsonld/u;
 
   private static readonly DEFAULT_CONTEXT: any = require('../../components/context.json');
 
   private static readonly DEFAULT_CONTEXTS: Record<string, any> = {
     [PrefetchedDocumentLoader.CONTEXT_URL]:
     PrefetchedDocumentLoader.DEFAULT_CONTEXT,
-    // TODO: temporarily also set old context versions for backwards-compatible.
-    'https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^4.0.0/components/context.jsonld':
-    PrefetchedDocumentLoader.DEFAULT_CONTEXT,
-    'https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^3.0.0/components/context.jsonld':
-    PrefetchedDocumentLoader.DEFAULT_CONTEXT,
   };
 
+  static {
+    // TODO: temporarily also set old context versions for backwards-compatible.
+    for (let i = 3; i < PrefetchedDocumentLoader.CJS_MAJOR_VERSION; i++) {
+      PrefetchedDocumentLoader.DEFAULT_CONTEXTS[
+        `https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^${i}.0.0/components/context.jsonld`
+      ] = PrefetchedDocumentLoader.DEFAULT_CONTEXT;
+    }
+  }
+
   private readonly contexts: Record<string, any>;
   private readonly path?: string;
   private readonly logger?: Logger;
@@ -37,10 +46,10 @@ export class PrefetchedDocumentLoader extends FetchDocumentLoader {
 
   public async load(url: string): Promise<IJsonLdContext> {
     // Warn on deprecated context usage
-    if (this.logger &&
-      (url === 'https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^4.0.0/components/context.jsonld' ||
-      url === 'https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^3.0.0/components/context.jsonld')) {
-      this.logger.warn(`Detected deprecated context URL '${url}'${this.path ? ` in ${this.path}` : ''}. Prefer using version '^5.0.0' instead.`);
+    // eslint-disable-next-line max-len
+    const match = PrefetchedDocumentLoader.CONTEXT_PATTERN.exec(url);
+    if (this.logger && match && Number.parseInt(match[1], 10) < PrefetchedDocumentLoader.CJS_MAJOR_VERSION) {
+      this.logger.warn(`Detected deprecated context URL '${url}'${this.path ? ` in ${this.path}` : ''}. Prefer using version '^${PrefetchedDocumentLoader.CJS_MAJOR_VERSION}.0.0' instead.`);
     }
 
     // Load prefetched contexts

diff --git a/test/unit/rdf/PrefetchedDocumentLoader-test.ts b/test/unit/rdf/PrefetchedDocumentLoader-test.ts
@@ -46,7 +46,7 @@ describe('PrefetchedDocumentLoader', () => {
       });
       expect(await loader.load(`https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^3.0.0/components/context.jsonld`))
         .toEqual(JSON.parse(fs.readFileSync(`${__dirname}/../../../components/context.jsonld`, 'utf8')));
-      expect(logger.warn).toHaveBeenCalledWith(`Detected deprecated context URL 'https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^3.0.0/components/context.jsonld' in PATH. Prefer using version '^5.0.0' instead.`);
+      expect(logger.warn).toHaveBeenCalledWith(`Detected deprecated context URL 'https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^3.0.0/components/context.jsonld' in PATH. Prefer using version '^${PrefetchedDocumentLoader.CJS_MAJOR_VERSION}.0.0' instead.`);
     });
 
     it('for the built-in prefetched 4.0.0 context that is deprecated with a logger', async() => {
@@ -60,7 +60,21 @@ describe('PrefetchedDocumentLoader', () => {
       });
       expect(await loader.load(`https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^4.0.0/components/context.jsonld`))
         .toEqual(JSON.parse(fs.readFileSync(`${__dirname}/../../../components/context.jsonld`, 'utf8')));
-      expect(logger.warn).toHaveBeenCalledWith(`Detected deprecated context URL 'https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^4.0.0/components/context.jsonld' in PATH. Prefer using version '^5.0.0' instead.`);
+      expect(logger.warn).toHaveBeenCalledWith(`Detected deprecated context URL 'https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^4.0.0/components/context.jsonld' in PATH. Prefer using version '^${PrefetchedDocumentLoader.CJS_MAJOR_VERSION}.0.0' instead.`);
+    });
+
+    it('for the built-in prefetched latest context that is not deprecated with a logger', async() => {
+      const logger: any = {
+        warn: jest.fn(),
+      };
+      loader = new PrefetchedDocumentLoader({
+        contexts: {},
+        logger,
+        path: 'PATH',
+      });
+      expect(await loader.load(`https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^${PrefetchedDocumentLoader.CJS_MAJOR_VERSION}.0.0/components/context.jsonld`))
+        .toEqual(JSON.parse(fs.readFileSync(`${__dirname}/../../../components/context.jsonld`, 'utf8')));
+      expect(logger.warn).not.toHaveBeenCalled();
     });
 
     it('for the built-in prefetched context that is deprecated with a logger without path', async() => {
@@ -73,7 +87,7 @@ describe('PrefetchedDocumentLoader', () => {
       });
       expect(await loader.load(`https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^3.0.0/components/context.jsonld`))
         .toEqual(JSON.parse(fs.readFileSync(`${__dirname}/../../../components/context.jsonld`, 'utf8')));
-      expect(logger.warn).toHaveBeenCalledWith(`Detected deprecated context URL 'https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^3.0.0/components/context.jsonld'. Prefer using version '^5.0.0' instead.`);
+      expect(logger.warn).toHaveBeenCalledWith(`Detected deprecated context URL 'https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^3.0.0/components/context.jsonld'. Prefer using version '^${PrefetchedDocumentLoader.CJS_MAJOR_VERSION}.0.0' instead.`);
     });
 
     it('for a non-prefetched context', async() => {