Handle lock file 3 version when caching the typings ensuring we can r…

…euse already installed packages (microsoft#61730)
codeOwlAI · May 16, 2025 · May 21, 2025 · Jun 3, 2025 · Jun 4, 2025 · Jun 4, 2025
commit b504a1eed45e35b5f54694a1e0a09f35d0a5663c
diff --git a/src/testRunner/unittests/tsserver/typingsInstaller.ts b/src/testRunner/unittests/tsserver/typingsInstaller.ts
@@ -1372,6 +1372,113 @@ describe("unittests:: tsserver:: typingsInstaller:: General functionality", () =
         host.runPendingInstalls();
         baselineTsserverLogs("typingsInstaller", "non expired cache entry", session);
     });
+
+    it("expired cache entry (inferred project, should install typings) lockFile3", () => {
+        const file1 = {
+            path: "/home/src/projects/project/app.js",
+            content: "",
+        };
+        const packageJson = {
+            path: "/home/src/projects/project/package.json",
+            content: jsonToReadableText({
+                name: "test",
+                dependencies: {
+                    jquery: "^3.1.0",
+                },
+            }),
+        };
+        const jquery = {
+            path: getPathForTypeScriptTypingInstallerCacheTest("node_modules/@types/jquery/index.d.ts"),
+            content: "declare const $: { x: number }",
+        };
+        const cacheConfig = {
+            path: getPathForTypeScriptTypingInstallerCacheTest("package.json"),
+            content: jsonToReadableText({
+                dependencies: {
+                    "types-registry": "^0.1.317",
+                },
+                devDependencies: {
+                    "@types/jquery": "^1.0.0",
+                },
+            }),
+        };
+        const cacheLockConfig = {
+            path: getPathForTypeScriptTypingInstallerCacheTest("package-lock.json"),
+            content: jsonToReadableText({
+                packages: {
+                    "node_modules/@types/jquery": {
+                        version: "1.0.0",
+                    },
+                },
+            }),
+        };
+        const host = TestServerHost.createServerHost(
+            [file1, packageJson, jquery, cacheConfig, cacheLockConfig],
+            { typingsInstallerTypesRegistry: "jquery" },
+        );
+        const session = new TestSession({
+            host,
+            useSingleInferredProject: true,
+            installAction: [jquery],
+        });
+        openFilesForSession([file1], session);
+        host.runPendingInstalls();
+        host.runQueuedTimeoutCallbacks();
+        baselineTsserverLogs("typingsInstaller", "expired cache entry lockFile3", session);
+    });
+
+    it("non-expired cache entry (inferred project, should not install typings) lockFile3", () => {
+        const file1 = {
+            path: "/home/src/projects/project/app.js",
+            content: "",
+        };
+        const packageJson = {
+            path: "/home/src/projects/project/package.json",
+            content: jsonToReadableText({
+                name: "test",
+                dependencies: {
+                    jquery: "^3.1.0",
+                },
+            }),
+        };
+        const cacheConfig = {
+            path: getPathForTypeScriptTypingInstallerCacheTest("package.json"),
+            content: jsonToReadableText({
+                dependencies: {
+                    "types-registry": "^0.1.317",
+                },
+                devDependencies: {
+                    "@types/jquery": "^1.3.0",
+                },
+            }),
+        };
+        const cacheLockConfig = {
+            path: getPathForTypeScriptTypingInstallerCacheTest("package-lock.json"),
+            content: jsonToReadableText({
+                packages: {
+                    "node_modules/@types/jquery": {
+                        version: "1.3.0",
+                    },
+                },
+            }),
+        };
+        const jquery = {
+            path: getPathForTypeScriptTypingInstallerCacheTest("node_modules/@types/jquery/index.d.ts"),
+            content: "declare const $: { x: number }",
+        };
+        const host = TestServerHost.createServerHost(
+            [file1, packageJson, cacheConfig, cacheLockConfig, jquery],
+            { typingsInstallerTypesRegistry: "jquery" },
+        );
+        const session = new TestSession({
+            host,
+            useSingleInferredProject: true,
+            installAction: true,
+        });
+        openFilesForSession([file1], session);
+        host.runPendingInstalls();
+        baselineTsserverLogs("typingsInstaller", "non expired cache entry lockFile3", session);
+    });
 });
 
 describe("unittests:: tsserver:: typingsInstaller:: Validate package name:", () => {

diff --git a/src/typingsInstallerCore/typingsInstaller.ts b/src/typingsInstallerCore/typingsInstaller.ts
@@ -46,7 +46,10 @@ interface NpmConfig {
 }
 
 interface NpmLock {
-    dependencies: { [packageName: string]: { version: string; }; };
+    dependencies?: { [packageName: string]: { version: string; }; };
+    packages?: {
+        [nodeModulesAtTypesPackage: string]: { version: string; };
+    };
 }
 
 export interface Log {
@@ -304,9 +307,13 @@ export abstract class TypingsInstaller {
                 this.log.writeLine(`Loaded content of '${packageJson}':${stringifyIndented(npmConfig)}`);
                 this.log.writeLine(`Loaded content of '${packageLockJson}':${stringifyIndented(npmLock)}`);
             }
-            if (npmConfig.devDependencies && npmLock.dependencies) {
+            // Packages is present in lock file 3 vs lockfile 2 has dependencies field for already installed types package
+            if (npmConfig.devDependencies && (npmLock.packages || npmLock.dependencies)) {
                 for (const key in npmConfig.devDependencies) {
-                    if (!hasProperty(npmLock.dependencies, key)) {
+                    if (
+                        (npmLock.packages && !hasProperty(npmLock.packages, `node_modules/${key}`)) ||
+                        (npmLock.dependencies && !hasProperty(npmLock.dependencies, key))
+                    ) {
                         // if package in package.json but not package-lock.json, skip adding to cache so it is reinstalled on next use
                         continue;
                     }
@@ -333,7 +340,8 @@ export abstract class TypingsInstaller {
                     if (this.log.isEnabled()) {
                         this.log.writeLine(`Adding entry into typings cache: '${packageName}' => '${typingFile}'`);
                     }
-                    const info = getProperty(npmLock.dependencies, key);
+                    const info = npmLock.packages && getProperty(npmLock.packages, `node_modules/${key}`) ||
+                        getProperty(npmLock.dependencies!, key);
                     const version = info && info.version;
                     if (!version) {
                         continue;