@rushstack/rush-sdk 5.102.0-pr3949.7 → 5.103.0

package/lib/pluginFramework/PhasedCommandHooks.d.ts

@@ -1,4 +1,4 @@
-import { AsyncSeriesBailHook, AsyncSeriesHook, AsyncSeriesWaterfallHook, SyncHook } from 'tapable';
+import { AsyncSeriesHook, AsyncSeriesWaterfallHook, SyncHook } from 'tapable';
 import type { CommandLineParameter } from '@rushstack/ts-command-line';
 import type { BuildCacheConfiguration } from '../api/BuildCacheConfiguration';
 import type { IPhase } from '../api/CommandLineConfiguration';
@@ -6,12 +6,8 @@ import type { RushConfiguration } from '../api/RushConfiguration';
 import type { RushConfigurationProject } from '../api/RushConfigurationProject';
 import type { Operation } from '../logic/operations/Operation';
 import type { ProjectChangeAnalyzer } from '../logic/ProjectChangeAnalyzer';
-import type { IExecutionResult, IOperationExecutionResult } from '../logic/operations/IOperationExecutionResult';
-import type { CobuildConfiguration } from '../api/CobuildConfiguration';
-import { RushProjectConfiguration } from '../api/RushProjectConfiguration';
-import type { IOperationRunnerContext } from '../logic/operations/IOperationRunner';
-import type { ITelemetryData } from '../logic/Telemetry';
-import type { OperationStatus } from '../logic/operations/OperationStatus';
+import { ITelemetryData } from '../logic/Telemetry';
+import { IExecutionResult, IOperationExecutionResult } from '../logic/operations/IOperationExecutionResult';
 /**
  * A plugin that interacts with a phased commands.
  * @alpha
@@ -31,10 +27,6 @@ export interface ICreateOperationsContext {
      * The configuration for the build cache, if the feature is enabled.
      */
     readonly buildCacheConfiguration: BuildCacheConfiguration | undefined;
-    /**
-     * The configuration for the cobuild, if cobuild feature and build cache feature are both enabled.
-     */
-    readonly cobuildConfiguration: CobuildConfiguration | undefined;
     /**
      * The set of custom parameters for the executing command.
      * Maps from the `longName` field in command-line.json to the parser configuration in ts-command-line.
@@ -70,10 +62,6 @@ export interface ICreateOperationsContext {
      * The set of Rush projects selected for the current command execution.
      */
     readonly projectSelection: ReadonlySet<RushConfigurationProject>;
-    /**
-     * All successfully loaded rush-project.json data for selected projects.
-     */
-    readonly projectConfigurations: ReadonlyMap<RushConfigurationProject, RushProjectConfiguration>;
     /**
      * The set of Rush projects that have not been built in the current process since they were last modified.
      * When `isInitial` is true, this will be an exact match of `projectSelection`.
@@ -98,10 +86,7 @@ export declare class PhasedCommandHooks {
      * Hook invoked before operation start
      * Hook is series for stable output.
      */
-    readonly beforeExecuteOperations: AsyncSeriesHook<[
-        Map<Operation, IOperationExecutionResult>,
-        ICreateOperationsContext
-    ]>;
+    readonly beforeExecuteOperations: AsyncSeriesHook<[Map<Operation, IOperationExecutionResult>]>;
     /**
      * Hook invoked when operation status changed
      * Hook is series for stable output.
@@ -113,18 +98,6 @@ export declare class PhasedCommandHooks {
      * Hook is series for stable output.
      */
     readonly afterExecuteOperations: AsyncSeriesHook<[IExecutionResult, ICreateOperationsContext]>;
-    /**
-     * Hook invoked before executing a operation.
-     */
-    readonly beforeExecuteOperation: AsyncSeriesBailHook<[
-        IOperationRunnerContext & IOperationExecutionResult
-    ], OperationStatus | undefined>;
-    /**
-     * Hook invoked after executing a operation.
-     */
-    readonly afterExecuteOperation: AsyncSeriesHook<[
-        IOperationRunnerContext & IOperationExecutionResult
-    ]>;
     /**
      * Hook invoked after a run has finished and the command is watching for changes.
      * May be used to display additional relevant data to the user.

package/lib/pluginFramework/RushSession.d.ts

@@ -1,10 +1,8 @@
 import { ITerminalProvider } from '@rushstack/node-core-library';
+import { IBuildCacheJson } from '../api/BuildCacheConfiguration';
+import { ICloudBuildCacheProvider } from '../logic/buildCache/ICloudBuildCacheProvider';
 import { ILogger } from './logging/Logger';
 import { RushLifecycleHooks } from './RushLifeCycle';
-import type { IBuildCacheJson } from '../api/BuildCacheConfiguration';
-import type { ICloudBuildCacheProvider } from '../logic/buildCache/ICloudBuildCacheProvider';
-import type { ICobuildJson } from '../api/CobuildConfiguration';
-import type { ICobuildLockProvider } from '../logic/cobuild/ICobuildLockProvider';
 /**
  * @beta
  */
