Rename "cobuildEnabled" to "cobuildFeatureEnabled" in "cobuild.json"

Author: iclanton

build-tests/rush-redis-cobuild-plugin-integration-test/sandbox/repo/common/config/rush/cobuild.json

@@ -10,7 +10,7 @@
    * RUSH_COBUILD_CONTEXT_ID should always be specified as an environment variable with an non-empty string,
    * otherwise the cobuild feature will be disabled.
    */
-  "cobuildEnabled": true,
+  "cobuildFeatureEnabled": true,
 
   /**
    * (Required) Choose where cobuild lock will be acquired.

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

@@ -97,7 +97,7 @@ export type CloudBuildCacheProviderFactory = (buildCacheJson: IBuildCacheJson) =
 // @beta
 export class CobuildConfiguration {
     readonly cobuildContextId: string | undefined;
-    readonly cobuildEnabled: boolean;
+    readonly cobuildFeatureEnabled: boolean;
     readonly cobuildLeafProjectLogOnlyAllowed: boolean;
     // (undocumented)
     get cobuildLockProvider(): ICobuildLockProvider;
@@ -182,7 +182,7 @@ export class EnvironmentConfiguration {
     static get buildCacheEnabled(): boolean | undefined;
     static get buildCacheWriteAllowed(): boolean | undefined;
     static get cobuildContextId(): string | undefined;
-    static get cobuildEnabled(): boolean | undefined;
+    static get cobuildFeatureEnabled(): 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
@@ -308,7 +308,7 @@ export interface ICobuildContext {
 // @beta (undocumented)
 export interface ICobuildJson {
     // (undocumented)
-    cobuildEnabled: boolean;
+    cobuildFeatureEnabled: boolean;
     // (undocumented)
     cobuildLockProvider: string;
 }

libraries/rush-lib/assets/rush-init/common/config/rush/cobuild.json

@@ -10,7 +10,7 @@
    * RUSH_COBUILD_CONTEXT_ID should always be specified as an environment variable with an non-empty string,
    * otherwise the cobuild feature will be disabled.
    */
-  "cobuildEnabled": false,
+  "cobuildFeatureEnabled": false,
 
   /**
    * (Required) Choose where cobuild lock will be acquired.

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

@@ -15,7 +15,7 @@ import schemaJson from '../schemas/cobuild.schema.json';
  * @beta
  */
 export interface ICobuildJson {
-  cobuildEnabled: boolean;
+  cobuildFeatureEnabled: boolean;
   cobuildLockProvider: string;
 }
 
