JS-757 Refactor package.json cache (#5697)

Author: vdiez

packages/jsts/src/analysis/analyzer.ts

@@ -31,10 +31,10 @@ import { SymbolHighlight } from '../linter/visitors/symbol-highlighting.js';
 import { computeMetrics, findNoSonarLines } from '../linter/visitors/metrics/index.js';
 import { getSyntaxHighlighting } from '../linter/visitors/syntax-highlighting.js';
 import { getCpdTokens } from '../linter/visitors/cpd.js';
-import { clearDependenciesCache } from '../rules/helpers/index.js';
 import { fillFileContent } from '../../../shared/src/types/analysis.js';
 import { shouldIgnoreFile } from '../../../shared/src/helpers/filter/filter.js';
 import { setGlobalConfiguration } from '../../../shared/src/helpers/configuration.js';
+import { clearDependenciesCache } from '../rules/helpers/package-jsons/index.js';
 
 /**
  * Analyzes a JavaScript / TypeScript analysis input

packages/jsts/src/analysis/projectAnalysis/file-stores/package-jsons.ts

@@ -15,39 +15,34 @@
  * along with this program; if not, see https://sonarsource.com/license/ssal/
  */
 
-import type { PackageJson } from 'type-fest';
 import { getFsEvents } from '../../../../../shared/src/helpers/configuration.js';
 import { basename, dirname } from 'node:path/posix';
-import {
-  clearDependenciesCache,
-  fillCacheWithNewPath,
-  PACKAGE_JSON,
-} from '../../../rules/helpers/index.js';
+import { readFile } from 'node:fs/promises';
 import type { Dirent } from 'node:fs';
 import { warn, debug } from '../../../../../shared/src/helpers/logging.js';
 import { FileStore } from './store-type.js';
-import { readFile } from '../../../../../shared/src/helpers/files.js';
+import type { File } from '../../../rules/helpers/files.js';
+import {
+  clearDependenciesCache,
+  fillPackageJsonCaches,
+  PACKAGE_JSON,
+} from '../../../rules/helpers/package-jsons/index.js';
 
 export const UNINITIALIZED_ERROR =
   'package.json cache has not been initialized. Call loadFiles() first.';
 
-type PackageJsonWithPath = {
-  filePath: string;
-  fileContent: PackageJson;
-};
-
 export class PackageJsonStore implements FileStore {
-  private packageJsons: PackageJsonWithPath[] | undefined = undefined;
+  private readonly packageJsons: Map<string, File> = new Map();
   private baseDir: string | undefined = undefined;
-  private readonly paths = new Set<string>();
+  private readonly dirnameToParent: Map<string, string | undefined> = new Map();
 
   async isInitialized(baseDir: string) {
     this.dirtyCachesIfNeeded(baseDir);
-    return typeof this.packageJsons !== 'undefined';
+    return typeof this.baseDir !== 'undefined';
   }
 
   getPackageJsons() {
-    if (!this.packageJsons) {
+    if (!this.baseDir) {
       throw new Error(UNINITIALIZED_ERROR);
     }
     return this.packageJsons;
@@ -68,48 +63,41 @@ export class PackageJsonStore implements FileStore {
   }
 
   clearCache() {
-    this.packageJsons = undefined;
     this.baseDir = undefined;
-    this.paths.clear();
+    this.packageJsons.clear();
+    this.dirnameToParent.clear();
     debug('Clearing dependencies cache');
     clearDependenciesCache();
   }
 
   setup(baseDir: string) {
     this.baseDir = baseDir;
-    this.paths.add(baseDir);
-    this.packageJsons = [];
+    this.dirnameToParent.set(baseDir, undefined);
   }
 
   async processFile(file: Dirent, filePath: string) {
-    if (!this.packageJsons) {
+    if (!this.baseDir) {
       throw new Error(UNINITIALIZED_ERROR);
     }
     if (file.name === PACKAGE_JSON) {
       try {
-        const fileContent = JSON.parse(await readFile(filePath));
-        this.packageJsons.push({ filePath, fileContent });
+        const content = await readFile(filePath, 'utf-8');
+        this.packageJsons.set(dirname(filePath), { content, path: filePath });
       } catch (e) {
-        warn(`Error parsing package.json ${filePath}: ${e}`);
+        warn(`Error reading package.json ${filePath}: ${e}`);
       }
     }
   }
 
   processDirectory(dir: string) {
-    this.paths.add(dir);
+    const parent = dirname(dir);
+    this.dirnameToParent.set(dir, parent);
   }
 
   async postProcess() {
-    if (!this.packageJsons) {
+    if (!this.baseDir) {
       throw new Error(UNINITIALIZED_ERROR);
     }
-    for (const projectPath of this.paths) {
-      fillCacheWithNewPath(
-        projectPath,
-        this.packageJsons
-          .filter(({ filePath }) => projectPath.startsWith(dirname(filePath)))
-          .map(({ fileContent }) => fileContent),
-      );
-    }
+    fillPackageJsonCaches(this.packageJsons, this.dirnameToParent, this.baseDir);
   }
 }

packages/jsts/src/linter/linter.ts

@@ -23,7 +23,7 @@ import { FileType } from '../../../shared/src/helpers/files.js';
 import { LintingResult, transformMessages } from './issues/transform.js';
 import { customRules } from './custom-rules/rules.js';
 import * as internalRules from '../rules/rules.js';
-import { getClosestPackageJSONDir, getDependencies, toUnixPath } from '../rules/helpers/index.js';
+import { toUnixPath } from '../rules/helpers/index.js';
 import { createOptions } from './pragmas.js';
 import path from 'path';
 import { ParseResult } from '../parsers/parse.js';
@@ -32,9 +32,11 @@ import globalsPkg from 'globals';
 import { APIError } from '../../../shared/src/errors/error.js';
 import { pathToFileURL } from 'node:url';
 import * as ruleMetas from '../rules/metas.js';
-import { extname } from 'node:path/posix';
+import { extname, dirname } from 'node:path/posix';
 import { defaultOptions } from '../rules/helpers/configs.js';
 import merge from 'lodash.merge';
+import { getDependencies } from '../rules/helpers/package-jsons/dependencies.js';
+import { getClosestPackageJSONDir } from '../rules/helpers/package-jsons/closest.js';
 
 interface InitializeParams {
   rules?: RuleConfig[];
@@ -251,7 +253,7 @@ export class Linter {
        * The wrapper's linting configuration includes multiple ESLint
        * configurations: one per fileType/language/analysisMode combination.
        */
-      const dependencies = getDependencies(filePath, Linter.baseDir);
+      const dependencies = getDependencies(dirname(filePath), Linter.baseDir);
       const rules = Linter.ruleConfigs?.filter(ruleConfig => {
         const {
           fileTypeTargets,
@@ -337,6 +339,6 @@ function createLinterConfigKey(
   language: JsTsLanguage,
   analysisMode: AnalysisMode,
 ) {
-  const packageJsonDirName = getClosestPackageJSONDir(filePath, baseDir);
+  const packageJsonDirName = getClosestPackageJSONDir(dirname(filePath), baseDir);
   return `${fileType}-${language}-${analysisMode}-${extname(toUnixPath(filePath))}-${packageJsonDirName}`;
 }

packages/jsts/src/rules/S1607/rule.ts

@@ -20,9 +20,7 @@ import type { Rule } from 'eslint';
 import type estree from 'estree';
 import {
   generateMeta,
-  getDependencies,
   getFullyQualifiedName,
-  getManifests,
   getProperty,
   getValueOfExpression,
   isFunctionInvocation,
@@ -34,7 +32,9 @@ import {
 } from '../helpers/index.js';
 import * as meta from './generated-meta.js';
 import type { TSESTree } from '@typescript-eslint/utils';
-import { dirname } from 'path/posix';
+import { dirname } from 'node:path';
+import { getDependencies } from '../helpers/package-jsons/dependencies.js';
+import { getManifests } from '../helpers/package-jsons/all-in-parent-dirs.js';
 
 export const rule: Rule.RuleModule = {
   meta: generateMeta(meta, {
@@ -43,7 +43,7 @@ export const rule: Rule.RuleModule = {
     },
   }),
   create(context) {
-    const dependencies = getDependencies(context.filename, context.cwd);
+    const dependencies = getDependencies(dirname(context.filename), context.cwd);
     switch (true) {
       case dependencies.has('jasmine'):
         return jasmineListener();

packages/jsts/src/rules/S4328/rule.ts

@@ -20,10 +20,12 @@ import type { Rule } from 'eslint';
 import type estree from 'estree';
 import builtins from 'builtin-modules';
 import ts from 'typescript';
-import { generateMeta, getDependencies } from '../helpers/index.js';
+import { generateMeta } from '../helpers/index.js';
 import { FromSchema } from 'json-schema-to-ts';
 import * as meta from './generated-meta.js';
 import { Minimatch } from 'minimatch';
+import { dirname } from 'node:path';
+import { getDependencies } from '../helpers/package-jsons/dependencies.js';
 
 const messages = {
   removeOrAddDependency: 'Either remove this import or add it as a dependency.',
@@ -33,7 +35,7 @@ export const rule: Rule.RuleModule = {
   meta: generateMeta(meta, { messages }),
   create(context: Rule.RuleContext) {
     // we need to find all the npm manifests from the directory of the analyzed file to the context working directory
-    const dependencies = getDependencies(context.filename, context.cwd);
+    const dependencies = getDependencies(dirname(context.filename), context.cwd);
 
     const whitelist = (context.options as FromSchema<typeof meta.schema>)[0]?.whitelist || [];
     const program = context.sourceCode.parserServices?.program;

packages/jsts/src/rules/S5973/rule.ts

@@ -19,14 +19,15 @@
 import type { Rule } from 'eslint';
 import {
   generateMeta,
-  getDependencies,
   getFullyQualifiedName,
   isIdentifier,
   isMethodInvocation,
   Mocha,
 } from '../helpers/index.js';
 import type estree from 'estree';
 import * as meta from './generated-meta.js';
+import { dirname } from 'node:path';
+import { getDependencies } from '../helpers/package-jsons/dependencies.js';
 
 export const rule: Rule.RuleModule = {
   meta: generateMeta(meta, {
@@ -79,7 +80,7 @@ function hasJestRetry(context: Rule.RuleContext, node: estree.CallExpression, ha
 }
 
 function hasJestDependency(context: Rule.RuleContext) {
-  const dependencies = getDependencies(context.filename, context.cwd);
+  const dependencies = getDependencies(dirname(context.filename), context.cwd);
   return dependencies.has('jest');
 }
 

packages/jsts/src/rules/S6477/rule.ts

@@ -17,10 +17,12 @@
 // https://sonarsource.github.io/rspec/#/rspec/S6477/javascript
 
 import type { Rule } from 'eslint';
+import { dirname } from 'node:path';
 import { rules } from '../external/react.js';
-import { generateMeta, getDependencies } from '../helpers/index.js';
+import { generateMeta } from '../helpers/index.js';
 import { decorate } from './decorator.js';
 import * as meta from './generated-meta.js';
+import { getDependencies } from '../helpers/package-jsons/dependencies.js';
 
 const decoratedJsxKey = decorate(rules['jsx-key']);
 
@@ -31,7 +33,7 @@ export const rule: Rule.RuleModule = {
     },
   }),
   create(context: Rule.RuleContext) {
-    const dependencies = getDependencies(context.filename, context.cwd);
+    const dependencies = getDependencies(dirname(context.filename), context.cwd);
     if (!dependencies.has('react')) {
       return {};
     }

packages/jsts/src/rules/S6747/rule.ts

@@ -17,12 +17,14 @@
 // https://sonarsource.github.io/rspec/#/rspec/S6747/javascript
 
 import type { Rule } from 'eslint';
+import { dirname } from 'node:path';
 import { rules as reactRules } from '../external/react.js';
 import { rules as jsxA11yRules } from '../external/a11y.js';
-import { generateMeta, getDependencies, interceptReport, mergeRules } from '../helpers/index.js';
+import { generateMeta, interceptReport, mergeRules } from '../helpers/index.js';
 import { decorate } from './decorator.js';
 import type { TSESTree } from '@typescript-eslint/utils';
 import * as meta from './generated-meta.js';
+import { getDependencies } from '../helpers/package-jsons/dependencies.js';
 
 const noUnknownProp = reactRules['no-unknown-property'];
 const decoratedNoUnknownProp = decorate(noUnknownProp);
@@ -85,7 +87,7 @@ export const rule: Rule.RuleModule = {
   }),
 
   create(context: Rule.RuleContext) {
-    const dependencies = getDependencies(context.filename, context.cwd);
+    const dependencies = getDependencies(dirname(context.filename), context.cwd);
     if (!dependencies.has('react')) {
       return {};
     }

packages/jsts/src/rules/S6957/rule.ts

@@ -18,10 +18,11 @@
 
 import type { Rule } from 'eslint';
 import { rules } from '../external/react.js';
-import { generateMeta, getManifests, toUnixPath } from '../helpers/index.js';
+import { generateMeta, toUnixPath } from '../helpers/index.js';
 import { FromSchema } from 'json-schema-to-ts';
 import * as meta from './generated-meta.js';
 import { dirname } from 'path/posix';
+import { getManifests } from '../helpers/package-jsons/all-in-parent-dirs.js';
 
 const reactNoDeprecated = rules['no-deprecated'];
 

packages/jsts/src/rules/helpers/cache.ts

@@ -0,0 +1,54 @@
+/*
+ * SonarQube JavaScript Plugin
+ * Copyright (C) 2011-2025 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+
+export class ComputedCache<K, V, TContext = null> {
+  private readonly cache: Map<K, V>;
+
+  constructor(private readonly computeFn: (key: K, context?: TContext) => V) {
+    this.cache = new Map();
+  }
+
+  get(key: K, context?: TContext) {
+    if (this.cache.has(key)) {
+      return this.cache.get(key)!;
+    }
+
+    const value = this.computeFn(key, context);
+    this.cache.set(key, value);
+    return value;
+  }
+
+  set(key: K, value: V) {
+    this.cache.set(key, value);
+  }
+
+  has(key: K) {
+    return this.cache.has(key);
+  }
+
+  delete(key: K) {
+    return this.cache.delete(key);
+  }
+
+  clear() {
+    this.cache.clear();
+  }
+
+  get size() {
+    return this.cache.size;
+  }
+}