@@ -16,24 +14,17 @@ export interface IRushSessionOptions {
  * @beta
  */
 export type CloudBuildCacheProviderFactory = (buildCacheJson: IBuildCacheJson) => ICloudBuildCacheProvider | Promise<ICloudBuildCacheProvider>;
-/**
- * @beta
- */
-export type CobuildLockProviderFactory = (cobuildJson: ICobuildJson) => ICobuildLockProvider | Promise<ICobuildLockProvider>;
 /**
  * @beta
  */
 export declare class RushSession {
     private readonly _options;
     private readonly _cloudBuildCacheProviderFactories;
-    private readonly _cobuildLockProviderFactories;
     readonly hooks: RushLifecycleHooks;
     constructor(options: IRushSessionOptions);
     getLogger(name: string): ILogger;
     get terminalProvider(): ITerminalProvider;
     registerCloudBuildCacheProviderFactory(cacheProviderName: string, factory: CloudBuildCacheProviderFactory): void;
     getCloudBuildCacheProviderFactory(cacheProviderName: string): CloudBuildCacheProviderFactory | undefined;
-    registerCobuildLockProviderFactory(cobuildLockProviderName: string, factory: CobuildLockProviderFactory): void;
-    getCobuildLockProviderFactory(cobuildLockProviderName: string): CobuildLockProviderFactory | undefined;
 }
 //# sourceMappingURL=RushSession.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.102.0-pr3949.7",
+  "version": "5.103.0",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -31,7 +31,7 @@
     "@types/node": "14.18.36",
     "@types/semver": "7.5.0",
     "@types/webpack-env": "1.18.0",
-    "@microsoft/rush-lib": "5.102.0-pr3949.7",
+    "@microsoft/rush-lib": "5.103.0",
     "@rushstack/eslint-config": "3.3.3",
     "@rushstack/heft": "0.58.2",
     "@rushstack/heft-node-rig": "2.2.22",

package/lib/api/CobuildConfiguration.d.ts

@@ -1,71 +0,0 @@
-import { ITerminal } from '@rushstack/node-core-library';
-import { CobuildLockProviderFactory, RushSession } from '../pluginFramework/RushSession';
-import type { ICobuildLockProvider } from '../logic/cobuild/ICobuildLockProvider';
-import type { RushConfiguration } from './RushConfiguration';
-/**
- * @beta
- */
-export interface ICobuildJson {
-    cobuildEnabled: boolean;
-    cobuildLockProvider: string;
-}
-/**
- * @beta
- */
-export interface ICobuildConfigurationOptions {
-    cobuildJson: ICobuildJson;
-    rushConfiguration: RushConfiguration;
-    rushSession: RushSession;
-    cobuildLockProviderFactory: CobuildLockProviderFactory;
-}
-/**
- * Use this class to load and save the "common/config/rush/cobuild.json" config file.
- * This file provides configuration options for the Rush Cobuild feature.
- * @beta
- */
-export declare class CobuildConfiguration {
-    private static _jsonSchema;
-    /**
-     * Indicates whether the cobuild feature is enabled.
-     * Typically it is enabled in the cobuild.json config file.
-     *
-     * Note: The orchestrator (or local users) should always have to opt into running with cobuilds by
-     * providing a cobuild context id. Even if cobuilds are "enabled" as a feature, they don't
-     * actually turn on for that particular build unless the cobuild context id is provided as an
-     * non-empty string.
-     */
-    readonly cobuildEnabled: boolean;
-    /**
-     * Cobuild context id
-     *
-     * @remarks
-     * The cobuild feature won't be enabled until the context id is provided as an non-empty string.
-     */
-    readonly cobuildContextId: string | undefined;
-    /**
-     * This is a name of the participating cobuild runner. It can be specified by the environment variable
-     * RUSH_COBUILD_RUNNER_ID. If it is not provided, a random id will be generated to identify the runner.
-     */
-    readonly cobuildRunnerId: string;
-    /**
-     * If true, Rush will automatically handle the leaf project with build cache "disabled" by writing
-     * to the cache in a special "log files only mode". This is useful when you want to use Cobuilds
-     * to improve the performance in CI validations and the leaf projects have not enabled cache.
-     */
-    readonly cobuildLeafProjectLogOnlyAllowed: boolean;
-    private _cobuildLockProvider;
-    private readonly _cobuildLockProviderFactory;
-    private readonly _cobuildJson;
-    private constructor();
-    /**
-     * Attempts to load the cobuild.json data from the standard file path `common/config/rush/cobuild.json`.
-     * If the file has not been created yet, then undefined is returned.
-     */
-    static tryLoadAsync(terminal: ITerminal, rushConfiguration: RushConfiguration, rushSession: RushSession): Promise<CobuildConfiguration | undefined>;
-    static getCobuildConfigFilePath(rushConfiguration: RushConfiguration): string;
-    private static _loadAsync;
-    createLockProviderAsync(terminal: ITerminal): Promise<void>;
-    destroyLockProviderAsync(): Promise<void>;
-    get cobuildLockProvider(): ICobuildLockProvider;
-}
-//# sourceMappingURL=CobuildConfiguration.d.ts.map

package/lib/api/CobuildConfiguration.js

@@ -1 +0,0 @@
-module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("api/CobuildConfiguration");

package/lib/logic/cobuild/CobuildLock.d.ts

@@ -1,43 +0,0 @@
-import type { CobuildConfiguration } from '../../api/CobuildConfiguration';
-import type { OperationStatus } from '../operations/OperationStatus';
-import type { ICobuildContext } from './ICobuildLockProvider';
-import type { ProjectBuildCache } from '../buildCache/ProjectBuildCache';
-export interface ICobuildLockOptions {
-    /**
-     * {@inheritdoc CobuildConfiguration}
-     */
-    cobuildConfiguration: CobuildConfiguration;
-    /**
-     * {@inheritdoc ICobuildContext.clusterId}
-     */
-    cobuildClusterId: string;
-    /**
-     * {@inheritdoc ICobuildContext.packageName}
-     */
-    packageName: string;
-    /**
-     * {@inheritdoc ICobuildContext.phaseName}
-     */
-    phaseName: string;
-    projectBuildCache: ProjectBuildCache;
-    /**
-     * The expire time of the lock in seconds.
-     */
-    lockExpireTimeInSeconds: number;
-}
-export interface ICobuildCompletedState {
-    status: OperationStatus.Success | OperationStatus.SuccessWithWarning | OperationStatus.Failure;
-    cacheId: string;
-}
-export declare class CobuildLock {
-    readonly cobuildConfiguration: CobuildConfiguration;
-    readonly projectBuildCache: ProjectBuildCache;
-    private _cobuildContext;
-    constructor(options: ICobuildLockOptions);
-    setCompletedStateAsync(state: ICobuildCompletedState): Promise<void>;
-    getCompletedStateAsync(): Promise<ICobuildCompletedState | undefined>;
-    tryAcquireLockAsync(): Promise<boolean>;
-    renewLockAsync(): Promise<void>;
-    get cobuildContext(): ICobuildContext;
-}
-//# sourceMappingURL=CobuildLock.d.ts.map

package/lib/logic/cobuild/CobuildLock.js

@@ -1 +0,0 @@
-module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/cobuild/CobuildLock");

package/lib/logic/cobuild/DisjointSet.d.ts

@@ -1,28 +0,0 @@
-/**
- * A disjoint set data structure
- */
-export declare class DisjointSet<T extends object> {
-    private _forest;
-    private _parentMap;
-    private _sizeMap;
-    private _setByElement;
-    constructor();
-    destroy(): void;
-    /**
-     * Adds a new set containing specific object
-     */
-    add(x: T): void;
-    /**
-     * Unions the sets that contain two objects
-     */
-    union(a: T, b: T): void;
-    getAllSets(): Iterable<Set<T>>;
-    /**
-     * Returns true if x and y are in the same set
-     */
-    isConnected(x: T, y: T): boolean;
-    private _find;
-    private _getParent;
-    private _getSize;
-}
-//# sourceMappingURL=DisjointSet.d.ts.map

package/lib/logic/cobuild/DisjointSet.js

@@ -1 +0,0 @@
-module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/cobuild/DisjointSet");

package/lib/logic/cobuild/ICobuildLockProvider.d.ts

@@ -1,99 +0,0 @@
-import type { OperationStatus } from '../operations/OperationStatus';
-/**
- * @beta
- */
-export interface ICobuildContext {
-    /**
-     * The key for acquiring lock.
-     */
-    lockKey: string;
-    /**
-     * The expire time of the lock in seconds.
-     */
-    lockExpireTimeInSeconds: number;
-    /**
-     * The key for storing completed state.
-     */
-    completedStateKey: string;
-    /**
-     * The contextId is provided by the monorepo maintainer, it reads from environment variable {@link EnvironmentVariableNames.RUSH_COBUILD_CONTEXT_ID}.
-     * It ensure only the builds from the same given contextId cooperated.
-     */
-    contextId: string;
-    /**
-     * The id of the cluster. The operations in the same cluster share the same clusterId and
-     * will be executed on the same machine.
-     */
-    clusterId: string;
-    /**
-     * The id of the runner. The identifier for the running machine.
-     *
-     * It can be specified via assigning `RUSH_COBUILD_RUNNER_ID` environment variable.
-     */
-    runnerId: string;
-    /**
-     * The id of the cache entry. It should be kept the same as the normal cacheId from ProjectBuildCache.
-     * Otherwise, there is a discrepancy in the success case wherein turning on cobuilds will
-     * fail to populate the normal build cache.
-     */
-    cacheId: string;
-    /**
-     * The name of NPM package
-     *
-     * Example: `@scope/MyProject`
-     */
-    packageName: string;
-    /**
-     * The name of the phase.
-     *
-     * Example: _phase:build
-     */
-    phaseName: string;
-}
-/**
- * @beta
- */
-export interface ICobuildCompletedState {
-    status: OperationStatus.Success | OperationStatus.SuccessWithWarning | OperationStatus.Failure;
-    /**
-     * Completed state points to the cache id that was used to store the build cache.
-     * Note: Cache failed builds in a separate cache id
-     */
-    cacheId: string;
-}
-/**
- * @beta
- */
-export interface ICobuildLockProvider {
-    /**
-     * The callback function invoked to connect to the lock provider.
-     * For example, initializing the connection to the redis server.
-     */
-    connectAsync(): Promise<void>;
-    /**
-     * The callback function invoked to disconnect the lock provider.
-     */
-    disconnectAsync(): Promise<void>;
-    /**
-     * The callback function to acquire a lock with a lock key and specific contexts.
-     *
-     * NOTE: This lock implementation must be a ReentrantLock. It says the lock might be acquired
-     * multiple times, since tasks in the same cluster can be run in the same VM.
-     */
-    acquireLockAsync(context: Readonly<ICobuildContext>): Promise<boolean>;
-    /**
-     * The callback function to renew a lock with a lock key and specific contexts.
-     *
-     * NOTE: If the lock key expired
-     */
-    renewLockAsync(context: Readonly<ICobuildContext>): Promise<void>;
-    /**
-     * The callback function to set completed state.
-     */
-    setCompletedStateAsync(context: Readonly<ICobuildContext>, state: ICobuildCompletedState): Promise<void>;
-    /**
-     * The callback function to get completed state.
-     */
-    getCompletedStateAsync(context: Readonly<ICobuildContext>): Promise<ICobuildCompletedState | undefined>;
-}
-//# sourceMappingURL=ICobuildLockProvider.d.ts.map

package/lib/logic/cobuild/ICobuildLockProvider.js

@@ -1 +0,0 @@
-module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/cobuild/ICobuildLockProvider");

package/lib/logic/operations/CacheableOperationPlugin.d.ts

@@ -1,51 +0,0 @@
-import { ITerminal } from '@rushstack/node-core-library';
-import { CobuildLock } from '../cobuild/CobuildLock';
-import { ProjectBuildCache } from '../buildCache/ProjectBuildCache';
-import { IOperationSettings } from '../../api/RushProjectConfiguration';
-import { ProjectLogWritable } from './ProjectLogWritable';
-import { CobuildConfiguration } from '../../api/CobuildConfiguration';
-import { PeriodicCallback } from './PeriodicCallback';
-import type { IPhasedCommandPlugin, PhasedCommandHooks } from '../../pluginFramework/PhasedCommandHooks';
-import type { BuildCacheConfiguration } from '../../api/BuildCacheConfiguration';
-export interface IProjectDeps {
-    files: {
-        [filePath: string]: string;
-    };
-    arguments: string;
-}
-export interface IOperationBuildCacheContext {
-    isCacheWriteAllowed: boolean;
-    isCacheReadAllowed: boolean;
-    projectBuildCache: ProjectBuildCache | undefined;
-    cacheDisabledReason: string | undefined;
-    operationSettings: IOperationSettings | undefined;
-    cobuildLock: CobuildLock | undefined;
-    cobuildClusterId: string | undefined;
-    buildCacheTerminal: ITerminal | undefined;
-    buildCacheProjectLogWritable: ProjectLogWritable | undefined;
-    periodicCallback: PeriodicCallback;
-    cacheRestored: boolean;
-    isCacheReadAttempted: boolean;
-}
-export interface ICacheableOperationPluginOptions {
-    allowWarningsInSuccessfulBuild: boolean;
-    buildCacheConfiguration: BuildCacheConfiguration;
-    cobuildConfiguration: CobuildConfiguration | undefined;
-    terminal: ITerminal;
-}
-export declare class CacheableOperationPlugin implements IPhasedCommandPlugin {
-    private _buildCacheContextByOperation;
-    private _createContext;
-    private readonly _options;
-    constructor(options: ICacheableOperationPluginOptions);
-    apply(hooks: PhasedCommandHooks): void;
-    private _getBuildCacheContextByOperation;
-    private _getBuildCacheContextByOperationOrThrow;
-    private _tryGetProjectBuildCacheAsync;
-    private _tryGetLogOnlyProjectBuildCacheAsync;
-    private _tryGetCobuildLockAsync;
-    private _getBuildCacheTerminal;
-    private _createBuildCacheTerminal;
-    private _tryGetBuildCacheProjectLogWritable;
-}
-//# sourceMappingURL=CacheableOperationPlugin.d.ts.map

package/lib/logic/operations/CacheableOperationPlugin.js

@@ -1 +0,0 @@
-module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/operations/CacheableOperationPlugin");

package/lib/logic/operations/LegacySkipPlugin.d.ts

@@ -1,22 +0,0 @@
-import { type ITerminal } from '@rushstack/node-core-library';
-import type { IPhasedCommandPlugin, PhasedCommandHooks } from '../../pluginFramework/PhasedCommandHooks';
-export interface IProjectDeps {
-    files: {
-        [filePath: string]: string;
-    };
-    arguments: string;
-}
-export interface ILegacySkipPluginOptions {
-    terminal: ITerminal;
-    changedProjectsOnly: boolean;
-    isIncrementalBuildAllowed: boolean;
-}
-/**
- * Core phased command plugin that implements the legacy skip detection logic, used when build cache is disabled.
- */
-export declare class LegacySkipPlugin implements IPhasedCommandPlugin {
-    private readonly _options;
-    constructor(options: ILegacySkipPluginOptions);
-    apply(hooks: PhasedCommandHooks): void;
-}
-//# sourceMappingURL=LegacySkipPlugin.d.ts.map

package/lib/logic/operations/LegacySkipPlugin.js

@@ -1 +0,0 @@
-module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/operations/LegacySkipPlugin");

package/lib/logic/operations/PeriodicCallback.d.ts

@@ -1,20 +0,0 @@
-export type ICallbackFn = () => Promise<void> | void;
-export interface IPeriodicCallbackOptions {
-    interval: number;
-}
-/**
- * A help class to run callbacks in a loop with a specified interval.
- *
- * @beta
- */
-export declare class PeriodicCallback {
-    private _callbacks;
-    private _interval;
-    private _intervalId;
-    private _isRunning;
-    constructor(options: IPeriodicCallbackOptions);
-    addCallback(callback: ICallbackFn): void;
-    start(): void;
-    stop(): void;
-}
-//# sourceMappingURL=PeriodicCallback.d.ts.map

package/lib/logic/operations/PeriodicCallback.js

@@ -1 +0,0 @@
-module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/operations/PeriodicCallback");

package/lib/utilities/NullTerminalProvider.d.ts

@@ -1,10 +0,0 @@
-import type { ITerminalProvider } from '@rushstack/node-core-library';
-/**
- * A terminal provider like /dev/null
- */
-export declare class NullTerminalProvider implements ITerminalProvider {
-    supportsColor: boolean;
-    eolCharacter: string;
-    write(): void;
-}
-//# sourceMappingURL=NullTerminalProvider.d.ts.map

package/lib/utilities/NullTerminalProvider.js

@@ -1 +0,0 @@
-module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("utilities/NullTerminalProvider");