@@ -46,7 +46,8 @@ export class CobuildConfiguration {
    * actually turn on for that particular build unless the cobuild context id is provided as an
    * non-empty string.
    */
-  public readonly cobuildEnabled: boolean;
+  public readonly cobuildFeatureEnabled: boolean;
+
   /**
    * Cobuild context id
    *
@@ -75,8 +76,8 @@ export class CobuildConfiguration {
     const { cobuildJson, cobuildLockProviderFactory } = options;
 
     this.cobuildContextId = EnvironmentConfiguration.cobuildContextId;
-    this.cobuildEnabled = this.cobuildContextId
-      ? EnvironmentConfiguration.cobuildEnabled ?? cobuildJson.cobuildEnabled
+    this.cobuildFeatureEnabled = this.cobuildContextId
+      ? EnvironmentConfiguration.cobuildFeatureEnabled ?? cobuildJson.cobuildFeatureEnabled
       : false;
     this.cobuildRunnerId = EnvironmentConfiguration.cobuildRunnerId || uuidv4();
     this.cobuildLeafProjectLogOnlyAllowed =
@@ -144,7 +145,7 @@ export class CobuildConfiguration {
   }
 
   public async createLockProviderAsync(terminal: ITerminal): Promise<void> {
-    if (this.cobuildEnabled) {
+    if (this.cobuildFeatureEnabled) {
       terminal.writeLine(`Running cobuild (runner ${this.cobuildContextId}/${this.cobuildRunnerId})`);
       const cobuildLockProvider: ICobuildLockProvider = await this._cobuildLockProviderFactory(
         this._cobuildJson
@@ -155,7 +156,7 @@ export class CobuildConfiguration {
   }
 
   public async destroyLockProviderAsync(): Promise<void> {
-    if (this.cobuildEnabled) {
+    if (this.cobuildFeatureEnabled) {
       await this._cobuildLockProvider?.disconnectAsync();
     }
   }

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

@@ -145,11 +145,11 @@ export const EnvironmentVariableNames = {
   RUSH_BUILD_CACHE_WRITE_ALLOWED: 'RUSH_BUILD_CACHE_WRITE_ALLOWED',
 
   /**
-   * Setting this environment variable overrides the value of `cobuildEnabled` in the `cobuild.json`
+   * Setting this environment variable overrides the value of `cobuildFeatureEnabled` in the `cobuild.json`
    * configuration file.
    *
    * @remarks
-   * Specify `1` to enable the cobuild or `0` to disable it.
+   * Specify `1` to enable the cobuild feature or `0` to disable it.
    *
    * If there is no cobuild configured, then this environment variable is ignored.
    */
@@ -244,7 +244,7 @@ export class EnvironmentConfiguration {
 
   private static _buildCacheWriteAllowed: boolean | undefined;
 
-  private static _cobuildEnabled: boolean | undefined;
+  private static _cobuildFeatureEnabled: boolean | undefined;
 
   private static _cobuildContextId: string | undefined;
 
@@ -353,9 +353,9 @@ export class EnvironmentConfiguration {
    * If set, enables or disables the cobuild feature.
    * See {@link EnvironmentVariableNames.RUSH_COBUILD_ENABLED}
    */
-  public static get cobuildEnabled(): boolean | undefined {
+  public static get cobuildFeatureEnabled(): boolean | undefined {
     EnvironmentConfiguration._ensureValidated();
-    return EnvironmentConfiguration._cobuildEnabled;
+    return EnvironmentConfiguration._cobuildFeatureEnabled;
   }
 
   /**
@@ -516,7 +516,7 @@ export class EnvironmentConfiguration {
           }
 
           case EnvironmentVariableNames.RUSH_COBUILD_ENABLED: {
-            EnvironmentConfiguration._cobuildEnabled =
+            EnvironmentConfiguration._cobuildFeatureEnabled =
               EnvironmentConfiguration.parseBooleanEnvironmentVariable(
                 EnvironmentVariableNames.RUSH_COBUILD_ENABLED,
                 value

libraries/rush-lib/src/logic/operations/CacheableOperationPlugin.ts

@@ -97,7 +97,7 @@ export class CacheableOperationPlugin implements IPhasedCommandPlugin {
 
         this._createContext = context;
 
-        const disjointSet: DisjointSet<Operation> | undefined = cobuildConfiguration?.cobuildEnabled
+        const disjointSet: DisjointSet<Operation> | undefined = cobuildConfiguration?.cobuildFeatureEnabled
           ? new DisjointSet()
           : undefined;
 
@@ -182,7 +182,7 @@ export class CacheableOperationPlugin implements IPhasedCommandPlugin {
           }
 
           for (const operationSet of disjointSet.getAllSets()) {
-            if (cobuildConfiguration?.cobuildEnabled && cobuildConfiguration.cobuildContextId) {
+            if (cobuildConfiguration?.cobuildFeatureEnabled && cobuildConfiguration.cobuildContextId) {
               // Get a deterministic ordered array of operations, which is important to get a deterministic cluster id.
               const groupedOperations: Operation[] = Array.from(operationSet);
               Sort.sortBy(groupedOperations, (operation: Operation) => {
@@ -292,7 +292,7 @@ export class CacheableOperationPlugin implements IPhasedCommandPlugin {
 
           // Try to acquire the cobuild lock
           let cobuildLock: CobuildLock | undefined;
-          if (cobuildConfiguration?.cobuildEnabled) {
+          if (cobuildConfiguration?.cobuildFeatureEnabled) {
             if (
               cobuildConfiguration?.cobuildLeafProjectLogOnlyAllowed &&
               record.operation.consumers.size === 0 &&
@@ -740,7 +740,7 @@ export class CacheableOperationPlugin implements IPhasedCommandPlugin {
     phaseName: string;
   }): Promise<CobuildLock | undefined> {
     if (!buildCacheContext.cobuildLock) {
-      if (projectBuildCache && cobuildConfiguration?.cobuildEnabled) {
+      if (projectBuildCache && cobuildConfiguration?.cobuildFeatureEnabled) {
         if (!buildCacheContext.cobuildClusterId) {
           // This should not happen
           throw new InternalError('Cobuild cluster id is not defined');

libraries/rush-lib/src/schemas/cobuild.schema.json

@@ -15,13 +15,13 @@
     {
       "type": "object",
       "additionalProperties": false,
-      "required": ["cobuildEnabled", "cobuildLockProvider"],
+      "required": ["cobuildFeatureEnabled", "cobuildLockProvider"],
       "properties": {
         "$schema": {
           "description": "Part of the JSON Schema standard, this optional keyword declares the URL of the schema that the file conforms to. Editors may download the schema and use it to perform syntax highlighting.",
           "type": "string"
         },
-        "cobuildEnabled": {
+        "cobuildFeatureEnabled": {
           "description": "Set this to true to enable the cobuild feature.",
           "type": "boolean"
         },