@rushstack/rush-bridge-cache-plugin 5.170.0 → 5.170.1-pr5378.0

package/lib-commonjs/BridgeCachePlugin.js

@@ -20,92 +20,79 @@ class BridgeCachePlugin {
     }
     apply(session) {
         session.hooks.runAnyPhasedCommand.tapPromise(PLUGIN_NAME, async (command) => {
-            const logger = session.getLogger(PLUGIN_NAME);
-            let cacheAction;
-            let requireOutputFolders = false;
-            // cancel the actual operations. We don't want to run the command, just cache the output folders on disk
-            command.hooks.createOperations.tap({ name: PLUGIN_NAME, stage: Number.MAX_SAFE_INTEGER }, (operations, context) => {
-                var _a;
-                const { customParameters } = context;
-                cacheAction = this._getCacheAction(customParameters);
+            command.hooks.onGraphCreatedAsync.tap(PLUGIN_NAME, async (graph, context) => {
+                const { customParameters, buildCacheConfiguration } = context;
+                const cacheAction = this._getCacheAction(customParameters);
                 if (cacheAction !== undefined) {
-                    if (!((_a = context.buildCacheConfiguration) === null || _a === void 0 ? void 0 : _a.buildCacheEnabled)) {
+                    if (!(buildCacheConfiguration === null || buildCacheConfiguration === void 0 ? void 0 : buildCacheConfiguration.buildCacheEnabled)) {
                         throw new Error(`The build cache must be enabled to use the "${this._actionParameterName}" parameter.`);
                     }
-                    for (const operation of operations) {
-                        operation.enabled = false;
-                    }
-                    requireOutputFolders = this._isRequireOutputFoldersFlagSet(customParameters);
-                }
-                return operations;
-            });
-            // populate the cache for each operation
-            command.hooks.beforeExecuteOperations.tapPromise(PLUGIN_NAME, async (recordByOperation, context) => {
-                const { buildCacheConfiguration, rushConfiguration: { experimentsConfiguration: { configuration: { omitAppleDoubleFilesFromBuildCache } } } } = context;
-                const { terminal } = logger;
-                if (cacheAction === undefined) {
-                    return;
-                }
-                if (!(buildCacheConfiguration === null || buildCacheConfiguration === void 0 ? void 0 : buildCacheConfiguration.buildCacheEnabled)) {
-                    throw new Error(`The build cache must be enabled to use the "${this._actionParameterName}" parameter.`);
-                }
-                const filteredOperations = new Set();
-                for (const operationExecutionResult of recordByOperation.values()) {
-                    if (!operationExecutionResult.operation.isNoOp) {
-                        filteredOperations.add(operationExecutionResult);
-                    }
-                }
-                let successCount = 0;
-                await node_core_library_1.Async.forEachAsync(filteredOperations, async (operationExecutionResult) => {
-                    var _a, _b, _c, _d;
-                    const projectBuildCache = rush_sdk_1._OperationBuildCache.forOperation(operationExecutionResult, {
-                        buildCacheConfiguration,
-                        terminal,
-                        excludeAppleDoubleFiles: !!omitAppleDoubleFilesFromBuildCache
-                    });
-                    const { operation } = operationExecutionResult;
-                    if (cacheAction === CACHE_ACTION_READ) {
-                        const success = await projectBuildCache.tryRestoreFromCacheAsync(terminal);
-                        if (success) {
-                            ++successCount;
-                            terminal.writeLine(`Operation "${operation.name}": Outputs have been restored from the build cache."`);
-                            terminal.writeLine(`Cache key: ${projectBuildCache.cacheId}`);
+                    const { rushConfiguration: { experimentsConfiguration: { configuration: { omitAppleDoubleFilesFromBuildCache } } } } = context;
+                    const logger = session.getLogger(PLUGIN_NAME);
+                    const { terminal } = logger;
+                    const requireOutputFolders = this._isRequireOutputFoldersFlagSet(customParameters);
+                    graph.hooks.beforeExecuteIterationAsync.tapPromise(PLUGIN_NAME, async (operationRecords, iterationOptions) => {
+                        const filteredOperations = [];
+                        for (const record of operationRecords.values()) {
+                            if (!record.operation.isNoOp) {
+                                filteredOperations.push(record);
+                            }
                         }
-                        else {
-                            terminal.writeWarningLine(`Operation "${operation.name}": Outputs could not be restored from the build cache.`);
+                        if (!filteredOperations.length) {
+                            return; // nothing to do, continue normal execution
                         }
-                    }
-                    else if (cacheAction === CACHE_ACTION_WRITE) {
-                        // if the require output folders flag has been passed, skip populating the cache if any of the expected output folders does not exist
-                        if (requireOutputFolders &&
-                            ((_a = operation.settings) === null || _a === void 0 ? void 0 : _a.outputFolderNames) &&
-                            ((_c = (_b = operation.settings) === null || _b === void 0 ? void 0 : _b.outputFolderNames) === null || _c === void 0 ? void 0 : _c.length) > 0) {
-                            const projectFolder = (_d = operation.associatedProject) === null || _d === void 0 ? void 0 : _d.projectFolder;
-                            const missingFolders = [];
-                            operation.settings.outputFolderNames.forEach((outputFolderName) => {
-                                if (!node_core_library_1.FileSystem.exists(`${projectFolder}/${outputFolderName}`)) {
-                                    missingFolders.push(outputFolderName);
-                                }
+                        let successCount = 0;
+                        await node_core_library_1.Async.forEachAsync(filteredOperations, async (operationExecutionResult) => {
+                            var _a, _b, _c, _d;
+                            const projectBuildCache = rush_sdk_1._OperationBuildCache.forOperation(operationExecutionResult, {
+                                buildCacheConfiguration,
+                                terminal,
+                                excludeAppleDoubleFiles: !!omitAppleDoubleFilesFromBuildCache
                             });
-                            if (missingFolders.length > 0) {
-                                terminal.writeWarningLine(`Operation "${operation.name}": The following output folders do not exist: "${missingFolders.join('", "')}". Skipping cache population.`);
-                                return;
+                            const { operation } = operationExecutionResult;
+                            if (cacheAction === CACHE_ACTION_READ) {
+                                const success = await projectBuildCache.tryRestoreFromCacheAsync(terminal);
+                                if (success) {
+                                    ++successCount;
+                                    terminal.writeLine(`Operation "${operation.name}": Outputs have been restored from the build cache."`);
+                                    terminal.writeLine(`Cache key: ${projectBuildCache.cacheId}`);
+                                }
+                                else {
+                                    terminal.writeWarningLine(`Operation "${operation.name}": Outputs could not be restored from the build cache.`);
+                                }
                             }
-                        }
-                        const success = await projectBuildCache.trySetCacheEntryAsync(terminal);
-                        if (success) {
-                            ++successCount;
-                            terminal.writeLine(`Operation "${operation.name}": Existing outputs have been successfully written to the build cache."`);
-                            terminal.writeLine(`Cache key: ${projectBuildCache.cacheId}`);
-                        }
-                        else {
-                            terminal.writeErrorLine(`Operation "${operation.name}": An error occurred while writing existing outputs to the build cache.`);
-                        }
-                    }
-                }, {
-                    concurrency: context.parallelism
-                });
-                terminal.writeLine(`Cache operation "${cacheAction}" completed successfully for ${successCount} out of ${filteredOperations.size} operations.`);
+                            else if (cacheAction === CACHE_ACTION_WRITE) {
+                                if (requireOutputFolders &&
+                                    ((_a = operation.settings) === null || _a === void 0 ? void 0 : _a.outputFolderNames) &&
+                                    ((_c = (_b = operation.settings) === null || _b === void 0 ? void 0 : _b.outputFolderNames) === null || _c === void 0 ? void 0 : _c.length) > 0) {
+                                    const projectFolder = (_d = operation.associatedProject) === null || _d === void 0 ? void 0 : _d.projectFolder;
+                                    const missingFolders = [];
+                                    operation.settings.outputFolderNames.forEach((outputFolderName) => {
+                                        if (!node_core_library_1.FileSystem.exists(`${projectFolder}/${outputFolderName}`)) {
+                                            missingFolders.push(outputFolderName);
+                                        }
+                                    });
+                                    if (missingFolders.length > 0) {
+                                        terminal.writeWarningLine(`Operation "${operation.name}": The following output folders do not exist: "${missingFolders.join('", "')}". Skipping cache population.`);
+                                        return;
+                                    }
+                                }
+                                const success = await projectBuildCache.trySetCacheEntryAsync(terminal);
+                                if (success) {
+                                    ++successCount;
+                                    terminal.writeLine(`Operation "${operation.name}": Existing outputs have been successfully written to the build cache."`);
+                                    terminal.writeLine(`Cache key: ${projectBuildCache.cacheId}`);
+                                }
+                                else {
+                                    terminal.writeErrorLine(`Operation "${operation.name}": An error occurred while writing existing outputs to the build cache.`);
+                                }
+                            }
+                        }, { concurrency: graph.parallelism });
+                        terminal.writeLine(`Cache operation "${cacheAction}" completed successfully for ${successCount} out of ${filteredOperations.length} operations.`);
+                        // Bail out with a status indicating success; treat cache read as FromCache.
+                        return cacheAction === CACHE_ACTION_READ ? rush_sdk_1.OperationStatus.FromCache : rush_sdk_1.OperationStatus.Success;
+                    });
+                }
             });
         });
     }

package/lib-commonjs/BridgeCachePlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"BridgeCachePlugin.js","sourceRoot":"","sources":["../src/BridgeCachePlugin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,oEAAiE;AACjE,kDAAkF;AAWlF,gEAAsE;AAGtE,MAAM,WAAW,GAA4B,uBAAuB,CAAC;AAErE,MAAM,iBAAiB,GAAW,MAAM,CAAC;AACzC,MAAM,kBAAkB,GAAY,OAAO,CAAC;AAS5C,MAAa,iBAAiB;IAK5B,YAAmB,OAAkC;QAJrC,eAAU,GAAW,WAAW,CAAC;QAK/C,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;QACxD,IAAI,CAAC,kCAAkC,GAAG,OAAO,CAAC,iCAAiC,CAAC;QAEpF,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,wHAAwH,CACzH,CAAC;QACJ,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,OAAoB;QAC/B,OAAO,CAAC,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,EAAE,OAAuB,EAAE,EAAE;YAC1F,MAAM,MAAM,GAAY,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YAEvD,IAAI,WAAoC,CAAC;YACzC,IAAI,oBAAoB,GAAY,KAAK,CAAC;YAE1C,wGAAwG;YACxG,OAAO,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,CAChC,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,CAAC,gBAAgB,EAAE,EACrD,CAAC,UAA0B,EAAE,OAAiC,EAAkB,EAAE;;gBAChF,MAAM,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC;gBACrC,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;gBAErD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;oBAC9B,IAAI,CAAC,CAAA,MAAA,OAAO,CAAC,uBAAuB,0CAAE,iBAAiB,CAAA,EAAE,CAAC;wBACxD,MAAM,IAAI,KAAK,CACb,+CAA+C,IAAI,CAAC,oBAAoB,cAAc,CACvF,CAAC;oBACJ,CAAC;oBAED,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;wBACnC,SAAS,CAAC,OAAO,GAAG,KAAK,CAAC;oBAC5B,CAAC;oBAED,oBAAoB,GAAG,IAAI,CAAC,8BAA8B,CAAC,gBAAgB,CAAC,CAAC;gBAC/E,CAAC;gBAED,OAAO,UAAU,CAAC;YACpB,CAAC,CACF,CAAC;YACF,wCAAwC;YACxC,OAAO,CAAC,KAAK,CAAC,uBAAuB,CAAC,UAAU,CAC9C,WAAW,EACX,KAAK,EACH,iBAA4D,EAC5D,OAAkC,EACnB,EAAE;gBACjB,MAAM,EACJ,uBAAuB,EACvB,iBAAiB,EAAE,EACjB,wBAAwB,EAAE,EACxB,aAAa,EAAE,EAAE,kCAAkC,EAAE,EACtD,EACF,EACF,GAAG,OAAO,CAAC;gBACZ,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;gBAE5B,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;oBAC9B,OAAO;gBACT,CAAC;gBAED,IAAI,CAAC,CAAA,uBAAuB,aAAvB,uBAAuB,uBAAvB,uBAAuB,CAAE,iBAAiB,CAAA,EAAE,CAAC;oBAChD,MAAM,IAAI,KAAK,CACb,+CAA+C,IAAI,CAAC,oBAAoB,cAAc,CACvF,CAAC;gBACJ,CAAC;gBAED,MAAM,kBAAkB,GAAmC,IAAI,GAAG,EAAE,CAAC;gBACrE,KAAK,MAAM,wBAAwB,IAAI,iBAAiB,CAAC,MAAM,EAAE,EAAE,CAAC;oBAClE,IAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;wBAC/C,kBAAkB,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;oBACnD,CAAC;gBACH,CAAC;gBAED,IAAI,YAAY,GAAW,CAAC,CAAC;gBAE7B,MAAM,yBAAK,CAAC,YAAY,CACtB,kBAAkB,EAClB,KAAK,EAAE,wBAAmD,EAAE,EAAE;;oBAC5D,MAAM,iBAAiB,GAAwB,+BAAmB,CAAC,YAAY,CAC7E,wBAAwB,EACxB;wBACE,uBAAuB;wBACvB,QAAQ;wBACR,uBAAuB,EAAE,CAAC,CAAC,kCAAkC;qBAC9D,CACF,CAAC;oBAEF,MAAM,EAAE,SAAS,EAAE,GAAG,wBAAwB,CAAC;oBAE/C,IAAI,WAAW,KAAK,iBAAiB,EAAE,CAAC;wBACtC,MAAM,OAAO,GAAY,MAAM,iBAAiB,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;wBACpF,IAAI,OAAO,EAAE,CAAC;4BACZ,EAAE,YAAY,CAAC;4BACf,QAAQ,CAAC,SAAS,CAChB,cAAc,SAAS,CAAC,IAAI,sDAAsD,CACnF,CAAC;4BACF,QAAQ,CAAC,SAAS,CAAC,cAAc,iBAAiB,CAAC,OAAO,EAAE,CAAC,CAAC;wBAChE,CAAC;6BAAM,CAAC;4BACN,QAAQ,CAAC,gBAAgB,CACvB,cAAc,SAAS,CAAC,IAAI,wDAAwD,CACrF,CAAC;wBACJ,CAAC;oBACH,CAAC;yBAAM,IAAI,WAAW,KAAK,kBAAkB,EAAE,CAAC;wBAC9C,qIAAqI;wBACrI,IACE,oBAAoB;6BACpB,MAAA,SAAS,CAAC,QAAQ,0CAAE,iBAAiB,CAAA;4BACrC,CAAA,MAAA,MAAA,SAAS,CAAC,QAAQ,0CAAE,iBAAiB,0CAAE,MAAM,IAAG,CAAC,EACjD,CAAC;4BACD,MAAM,aAAa,GAAW,MAAA,SAAS,CAAC,iBAAiB,0CAAE,aAAa,CAAC;4BACzE,MAAM,cAAc,GAAa,EAAE,CAAC;4BACpC,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,gBAAwB,EAAE,EAAE;gCACxE,IAAI,CAAC,8BAAU,CAAC,MAAM,CAAC,GAAG,aAAa,IAAI,gBAAgB,EAAE,CAAC,EAAE,CAAC;oCAC/D,cAAc,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;gCACxC,CAAC;4BACH,CAAC,CAAC,CAAC;4BACH,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gCAC9B,QAAQ,CAAC,gBAAgB,CACvB,cAAc,SAAS,CAAC,IAAI,kDAAkD,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,+BAA+B,CACzI,CAAC;gCACF,OAAO;4BACT,CAAC;wBACH,CAAC;wBAED,MAAM,OAAO,GAAY,MAAM,iBAAiB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;wBACjF,IAAI,OAAO,EAAE,CAAC;4BACZ,EAAE,YAAY,CAAC;4BACf,QAAQ,CAAC,SAAS,CAChB,cAAc,SAAS,CAAC,IAAI,yEAAyE,CACtG,CAAC;4BACF,QAAQ,CAAC,SAAS,CAAC,cAAc,iBAAiB,CAAC,OAAO,EAAE,CAAC,CAAC;wBAChE,CAAC;6BAAM,CAAC;4BACN,QAAQ,CAAC,cAAc,CACrB,cAAc,SAAS,CAAC,IAAI,yEAAyE,CACtG,CAAC;wBACJ,CAAC;oBACH,CAAC;gBACH,CAAC,EACD;oBACE,WAAW,EAAE,OAAO,CAAC,WAAW;iBACjC,CACF,CAAC;gBAEF,QAAQ,CAAC,SAAS,CAChB,oBAAoB,WAAW,gCAAgC,YAAY,WAAW,kBAAkB,CAAC,IAAI,cAAc,CAC5H,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,eAAe,CACrB,gBAA2D;QAE3D,MAAM,oBAAoB,GAAqC,gBAAgB,CAAC,GAAG,CACjF,IAAI,CAAC,oBAAoB,CAC1B,CAAC;QAEF,IAAI,oBAAoB,EAAE,CAAC;YACzB,IAAI,oBAAoB,CAAC,IAAI,KAAK,0CAAwB,CAAC,MAAM,EAAE,CAAC;gBAClE,MAAM,IAAI,KAAK,CACb,kBAAkB,IAAI,CAAC,oBAAoB,4DAA4D,CACxG,CAAC;YACJ,CAAC;YAED,IACE,oBAAoB,CAAC,YAAY,CAAC,IAAI,KAAK,CAAC;gBAC5C,CAAC,oBAAoB,CAAC,YAAY,CAAC,GAAG,CAAC,iBAAiB,CAAC;gBACzD,CAAC,oBAAoB,CAAC,YAAY,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAC1D,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,kBAAkB,IAAI,CAAC,oBAAoB,qCAAqC,iBAAiB,UAAU,kBAAkB,2CAA2C,CACzK,CAAC;YACJ,CAAC;YAED,MAAM,KAAK,GAAuB,oBAAoB,CAAC,KAAK,CAAC;YAC7D,QAAQ,KAAK,EAAE,CAAC;gBACd,KAAK,iBAAiB,CAAC;gBACvB,KAAK,kBAAkB;oBACrB,OAAO,KAAK,CAAC;gBACf,KAAK,SAAS;oBACZ,OAAO,SAAS,CAAC;gBACnB;oBACE,MAAM,IAAI,KAAK,CACb,kBAAkB,IAAI,CAAC,oBAAoB,sBAAsB,iBAAiB,SAAS,kBAAkB,iBAAiB,KAAK,2CAA2C,CAC/K,CAAC;YACN,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,8BAA8B,CACpC,gBAA2D;QAE3D,IAAI,CAAC,IAAI,CAAC,kCAAkC,EAAE,CAAC;YAC7C,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,yBAAyB,GAAqC,gBAAgB,CAAC,GAAG,CACtF,IAAI,CAAC,kCAAkC,CACxC,CAAC;QAEF,IAAI,CAAC,yBAAyB,EAAE,CAAC;YAC/B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,yBAAyB,CAAC,IAAI,KAAK,0CAAwB,CAAC,IAAI,EAAE,CAAC;YACrE,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,CAAC,kCAAkC,mBAAmB,CAAC,CAAC;QAChG,CAAC;QAED,OAAO,yBAAyB,CAAC,KAAK,CAAC;IACzC,CAAC;CACF;AA7ND,8CA6NC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { Async, FileSystem } from '@rushstack/node-core-library';\nimport { _OperationBuildCache as OperationBuildCache } from '@rushstack/rush-sdk';\nimport type {\n  ICreateOperationsContext,\n  IExecuteOperationsContext,\n  ILogger,\n  IOperationExecutionResult,\n  IPhasedCommand,\n  IRushPlugin,\n  Operation,\n  RushSession\n} from '@rushstack/rush-sdk';\nimport { CommandLineParameterKind } from '@rushstack/ts-command-line';\nimport type { CommandLineParameter } from '@rushstack/ts-command-line';\n\nconst PLUGIN_NAME: 'RushBridgeCachePlugin' = 'RushBridgeCachePlugin';\n\nconst CACHE_ACTION_READ: 'read' = 'read';\nconst CACHE_ACTION_WRITE: 'write' = 'write';\n\ntype CacheAction = typeof CACHE_ACTION_READ | typeof CACHE_ACTION_WRITE;\n\nexport interface IBridgeCachePluginOptions {\n  readonly actionParameterName: string;\n  readonly requireOutputFoldersParameterName: string | undefined;\n}\n\nexport class BridgeCachePlugin implements IRushPlugin {\n  public readonly pluginName: string = PLUGIN_NAME;\n  private readonly _actionParameterName: string;\n  private readonly _requireOutputFoldersParameterName: string | undefined;\n\n  public constructor(options: IBridgeCachePluginOptions) {\n    this._actionParameterName = options.actionParameterName;\n    this._requireOutputFoldersParameterName = options.requireOutputFoldersParameterName;\n\n    if (!this._actionParameterName) {\n      throw new Error(\n        'The \"actionParameterName\" option must be provided for the BridgeCachePlugin. Please see the plugin README for details.'\n      );\n    }\n  }\n\n  public apply(session: RushSession): void {\n    session.hooks.runAnyPhasedCommand.tapPromise(PLUGIN_NAME, async (command: IPhasedCommand) => {\n      const logger: ILogger = session.getLogger(PLUGIN_NAME);\n\n      let cacheAction: CacheAction | undefined;\n      let requireOutputFolders: boolean = false;\n\n      // cancel the actual operations. We don't want to run the command, just cache the output folders on disk\n      command.hooks.createOperations.tap(\n        { name: PLUGIN_NAME, stage: Number.MAX_SAFE_INTEGER },\n        (operations: Set<Operation>, context: ICreateOperationsContext): Set<Operation> => {\n          const { customParameters } = context;\n          cacheAction = this._getCacheAction(customParameters);\n\n          if (cacheAction !== undefined) {\n            if (!context.buildCacheConfiguration?.buildCacheEnabled) {\n              throw new Error(\n                `The build cache must be enabled to use the \"${this._actionParameterName}\" parameter.`\n              );\n            }\n\n            for (const operation of operations) {\n              operation.enabled = false;\n            }\n\n            requireOutputFolders = this._isRequireOutputFoldersFlagSet(customParameters);\n          }\n\n          return operations;\n        }\n      );\n      // populate the cache for each operation\n      command.hooks.beforeExecuteOperations.tapPromise(\n        PLUGIN_NAME,\n        async (\n          recordByOperation: Map<Operation, IOperationExecutionResult>,\n          context: IExecuteOperationsContext\n        ): Promise<void> => {\n          const {\n            buildCacheConfiguration,\n            rushConfiguration: {\n              experimentsConfiguration: {\n                configuration: { omitAppleDoubleFilesFromBuildCache }\n              }\n            }\n          } = context;\n          const { terminal } = logger;\n\n          if (cacheAction === undefined) {\n            return;\n          }\n\n          if (!buildCacheConfiguration?.buildCacheEnabled) {\n            throw new Error(\n              `The build cache must be enabled to use the \"${this._actionParameterName}\" parameter.`\n            );\n          }\n\n          const filteredOperations: Set<IOperationExecutionResult> = new Set();\n          for (const operationExecutionResult of recordByOperation.values()) {\n            if (!operationExecutionResult.operation.isNoOp) {\n              filteredOperations.add(operationExecutionResult);\n            }\n          }\n\n          let successCount: number = 0;\n\n          await Async.forEachAsync(\n            filteredOperations,\n            async (operationExecutionResult: IOperationExecutionResult) => {\n              const projectBuildCache: OperationBuildCache = OperationBuildCache.forOperation(\n                operationExecutionResult,\n                {\n                  buildCacheConfiguration,\n                  terminal,\n                  excludeAppleDoubleFiles: !!omitAppleDoubleFilesFromBuildCache\n                }\n              );\n\n              const { operation } = operationExecutionResult;\n\n              if (cacheAction === CACHE_ACTION_READ) {\n                const success: boolean = await projectBuildCache.tryRestoreFromCacheAsync(terminal);\n                if (success) {\n                  ++successCount;\n                  terminal.writeLine(\n                    `Operation \"${operation.name}\": Outputs have been restored from the build cache.\"`\n                  );\n                  terminal.writeLine(`Cache key: ${projectBuildCache.cacheId}`);\n                } else {\n                  terminal.writeWarningLine(\n                    `Operation \"${operation.name}\": Outputs could not be restored from the build cache.`\n                  );\n                }\n              } else if (cacheAction === CACHE_ACTION_WRITE) {\n                // if the require output folders flag has been passed, skip populating the cache if any of the expected output folders does not exist\n                if (\n                  requireOutputFolders &&\n                  operation.settings?.outputFolderNames &&\n                  operation.settings?.outputFolderNames?.length > 0\n                ) {\n                  const projectFolder: string = operation.associatedProject?.projectFolder;\n                  const missingFolders: string[] = [];\n                  operation.settings.outputFolderNames.forEach((outputFolderName: string) => {\n                    if (!FileSystem.exists(`${projectFolder}/${outputFolderName}`)) {\n                      missingFolders.push(outputFolderName);\n                    }\n                  });\n                  if (missingFolders.length > 0) {\n                    terminal.writeWarningLine(\n                      `Operation \"${operation.name}\": The following output folders do not exist: \"${missingFolders.join('\", \"')}\". Skipping cache population.`\n                    );\n                    return;\n                  }\n                }\n\n                const success: boolean = await projectBuildCache.trySetCacheEntryAsync(terminal);\n                if (success) {\n                  ++successCount;\n                  terminal.writeLine(\n                    `Operation \"${operation.name}\": Existing outputs have been successfully written to the build cache.\"`\n                  );\n                  terminal.writeLine(`Cache key: ${projectBuildCache.cacheId}`);\n                } else {\n                  terminal.writeErrorLine(\n                    `Operation \"${operation.name}\": An error occurred while writing existing outputs to the build cache.`\n                  );\n                }\n              }\n            },\n            {\n              concurrency: context.parallelism\n            }\n          );\n\n          terminal.writeLine(\n            `Cache operation \"${cacheAction}\" completed successfully for ${successCount} out of ${filteredOperations.size} operations.`\n          );\n        }\n      );\n    });\n  }\n\n  private _getCacheAction(\n    customParameters: ReadonlyMap<string, CommandLineParameter>\n  ): CacheAction | undefined {\n    const cacheActionParameter: CommandLineParameter | undefined = customParameters.get(\n      this._actionParameterName\n    );\n\n    if (cacheActionParameter) {\n      if (cacheActionParameter.kind !== CommandLineParameterKind.Choice) {\n        throw new Error(\n          `The parameter \"${this._actionParameterName}\" must be a choice. Please check the plugin configuration.`\n        );\n      }\n\n      if (\n        cacheActionParameter.alternatives.size !== 2 ||\n        !cacheActionParameter.alternatives.has(CACHE_ACTION_READ) ||\n        !cacheActionParameter.alternatives.has(CACHE_ACTION_WRITE)\n      ) {\n        throw new Error(\n          `The parameter \"${this._actionParameterName}\" must have exactly two choices: \"${CACHE_ACTION_READ}\" and \"${CACHE_ACTION_WRITE}\". Please check the plugin configuration.`\n        );\n      }\n\n      const value: string | undefined = cacheActionParameter.value;\n      switch (value) {\n        case CACHE_ACTION_READ:\n        case CACHE_ACTION_WRITE:\n          return value;\n        case undefined:\n          return undefined;\n        default:\n          throw new Error(\n            `The parameter \"${this._actionParameterName}\" must be one of: \"${CACHE_ACTION_READ}\" or \"${CACHE_ACTION_WRITE}\". Received: \"${value}\". Please check the plugin configuration.`\n          );\n      }\n    }\n\n    return undefined;\n  }\n\n  private _isRequireOutputFoldersFlagSet(\n    customParameters: ReadonlyMap<string, CommandLineParameter>\n  ): boolean {\n    if (!this._requireOutputFoldersParameterName) {\n      return false;\n    }\n\n    const requireOutputFoldersParam: CommandLineParameter | undefined = customParameters.get(\n      this._requireOutputFoldersParameterName\n    );\n\n    if (!requireOutputFoldersParam) {\n      return false;\n    }\n\n    if (requireOutputFoldersParam.kind !== CommandLineParameterKind.Flag) {\n      throw new Error(`The parameter \"${this._requireOutputFoldersParameterName}\" must be a flag.`);\n    }\n\n    return requireOutputFoldersParam.value;\n  }\n}\n"]}
+{"version":3,"file":"BridgeCachePlugin.js","sourceRoot":"","sources":["../src/BridgeCachePlugin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,oEAAiE;AACjE,kDAW6B;AAC7B,gEAAiG;AAEjG,MAAM,WAAW,GAA4B,uBAAuB,CAAC;AAErE,MAAM,iBAAiB,GAAW,MAAM,CAAC;AACzC,MAAM,kBAAkB,GAAY,OAAO,CAAC;AAS5C,MAAa,iBAAiB;IAK5B,YAAmB,OAAkC;QAJrC,eAAU,GAAW,WAAW,CAAC;QAK/C,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;QACxD,IAAI,CAAC,kCAAkC,GAAG,OAAO,CAAC,iCAAiC,CAAC;QAEpF,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,wHAAwH,CACzH,CAAC;QACJ,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,OAAoB;QAC/B,OAAO,CAAC,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,EAAE,OAAuB,EAAE,EAAE;YAC1F,OAAO,CAAC,KAAK,CAAC,mBAAmB,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;gBAC1E,MAAM,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,GAAG,OAAO,CAAC;gBAC9D,MAAM,WAAW,GAA4B,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;gBAEpF,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;oBAC9B,IAAI,CAAC,CAAA,uBAAuB,aAAvB,uBAAuB,uBAAvB,uBAAuB,CAAE,iBAAiB,CAAA,EAAE,CAAC;wBAChD,MAAM,IAAI,KAAK,CACb,+CAA+C,IAAI,CAAC,oBAAoB,cAAc,CACvF,CAAC;oBACJ,CAAC;oBAED,MAAM,EACJ,iBAAiB,EAAE,EACjB,wBAAwB,EAAE,EACxB,aAAa,EAAE,EAAE,kCAAkC,EAAE,EACtD,EACF,EACF,GAAG,OAAO,CAAC;oBAEZ,MAAM,MAAM,GAAY,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;oBACvD,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;oBAC5B,MAAM,oBAAoB,GAAY,IAAI,CAAC,8BAA8B,CAAC,gBAAgB,CAAC,CAAC;oBAE5F,KAAK,CAAC,KAAK,CAAC,2BAA2B,CAAC,UAAU,CAChD,WAAW,EACX,KAAK,EACH,gBAAmE,EACnE,gBAAiD,EACX,EAAE;wBACxC,MAAM,kBAAkB,GAAoC,EAAE,CAAC;wBAC/D,KAAK,MAAM,MAAM,IAAI,gBAAgB,CAAC,MAAM,EAAE,EAAE,CAAC;4BAC/C,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;gCAC7B,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;4BAClC,CAAC;wBACH,CAAC;wBAED,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC;4BAC/B,OAAO,CAAC,2CAA2C;wBACrD,CAAC;wBAED,IAAI,YAAY,GAAW,CAAC,CAAC;wBAC7B,MAAM,yBAAK,CAAC,YAAY,CACtB,kBAAkB,EAClB,KAAK,EAAE,wBAAuD,EAAE,EAAE;;4BAChE,MAAM,iBAAiB,GAAwB,+BAAmB,CAAC,YAAY,CAC7E,wBAAwB,EACxB;gCACE,uBAAuB;gCACvB,QAAQ;gCACR,uBAAuB,EAAE,CAAC,CAAC,kCAAkC;6BAC9D,CACF,CAAC;4BAEF,MAAM,EAAE,SAAS,EAAE,GAAG,wBAAwB,CAAC;4BAE/C,IAAI,WAAW,KAAK,iBAAiB,EAAE,CAAC;gCACtC,MAAM,OAAO,GAAY,MAAM,iBAAiB,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;gCACpF,IAAI,OAAO,EAAE,CAAC;oCACZ,EAAE,YAAY,CAAC;oCACf,QAAQ,CAAC,SAAS,CAChB,cAAc,SAAS,CAAC,IAAI,sDAAsD,CACnF,CAAC;oCACF,QAAQ,CAAC,SAAS,CAAC,cAAc,iBAAiB,CAAC,OAAO,EAAE,CAAC,CAAC;gCAChE,CAAC;qCAAM,CAAC;oCACN,QAAQ,CAAC,gBAAgB,CACvB,cAAc,SAAS,CAAC,IAAI,wDAAwD,CACrF,CAAC;gCACJ,CAAC;4BACH,CAAC;iCAAM,IAAI,WAAW,KAAK,kBAAkB,EAAE,CAAC;gCAC9C,IACE,oBAAoB;qCACpB,MAAA,SAAS,CAAC,QAAQ,0CAAE,iBAAiB,CAAA;oCACrC,CAAA,MAAA,MAAA,SAAS,CAAC,QAAQ,0CAAE,iBAAiB,0CAAE,MAAM,IAAG,CAAC,EACjD,CAAC;oCACD,MAAM,aAAa,GAAW,MAAA,SAAS,CAAC,iBAAiB,0CAAE,aAAa,CAAC;oCACzE,MAAM,cAAc,GAAa,EAAE,CAAC;oCACpC,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,gBAAwB,EAAE,EAAE;wCACxE,IAAI,CAAC,8BAAU,CAAC,MAAM,CAAC,GAAG,aAAa,IAAI,gBAAgB,EAAE,CAAC,EAAE,CAAC;4CAC/D,cAAc,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;wCACxC,CAAC;oCACH,CAAC,CAAC,CAAC;oCACH,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wCAC9B,QAAQ,CAAC,gBAAgB,CACvB,cAAc,SAAS,CAAC,IAAI,kDAAkD,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,+BAA+B,CACzI,CAAC;wCACF,OAAO;oCACT,CAAC;gCACH,CAAC;gCAED,MAAM,OAAO,GAAY,MAAM,iBAAiB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;gCACjF,IAAI,OAAO,EAAE,CAAC;oCACZ,EAAE,YAAY,CAAC;oCACf,QAAQ,CAAC,SAAS,CAChB,cAAc,SAAS,CAAC,IAAI,yEAAyE,CACtG,CAAC;oCACF,QAAQ,CAAC,SAAS,CAAC,cAAc,iBAAiB,CAAC,OAAO,EAAE,CAAC,CAAC;gCAChE,CAAC;qCAAM,CAAC;oCACN,QAAQ,CAAC,cAAc,CACrB,cAAc,SAAS,CAAC,IAAI,yEAAyE,CACtG,CAAC;gCACJ,CAAC;4BACH,CAAC;wBACH,CAAC,EACD,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,CACnC,CAAC;wBAEF,QAAQ,CAAC,SAAS,CAChB,oBAAoB,WAAW,gCAAgC,YAAY,WAAW,kBAAkB,CAAC,MAAM,cAAc,CAC9H,CAAC;wBAEF,4EAA4E;wBAC5E,OAAO,WAAW,KAAK,iBAAiB,CAAC,CAAC,CAAC,0BAAe,CAAC,SAAS,CAAC,CAAC,CAAC,0BAAe,CAAC,OAAO,CAAC;oBACjG,CAAC,CACF,CAAC;gBACJ,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,eAAe,CACrB,gBAA2D;QAE3D,MAAM,oBAAoB,GAAqC,gBAAgB,CAAC,GAAG,CACjF,IAAI,CAAC,oBAAoB,CAC1B,CAAC;QAEF,IAAI,oBAAoB,EAAE,CAAC;YACzB,IAAI,oBAAoB,CAAC,IAAI,KAAK,0CAAwB,CAAC,MAAM,EAAE,CAAC;gBAClE,MAAM,IAAI,KAAK,CACb,kBAAkB,IAAI,CAAC,oBAAoB,4DAA4D,CACxG,CAAC;YACJ,CAAC;YAED,IACE,oBAAoB,CAAC,YAAY,CAAC,IAAI,KAAK,CAAC;gBAC5C,CAAC,oBAAoB,CAAC,YAAY,CAAC,GAAG,CAAC,iBAAiB,CAAC;gBACzD,CAAC,oBAAoB,CAAC,YAAY,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAC1D,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,kBAAkB,IAAI,CAAC,oBAAoB,qCAAqC,iBAAiB,UAAU,kBAAkB,2CAA2C,CACzK,CAAC;YACJ,CAAC;YAED,MAAM,KAAK,GAAuB,oBAAoB,CAAC,KAAK,CAAC;YAC7D,QAAQ,KAAK,EAAE,CAAC;gBACd,KAAK,iBAAiB,CAAC;gBACvB,KAAK,kBAAkB;oBACrB,OAAO,KAAK,CAAC;gBACf,KAAK,SAAS;oBACZ,OAAO,SAAS,CAAC;gBACnB;oBACE,MAAM,IAAI,KAAK,CACb,kBAAkB,IAAI,CAAC,oBAAoB,sBAAsB,iBAAiB,SAAS,kBAAkB,iBAAiB,KAAK,2CAA2C,CAC/K,CAAC;YACN,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,8BAA8B,CACpC,gBAA2D;QAE3D,IAAI,CAAC,IAAI,CAAC,kCAAkC,EAAE,CAAC;YAC7C,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,yBAAyB,GAAqC,gBAAgB,CAAC,GAAG,CACtF,IAAI,CAAC,kCAAkC,CACxC,CAAC;QAEF,IAAI,CAAC,yBAAyB,EAAE,CAAC;YAC/B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,yBAAyB,CAAC,IAAI,KAAK,0CAAwB,CAAC,IAAI,EAAE,CAAC;YACrE,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,CAAC,kCAAkC,mBAAmB,CAAC,CAAC;QAChG,CAAC;QAED,OAAO,yBAAyB,CAAC,KAAK,CAAC;IACzC,CAAC;CACF;AAvMD,8CAuMC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { Async, FileSystem } from '@rushstack/node-core-library';\nimport {\n  _OperationBuildCache as OperationBuildCache,\n  OperationStatus,\n  type Operation,\n  type IOperationExecutionResult,\n  type IOperationGraphIterationOptions,\n  type ILogger,\n  type IBaseOperationExecutionResult,\n  type IPhasedCommand,\n  type IRushPlugin,\n  type RushSession\n} from '@rushstack/rush-sdk';\nimport { CommandLineParameterKind, type CommandLineParameter } from '@rushstack/ts-command-line';\n\nconst PLUGIN_NAME: 'RushBridgeCachePlugin' = 'RushBridgeCachePlugin';\n\nconst CACHE_ACTION_READ: 'read' = 'read';\nconst CACHE_ACTION_WRITE: 'write' = 'write';\n\ntype CacheAction = typeof CACHE_ACTION_READ | typeof CACHE_ACTION_WRITE;\n\nexport interface IBridgeCachePluginOptions {\n  readonly actionParameterName: string;\n  readonly requireOutputFoldersParameterName: string | undefined;\n}\n\nexport class BridgeCachePlugin implements IRushPlugin {\n  public readonly pluginName: string = PLUGIN_NAME;\n  private readonly _actionParameterName: string;\n  private readonly _requireOutputFoldersParameterName: string | undefined;\n\n  public constructor(options: IBridgeCachePluginOptions) {\n    this._actionParameterName = options.actionParameterName;\n    this._requireOutputFoldersParameterName = options.requireOutputFoldersParameterName;\n\n    if (!this._actionParameterName) {\n      throw new Error(\n        'The \"actionParameterName\" option must be provided for the BridgeCachePlugin. Please see the plugin README for details.'\n      );\n    }\n  }\n\n  public apply(session: RushSession): void {\n    session.hooks.runAnyPhasedCommand.tapPromise(PLUGIN_NAME, async (command: IPhasedCommand) => {\n      command.hooks.onGraphCreatedAsync.tap(PLUGIN_NAME, async (graph, context) => {\n        const { customParameters, buildCacheConfiguration } = context;\n        const cacheAction: CacheAction | undefined = this._getCacheAction(customParameters);\n\n        if (cacheAction !== undefined) {\n          if (!buildCacheConfiguration?.buildCacheEnabled) {\n            throw new Error(\n              `The build cache must be enabled to use the \"${this._actionParameterName}\" parameter.`\n            );\n          }\n\n          const {\n            rushConfiguration: {\n              experimentsConfiguration: {\n                configuration: { omitAppleDoubleFilesFromBuildCache }\n              }\n            }\n          } = context;\n\n          const logger: ILogger = session.getLogger(PLUGIN_NAME);\n          const { terminal } = logger;\n          const requireOutputFolders: boolean = this._isRequireOutputFoldersFlagSet(customParameters);\n\n          graph.hooks.beforeExecuteIterationAsync.tapPromise(\n            PLUGIN_NAME,\n            async (\n              operationRecords: ReadonlyMap<Operation, IOperationExecutionResult>,\n              iterationOptions: IOperationGraphIterationOptions\n            ): Promise<OperationStatus | undefined> => {\n              const filteredOperations: IBaseOperationExecutionResult[] = [];\n              for (const record of operationRecords.values()) {\n                if (!record.operation.isNoOp) {\n                  filteredOperations.push(record);\n                }\n              }\n\n              if (!filteredOperations.length) {\n                return; // nothing to do, continue normal execution\n              }\n\n              let successCount: number = 0;\n              await Async.forEachAsync(\n                filteredOperations,\n                async (operationExecutionResult: IBaseOperationExecutionResult) => {\n                  const projectBuildCache: OperationBuildCache = OperationBuildCache.forOperation(\n                    operationExecutionResult,\n                    {\n                      buildCacheConfiguration,\n                      terminal,\n                      excludeAppleDoubleFiles: !!omitAppleDoubleFilesFromBuildCache\n                    }\n                  );\n\n                  const { operation } = operationExecutionResult;\n\n                  if (cacheAction === CACHE_ACTION_READ) {\n                    const success: boolean = await projectBuildCache.tryRestoreFromCacheAsync(terminal);\n                    if (success) {\n                      ++successCount;\n                      terminal.writeLine(\n                        `Operation \"${operation.name}\": Outputs have been restored from the build cache.\"`\n                      );\n                      terminal.writeLine(`Cache key: ${projectBuildCache.cacheId}`);\n                    } else {\n                      terminal.writeWarningLine(\n                        `Operation \"${operation.name}\": Outputs could not be restored from the build cache.`\n                      );\n                    }\n                  } else if (cacheAction === CACHE_ACTION_WRITE) {\n                    if (\n                      requireOutputFolders &&\n                      operation.settings?.outputFolderNames &&\n                      operation.settings?.outputFolderNames?.length > 0\n                    ) {\n                      const projectFolder: string = operation.associatedProject?.projectFolder;\n                      const missingFolders: string[] = [];\n                      operation.settings.outputFolderNames.forEach((outputFolderName: string) => {\n                        if (!FileSystem.exists(`${projectFolder}/${outputFolderName}`)) {\n                          missingFolders.push(outputFolderName);\n                        }\n                      });\n                      if (missingFolders.length > 0) {\n                        terminal.writeWarningLine(\n                          `Operation \"${operation.name}\": The following output folders do not exist: \"${missingFolders.join('\", \"')}\". Skipping cache population.`\n                        );\n                        return;\n                      }\n                    }\n\n                    const success: boolean = await projectBuildCache.trySetCacheEntryAsync(terminal);\n                    if (success) {\n                      ++successCount;\n                      terminal.writeLine(\n                        `Operation \"${operation.name}\": Existing outputs have been successfully written to the build cache.\"`\n                      );\n                      terminal.writeLine(`Cache key: ${projectBuildCache.cacheId}`);\n                    } else {\n                      terminal.writeErrorLine(\n                        `Operation \"${operation.name}\": An error occurred while writing existing outputs to the build cache.`\n                      );\n                    }\n                  }\n                },\n                { concurrency: graph.parallelism }\n              );\n\n              terminal.writeLine(\n                `Cache operation \"${cacheAction}\" completed successfully for ${successCount} out of ${filteredOperations.length} operations.`\n              );\n\n              // Bail out with a status indicating success; treat cache read as FromCache.\n              return cacheAction === CACHE_ACTION_READ ? OperationStatus.FromCache : OperationStatus.Success;\n            }\n          );\n        }\n      });\n    });\n  }\n\n  private _getCacheAction(\n    customParameters: ReadonlyMap<string, CommandLineParameter>\n  ): CacheAction | undefined {\n    const cacheActionParameter: CommandLineParameter | undefined = customParameters.get(\n      this._actionParameterName\n    );\n\n    if (cacheActionParameter) {\n      if (cacheActionParameter.kind !== CommandLineParameterKind.Choice) {\n        throw new Error(\n          `The parameter \"${this._actionParameterName}\" must be a choice. Please check the plugin configuration.`\n        );\n      }\n\n      if (\n        cacheActionParameter.alternatives.size !== 2 ||\n        !cacheActionParameter.alternatives.has(CACHE_ACTION_READ) ||\n        !cacheActionParameter.alternatives.has(CACHE_ACTION_WRITE)\n      ) {\n        throw new Error(\n          `The parameter \"${this._actionParameterName}\" must have exactly two choices: \"${CACHE_ACTION_READ}\" and \"${CACHE_ACTION_WRITE}\". Please check the plugin configuration.`\n        );\n      }\n\n      const value: string | undefined = cacheActionParameter.value;\n      switch (value) {\n        case CACHE_ACTION_READ:\n        case CACHE_ACTION_WRITE:\n          return value;\n        case undefined:\n          return undefined;\n        default:\n          throw new Error(\n            `The parameter \"${this._actionParameterName}\" must be one of: \"${CACHE_ACTION_READ}\" or \"${CACHE_ACTION_WRITE}\". Received: \"${value}\". Please check the plugin configuration.`\n          );\n      }\n    }\n\n    return undefined;\n  }\n\n  private _isRequireOutputFoldersFlagSet(\n    customParameters: ReadonlyMap<string, CommandLineParameter>\n  ): boolean {\n    if (!this._requireOutputFoldersParameterName) {\n      return false;\n    }\n\n    const requireOutputFoldersParam: CommandLineParameter | undefined = customParameters.get(\n      this._requireOutputFoldersParameterName\n    );\n\n    if (!requireOutputFoldersParam) {\n      return false;\n    }\n\n    if (requireOutputFoldersParam.kind !== CommandLineParameterKind.Flag) {\n      throw new Error(`The parameter \"${this._requireOutputFoldersParameterName}\" must be a flag.`);\n    }\n\n    return requireOutputFoldersParam.value;\n  }\n}\n"]}

package/lib-dts/BridgeCachePlugin.d.ts

@@ -1,4 +1,4 @@
-import type { IRushPlugin, RushSession } from '@rushstack/rush-sdk';
+import { type IRushPlugin, type RushSession } from '@rushstack/rush-sdk';
 export interface IBridgeCachePluginOptions {
     readonly actionParameterName: string;
     readonly requireOutputFoldersParameterName: string | undefined;

package/lib-dts/BridgeCachePlugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BridgeCachePlugin.d.ts","sourceRoot":"","sources":["../src/BridgeCachePlugin.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAMV,WAAW,EAEX,WAAW,EACZ,MAAM,qBAAqB,CAAC;AAW7B,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,iCAAiC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChE;AAED,qBAAa,iBAAkB,YAAW,WAAW;IACnD,SAAgB,UAAU,EAAE,MAAM,CAAe;IACjD,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,kCAAkC,CAAqB;gBAErD,OAAO,EAAE,yBAAyB;IAW9C,KAAK,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IA+IxC,OAAO,CAAC,eAAe;IAyCvB,OAAO,CAAC,8BAA8B;CAqBvC"}
+{"version":3,"file":"BridgeCachePlugin.d.ts","sourceRoot":"","sources":["../src/BridgeCachePlugin.ts"],"names":[],"mappings":"AAIA,OAAO,EASL,KAAK,WAAW,EAChB,KAAK,WAAW,EACjB,MAAM,qBAAqB,CAAC;AAU7B,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,iCAAiC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChE;AAED,qBAAa,iBAAkB,YAAW,WAAW;IACnD,SAAgB,UAAU,EAAE,MAAM,CAAe;IACjD,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,kCAAkC,CAAqB;gBAErD,OAAO,EAAE,yBAAyB;IAW9C,KAAK,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAyHxC,OAAO,CAAC,eAAe;IAyCvB,OAAO,CAAC,8BAA8B;CAqBvC"}

package/lib-esm/BridgeCachePlugin.js

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 import { Async, FileSystem } from '@rushstack/node-core-library';
-import { _OperationBuildCache as OperationBuildCache } from '@rushstack/rush-sdk';
+import { _OperationBuildCache as OperationBuildCache, OperationStatus } from '@rushstack/rush-sdk';
 import { CommandLineParameterKind } from '@rushstack/ts-command-line';
 const PLUGIN_NAME = 'RushBridgeCachePlugin';
 const CACHE_ACTION_READ = 'read';
@@ -17,92 +17,79 @@ export class BridgeCachePlugin {
     }
     apply(session) {
         session.hooks.runAnyPhasedCommand.tapPromise(PLUGIN_NAME, async (command) => {
-            const logger = session.getLogger(PLUGIN_NAME);
-            let cacheAction;
-            let requireOutputFolders = false;
-            // cancel the actual operations. We don't want to run the command, just cache the output folders on disk
-            command.hooks.createOperations.tap({ name: PLUGIN_NAME, stage: Number.MAX_SAFE_INTEGER }, (operations, context) => {
-                var _a;
-                const { customParameters } = context;
-                cacheAction = this._getCacheAction(customParameters);
+            command.hooks.onGraphCreatedAsync.tap(PLUGIN_NAME, async (graph, context) => {
+                const { customParameters, buildCacheConfiguration } = context;
+                const cacheAction = this._getCacheAction(customParameters);
                 if (cacheAction !== undefined) {
-                    if (!((_a = context.buildCacheConfiguration) === null || _a === void 0 ? void 0 : _a.buildCacheEnabled)) {
+                    if (!(buildCacheConfiguration === null || buildCacheConfiguration === void 0 ? void 0 : buildCacheConfiguration.buildCacheEnabled)) {
                         throw new Error(`The build cache must be enabled to use the "${this._actionParameterName}" parameter.`);
                     }
-                    for (const operation of operations) {
-                        operation.enabled = false;
-                    }
-                    requireOutputFolders = this._isRequireOutputFoldersFlagSet(customParameters);
-                }
-                return operations;
-            });
-            // populate the cache for each operation
-            command.hooks.beforeExecuteOperations.tapPromise(PLUGIN_NAME, async (recordByOperation, context) => {
-                const { buildCacheConfiguration, rushConfiguration: { experimentsConfiguration: { configuration: { omitAppleDoubleFilesFromBuildCache } } } } = context;
-                const { terminal } = logger;
-                if (cacheAction === undefined) {
-                    return;
-                }
-                if (!(buildCacheConfiguration === null || buildCacheConfiguration === void 0 ? void 0 : buildCacheConfiguration.buildCacheEnabled)) {
-                    throw new Error(`The build cache must be enabled to use the "${this._actionParameterName}" parameter.`);
-                }
-                const filteredOperations = new Set();
-                for (const operationExecutionResult of recordByOperation.values()) {
-                    if (!operationExecutionResult.operation.isNoOp) {
-                        filteredOperations.add(operationExecutionResult);
-                    }
-                }
-                let successCount = 0;
-                await Async.forEachAsync(filteredOperations, async (operationExecutionResult) => {
-                    var _a, _b, _c, _d;
-                    const projectBuildCache = OperationBuildCache.forOperation(operationExecutionResult, {
-                        buildCacheConfiguration,
-                        terminal,
-                        excludeAppleDoubleFiles: !!omitAppleDoubleFilesFromBuildCache
-                    });
-                    const { operation } = operationExecutionResult;
-                    if (cacheAction === CACHE_ACTION_READ) {
-                        const success = await projectBuildCache.tryRestoreFromCacheAsync(terminal);
-                        if (success) {
-                            ++successCount;
-                            terminal.writeLine(`Operation "${operation.name}": Outputs have been restored from the build cache."`);
-                            terminal.writeLine(`Cache key: ${projectBuildCache.cacheId}`);
+                    const { rushConfiguration: { experimentsConfiguration: { configuration: { omitAppleDoubleFilesFromBuildCache } } } } = context;
+                    const logger = session.getLogger(PLUGIN_NAME);
+                    const { terminal } = logger;
+                    const requireOutputFolders = this._isRequireOutputFoldersFlagSet(customParameters);
+                    graph.hooks.beforeExecuteIterationAsync.tapPromise(PLUGIN_NAME, async (operationRecords, iterationOptions) => {
+                        const filteredOperations = [];
+                        for (const record of operationRecords.values()) {
+                            if (!record.operation.isNoOp) {
+                                filteredOperations.push(record);
+                            }
                         }
-                        else {
-                            terminal.writeWarningLine(`Operation "${operation.name}": Outputs could not be restored from the build cache.`);
+                        if (!filteredOperations.length) {
+                            return; // nothing to do, continue normal execution
                         }
-                    }
-                    else if (cacheAction === CACHE_ACTION_WRITE) {
-                        // if the require output folders flag has been passed, skip populating the cache if any of the expected output folders does not exist
-                        if (requireOutputFolders &&
-                            ((_a = operation.settings) === null || _a === void 0 ? void 0 : _a.outputFolderNames) &&
-                            ((_c = (_b = operation.settings) === null || _b === void 0 ? void 0 : _b.outputFolderNames) === null || _c === void 0 ? void 0 : _c.length) > 0) {
-                            const projectFolder = (_d = operation.associatedProject) === null || _d === void 0 ? void 0 : _d.projectFolder;
-                            const missingFolders = [];
-                            operation.settings.outputFolderNames.forEach((outputFolderName) => {
-                                if (!FileSystem.exists(`${projectFolder}/${outputFolderName}`)) {
-                                    missingFolders.push(outputFolderName);
-                                }
+                        let successCount = 0;
+                        await Async.forEachAsync(filteredOperations, async (operationExecutionResult) => {
+                            var _a, _b, _c, _d;
+                            const projectBuildCache = OperationBuildCache.forOperation(operationExecutionResult, {
+                                buildCacheConfiguration,
+                                terminal,
+                                excludeAppleDoubleFiles: !!omitAppleDoubleFilesFromBuildCache
                             });
-                            if (missingFolders.length > 0) {
-                                terminal.writeWarningLine(`Operation "${operation.name}": The following output folders do not exist: "${missingFolders.join('", "')}". Skipping cache population.`);
-                                return;
+                            const { operation } = operationExecutionResult;
+                            if (cacheAction === CACHE_ACTION_READ) {
+                                const success = await projectBuildCache.tryRestoreFromCacheAsync(terminal);
+                                if (success) {
+                                    ++successCount;
+                                    terminal.writeLine(`Operation "${operation.name}": Outputs have been restored from the build cache."`);
+                                    terminal.writeLine(`Cache key: ${projectBuildCache.cacheId}`);
+                                }
+                                else {
+                                    terminal.writeWarningLine(`Operation "${operation.name}": Outputs could not be restored from the build cache.`);
+                                }
                             }
-                        }
-                        const success = await projectBuildCache.trySetCacheEntryAsync(terminal);
-                        if (success) {
-                            ++successCount;
-                            terminal.writeLine(`Operation "${operation.name}": Existing outputs have been successfully written to the build cache."`);
-                            terminal.writeLine(`Cache key: ${projectBuildCache.cacheId}`);
-                        }
-                        else {
-                            terminal.writeErrorLine(`Operation "${operation.name}": An error occurred while writing existing outputs to the build cache.`);
-                        }
-                    }
-                }, {
-                    concurrency: context.parallelism
-                });
-                terminal.writeLine(`Cache operation "${cacheAction}" completed successfully for ${successCount} out of ${filteredOperations.size} operations.`);
+                            else if (cacheAction === CACHE_ACTION_WRITE) {
+                                if (requireOutputFolders &&
+                                    ((_a = operation.settings) === null || _a === void 0 ? void 0 : _a.outputFolderNames) &&
+                                    ((_c = (_b = operation.settings) === null || _b === void 0 ? void 0 : _b.outputFolderNames) === null || _c === void 0 ? void 0 : _c.length) > 0) {
+                                    const projectFolder = (_d = operation.associatedProject) === null || _d === void 0 ? void 0 : _d.projectFolder;
+                                    const missingFolders = [];
+                                    operation.settings.outputFolderNames.forEach((outputFolderName) => {
+                                        if (!FileSystem.exists(`${projectFolder}/${outputFolderName}`)) {
+                                            missingFolders.push(outputFolderName);
+                                        }
+                                    });
+                                    if (missingFolders.length > 0) {
+                                        terminal.writeWarningLine(`Operation "${operation.name}": The following output folders do not exist: "${missingFolders.join('", "')}". Skipping cache population.`);
+                                        return;
+                                    }
+                                }
+                                const success = await projectBuildCache.trySetCacheEntryAsync(terminal);
+                                if (success) {
+                                    ++successCount;
+                                    terminal.writeLine(`Operation "${operation.name}": Existing outputs have been successfully written to the build cache."`);
+                                    terminal.writeLine(`Cache key: ${projectBuildCache.cacheId}`);
+                                }
+                                else {
+                                    terminal.writeErrorLine(`Operation "${operation.name}": An error occurred while writing existing outputs to the build cache.`);
+                                }
+                            }
+                        }, { concurrency: graph.parallelism });
+                        terminal.writeLine(`Cache operation "${cacheAction}" completed successfully for ${successCount} out of ${filteredOperations.length} operations.`);
+                        // Bail out with a status indicating success; treat cache read as FromCache.
+                        return cacheAction === CACHE_ACTION_READ ? OperationStatus.FromCache : OperationStatus.Success;
+                    });
+                }
             });
         });
     }

package/lib-esm/BridgeCachePlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"BridgeCachePlugin.js","sourceRoot":"","sources":["../src/BridgeCachePlugin.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,oBAAoB,IAAI,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAWlF,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAGtE,MAAM,WAAW,GAA4B,uBAAuB,CAAC;AAErE,MAAM,iBAAiB,GAAW,MAAM,CAAC;AACzC,MAAM,kBAAkB,GAAY,OAAO,CAAC;AAS5C,MAAM,OAAO,iBAAiB;IAK5B,YAAmB,OAAkC;QAJrC,eAAU,GAAW,WAAW,CAAC;QAK/C,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;QACxD,IAAI,CAAC,kCAAkC,GAAG,OAAO,CAAC,iCAAiC,CAAC;QAEpF,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,wHAAwH,CACzH,CAAC;QACJ,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,OAAoB;QAC/B,OAAO,CAAC,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,EAAE,OAAuB,EAAE,EAAE;YAC1F,MAAM,MAAM,GAAY,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YAEvD,IAAI,WAAoC,CAAC;YACzC,IAAI,oBAAoB,GAAY,KAAK,CAAC;YAE1C,wGAAwG;YACxG,OAAO,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,CAChC,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,CAAC,gBAAgB,EAAE,EACrD,CAAC,UAA0B,EAAE,OAAiC,EAAkB,EAAE;;gBAChF,MAAM,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC;gBACrC,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;gBAErD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;oBAC9B,IAAI,CAAC,CAAA,MAAA,OAAO,CAAC,uBAAuB,0CAAE,iBAAiB,CAAA,EAAE,CAAC;wBACxD,MAAM,IAAI,KAAK,CACb,+CAA+C,IAAI,CAAC,oBAAoB,cAAc,CACvF,CAAC;oBACJ,CAAC;oBAED,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;wBACnC,SAAS,CAAC,OAAO,GAAG,KAAK,CAAC;oBAC5B,CAAC;oBAED,oBAAoB,GAAG,IAAI,CAAC,8BAA8B,CAAC,gBAAgB,CAAC,CAAC;gBAC/E,CAAC;gBAED,OAAO,UAAU,CAAC;YACpB,CAAC,CACF,CAAC;YACF,wCAAwC;YACxC,OAAO,CAAC,KAAK,CAAC,uBAAuB,CAAC,UAAU,CAC9C,WAAW,EACX,KAAK,EACH,iBAA4D,EAC5D,OAAkC,EACnB,EAAE;gBACjB,MAAM,EACJ,uBAAuB,EACvB,iBAAiB,EAAE,EACjB,wBAAwB,EAAE,EACxB,aAAa,EAAE,EAAE,kCAAkC,EAAE,EACtD,EACF,EACF,GAAG,OAAO,CAAC;gBACZ,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;gBAE5B,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;oBAC9B,OAAO;gBACT,CAAC;gBAED,IAAI,CAAC,CAAA,uBAAuB,aAAvB,uBAAuB,uBAAvB,uBAAuB,CAAE,iBAAiB,CAAA,EAAE,CAAC;oBAChD,MAAM,IAAI,KAAK,CACb,+CAA+C,IAAI,CAAC,oBAAoB,cAAc,CACvF,CAAC;gBACJ,CAAC;gBAED,MAAM,kBAAkB,GAAmC,IAAI,GAAG,EAAE,CAAC;gBACrE,KAAK,MAAM,wBAAwB,IAAI,iBAAiB,CAAC,MAAM,EAAE,EAAE,CAAC;oBAClE,IAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;wBAC/C,kBAAkB,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;oBACnD,CAAC;gBACH,CAAC;gBAED,IAAI,YAAY,GAAW,CAAC,CAAC;gBAE7B,MAAM,KAAK,CAAC,YAAY,CACtB,kBAAkB,EAClB,KAAK,EAAE,wBAAmD,EAAE,EAAE;;oBAC5D,MAAM,iBAAiB,GAAwB,mBAAmB,CAAC,YAAY,CAC7E,wBAAwB,EACxB;wBACE,uBAAuB;wBACvB,QAAQ;wBACR,uBAAuB,EAAE,CAAC,CAAC,kCAAkC;qBAC9D,CACF,CAAC;oBAEF,MAAM,EAAE,SAAS,EAAE,GAAG,wBAAwB,CAAC;oBAE/C,IAAI,WAAW,KAAK,iBAAiB,EAAE,CAAC;wBACtC,MAAM,OAAO,GAAY,MAAM,iBAAiB,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;wBACpF,IAAI,OAAO,EAAE,CAAC;4BACZ,EAAE,YAAY,CAAC;4BACf,QAAQ,CAAC,SAAS,CAChB,cAAc,SAAS,CAAC,IAAI,sDAAsD,CACnF,CAAC;4BACF,QAAQ,CAAC,SAAS,CAAC,cAAc,iBAAiB,CAAC,OAAO,EAAE,CAAC,CAAC;wBAChE,CAAC;6BAAM,CAAC;4BACN,QAAQ,CAAC,gBAAgB,CACvB,cAAc,SAAS,CAAC,IAAI,wDAAwD,CACrF,CAAC;wBACJ,CAAC;oBACH,CAAC;yBAAM,IAAI,WAAW,KAAK,kBAAkB,EAAE,CAAC;wBAC9C,qIAAqI;wBACrI,IACE,oBAAoB;6BACpB,MAAA,SAAS,CAAC,QAAQ,0CAAE,iBAAiB,CAAA;4BACrC,CAAA,MAAA,MAAA,SAAS,CAAC,QAAQ,0CAAE,iBAAiB,0CAAE,MAAM,IAAG,CAAC,EACjD,CAAC;4BACD,MAAM,aAAa,GAAW,MAAA,SAAS,CAAC,iBAAiB,0CAAE,aAAa,CAAC;4BACzE,MAAM,cAAc,GAAa,EAAE,CAAC;4BACpC,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,gBAAwB,EAAE,EAAE;gCACxE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,aAAa,IAAI,gBAAgB,EAAE,CAAC,EAAE,CAAC;oCAC/D,cAAc,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;gCACxC,CAAC;4BACH,CAAC,CAAC,CAAC;4BACH,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gCAC9B,QAAQ,CAAC,gBAAgB,CACvB,cAAc,SAAS,CAAC,IAAI,kDAAkD,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,+BAA+B,CACzI,CAAC;gCACF,OAAO;4BACT,CAAC;wBACH,CAAC;wBAED,MAAM,OAAO,GAAY,MAAM,iBAAiB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;wBACjF,IAAI,OAAO,EAAE,CAAC;4BACZ,EAAE,YAAY,CAAC;4BACf,QAAQ,CAAC,SAAS,CAChB,cAAc,SAAS,CAAC,IAAI,yEAAyE,CACtG,CAAC;4BACF,QAAQ,CAAC,SAAS,CAAC,cAAc,iBAAiB,CAAC,OAAO,EAAE,CAAC,CAAC;wBAChE,CAAC;6BAAM,CAAC;4BACN,QAAQ,CAAC,cAAc,CACrB,cAAc,SAAS,CAAC,IAAI,yEAAyE,CACtG,CAAC;wBACJ,CAAC;oBACH,CAAC;gBACH,CAAC,EACD;oBACE,WAAW,EAAE,OAAO,CAAC,WAAW;iBACjC,CACF,CAAC;gBAEF,QAAQ,CAAC,SAAS,CAChB,oBAAoB,WAAW,gCAAgC,YAAY,WAAW,kBAAkB,CAAC,IAAI,cAAc,CAC5H,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,eAAe,CACrB,gBAA2D;QAE3D,MAAM,oBAAoB,GAAqC,gBAAgB,CAAC,GAAG,CACjF,IAAI,CAAC,oBAAoB,CAC1B,CAAC;QAEF,IAAI,oBAAoB,EAAE,CAAC;YACzB,IAAI,oBAAoB,CAAC,IAAI,KAAK,wBAAwB,CAAC,MAAM,EAAE,CAAC;gBAClE,MAAM,IAAI,KAAK,CACb,kBAAkB,IAAI,CAAC,oBAAoB,4DAA4D,CACxG,CAAC;YACJ,CAAC;YAED,IACE,oBAAoB,CAAC,YAAY,CAAC,IAAI,KAAK,CAAC;gBAC5C,CAAC,oBAAoB,CAAC,YAAY,CAAC,GAAG,CAAC,iBAAiB,CAAC;gBACzD,CAAC,oBAAoB,CAAC,YAAY,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAC1D,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,kBAAkB,IAAI,CAAC,oBAAoB,qCAAqC,iBAAiB,UAAU,kBAAkB,2CAA2C,CACzK,CAAC;YACJ,CAAC;YAED,MAAM,KAAK,GAAuB,oBAAoB,CAAC,KAAK,CAAC;YAC7D,QAAQ,KAAK,EAAE,CAAC;gBACd,KAAK,iBAAiB,CAAC;gBACvB,KAAK,kBAAkB;oBACrB,OAAO,KAAK,CAAC;gBACf,KAAK,SAAS;oBACZ,OAAO,SAAS,CAAC;gBACnB;oBACE,MAAM,IAAI,KAAK,CACb,kBAAkB,IAAI,CAAC,oBAAoB,sBAAsB,iBAAiB,SAAS,kBAAkB,iBAAiB,KAAK,2CAA2C,CAC/K,CAAC;YACN,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,8BAA8B,CACpC,gBAA2D;QAE3D,IAAI,CAAC,IAAI,CAAC,kCAAkC,EAAE,CAAC;YAC7C,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,yBAAyB,GAAqC,gBAAgB,CAAC,GAAG,CACtF,IAAI,CAAC,kCAAkC,CACxC,CAAC;QAEF,IAAI,CAAC,yBAAyB,EAAE,CAAC;YAC/B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,yBAAyB,CAAC,IAAI,KAAK,wBAAwB,CAAC,IAAI,EAAE,CAAC;YACrE,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,CAAC,kCAAkC,mBAAmB,CAAC,CAAC;QAChG,CAAC;QAED,OAAO,yBAAyB,CAAC,KAAK,CAAC;IACzC,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { Async, FileSystem } from '@rushstack/node-core-library';\nimport { _OperationBuildCache as OperationBuildCache } from '@rushstack/rush-sdk';\nimport type {\n  ICreateOperationsContext,\n  IExecuteOperationsContext,\n  ILogger,\n  IOperationExecutionResult,\n  IPhasedCommand,\n  IRushPlugin,\n  Operation,\n  RushSession\n} from '@rushstack/rush-sdk';\nimport { CommandLineParameterKind } from '@rushstack/ts-command-line';\nimport type { CommandLineParameter } from '@rushstack/ts-command-line';\n\nconst PLUGIN_NAME: 'RushBridgeCachePlugin' = 'RushBridgeCachePlugin';\n\nconst CACHE_ACTION_READ: 'read' = 'read';\nconst CACHE_ACTION_WRITE: 'write' = 'write';\n\ntype CacheAction = typeof CACHE_ACTION_READ | typeof CACHE_ACTION_WRITE;\n\nexport interface IBridgeCachePluginOptions {\n  readonly actionParameterName: string;\n  readonly requireOutputFoldersParameterName: string | undefined;\n}\n\nexport class BridgeCachePlugin implements IRushPlugin {\n  public readonly pluginName: string = PLUGIN_NAME;\n  private readonly _actionParameterName: string;\n  private readonly _requireOutputFoldersParameterName: string | undefined;\n\n  public constructor(options: IBridgeCachePluginOptions) {\n    this._actionParameterName = options.actionParameterName;\n    this._requireOutputFoldersParameterName = options.requireOutputFoldersParameterName;\n\n    if (!this._actionParameterName) {\n      throw new Error(\n        'The \"actionParameterName\" option must be provided for the BridgeCachePlugin. Please see the plugin README for details.'\n      );\n    }\n  }\n\n  public apply(session: RushSession): void {\n    session.hooks.runAnyPhasedCommand.tapPromise(PLUGIN_NAME, async (command: IPhasedCommand) => {\n      const logger: ILogger = session.getLogger(PLUGIN_NAME);\n\n      let cacheAction: CacheAction | undefined;\n      let requireOutputFolders: boolean = false;\n\n      // cancel the actual operations. We don't want to run the command, just cache the output folders on disk\n      command.hooks.createOperations.tap(\n        { name: PLUGIN_NAME, stage: Number.MAX_SAFE_INTEGER },\n        (operations: Set<Operation>, context: ICreateOperationsContext): Set<Operation> => {\n          const { customParameters } = context;\n          cacheAction = this._getCacheAction(customParameters);\n\n          if (cacheAction !== undefined) {\n            if (!context.buildCacheConfiguration?.buildCacheEnabled) {\n              throw new Error(\n                `The build cache must be enabled to use the \"${this._actionParameterName}\" parameter.`\n              );\n            }\n\n            for (const operation of operations) {\n              operation.enabled = false;\n            }\n\n            requireOutputFolders = this._isRequireOutputFoldersFlagSet(customParameters);\n          }\n\n          return operations;\n        }\n      );\n      // populate the cache for each operation\n      command.hooks.beforeExecuteOperations.tapPromise(\n        PLUGIN_NAME,\n        async (\n          recordByOperation: Map<Operation, IOperationExecutionResult>,\n          context: IExecuteOperationsContext\n        ): Promise<void> => {\n          const {\n            buildCacheConfiguration,\n            rushConfiguration: {\n              experimentsConfiguration: {\n                configuration: { omitAppleDoubleFilesFromBuildCache }\n              }\n            }\n          } = context;\n          const { terminal } = logger;\n\n          if (cacheAction === undefined) {\n            return;\n          }\n\n          if (!buildCacheConfiguration?.buildCacheEnabled) {\n            throw new Error(\n              `The build cache must be enabled to use the \"${this._actionParameterName}\" parameter.`\n            );\n          }\n\n          const filteredOperations: Set<IOperationExecutionResult> = new Set();\n          for (const operationExecutionResult of recordByOperation.values()) {\n            if (!operationExecutionResult.operation.isNoOp) {\n              filteredOperations.add(operationExecutionResult);\n            }\n          }\n\n          let successCount: number = 0;\n\n          await Async.forEachAsync(\n            filteredOperations,\n            async (operationExecutionResult: IOperationExecutionResult) => {\n              const projectBuildCache: OperationBuildCache = OperationBuildCache.forOperation(\n                operationExecutionResult,\n                {\n                  buildCacheConfiguration,\n                  terminal,\n                  excludeAppleDoubleFiles: !!omitAppleDoubleFilesFromBuildCache\n                }\n              );\n\n              const { operation } = operationExecutionResult;\n\n              if (cacheAction === CACHE_ACTION_READ) {\n                const success: boolean = await projectBuildCache.tryRestoreFromCacheAsync(terminal);\n                if (success) {\n                  ++successCount;\n                  terminal.writeLine(\n                    `Operation \"${operation.name}\": Outputs have been restored from the build cache.\"`\n                  );\n                  terminal.writeLine(`Cache key: ${projectBuildCache.cacheId}`);\n                } else {\n                  terminal.writeWarningLine(\n                    `Operation \"${operation.name}\": Outputs could not be restored from the build cache.`\n                  );\n                }\n              } else if (cacheAction === CACHE_ACTION_WRITE) {\n                // if the require output folders flag has been passed, skip populating the cache if any of the expected output folders does not exist\n                if (\n                  requireOutputFolders &&\n                  operation.settings?.outputFolderNames &&\n                  operation.settings?.outputFolderNames?.length > 0\n                ) {\n                  const projectFolder: string = operation.associatedProject?.projectFolder;\n                  const missingFolders: string[] = [];\n                  operation.settings.outputFolderNames.forEach((outputFolderName: string) => {\n                    if (!FileSystem.exists(`${projectFolder}/${outputFolderName}`)) {\n                      missingFolders.push(outputFolderName);\n                    }\n                  });\n                  if (missingFolders.length > 0) {\n                    terminal.writeWarningLine(\n                      `Operation \"${operation.name}\": The following output folders do not exist: \"${missingFolders.join('\", \"')}\". Skipping cache population.`\n                    );\n                    return;\n                  }\n                }\n\n                const success: boolean = await projectBuildCache.trySetCacheEntryAsync(terminal);\n                if (success) {\n                  ++successCount;\n                  terminal.writeLine(\n                    `Operation \"${operation.name}\": Existing outputs have been successfully written to the build cache.\"`\n                  );\n                  terminal.writeLine(`Cache key: ${projectBuildCache.cacheId}`);\n                } else {\n                  terminal.writeErrorLine(\n                    `Operation \"${operation.name}\": An error occurred while writing existing outputs to the build cache.`\n                  );\n                }\n              }\n            },\n            {\n              concurrency: context.parallelism\n            }\n          );\n\n          terminal.writeLine(\n            `Cache operation \"${cacheAction}\" completed successfully for ${successCount} out of ${filteredOperations.size} operations.`\n          );\n        }\n      );\n    });\n  }\n\n  private _getCacheAction(\n    customParameters: ReadonlyMap<string, CommandLineParameter>\n  ): CacheAction | undefined {\n    const cacheActionParameter: CommandLineParameter | undefined = customParameters.get(\n      this._actionParameterName\n    );\n\n    if (cacheActionParameter) {\n      if (cacheActionParameter.kind !== CommandLineParameterKind.Choice) {\n        throw new Error(\n          `The parameter \"${this._actionParameterName}\" must be a choice. Please check the plugin configuration.`\n        );\n      }\n\n      if (\n        cacheActionParameter.alternatives.size !== 2 ||\n        !cacheActionParameter.alternatives.has(CACHE_ACTION_READ) ||\n        !cacheActionParameter.alternatives.has(CACHE_ACTION_WRITE)\n      ) {\n        throw new Error(\n          `The parameter \"${this._actionParameterName}\" must have exactly two choices: \"${CACHE_ACTION_READ}\" and \"${CACHE_ACTION_WRITE}\". Please check the plugin configuration.`\n        );\n      }\n\n      const value: string | undefined = cacheActionParameter.value;\n      switch (value) {\n        case CACHE_ACTION_READ:\n        case CACHE_ACTION_WRITE:\n          return value;\n        case undefined:\n          return undefined;\n        default:\n          throw new Error(\n            `The parameter \"${this._actionParameterName}\" must be one of: \"${CACHE_ACTION_READ}\" or \"${CACHE_ACTION_WRITE}\". Received: \"${value}\". Please check the plugin configuration.`\n          );\n      }\n    }\n\n    return undefined;\n  }\n\n  private _isRequireOutputFoldersFlagSet(\n    customParameters: ReadonlyMap<string, CommandLineParameter>\n  ): boolean {\n    if (!this._requireOutputFoldersParameterName) {\n      return false;\n    }\n\n    const requireOutputFoldersParam: CommandLineParameter | undefined = customParameters.get(\n      this._requireOutputFoldersParameterName\n    );\n\n    if (!requireOutputFoldersParam) {\n      return false;\n    }\n\n    if (requireOutputFoldersParam.kind !== CommandLineParameterKind.Flag) {\n      throw new Error(`The parameter \"${this._requireOutputFoldersParameterName}\" must be a flag.`);\n    }\n\n    return requireOutputFoldersParam.value;\n  }\n}\n"]}
+{"version":3,"file":"BridgeCachePlugin.js","sourceRoot":"","sources":["../src/BridgeCachePlugin.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EACL,oBAAoB,IAAI,mBAAmB,EAC3C,eAAe,EAShB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,wBAAwB,EAA6B,MAAM,4BAA4B,CAAC;AAEjG,MAAM,WAAW,GAA4B,uBAAuB,CAAC;AAErE,MAAM,iBAAiB,GAAW,MAAM,CAAC;AACzC,MAAM,kBAAkB,GAAY,OAAO,CAAC;AAS5C,MAAM,OAAO,iBAAiB;IAK5B,YAAmB,OAAkC;QAJrC,eAAU,GAAW,WAAW,CAAC;QAK/C,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;QACxD,IAAI,CAAC,kCAAkC,GAAG,OAAO,CAAC,iCAAiC,CAAC;QAEpF,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,wHAAwH,CACzH,CAAC;QACJ,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,OAAoB;QAC/B,OAAO,CAAC,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,EAAE,OAAuB,EAAE,EAAE;YAC1F,OAAO,CAAC,KAAK,CAAC,mBAAmB,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;gBAC1E,MAAM,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,GAAG,OAAO,CAAC;gBAC9D,MAAM,WAAW,GAA4B,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;gBAEpF,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;oBAC9B,IAAI,CAAC,CAAA,uBAAuB,aAAvB,uBAAuB,uBAAvB,uBAAuB,CAAE,iBAAiB,CAAA,EAAE,CAAC;wBAChD,MAAM,IAAI,KAAK,CACb,+CAA+C,IAAI,CAAC,oBAAoB,cAAc,CACvF,CAAC;oBACJ,CAAC;oBAED,MAAM,EACJ,iBAAiB,EAAE,EACjB,wBAAwB,EAAE,EACxB,aAAa,EAAE,EAAE,kCAAkC,EAAE,EACtD,EACF,EACF,GAAG,OAAO,CAAC;oBAEZ,MAAM,MAAM,GAAY,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;oBACvD,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;oBAC5B,MAAM,oBAAoB,GAAY,IAAI,CAAC,8BAA8B,CAAC,gBAAgB,CAAC,CAAC;oBAE5F,KAAK,CAAC,KAAK,CAAC,2BAA2B,CAAC,UAAU,CAChD,WAAW,EACX,KAAK,EACH,gBAAmE,EACnE,gBAAiD,EACX,EAAE;wBACxC,MAAM,kBAAkB,GAAoC,EAAE,CAAC;wBAC/D,KAAK,MAAM,MAAM,IAAI,gBAAgB,CAAC,MAAM,EAAE,EAAE,CAAC;4BAC/C,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;gCAC7B,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;4BAClC,CAAC;wBACH,CAAC;wBAED,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC;4BAC/B,OAAO,CAAC,2CAA2C;wBACrD,CAAC;wBAED,IAAI,YAAY,GAAW,CAAC,CAAC;wBAC7B,MAAM,KAAK,CAAC,YAAY,CACtB,kBAAkB,EAClB,KAAK,EAAE,wBAAuD,EAAE,EAAE;;4BAChE,MAAM,iBAAiB,GAAwB,mBAAmB,CAAC,YAAY,CAC7E,wBAAwB,EACxB;gCACE,uBAAuB;gCACvB,QAAQ;gCACR,uBAAuB,EAAE,CAAC,CAAC,kCAAkC;6BAC9D,CACF,CAAC;4BAEF,MAAM,EAAE,SAAS,EAAE,GAAG,wBAAwB,CAAC;4BAE/C,IAAI,WAAW,KAAK,iBAAiB,EAAE,CAAC;gCACtC,MAAM,OAAO,GAAY,MAAM,iBAAiB,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;gCACpF,IAAI,OAAO,EAAE,CAAC;oCACZ,EAAE,YAAY,CAAC;oCACf,QAAQ,CAAC,SAAS,CAChB,cAAc,SAAS,CAAC,IAAI,sDAAsD,CACnF,CAAC;oCACF,QAAQ,CAAC,SAAS,CAAC,cAAc,iBAAiB,CAAC,OAAO,EAAE,CAAC,CAAC;gCAChE,CAAC;qCAAM,CAAC;oCACN,QAAQ,CAAC,gBAAgB,CACvB,cAAc,SAAS,CAAC,IAAI,wDAAwD,CACrF,CAAC;gCACJ,CAAC;4BACH,CAAC;iCAAM,IAAI,WAAW,KAAK,kBAAkB,EAAE,CAAC;gCAC9C,IACE,oBAAoB;qCACpB,MAAA,SAAS,CAAC,QAAQ,0CAAE,iBAAiB,CAAA;oCACrC,CAAA,MAAA,MAAA,SAAS,CAAC,QAAQ,0CAAE,iBAAiB,0CAAE,MAAM,IAAG,CAAC,EACjD,CAAC;oCACD,MAAM,aAAa,GAAW,MAAA,SAAS,CAAC,iBAAiB,0CAAE,aAAa,CAAC;oCACzE,MAAM,cAAc,GAAa,EAAE,CAAC;oCACpC,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,gBAAwB,EAAE,EAAE;wCACxE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,aAAa,IAAI,gBAAgB,EAAE,CAAC,EAAE,CAAC;4CAC/D,cAAc,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;wCACxC,CAAC;oCACH,CAAC,CAAC,CAAC;oCACH,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wCAC9B,QAAQ,CAAC,gBAAgB,CACvB,cAAc,SAAS,CAAC,IAAI,kDAAkD,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,+BAA+B,CACzI,CAAC;wCACF,OAAO;oCACT,CAAC;gCACH,CAAC;gCAED,MAAM,OAAO,GAAY,MAAM,iBAAiB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;gCACjF,IAAI,OAAO,EAAE,CAAC;oCACZ,EAAE,YAAY,CAAC;oCACf,QAAQ,CAAC,SAAS,CAChB,cAAc,SAAS,CAAC,IAAI,yEAAyE,CACtG,CAAC;oCACF,QAAQ,CAAC,SAAS,CAAC,cAAc,iBAAiB,CAAC,OAAO,EAAE,CAAC,CAAC;gCAChE,CAAC;qCAAM,CAAC;oCACN,QAAQ,CAAC,cAAc,CACrB,cAAc,SAAS,CAAC,IAAI,yEAAyE,CACtG,CAAC;gCACJ,CAAC;4BACH,CAAC;wBACH,CAAC,EACD,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,CACnC,CAAC;wBAEF,QAAQ,CAAC,SAAS,CAChB,oBAAoB,WAAW,gCAAgC,YAAY,WAAW,kBAAkB,CAAC,MAAM,cAAc,CAC9H,CAAC;wBAEF,4EAA4E;wBAC5E,OAAO,WAAW,KAAK,iBAAiB,CAAC,CAAC,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC;oBACjG,CAAC,CACF,CAAC;gBACJ,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,eAAe,CACrB,gBAA2D;QAE3D,MAAM,oBAAoB,GAAqC,gBAAgB,CAAC,GAAG,CACjF,IAAI,CAAC,oBAAoB,CAC1B,CAAC;QAEF,IAAI,oBAAoB,EAAE,CAAC;YACzB,IAAI,oBAAoB,CAAC,IAAI,KAAK,wBAAwB,CAAC,MAAM,EAAE,CAAC;gBAClE,MAAM,IAAI,KAAK,CACb,kBAAkB,IAAI,CAAC,oBAAoB,4DAA4D,CACxG,CAAC;YACJ,CAAC;YAED,IACE,oBAAoB,CAAC,YAAY,CAAC,IAAI,KAAK,CAAC;gBAC5C,CAAC,oBAAoB,CAAC,YAAY,CAAC,GAAG,CAAC,iBAAiB,CAAC;gBACzD,CAAC,oBAAoB,CAAC,YAAY,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAC1D,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,kBAAkB,IAAI,CAAC,oBAAoB,qCAAqC,iBAAiB,UAAU,kBAAkB,2CAA2C,CACzK,CAAC;YACJ,CAAC;YAED,MAAM,KAAK,GAAuB,oBAAoB,CAAC,KAAK,CAAC;YAC7D,QAAQ,KAAK,EAAE,CAAC;gBACd,KAAK,iBAAiB,CAAC;gBACvB,KAAK,kBAAkB;oBACrB,OAAO,KAAK,CAAC;gBACf,KAAK,SAAS;oBACZ,OAAO,SAAS,CAAC;gBACnB;oBACE,MAAM,IAAI,KAAK,CACb,kBAAkB,IAAI,CAAC,oBAAoB,sBAAsB,iBAAiB,SAAS,kBAAkB,iBAAiB,KAAK,2CAA2C,CAC/K,CAAC;YACN,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,8BAA8B,CACpC,gBAA2D;QAE3D,IAAI,CAAC,IAAI,CAAC,kCAAkC,EAAE,CAAC;YAC7C,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,yBAAyB,GAAqC,gBAAgB,CAAC,GAAG,CACtF,IAAI,CAAC,kCAAkC,CACxC,CAAC;QAEF,IAAI,CAAC,yBAAyB,EAAE,CAAC;YAC/B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,yBAAyB,CAAC,IAAI,KAAK,wBAAwB,CAAC,IAAI,EAAE,CAAC;YACrE,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,CAAC,kCAAkC,mBAAmB,CAAC,CAAC;QAChG,CAAC;QAED,OAAO,yBAAyB,CAAC,KAAK,CAAC;IACzC,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { Async, FileSystem } from '@rushstack/node-core-library';\nimport {\n  _OperationBuildCache as OperationBuildCache,\n  OperationStatus,\n  type Operation,\n  type IOperationExecutionResult,\n  type IOperationGraphIterationOptions,\n  type ILogger,\n  type IBaseOperationExecutionResult,\n  type IPhasedCommand,\n  type IRushPlugin,\n  type RushSession\n} from '@rushstack/rush-sdk';\nimport { CommandLineParameterKind, type CommandLineParameter } from '@rushstack/ts-command-line';\n\nconst PLUGIN_NAME: 'RushBridgeCachePlugin' = 'RushBridgeCachePlugin';\n\nconst CACHE_ACTION_READ: 'read' = 'read';\nconst CACHE_ACTION_WRITE: 'write' = 'write';\n\ntype CacheAction = typeof CACHE_ACTION_READ | typeof CACHE_ACTION_WRITE;\n\nexport interface IBridgeCachePluginOptions {\n  readonly actionParameterName: string;\n  readonly requireOutputFoldersParameterName: string | undefined;\n}\n\nexport class BridgeCachePlugin implements IRushPlugin {\n  public readonly pluginName: string = PLUGIN_NAME;\n  private readonly _actionParameterName: string;\n  private readonly _requireOutputFoldersParameterName: string | undefined;\n\n  public constructor(options: IBridgeCachePluginOptions) {\n    this._actionParameterName = options.actionParameterName;\n    this._requireOutputFoldersParameterName = options.requireOutputFoldersParameterName;\n\n    if (!this._actionParameterName) {\n      throw new Error(\n        'The \"actionParameterName\" option must be provided for the BridgeCachePlugin. Please see the plugin README for details.'\n      );\n    }\n  }\n\n  public apply(session: RushSession): void {\n    session.hooks.runAnyPhasedCommand.tapPromise(PLUGIN_NAME, async (command: IPhasedCommand) => {\n      command.hooks.onGraphCreatedAsync.tap(PLUGIN_NAME, async (graph, context) => {\n        const { customParameters, buildCacheConfiguration } = context;\n        const cacheAction: CacheAction | undefined = this._getCacheAction(customParameters);\n\n        if (cacheAction !== undefined) {\n          if (!buildCacheConfiguration?.buildCacheEnabled) {\n            throw new Error(\n              `The build cache must be enabled to use the \"${this._actionParameterName}\" parameter.`\n            );\n          }\n\n          const {\n            rushConfiguration: {\n              experimentsConfiguration: {\n                configuration: { omitAppleDoubleFilesFromBuildCache }\n              }\n            }\n          } = context;\n\n          const logger: ILogger = session.getLogger(PLUGIN_NAME);\n          const { terminal } = logger;\n          const requireOutputFolders: boolean = this._isRequireOutputFoldersFlagSet(customParameters);\n\n          graph.hooks.beforeExecuteIterationAsync.tapPromise(\n            PLUGIN_NAME,\n            async (\n              operationRecords: ReadonlyMap<Operation, IOperationExecutionResult>,\n              iterationOptions: IOperationGraphIterationOptions\n            ): Promise<OperationStatus | undefined> => {\n              const filteredOperations: IBaseOperationExecutionResult[] = [];\n              for (const record of operationRecords.values()) {\n                if (!record.operation.isNoOp) {\n                  filteredOperations.push(record);\n                }\n              }\n\n              if (!filteredOperations.length) {\n                return; // nothing to do, continue normal execution\n              }\n\n              let successCount: number = 0;\n              await Async.forEachAsync(\n                filteredOperations,\n                async (operationExecutionResult: IBaseOperationExecutionResult) => {\n                  const projectBuildCache: OperationBuildCache = OperationBuildCache.forOperation(\n                    operationExecutionResult,\n                    {\n                      buildCacheConfiguration,\n                      terminal,\n                      excludeAppleDoubleFiles: !!omitAppleDoubleFilesFromBuildCache\n                    }\n                  );\n\n                  const { operation } = operationExecutionResult;\n\n                  if (cacheAction === CACHE_ACTION_READ) {\n                    const success: boolean = await projectBuildCache.tryRestoreFromCacheAsync(terminal);\n                    if (success) {\n                      ++successCount;\n                      terminal.writeLine(\n                        `Operation \"${operation.name}\": Outputs have been restored from the build cache.\"`\n                      );\n                      terminal.writeLine(`Cache key: ${projectBuildCache.cacheId}`);\n                    } else {\n                      terminal.writeWarningLine(\n                        `Operation \"${operation.name}\": Outputs could not be restored from the build cache.`\n                      );\n                    }\n                  } else if (cacheAction === CACHE_ACTION_WRITE) {\n                    if (\n                      requireOutputFolders &&\n                      operation.settings?.outputFolderNames &&\n                      operation.settings?.outputFolderNames?.length > 0\n                    ) {\n                      const projectFolder: string = operation.associatedProject?.projectFolder;\n                      const missingFolders: string[] = [];\n                      operation.settings.outputFolderNames.forEach((outputFolderName: string) => {\n                        if (!FileSystem.exists(`${projectFolder}/${outputFolderName}`)) {\n                          missingFolders.push(outputFolderName);\n                        }\n                      });\n                      if (missingFolders.length > 0) {\n                        terminal.writeWarningLine(\n                          `Operation \"${operation.name}\": The following output folders do not exist: \"${missingFolders.join('\", \"')}\". Skipping cache population.`\n                        );\n                        return;\n                      }\n                    }\n\n                    const success: boolean = await projectBuildCache.trySetCacheEntryAsync(terminal);\n                    if (success) {\n                      ++successCount;\n                      terminal.writeLine(\n                        `Operation \"${operation.name}\": Existing outputs have been successfully written to the build cache.\"`\n                      );\n                      terminal.writeLine(`Cache key: ${projectBuildCache.cacheId}`);\n                    } else {\n                      terminal.writeErrorLine(\n                        `Operation \"${operation.name}\": An error occurred while writing existing outputs to the build cache.`\n                      );\n                    }\n                  }\n                },\n                { concurrency: graph.parallelism }\n              );\n\n              terminal.writeLine(\n                `Cache operation \"${cacheAction}\" completed successfully for ${successCount} out of ${filteredOperations.length} operations.`\n              );\n\n              // Bail out with a status indicating success; treat cache read as FromCache.\n              return cacheAction === CACHE_ACTION_READ ? OperationStatus.FromCache : OperationStatus.Success;\n            }\n          );\n        }\n      });\n    });\n  }\n\n  private _getCacheAction(\n    customParameters: ReadonlyMap<string, CommandLineParameter>\n  ): CacheAction | undefined {\n    const cacheActionParameter: CommandLineParameter | undefined = customParameters.get(\n      this._actionParameterName\n    );\n\n    if (cacheActionParameter) {\n      if (cacheActionParameter.kind !== CommandLineParameterKind.Choice) {\n        throw new Error(\n          `The parameter \"${this._actionParameterName}\" must be a choice. Please check the plugin configuration.`\n        );\n      }\n\n      if (\n        cacheActionParameter.alternatives.size !== 2 ||\n        !cacheActionParameter.alternatives.has(CACHE_ACTION_READ) ||\n        !cacheActionParameter.alternatives.has(CACHE_ACTION_WRITE)\n      ) {\n        throw new Error(\n          `The parameter \"${this._actionParameterName}\" must have exactly two choices: \"${CACHE_ACTION_READ}\" and \"${CACHE_ACTION_WRITE}\". Please check the plugin configuration.`\n        );\n      }\n\n      const value: string | undefined = cacheActionParameter.value;\n      switch (value) {\n        case CACHE_ACTION_READ:\n        case CACHE_ACTION_WRITE:\n          return value;\n        case undefined:\n          return undefined;\n        default:\n          throw new Error(\n            `The parameter \"${this._actionParameterName}\" must be one of: \"${CACHE_ACTION_READ}\" or \"${CACHE_ACTION_WRITE}\". Received: \"${value}\". Please check the plugin configuration.`\n          );\n      }\n    }\n\n    return undefined;\n  }\n\n  private _isRequireOutputFoldersFlagSet(\n    customParameters: ReadonlyMap<string, CommandLineParameter>\n  ): boolean {\n    if (!this._requireOutputFoldersParameterName) {\n      return false;\n    }\n\n    const requireOutputFoldersParam: CommandLineParameter | undefined = customParameters.get(\n      this._requireOutputFoldersParameterName\n    );\n\n    if (!requireOutputFoldersParam) {\n      return false;\n    }\n\n    if (requireOutputFoldersParam.kind !== CommandLineParameterKind.Flag) {\n      throw new Error(`The parameter \"${this._requireOutputFoldersParameterName}\" must be a flag.`);\n    }\n\n    return requireOutputFoldersParam.value;\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-bridge-cache-plugin",
-  "version": "5.170.0",
+  "version": "5.170.1-pr5378.0",
   "description": "Rush plugin that provides a --set-cache-only command flag to populate the cache from content on disk.",
   "license": "MIT",
   "main": "./lib-commonjs/index.js",
@@ -38,9 +38,9 @@
   },
   "dependencies": {
     "@rushstack/ts-command-line": "5.3.3",
-    "@rushstack/rush-sdk": "5.170.0",
-    "@rushstack/terminal": "0.22.3",
-    "@rushstack/node-core-library": "5.20.3"
+    "@rushstack/rush-sdk": "5.170.1-pr5378.0",
+    "@rushstack/node-core-library": "5.20.3",
+    "@rushstack/terminal": "0.22.3"
   },
   "devDependencies": {
     "eslint": "~9.37.0",