feat: cobuild runner id

Author: chengcyber

build-tests/rush-redis-cobuild-plugin-integration-test/.vscode/tasks.json

@@ -34,7 +34,7 @@
     {
       "type": "shell",
       "label": "build 1",
-      "command": "node ../../lib/runRush.js --debug cobuild --parallelism 1 --verbose",
+      "command": "node ../../lib/runRush.js --debug cobuild --timeline --parallelism 1 --verbose",
       "problemMatcher": [],
       "options": {
         "cwd": "${workspaceFolder}/sandbox/repo",
@@ -57,7 +57,7 @@
     {
       "type": "shell",
       "label": "build 2",
-      "command": "node ../../lib/runRush.js --debug cobuild --parallelism 1 --verbose",
+      "command": "node ../../lib/runRush.js --debug cobuild --timeline --parallelism 1 --verbose",
       "problemMatcher": [],
       "options": {
         "cwd": "${workspaceFolder}/sandbox/repo",

common/config/rush/nonbrowser-approved-packages.json

@@ -174,10 +174,6 @@
       "name": "@rushstack/package-extractor",
       "allowedCategories": [ "libraries" ]
     },
-    {
-      "name": "@rushstack/rush-redis-cobuild-plugin",
-      "allowedCategories": [ "tests" ]
-    },
     {
       "name": "@rushstack/rig-package",
       "allowedCategories": [ "libraries" ]
@@ -194,6 +190,10 @@
       "name": "@rushstack/rush-http-build-cache-plugin",
       "allowedCategories": [ "libraries" ]
     },
+    {
+      "name": "@rushstack/rush-redis-cobuild-plugin",
+      "allowedCategories": [ "tests" ]
+    },
     {
       "name": "@rushstack/rush-sdk",
       "allowedCategories": [ "libraries", "tests" ]
@@ -738,6 +738,10 @@
       "name": "url-loader",
       "allowedCategories": [ "libraries" ]
     },
+    {
+      "name": "uuid",
+      "allowedCategories": [ "libraries" ]
+    },
     {
       "name": "webpack",
       "allowedCategories": [ "libraries", "tests" ]

common/config/rush/pnpm-lock.yaml

@@ -1,5 +1,5 @@
 // DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush.
 {
-  "pnpmShrinkwrapHash": "e42ca74053e55c066f8ce4291d494a77ebd367fa",
+  "pnpmShrinkwrapHash": "03f6c90980f46e8036baf7f321d98c778148cb22",
   "preferredVersionsHash": "1926a5b12ac8f4ab41e76503a0d1d0dccc9c0e06"
 }

common/config/rush/repo-state.json

@@ -102,10 +102,11 @@ export class CobuildConfiguration {
     readonly cobuildLeafProjectLogOnlyAllowed: boolean;
     // (undocumented)
     get cobuildLockProvider(): ICobuildLockProvider;
+    readonly cobuildRunnerId: string;
     // (undocumented)
     get contextId(): string | undefined;
     // (undocumented)
-    createLockProviderAsync(): Promise<void>;
+    createLockProviderAsync(terminal: ITerminal): Promise<void>;
     // (undocumented)
     destroyLockProviderAsync(): Promise<void>;
     // (undocumented)
@@ -173,6 +174,7 @@ export class EnvironmentConfiguration {
     static get cobuildContextId(): string | undefined;
     static get cobuildEnabled(): boolean | undefined;
     static get cobuildLeafProjectLogOnlyAllowed(): boolean | undefined;
+    static get cobuildRunnerId(): string | undefined;
     // Warning: (ae-forgotten-export) The symbol "IEnvironment" needs to be exported by the entry point index.d.ts
     //
     // @internal
@@ -207,6 +209,7 @@ export const EnvironmentVariableNames: {
     readonly RUSH_BUILD_CACHE_WRITE_ALLOWED: "RUSH_BUILD_CACHE_WRITE_ALLOWED";
     readonly RUSH_COBUILD_ENABLED: "RUSH_COBUILD_ENABLED";
     readonly RUSH_COBUILD_CONTEXT_ID: "RUSH_COBUILD_CONTEXT_ID";
+    readonly RUSH_COBUILD_RUNNER_ID: "RUSH_COBUILD_RUNNER_ID";
     readonly RUSH_COBUILD_LEAF_PROJECT_LOG_ONLY_ALLOWED: "RUSH_COBUILD_LEAF_PROJECT_LOG_ONLY_ALLOWED";
     readonly RUSH_GIT_BINARY_PATH: "RUSH_GIT_BINARY_PATH";
     readonly RUSH_TAR_BINARY_PATH: "RUSH_TAR_BINARY_PATH";
@@ -452,6 +455,7 @@ export interface _INpmOptionsJson extends IPackageManagerOptionsJsonBase {
 
 // @alpha
 export interface IOperationExecutionResult {
+    readonly cobuildRunnerId: string | undefined;
     readonly error: Error | undefined;
     readonly nonCachedDurationMs: number | undefined;
     readonly status: OperationStatus;
@@ -461,6 +465,10 @@ export interface IOperationExecutionResult {
 
 // @internal (undocumented)
 export interface _IOperationMetadata {
+    // (undocumented)
+    cobuildContextId: string | undefined;
+    // (undocumented)
+    cobuildRunnerId: string | undefined;
     // (undocumented)
     durationInSeconds: number;
     // (undocumented)
@@ -520,6 +528,10 @@ export interface _IOperationStateFileOptions {
 
 // @internal (undocumented)
 export interface _IOperationStateJson {
+    // (undocumented)
+    cobuildContextId: string | undefined;
+    // (undocumented)
+    cobuildRunnerId: string | undefined;
     // (undocumented)
     nonCachedDurationMs: number;
 }
@@ -725,7 +737,7 @@ export class _OperationMetadataManager {
     constructor(options: _IOperationMetadataManagerOptions);
     get relativeFilepaths(): string[];
     // (undocumented)
-    saveAsync({ durationInSeconds, logPath, errorLogPath }: _IOperationMetadata): Promise<void>;
+    saveAsync({ durationInSeconds, cobuildContextId, cobuildRunnerId, logPath, errorLogPath }: _IOperationMetadata): Promise<void>;
     // (undocumented)
     readonly stateFile: _OperationStateFile;
     // (undocumented)

common/reviews/api/rush-lib.api.md

@@ -56,7 +56,8 @@
     "strict-uri-encode": "~2.0.0",
     "tapable": "2.2.1",
     "tar": "~6.1.11",
-    "true-case-path": "~2.2.1"
+    "true-case-path": "~2.2.1",
+    "uuid": "~8.3.2"
   },
   "devDependencies": {
     "@pnpm/logger": "4.0.0",
@@ -79,6 +80,7 @@
     "@types/ssri": "~7.1.0",
     "@types/strict-uri-encode": "2.0.0",
     "@types/tar": "6.1.1",
+    "@types/uuid": "~8.3.4",
     "@types/webpack-env": "1.18.0",
     "webpack": "~5.80.0"
   },

libraries/rush-lib/package.json

@@ -7,6 +7,7 @@ import schemaJson from '../schemas/cobuild.schema.json';
 import { EnvironmentConfiguration } from './EnvironmentConfiguration';
 import { CobuildLockProviderFactory, RushSession } from '../pluginFramework/RushSession';
 import { RushConstants } from '../logic/RushConstants';
+import { v4 as uuidv4 } from 'uuid';
 
 import type { ICobuildLockProvider } from '../logic/cobuild/ICobuildLockProvider';
 import type { RushConfiguration } from './RushConfiguration';
@@ -54,6 +55,12 @@ export class CobuildConfiguration {
    * The cobuild feature won't be enabled until the context id is provided as an non-empty string.
    */
   public readonly cobuildContextId: string | undefined;
+
+  /**
+   * This is a name of the participating cobuild runner. It can be specified by the environment variable
+   * RUSH_COBUILD_RUNNER_ID. If it is not provided, a random id will be generated to identify the runner.
+   */
+  public readonly cobuildRunnerId: string;
   /**
    * If true, Rush will automatically handle the leaf project with build cache "disabled" by writing
    * to the cache in a special "log files only mode". This is useful when you want to use Cobuilds
@@ -70,6 +77,7 @@ export class CobuildConfiguration {
 
     this.cobuildEnabled = EnvironmentConfiguration.cobuildEnabled ?? cobuildJson.cobuildEnabled;
     this.cobuildContextId = EnvironmentConfiguration.cobuildContextId;
+    this.cobuildRunnerId = EnvironmentConfiguration.cobuildRunnerId || uuidv4();
     this.cobuildLeafProjectLogOnlyAllowed =
       EnvironmentConfiguration.cobuildLeafProjectLogOnlyAllowed ?? false;
     if (!this.cobuildContextId) {
@@ -129,8 +137,9 @@ export class CobuildConfiguration {
     return this.cobuildContextId;
   }
 
-  public async createLockProviderAsync(): Promise<void> {
+  public async createLockProviderAsync(terminal: ITerminal): Promise<void> {
     if (this.cobuildEnabled) {
+      terminal.writeLine(`Running cobuild (runner ${this.cobuildContextId}/${this.cobuildRunnerId})`);
       const cobuildLockProvider: ICobuildLockProvider = await this._cobuildLockProviderFactory(
         this._cobuildJson
       );

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

@@ -163,6 +163,18 @@ export const EnvironmentVariableNames = {
    */
   RUSH_COBUILD_CONTEXT_ID: 'RUSH_COBUILD_CONTEXT_ID',
 
+  /**
+   * Explicitly specifies a name for each participating cobuild runner.
+   *
+   * Setting this environment variable opt into running with cobuilds.
+   *
+   * @remarks
+   * This environment variable is optional, if it is not provided, a random id is used.
+   *
+   * If there is no cobuild configured, then this environment variable is ignored.
+   */
+  RUSH_COBUILD_RUNNER_ID: 'RUSH_COBUILD_RUNNER_ID',
+
   /**
    * If this variable is set to "1", When getting distributed builds, Rush will automatically handle the leaf project
    * with build cache "disabled" by writing to the cache in a special "log files only mode". This is useful when you
@@ -233,6 +245,8 @@ export class EnvironmentConfiguration {
 
   private static _cobuildContextId: string | undefined;
 
+  private static _cobuildRunnerId: string | undefined;
+
   private static _cobuildLeafProjectLogOnlyAllowed: boolean | undefined;
 
   private static _gitBinaryPath: string | undefined;
@@ -350,6 +364,15 @@ export class EnvironmentConfiguration {
     return EnvironmentConfiguration._cobuildContextId;
   }
 
+  /**
+   * Provides a determined cobuild runner id if configured
+   * See {@link EnvironmentVariableNames.RUSH_COBUILD_RUNNER_ID}
+   */
+  public static get cobuildRunnerId(): string | undefined {
+    EnvironmentConfiguration._ensureValidated();
+    return EnvironmentConfiguration._cobuildRunnerId;
+  }
+
   /**
    * If set, enables or disables the cobuild leaf project log only feature.
    * See {@link EnvironmentVariableNames.RUSH_COBUILD_LEAF_PROJECT_LOG_ONLY_ALLOWED}
@@ -503,6 +526,11 @@ export class EnvironmentConfiguration {
             break;
           }
 
+          case EnvironmentVariableNames.RUSH_COBUILD_RUNNER_ID: {
+            EnvironmentConfiguration._cobuildRunnerId = value;
+            break;
+          }
+
           case EnvironmentVariableNames.RUSH_COBUILD_LEAF_PROJECT_LOG_ONLY_ALLOWED: {
             EnvironmentConfiguration._cobuildLeafProjectLogOnlyAllowed =
               EnvironmentConfiguration.parseBooleanEnvironmentVariable(

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

@@ -320,7 +320,7 @@ export class PhasedScriptAction extends BaseScriptAction<IPhasedCommandConfig> {
         this.rushConfiguration,
         this.rushSession
       );
-      await cobuildConfiguration?.createLockProviderAsync();
+      await cobuildConfiguration?.createLockProviderAsync(terminal);
     }
 
     const projectSelection: Set<RushConfigurationProject> =

libraries/rush-lib/src/cli/scriptActions/PhasedScriptAction.ts

@@ -339,10 +339,20 @@ export class CacheableOperationPlugin implements IPhasedCommandPlugin {
     runner.hooks.afterExecute.tapPromise(
       PLUGIN_NAME,
       async (afterExecuteContext: IOperationRunnerAfterExecuteContext) => {
-        const { context, status, taskIsSuccessful } = afterExecuteContext;
+        const { context, status, taskIsSuccessful, logPath, errorLogPath } = afterExecuteContext;
 
         const { cobuildLock, projectBuildCache, isCacheWriteAllowed, buildCacheTerminal } = buildCacheContext;
 
+        // Save the metadata to disk
+        const { duration: durationInSeconds } = context.stopwatch;
+        await context._operationMetadataManager?.saveAsync({
+          durationInSeconds,
+          cobuildContextId: cobuildLock?.cobuildConfiguration.cobuildContextId,
+          cobuildRunnerId: cobuildLock?.cobuildConfiguration.cobuildRunnerId,
+          logPath,
+          errorLogPath
+        });
+
         if (!buildCacheTerminal) {
           // This should not happen
           throw new InternalError(`Build Cache Terminal is not created`);