fix: include version from package.json into cache key

ahnpnl · ahnpnl · commit de02c793085b · 2024-11-20T14:23:50.000+07:00
Fixes #2844
diff --git a/.gitignore b/.gitignore
@@ -7,6 +7,7 @@ node_modules
 e2e/**/.yarn/*
 examples/**/.yarn/*
 website/.yarn/*
+tmp
 .idx
 .vscode
 !.yarn/patches
diff --git a/src/__snapshots__/ng-jest-transformer.spec.ts.snap b/src/__snapshots__/ng-jest-transformer.spec.ts.snap
@@ -4,7 +4,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
 [
   "
       const pi = parseFloat(3.124);
-      
+
       export { pi };
     ",
   {
@@ -23,7 +23,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
 [
   "
       const pi = parseFloat(3.124);
-      
+
       export { pi };
     ",
   {
@@ -42,7 +42,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
 [
   "
       const pi = parseFloat(3.124);
-      
+
       export { pi };
     ",
   {
@@ -61,7 +61,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
 [
   "
       const pi = parseFloat(3.124);
-      
+
       export { pi };
     ",
   {
@@ -80,7 +80,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
 [
   "
       const pi = parseFloat(3.124);
-      
+
       export { pi };
     ",
   {
@@ -99,7 +99,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
 [
   "
       const pi = parseFloat(3.124);
-      
+
       export { pi };
     ",
   {
@@ -118,7 +118,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
 [
   "
       const pi = parseFloat(3.124);
-      
+
       export { pi };
     ",
   {
@@ -137,7 +137,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
 [
   "
       const pi = parseFloat(3.124);
-      
+
       export { pi };
     ",
   {
@@ -156,7 +156,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
 [
   "
       const pi = parseFloat(3.124);
-      
+
       export { pi };
     ",
   {
@@ -175,7 +175,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
 [
   "
       const pi = parseFloat(3.124);
-      
+
       export { pi };
     ",
   {
@@ -194,7 +194,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
 [
   "
       const pi = parseFloat(3.124);
-      
+
       export { pi };
     ",
   {
@@ -213,7 +213,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
 [
   "
       const pi = parseFloat(3.124);
-      
+
       export { pi };
     ",
   {
diff --git a/src/ng-jest-transformer.spec.ts b/src/ng-jest-transformer.spec.ts
@@ -1,6 +1,7 @@
 import { transformSync } from 'esbuild';
 import { TsJestTransformer } from 'ts-jest';
 
+import packageJson from '../package.json';
 import { NgJestCompiler } from './compiler/ng-jest-compiler';
 import { NgJestConfig } from './config/ng-jest-config';
 import { NgJestTransformer } from './ng-jest-transformer';
@@ -49,7 +50,7 @@ describe('NgJestTransformer', () => {
         tr.process(
             `
       const pi = parseFloat(3.124);
-      
+
       export { pi };
     `,
             'foo.js',
@@ -73,7 +74,7 @@ describe('NgJestTransformer', () => {
         tr.process(
             `
       const pi = parseFloat(3.124);
-      
+
       export { pi };
     `,
             'node_modules/tslib.es6.js',
@@ -125,7 +126,7 @@ describe('NgJestTransformer', () => {
         tr.process(
             `
       const pi = parseFloat(3.124);
-      
+
       export { pi };
     `,
             'foo.mjs',
@@ -134,7 +135,7 @@ describe('NgJestTransformer', () => {
         tr.process(
             `
       const pi = parseFloat(3.124);
-      
+
       export { pi };
     `,
             'node_modules/foo.js',
@@ -184,7 +185,7 @@ describe('NgJestTransformer', () => {
         tr.process(
             `
       const pi = parseFloat(3.124);
-      
+
       export { pi };
     `,
             'foo.mjs',
@@ -193,7 +194,7 @@ describe('NgJestTransformer', () => {
         tr.process(
             `
       const pi = parseFloat(3.124);
-      
+
       export { pi };
     `,
             'node_modules/foo.js',
@@ -205,4 +206,25 @@ describe('NgJestTransformer', () => {
 
         mockedTransformSync.mockClear();
     });
+
+    it('should include version from package.json', async () => {
+        const transformCfg = {
+            config: {
+                cwd: process.cwd(),
+                extensionsToTreatAsEsm: [],
+                testMatch: [],
+                testRegex: [],
+            },
+        } as any; // eslint-disable-line @typescript-eslint/no-explicit-any
+        const tr = new NgJestTransformer({
+            isolatedModules: true,
+        });
+
+        packageJson.version = '1.0.0';
+        const cacheKey1 = tr.getCacheKey('export const foo = 1', 'file1.ts', transformCfg);
+        packageJson.version = '2.0.0';
+        const cacheKey2 = tr.getCacheKey('export const foo = 1', 'file1.ts', transformCfg);
+
+        expect(cacheKey1).not.toBe(cacheKey2);
+    });
 });
diff --git a/src/ng-jest-transformer.ts b/src/ng-jest-transformer.ts
@@ -1,3 +1,5 @@
+import { createHash } from 'node:crypto';
+
 import type { TransformedSource } from '@jest/transform';
 import { LogContexts, LogLevels, type Logger, createLogger } from 'bs-logger';
 import { transformSync } from 'esbuild';
@@ -6,6 +8,41 @@ import { type TsJestTransformerOptions, ConfigSet, TsJestTransformer, type TsJes
 import { NgJestCompiler } from './compiler/ng-jest-compiler';
 import { NgJestConfig } from './config/ng-jest-config';
 
+// stores hashes made out of only one argument being a string
+const cache: Record<string, string> = {};
+
+type DataItem = string | Buffer;
+
+const sha1 = (...data: DataItem[]): string => {
+    const canCache = data.length === 1 && typeof data[0] === 'string';
+    // caching
+    let cacheKey!: string;
+    if (canCache) {
+        cacheKey = data[0] as string;
+        if (cacheKey in cache) {
+            return cache[cacheKey];
+        }
+    }
+
+    // we use SHA1 because it's the fastest provided by node
+    // and we are not concerned about security here
+    const hash = createHash('sha1');
+    data.forEach((item) => {
+        if (typeof item === 'string') {
+            hash.update(item, 'utf8');
+        } else {
+            hash.update(item);
+        }
+    });
+    const res = hash.digest('hex').toString();
+
+    if (canCache) {
+        cache[cacheKey] = res;
+    }
+
+    return res;
+};
+
 export class NgJestTransformer extends TsJestTransformer {
     readonly #ngJestLogger: Logger;
 
@@ -15,8 +52,7 @@ export class NgJestTransformer extends TsJestTransformer {
             context: {
                 [LogContexts.package]: 'jest-preset-angular',
                 [LogContexts.logLevel]: LogLevels.trace,
-                // eslint-disable-next-line @typescript-eslint/no-require-imports
-                version: require('../package.json').version,
+                version: this.version,
             },
             targets: process.env.NG_JEST_LOG ?? undefined,
         });
@@ -30,6 +66,11 @@ export class NgJestTransformer extends TsJestTransformer {
         this._compiler = new NgJestCompiler(configSet, cacheFS);
     }
 
+    private get version(): string {
+        // eslint-disable-next-line @typescript-eslint/no-require-imports
+        return require('../package.json').version;
+    }
+
     process(fileContent: string, filePath: string, transformOptions: TsJestTransformOptions): TransformedSource {
         // @ts-expect-error we are accessing the private cache to avoid creating new objects all the time
         const configSet = super._configsFor(transformOptions);
@@ -55,4 +96,8 @@ export class NgJestTransformer extends TsJestTransformer {
             return super.process(fileContent, filePath, transformOptions);
         }
     }
+
+    getCacheKey(fileContent: string, filePath: string, transformOptions: TsJestTransformOptions): string {
+        return sha1(super.getCacheKey(fileContent, filePath, transformOptions), this.version);
+    }
 }
diff --git a/tsconfig.json b/tsconfig.json
@@ -11,6 +11,7 @@
     "noImplicitReturns": true,
     "skipLibCheck": true,
     "esModuleInterop": true,
+    "resolveJsonModule": true,
     "moduleResolution": "Node",
     "target": "ES2015",
     "module": "CommonJS",

Original file line number	Diff line number	Diff line change
@@ -4,7 +4,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
`4`	`4`	`[`
`5`	`5`	`"`
`6`	`6`	`const pi = parseFloat(3.124);`
`7`		`-`
	`7`	`+`
`8`	`8`	`export { pi };`
`9`	`9`	`",`
`10`	`10`	`{`
@@ -23,7 +23,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
`23`	`23`	`[`
`24`	`24`	`"`
`25`	`25`	`const pi = parseFloat(3.124);`
`26`		`-`
	`26`	`+`
`27`	`27`	`export { pi };`
`28`	`28`	`",`
`29`	`29`	`{`
@@ -42,7 +42,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
`42`	`42`	`[`
`43`	`43`	`"`
`44`	`44`	`const pi = parseFloat(3.124);`
`45`		`-`
	`45`	`+`
`46`	`46`	`export { pi };`
`47`	`47`	`",`
`48`	`48`	`{`
@@ -61,7 +61,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
`61`	`61`	`[`
`62`	`62`	`"`
`63`	`63`	`const pi = parseFloat(3.124);`
`64`		`-`
	`64`	`+`
`65`	`65`	`export { pi };`
`66`	`66`	`",`
`67`	`67`	`{`
@@ -80,7 +80,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
`80`	`80`	`[`
`81`	`81`	`"`
`82`	`82`	`const pi = parseFloat(3.124);`
`83`		`-`
	`83`	`+`
`84`	`84`	`export { pi };`
`85`	`85`	`",`
`86`	`86`	`{`
@@ -99,7 +99,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
`99`	`99`	`[`
`100`	`100`	`"`
`101`	`101`	`const pi = parseFloat(3.124);`
`102`		`-`
	`102`	`+`
`103`	`103`	`export { pi };`
`104`	`104`	`",`
`105`	`105`	`{`
@@ -118,7 +118,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
`118`	`118`	`[`
`119`	`119`	`"`
`120`	`120`	`const pi = parseFloat(3.124);`
`121`		`-`
	`121`	`+`
`122`	`122`	`export { pi };`
`123`	`123`	`",`
`124`	`124`	`{`
@@ -137,7 +137,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
`137`	`137`	`[`
`138`	`138`	`"`
`139`	`139`	`const pi = parseFloat(3.124);`
`140`		`-`
	`140`	`+`
`141`	`141`	`export { pi };`
`142`	`142`	`",`
`143`	`143`	`{`
@@ -156,7 +156,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
`156`	`156`	`[`
`157`	`157`	`"`
`158`	`158`	`const pi = parseFloat(3.124);`
`159`		`-`
	`159`	`+`
`160`	`160`	`export { pi };`
`161`	`161`	`",`
`162`	`162`	`{`
@@ -175,7 +175,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
`175`	`175`	`[`
`176`	`176`	`"`
`177`	`177`	`const pi = parseFloat(3.124);`
`178`		`-`
	`178`	`+`
`179`	`179`	`export { pi };`
`180`	`180`	`",`
`181`	`181`	`{`
@@ -194,7 +194,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
`194`	`194`	`[`
`195`	`195`	`"`
`196`	`196`	`const pi = parseFloat(3.124);`
`197`		`-`
	`197`	`+`
`198`	`198`	`export { pi };`
`199`	`199`	`",`
`200`	`200`	`{`
@@ -213,7 +213,7 @@ exports[`NgJestTransformer should use esbuild to process mjs or \`node_modules\`
`213`	`213`	`[`
`214`	`214`	`"`
`215`	`215`	`const pi = parseFloat(3.124);`
`216`		`-`
	`216`	`+`
`217`	`217`	`export { pi };`
`218`	`218`	`",`
`219`	`219`	`{`