@rushstack/rush-sdk 5.90.1 → 5.91.0

package/dist/rush-lib.d.ts

@@ -1095,6 +1095,23 @@ export declare interface IOperationExecutionResult {
     readonly nonCachedDurationMs: number | undefined;
 }
 
+/**
+ * @internal
+ */
+export declare interface _IOperationMetadata {
+    durationInSeconds: number;
+    logPath: string;
+    errorLogPath: string;
+}
+
+/**
+ * @internal
+ */
+export declare interface _IOperationMetadataManagerOptions {
+    rushProject: RushConfigurationProject;
+    phase: IPhase;
+}
+
 /**
  * Options for constructing a new Operation.
  * @alpha
@@ -1177,11 +1194,11 @@ export declare interface IOperationRunnerContext {
      */
     stdioSummarizer: StdioSummarizer;
     /**
-     * Object used to record state of the operation.
+     * Object used to manage metadata of the operation.
      *
      * @internal
      */
-    _operationStateFile?: _OperationStateFile;
+    _operationMetadataManager?: _OperationMetadataManager;
     /**
      * Object used to track elapsed time.
      */
@@ -1192,8 +1209,8 @@ export declare interface IOperationRunnerContext {
  * @internal
  */
 export declare interface _IOperationStateFileOptions {
-    rushProject: RushConfigurationProject;
-    phase: IPhase;
+    projectFolder: string;
+    metadataFolder: string;
 }
 
 /**
@@ -1962,6 +1979,35 @@ export declare class Operation {
     deleteDependency(dependency: Operation): void;
 }
 
+/**
+ * A helper class for managing the meta files of a operation.
+ *
+ * @internal
+ */
+export declare class _OperationMetadataManager {
+    readonly stateFile: _OperationStateFile;
+    private _metadataFolder;
+    private _logPath;
+    private _errorLogPath;
+    private _relativeLogPath;
+    private _relativeErrorLogPath;
+    constructor(options: _IOperationMetadataManagerOptions);
+    /**
+     * Returns the relative paths of the metadata files to project folder.
+     *
+     * Example: `.rush/temp/operation/_phase_build/state.json`
+     * Example: `.rush/temp/operation/_phase_build/all.log`
+     * Example: `.rush/temp/operation/_phase_build/error.log`
+     */
+    get relativeFilepaths(): string[];
+    saveAsync({ durationInSeconds, logPath, errorLogPath }: _IOperationMetadata): Promise<void>;
+    tryRestoreAsync({ terminal, logPath, errorLogPath }: {
+        terminal: ITerminal;
+        logPath: string;
+        errorLogPath: string;
+    }): Promise<void>;
+}
+
 /**
  * A helper class for managing the state file of a operation.
  *
@@ -1970,17 +2016,19 @@ export declare class Operation {
 export declare class _OperationStateFile {
     private _state;
     /**
-     * Returns the filename of the metadata file.
+     * The path of the state json file.
+     *
+     * Example: `/code/repo/my-project/.rush/temp/operation/_phase_build/state.json`
      */
-    readonly filename: string;
-    constructor(options: _IOperationStateFileOptions);
-    private static _getFilename;
+    readonly filepath: string;
     /**
-     * ProjectBuildCache expects the relative path for better logging
+     * The relative path of the state json file to project folder
      *
-     * @internal
+     * Example: `.rush/temp/operation/_phase_build/state.json`
      */
-    static getFilenameRelativeToProjectRoot(phase: IPhase): string;
+    readonly relativeFilepath: string;
+    static filename: string;
+    constructor(options: _IOperationStateFileOptions);
     get state(): _IOperationStateJson | undefined;
     writeAsync(json: _IOperationStateJson): Promise<void>;
     tryRestoreAsync(): Promise<_IOperationStateJson | undefined>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.90.1",
+  "version": "5.91.0",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -14,19 +14,19 @@
   "dependencies": {
     "@types/node-fetch": "2.6.2",
     "tapable": "2.2.1",
-    "@rushstack/node-core-library": "3.55.1"
+    "@rushstack/node-core-library": "3.55.2"
   },
   "devDependencies": {
     "@types/heft-jest": "1.0.1",
     "@types/semver": "7.3.5",
     "@types/webpack-env": "1.18.0",
-    "@microsoft/rush-lib": "5.90.1",
-    "@rushstack/eslint-config": "3.1.1",
-    "@rushstack/heft": "0.49.6",
-    "@rushstack/heft-node-rig": "1.12.3",
-    "@rushstack/stream-collator": "4.0.226",
-    "@rushstack/ts-command-line": "4.13.1",
-    "@rushstack/terminal": "0.5.1"
+    "@microsoft/rush-lib": "5.91.0",
+    "@rushstack/heft": "0.49.7",
+    "@rushstack/eslint-config": "3.2.0",
+    "@rushstack/heft-node-rig": "1.12.4",
+    "@rushstack/stream-collator": "4.0.227",
+    "@rushstack/ts-command-line": "4.13.2",
+    "@rushstack/terminal": "0.5.2"
   },
   "scripts": {
     "build": "heft build --clean",