fix(rush): don't update injected state hash on devDep change

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

Author: aramissennyeydd

common/reviews/api/node-core-library.api.md

@@ -42,8 +42,8 @@ export class Async {
     static mapAsync<TEntry extends IWeighted, TRetVal>(iterable: Iterable<TEntry> | AsyncIterable<TEntry>, callback: (entry: TEntry, arrayIndex: number) => Promise<TRetVal>, options: IAsyncParallelismOptions & {
         weighted: true;
     }): Promise<TRetVal[]>;
-    static runWithRetriesAsync<TResult>(input: IRunWithRetriesOptions<TResult>): Promise<TResult>;
-    static runWithTimeoutAsync<TResult>(input: IRunWithTimeoutOptions<TResult>): Promise<TResult>;
+    static runWithRetriesAsync<TResult>({ action, maxRetries, retryDelayMs }: IRunWithRetriesOptions<TResult>): Promise<TResult>;
+    static runWithTimeoutAsync<TResult>({ action, timeoutMs, timeoutMessage }: IRunWithTimeoutOptions<TResult>): Promise<TResult>;
     static sleepAsync(ms: number): Promise<void>;
     static validateWeightedIterable(operation: IWeighted): void;
 }

libraries/rush-lib/src/api/Subspace.ts

@@ -478,7 +478,6 @@ export class Subspace {
         name,
         bin,
         dependencies,
-        devDependencies,
         peerDependencies,
         optionalDependencies,
         dependenciesMeta,
@@ -500,7 +499,6 @@ export class Subspace {
         name,
         bin,
         dependencies,
-        devDependencies,
         peerDependencies,
         optionalDependencies,
         dependenciesMeta,

libraries/rush-lib/src/api/test/Subspace.test.ts

@@ -74,4 +74,80 @@ describe(Subspace.name, () => {
       expect(hashWithCatalogs).toBeDefined();
     });
   });
+
+  describe('getPackageJsonInjectedDependenciesHash', () => {
+    it('returns undefined when no injected dependencies exist', () => {
+      const rushJsonFilename: string = path.resolve(__dirname, 'repo', 'rush-pnpm.json');
+      const rushConfiguration: RushConfiguration =
+        RushConfiguration.loadFromConfigurationFile(rushJsonFilename);
+      const defaultSubspace: Subspace = rushConfiguration.defaultSubspace;
+
+      const hash: string | undefined = defaultSubspace.getPackageJsonInjectedDependenciesHash();
+      expect(hash).toBeUndefined();
+    });
+
+    it('computes a hash when injected dependencies exist', () => {
+      const rushJsonFilename: string = path.resolve(__dirname, 'repoInjectedDeps', 'rush.json');
+      const rushConfiguration: RushConfiguration =
+        RushConfiguration.loadFromConfigurationFile(rushJsonFilename);
+      const defaultSubspace: Subspace = rushConfiguration.defaultSubspace;
+
+      const hash: string | undefined = defaultSubspace.getPackageJsonInjectedDependenciesHash();
+      expect(hash).toBeDefined();
+      expect(typeof hash).toBe('string');
+      expect(hash).toHaveLength(40); // SHA1 hash
+    });
+
+    it('does not change when devDependencies of the injected package change', () => {
+      const rushJsonFilename: string = path.resolve(__dirname, 'repoInjectedDeps', 'rush.json');
+      const rushConfiguration: RushConfiguration =
+        RushConfiguration.loadFromConfigurationFile(rushJsonFilename);
+      const defaultSubspace: Subspace = rushConfiguration.defaultSubspace;
+
+      const hashBefore: string | undefined = defaultSubspace.getPackageJsonInjectedDependenciesHash();
+
+      // Mutate devDependencies of the injected provider package
+      const providerProject = rushConfiguration.getProjectByName('provider')!;
+      const originalDevDeps = providerProject.packageJson.devDependencies;
+      providerProject.packageJson.devDependencies = {
+        ...originalDevDeps,
+        jest: '^29.0.0'
+      };
+
+      const hashAfter: string | undefined = defaultSubspace.getPackageJsonInjectedDependenciesHash();
+
+      expect(hashBefore).toBeDefined();
+      expect(hashAfter).toBeDefined();
+      expect(hashBefore).toBe(hashAfter);
+
+      // Restore
+      providerProject.packageJson.devDependencies = originalDevDeps;
+    });
+
+    it('changes when production dependencies of the injected package change', () => {
+      const rushJsonFilename: string = path.resolve(__dirname, 'repoInjectedDeps', 'rush.json');
+      const rushConfiguration: RushConfiguration =
+        RushConfiguration.loadFromConfigurationFile(rushJsonFilename);
+      const defaultSubspace: Subspace = rushConfiguration.defaultSubspace;
+
+      const hashBefore: string | undefined = defaultSubspace.getPackageJsonInjectedDependenciesHash();
+
+      // Mutate dependencies of the injected provider package
+      const providerProject = rushConfiguration.getProjectByName('provider')!;
+      const originalDeps = providerProject.packageJson.dependencies;
+      providerProject.packageJson.dependencies = {
+        ...originalDeps,
+        axios: '^1.6.0'
+      };
+
+      const hashAfter: string | undefined = defaultSubspace.getPackageJsonInjectedDependenciesHash();
+
+      expect(hashBefore).toBeDefined();
+      expect(hashAfter).toBeDefined();
+      expect(hashBefore).not.toBe(hashAfter);
+
+      // Restore
+      providerProject.packageJson.dependencies = originalDeps;
+    });
+  });
 });

libraries/rush-lib/src/api/test/repoInjectedDeps/consumer/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "consumer",
+  "version": "1.0.0",
+  "dependencies": {
+    "provider": "workspace:*"
+  },
+  "dependenciesMeta": {
+    "provider": {
+      "injected": true
+    }
+  }
+}

libraries/rush-lib/src/api/test/repoInjectedDeps/provider/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "provider",
+  "version": "1.0.0",
+  "dependencies": {
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {
+    "typescript": "~5.3.0"
+  }
+}

libraries/rush-lib/src/api/test/repoInjectedDeps/rush.json

@@ -0,0 +1,17 @@
+{
+  "pnpmVersion": "9.5.0",
+  "rushVersion": "5.46.1",
+  "projectFolderMinDepth": 1,
+  "projectFolderMaxDepth": 99,
+
+  "projects": [
+    {
+      "packageName": "consumer",
+      "projectFolder": "consumer"
+    },
+    {
+      "packageName": "provider",
+      "projectFolder": "provider"
+    }
+  ]
+}