@rushstack/rush-redis-cobuild-plugin 5.97.1-pr3949.2 → 5.101.0-pr3949.3

package/dist/rush-redis-cobuild-plugin.d.ts

@@ -1,12 +1,12 @@
 /// <reference types="node" />
 
-import type { ICobuildCompletedState } from '@rushstack/rush-sdk';
-import type { ICobuildContext } from '@rushstack/rush-sdk';
-import type { ICobuildLockProvider } from '@rushstack/rush-sdk';
+import { ICobuildCompletedState } from '@rushstack/rush-sdk';
+import { ICobuildContext } from '@rushstack/rush-sdk';
+import { ICobuildLockProvider } from '@rushstack/rush-sdk';
 import type { IRushPlugin } from '@rushstack/rush-sdk';
 import type { RedisClientOptions } from '@redis/client';
 import type { RushConfiguration } from '@rushstack/rush-sdk';
-import type { RushSession } from '@rushstack/rush-sdk';
+import { RushSession } from '@rushstack/rush-sdk';
 
 /**
  * The redis client options
@@ -30,29 +30,26 @@ declare type IRushRedisCobuildPluginOptions = IRedisCobuildLockProviderOptions;
 export declare class RedisCobuildLockProvider implements ICobuildLockProvider {
     private readonly _options;
     private readonly _terminal;
+    private readonly _lockKeyIdentifierMap;
+    private readonly _completedStateKeyIdentifierMap;
     private readonly _redisClient;
-    private readonly _lockKeyMap;
-    private readonly _completedKeyMap;
     constructor(options: IRedisCobuildLockProviderOptions, rushSession: RushSession);
     static expandOptionsWithEnvironmentVariables(options: IRedisCobuildLockProviderOptions, environment?: NodeJS.ProcessEnv): IRedisCobuildLockProviderOptions;
     connectAsync(): Promise<void>;
     disconnectAsync(): Promise<void>;
+    /**
+     * Acquiring the lock based on the specific context.
+     *
+     * NOTE: this is a reentrant lock implementation
+     */
     acquireLockAsync(context: ICobuildContext): Promise<boolean>;
     renewLockAsync(context: ICobuildContext): Promise<void>;
     setCompletedStateAsync(context: ICobuildContext, state: ICobuildCompletedState): Promise<void>;
     getCompletedStateAsync(context: ICobuildContext): Promise<ICobuildCompletedState | undefined>;
-    /**
-     * Returns the lock key for the given context
-     * Example: cobuild:v1:<contextId>:<cacheId>:lock
-     */
-    getLockKey(context: ICobuildContext): string;
-    /**
-     * Returns the completed key for the given context
-     * Example: cobuild:v1:<contextId>:<cacheId>:completed
-     */
-    getCompletedStateKey(context: ICobuildContext): string;
     private _serializeCompletedState;
     private _deserializeCompletedState;
+    private _getLockKeyIdentifier;
+    private _getCompletedStateKeyIdentifier;
 }
 
 /**

package/lib/RedisCobuildLockProvider.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import type { ICobuildLockProvider, ICobuildContext, ICobuildCompletedState, RushSession } from '@rushstack/rush-sdk';
+import { ICobuildLockProvider, ICobuildContext, ICobuildCompletedState, RushSession } from '@rushstack/rush-sdk';
 import type { RedisClientOptions } from '@redis/client';
 /**
  * The redis client options
@@ -17,28 +17,25 @@ export interface IRedisCobuildLockProviderOptions extends RedisClientOptions {
 export declare class RedisCobuildLockProvider implements ICobuildLockProvider {
     private readonly _options;
     private readonly _terminal;
+    private readonly _lockKeyIdentifierMap;
+    private readonly _completedStateKeyIdentifierMap;
     private readonly _redisClient;
-    private readonly _lockKeyMap;
-    private readonly _completedKeyMap;
     constructor(options: IRedisCobuildLockProviderOptions, rushSession: RushSession);
     static expandOptionsWithEnvironmentVariables(options: IRedisCobuildLockProviderOptions, environment?: NodeJS.ProcessEnv): IRedisCobuildLockProviderOptions;
     connectAsync(): Promise<void>;
     disconnectAsync(): Promise<void>;
+    /**
+     * Acquiring the lock based on the specific context.
+     *
+     * NOTE: this is a reentrant lock implementation
+     */
     acquireLockAsync(context: ICobuildContext): Promise<boolean>;
     renewLockAsync(context: ICobuildContext): Promise<void>;
     setCompletedStateAsync(context: ICobuildContext, state: ICobuildCompletedState): Promise<void>;
     getCompletedStateAsync(context: ICobuildContext): Promise<ICobuildCompletedState | undefined>;
-    /**
-     * Returns the lock key for the given context
-     * Example: cobuild:v1:<contextId>:<cacheId>:lock
-     */
-    getLockKey(context: ICobuildContext): string;
-    /**
-     * Returns the completed key for the given context
-     * Example: cobuild:v1:<contextId>:<cacheId>:completed
-     */
-    getCompletedStateKey(context: ICobuildContext): string;
     private _serializeCompletedState;
     private _deserializeCompletedState;
+    private _getLockKeyIdentifier;
+    private _getCompletedStateKeyIdentifier;
 }
 //# sourceMappingURL=RedisCobuildLockProvider.d.ts.map

package/lib/RedisCobuildLockProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RedisCobuildLockProvider.d.ts","sourceRoot":"","sources":["../src/RedisCobuildLockProvider.ts"],"names":[],"mappings":";AAKA,OAAO,KAAK,EACV,oBAAoB,EACpB,eAAe,EACf,sBAAsB,EACtB,WAAW,EACZ,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,kBAAkB,EAKnB,MAAM,eAAe,CAAC;AAGvB;;;GAGG;AACH,MAAM,WAAW,gCAAiC,SAAQ,kBAAkB;IAC1E;;OAEG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;CACtC;AAKD;;GAEG;AACH,qBAAa,wBAAyB,YAAW,oBAAoB;IACnE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmC;IAC5D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;IAEtC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA8D;IAC3F,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA4E;IACxG,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAG7B;gBAEe,OAAO,EAAE,gCAAgC,EAAE,WAAW,EAAE,WAAW;WAUxE,qCAAqC,CACjD,OAAO,EAAE,gCAAgC,EACzC,WAAW,GAAE,MAAM,CAAC,UAAwB,GAC3C,gCAAgC;IA0BtB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAU7B,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAQhC,gBAAgB,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAiB5D,cAAc,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAWvD,sBAAsB,CACjC,OAAO,EAAE,eAAe,EACxB,KAAK,EAAE,sBAAsB,GAC5B,OAAO,CAAC,IAAI,CAAC;IAYH,sBAAsB,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,sBAAsB,GAAG,SAAS,CAAC;IAgB1G;;;OAGG;IACI,UAAU,CAAC,OAAO,EAAE,eAAe,GAAG,MAAM;IAUnD;;;OAGG;IACI,oBAAoB,CAAC,OAAO,EAAE,eAAe,GAAG,MAAM;IAU7D,OAAO,CAAC,wBAAwB;IAMhC,OAAO,CAAC,0BAA0B;CAInC"}
+{"version":3,"file":"RedisCobuildLockProvider.d.ts","sourceRoot":"","sources":["../src/RedisCobuildLockProvider.ts"],"names":[],"mappings":";AAKA,OAAO,EACL,oBAAoB,EACpB,eAAe,EACf,sBAAsB,EACtB,WAAW,EACZ,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,kBAAkB,EAKnB,MAAM,eAAe,CAAC;AAGvB;;;GAGG;AACH,MAAM,WAAW,gCAAiC,SAAQ,kBAAkB;IAC1E;;OAEG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;CACtC;AAID;;GAEG;AACH,qBAAa,wBAAyB,YAAW,oBAAoB;IACnE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmC;IAC5D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;IACtC,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAGlC;IACJ,OAAO,CAAC,QAAQ,CAAC,+BAA+B,CAG5C;IAEJ,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA8D;gBAExE,OAAO,EAAE,gCAAgC,EAAE,WAAW,EAAE,WAAW;WAUxE,qCAAqC,CACjD,OAAO,EAAE,gCAAgC,EACzC,WAAW,GAAE,MAAM,CAAC,UAAwB,GAC3C,gCAAgC;IA0BtB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAU7B,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ7C;;;;OAIG;IACU,gBAAgB,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAiC5D,cAAc,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAYvD,sBAAsB,CACjC,OAAO,EAAE,eAAe,EACxB,KAAK,EAAE,sBAAsB,GAC5B,OAAO,CAAC,IAAI,CAAC;IAaH,sBAAsB,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,sBAAsB,GAAG,SAAS,CAAC;IAiB1G,OAAO,CAAC,wBAAwB;IAOhC,OAAO,CAAC,0BAA0B;IAKlC,OAAO,CAAC,qBAAqB;IAU7B,OAAO,CAAC,+BAA+B;CASxC"}

package/lib/RedisCobuildLockProvider.js

@@ -4,15 +4,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RedisCobuildLockProvider = void 0;
 const client_1 = require("@redis/client");
-const KEY_SEPARATOR = ':';
 const COMPLETED_STATE_SEPARATOR = ';';
 /**
  * @beta
  */
 class RedisCobuildLockProvider {
     constructor(options, rushSession) {
-        this._lockKeyMap = new WeakMap();
-        this._completedKeyMap = new WeakMap();
+        this._lockKeyIdentifierMap = new WeakMap();
+        this._completedStateKeyIdentifierMap = new WeakMap();
         this._options = RedisCobuildLockProvider.expandOptionsWithEnvironmentVariables(options);
         this._terminal = rushSession.getLogger('RedisCobuildLockProvider').terminal;
         try {
@@ -58,97 +57,113 @@ class RedisCobuildLockProvider {
             throw new Error(`Failed to disconnect to redis server: ${e.message}`);
         }
     }
+    /**
+     * Acquiring the lock based on the specific context.
+     *
+     * NOTE: this is a reentrant lock implementation
+     */
     async acquireLockAsync(context) {
         const { _terminal: terminal } = this;
-        const lockKey = this.getLockKey(context);
+        const { lockKey, lockExpireTimeInSeconds, runnerId } = context;
         let result = false;
+        const lockKeyIdentifier = this._getLockKeyIdentifier(context);
         try {
-            const incrResult = await this._redisClient.incr(lockKey);
-            result = incrResult === 1;
-            terminal.writeDebugLine(`Acquired lock for ${lockKey}: ${incrResult}, 1 is success`);
+            // According to the doc, the reply of set command is either "OK" or nil. The reply doesn't matter
+            await this._redisClient.set(lockKey, runnerId, {
+                NX: true,
+                // call EXPIRE in an atomic command
+                EX: lockExpireTimeInSeconds
+                // Do not specify GET here since using NX ane GET together requires Redis@7.
+            });
+            // Just read the value by lock key to see wether it equals current runner id
+            const value = await this._redisClient.get(lockKey);
+            if (value === null) {
+                // This should not happen.
+                throw new Error(`Get redis key failed: ${lockKey}`);
+            }
+            result = value === runnerId;
             if (result) {
-                await this.renewLockAsync(context);
+                terminal.writeDebugLine(`Successfully acquired ${lockKeyIdentifier} to runner(${runnerId}) and it expires in ${lockExpireTimeInSeconds}s`);
+            }
+            else {
+                terminal.writeDebugLine(`Failed to acquire ${lockKeyIdentifier}, locked by runner ${value}`);
             }
         }
         catch (e) {
-            throw new Error(`Failed to acquire lock for ${lockKey}: ${e.message}`);
+            throw new Error(`Error occurs when acquiring ${lockKeyIdentifier}: ${e.message}`);
         }
         return result;
     }
     async renewLockAsync(context) {
         const { _terminal: terminal } = this;
-        const lockKey = this.getLockKey(context);
+        const { lockKey, lockExpireTimeInSeconds } = context;
+        const lockKeyIdentifier = this._getLockKeyIdentifier(context);
         try {
-            await this._redisClient.expire(lockKey, 30);
+            await this._redisClient.expire(lockKey, lockExpireTimeInSeconds);
         }
         catch (e) {
-            throw new Error(`Failed to renew lock for ${lockKey}: ${e.message}`);
+            throw new Error(`Failed to renew ${lockKeyIdentifier}: ${e.message}`);
         }
-        terminal.writeDebugLine(`Renewed lock for ${lockKey}`);
+        terminal.writeDebugLine(`Renewed ${lockKeyIdentifier} expires in ${lockExpireTimeInSeconds} seconds`);
     }
     async setCompletedStateAsync(context, state) {
         const { _terminal: terminal } = this;
-        const key = this.getCompletedStateKey(context);
+        const { completedStateKey: key } = context;
         const value = this._serializeCompletedState(state);
+        const completedStateKeyIdentifier = this._getCompletedStateKeyIdentifier(context);
         try {
             await this._redisClient.set(key, value);
         }
         catch (e) {
-            throw new Error(`Failed to set completed state for ${key}: ${e.message}`);
+            throw new Error(`Failed to set ${completedStateKeyIdentifier}: ${e.message}`);
         }
-        terminal.writeDebugLine(`Set completed state for ${key}: ${value}`);
+        terminal.writeDebugLine(`Set ${completedStateKeyIdentifier}: ${value}`);
     }
     async getCompletedStateAsync(context) {
         const { _terminal: terminal } = this;
-        const key = this.getCompletedStateKey(context);
+        const { completedStateKey: key } = context;
+        const completedStateKeyIdentifier = this._getCompletedStateKeyIdentifier(context);
         let state;
         try {
             const value = await this._redisClient.get(key);
             if (value) {
                 state = this._deserializeCompletedState(value);
             }
-            terminal.writeDebugLine(`Get completed state for ${key}: ${value}`);
+            terminal.writeDebugLine(`Get ${completedStateKeyIdentifier}: ${value}`);
         }
         catch (e) {
-            throw new Error(`Failed to get completed state for ${key}: ${e.message}`);
+            throw new Error(`Failed to get ${completedStateKeyIdentifier}: ${e.message}`);
         }
         return state;
     }
-    /**
-     * Returns the lock key for the given context
-     * Example: cobuild:v1:<contextId>:<cacheId>:lock
-     */
-    getLockKey(context) {
-        const { version, contextId, cacheId } = context;
-        let lockKey = this._lockKeyMap.get(context);
-        if (!lockKey) {
-            lockKey = ['cobuild', `v${version}`, contextId, cacheId, 'lock'].join(KEY_SEPARATOR);
-            this._lockKeyMap.set(context, lockKey);
-        }
-        return lockKey;
-    }
-    /**
-     * Returns the completed key for the given context
-     * Example: cobuild:v1:<contextId>:<cacheId>:completed
-     */
-    getCompletedStateKey(context) {
-        const { version, contextId, cacheId } = context;
-        let completedKey = this._completedKeyMap.get(context);
-        if (!completedKey) {
-            completedKey = ['cobuild', `v${version}`, contextId, cacheId, 'completed'].join(KEY_SEPARATOR);
-            this._completedKeyMap.set(context, completedKey);
-        }
-        return completedKey;
-    }
     _serializeCompletedState(state) {
         // Example: SUCCESS;1234567890
         // Example: FAILURE;1234567890
-        return `${state.status}${COMPLETED_STATE_SEPARATOR}${state.cacheId}`;
+        const { status, cacheId } = state;
+        return [status, cacheId].join(COMPLETED_STATE_SEPARATOR);
     }
     _deserializeCompletedState(state) {
         const [status, cacheId] = state.split(COMPLETED_STATE_SEPARATOR);
         return { status: status, cacheId };
     }
+    _getLockKeyIdentifier(context) {
+        let lockKeyIdentifier = this._lockKeyIdentifierMap.get(context);
+        if (lockKeyIdentifier === undefined) {
+            const { lockKey, packageName, phaseName } = context;
+            lockKeyIdentifier = `lock(${lockKey})_package(${packageName})_phase(${phaseName})`;
+            this._lockKeyIdentifierMap.set(context, lockKeyIdentifier);
+        }
+        return lockKeyIdentifier;
+    }
+    _getCompletedStateKeyIdentifier(context) {
+        let completedStateKeyIdentifier = this._completedStateKeyIdentifierMap.get(context);
+        if (completedStateKeyIdentifier === undefined) {
+            const { completedStateKey, packageName, phaseName } = context;
+            completedStateKeyIdentifier = `completed_state(${completedStateKey})_package(${packageName})_phase(${phaseName})`;
+            this._completedStateKeyIdentifierMap.set(context, completedStateKeyIdentifier);
+        }
+        return completedStateKeyIdentifier;
+    }
 }
 exports.RedisCobuildLockProvider = RedisCobuildLockProvider;
 //# sourceMappingURL=RedisCobuildLockProvider.js.map

package/lib/RedisCobuildLockProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"RedisCobuildLockProvider.js","sourceRoot":"","sources":["../src/RedisCobuildLockProvider.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,0CAA6C;AA4B7C,MAAM,aAAa,GAAQ,GAAG,CAAC;AAC/B,MAAM,yBAAyB,GAAQ,GAAG,CAAC;AAE3C;;GAEG;AACH,MAAa,wBAAwB;IAWnC,YAAmB,OAAyC,EAAE,WAAwB;QANrE,gBAAW,GAAqC,IAAI,OAAO,EAA2B,CAAC;QACvF,qBAAgB,GAAqC,IAAI,OAAO,EAG9E,CAAC;QAGF,IAAI,CAAC,QAAQ,GAAG,wBAAwB,CAAC,qCAAqC,CAAC,OAAO,CAAC,CAAC;QACxF,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC,QAAQ,CAAC;QAC5E,IAAI;YACF,IAAI,CAAC,YAAY,GAAG,IAAA,qBAAY,EAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACjD;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SAChE;IACH,CAAC;IAEM,MAAM,CAAC,qCAAqC,CACjD,OAAyC,EACzC,cAAiC,OAAO,CAAC,GAAG;QAE5C,MAAM,YAAY,qBAA0C,OAAO,CAAE,CAAC;QACtE,MAAM,2BAA2B,GAAgB,IAAI,GAAG,EAAU,CAAC;QAEnE,IAAI,YAAY,CAAC,2BAA2B,EAAE;YAC5C,MAAM,QAAQ,GAAuB,WAAW,CAAC,YAAY,CAAC,2BAA2B,CAAC,CAAC;YAC3F,IAAI,QAAQ,KAAK,SAAS,EAAE;gBAC1B,YAAY,CAAC,QAAQ,GAAG,QAAQ,CAAC;aAClC;iBAAM;gBACL,2BAA2B,CAAC,GAAG,CAAC,YAAY,CAAC,2BAA2B,CAAC,CAAC;aAC3E;YACD,YAAY,CAAC,2BAA2B,GAAG,SAAS,CAAC;SACtD;QAED,IAAI,2BAA2B,CAAC,IAAI,EAAE;YACpC,MAAM,IAAI,KAAK,CACb,8EACE,2BAA2B,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAC/C,KAAK,KAAK,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,IAAI,CAC/C,IAAI,CACL,yEAAyE,CAC3E,CAAC;SACH;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAEM,KAAK,CAAC,YAAY;QACvB,IAAI;YACF,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;YAClC,4CAA4C;YAC5C,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;SAChC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SACpE;IACH,CAAC;IAEM,KAAK,CAAC,eAAe;QAC1B,IAAI;YACF,MAAM,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;SACtC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SACvE;IACH,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,OAAwB;QACpD,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QACrC,MAAM,OAAO,GAAW,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,MAAM,GAAY,KAAK,CAAC;QAC5B,IAAI;YACF,MAAM,UAAU,GAAW,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACjE,MAAM,GAAG,UAAU,KAAK,CAAC,CAAC;YAC1B,QAAQ,CAAC,cAAc,CAAC,qBAAqB,OAAO,KAAK,UAAU,gBAAgB,CAAC,CAAC;YACrF,IAAI,MAAM,EAAE;gBACV,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;aACpC;SACF;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,8BAA8B,OAAO,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SACxE;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,OAAwB;QAClD,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QACrC,MAAM,OAAO,GAAW,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI;YACF,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;SAC7C;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,4BAA4B,OAAO,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SACtE;QACD,QAAQ,CAAC,cAAc,CAAC,oBAAoB,OAAO,EAAE,CAAC,CAAC;IACzD,CAAC;IAEM,KAAK,CAAC,sBAAsB,CACjC,OAAwB,EACxB,KAA6B;QAE7B,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QACrC,MAAM,GAAG,GAAW,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QACvD,MAAM,KAAK,GAAW,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;QAC3D,IAAI;YACF,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SACzC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,qCAAqC,GAAG,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SAC3E;QACD,QAAQ,CAAC,cAAc,CAAC,2BAA2B,GAAG,KAAK,KAAK,EAAE,CAAC,CAAC;IACtE,CAAC;IAEM,KAAK,CAAC,sBAAsB,CAAC,OAAwB;QAC1D,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QACrC,MAAM,GAAG,GAAW,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,KAAyC,CAAC;QAC9C,IAAI;YACF,MAAM,KAAK,GAAkB,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC9D,IAAI,KAAK,EAAE;gBACT,KAAK,GAAG,IAAI,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;aAChD;YACD,QAAQ,CAAC,cAAc,CAAC,2BAA2B,GAAG,KAAK,KAAK,EAAE,CAAC,CAAC;SACrE;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,qCAAqC,GAAG,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SAC3E;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,UAAU,CAAC,OAAwB;QACxC,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAChD,IAAI,OAAO,GAAuB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAChE,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,GAAG,CAAC,SAAS,EAAE,IAAI,OAAO,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACrF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;SACxC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;OAGG;IACI,oBAAoB,CAAC,OAAwB;QAClD,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAChD,IAAI,YAAY,GAAuB,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC1E,IAAI,CAAC,YAAY,EAAE;YACjB,YAAY,GAAG,CAAC,SAAS,EAAE,IAAI,OAAO,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAC/F,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;SAClD;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAEO,wBAAwB,CAAC,KAA6B;QAC5D,8BAA8B;QAC9B,8BAA8B;QAC9B,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,yBAAyB,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;IACvE,CAAC;IAEO,0BAA0B,CAAC,KAAa;QAC9C,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;QACjE,OAAO,EAAE,MAAM,EAAE,MAA0C,EAAE,OAAO,EAAE,CAAC;IACzE,CAAC;CACF;AArKD,4DAqKC","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 { createClient } from '@redis/client';\n\nimport type {\n  ICobuildLockProvider,\n  ICobuildContext,\n  ICobuildCompletedState,\n  RushSession\n} from '@rushstack/rush-sdk';\nimport type {\n  RedisClientOptions,\n  RedisClientType,\n  RedisFunctions,\n  RedisModules,\n  RedisScripts\n} from '@redis/client';\nimport type { ITerminal } from '@rushstack/node-core-library';\n\n/**\n * The redis client options\n * @beta\n */\nexport interface IRedisCobuildLockProviderOptions extends RedisClientOptions {\n  /**\n   * The environment variable name for the redis password\n   */\n  passwordEnvironmentVariable?: string;\n}\n\nconst KEY_SEPARATOR: ':' = ':';\nconst COMPLETED_STATE_SEPARATOR: ';' = ';';\n\n/**\n * @beta\n */\nexport class RedisCobuildLockProvider implements ICobuildLockProvider {\n  private readonly _options: IRedisCobuildLockProviderOptions;\n  private readonly _terminal: ITerminal;\n\n  private readonly _redisClient: RedisClientType<RedisModules, RedisFunctions, RedisScripts>;\n  private readonly _lockKeyMap: WeakMap<ICobuildContext, string> = new WeakMap<ICobuildContext, string>();\n  private readonly _completedKeyMap: WeakMap<ICobuildContext, string> = new WeakMap<\n    ICobuildContext,\n    string\n  >();\n\n  public constructor(options: IRedisCobuildLockProviderOptions, rushSession: RushSession) {\n    this._options = RedisCobuildLockProvider.expandOptionsWithEnvironmentVariables(options);\n    this._terminal = rushSession.getLogger('RedisCobuildLockProvider').terminal;\n    try {\n      this._redisClient = createClient(this._options);\n    } catch (e) {\n      throw new Error(`Failed to create redis client: ${e.message}`);\n    }\n  }\n\n  public static expandOptionsWithEnvironmentVariables(\n    options: IRedisCobuildLockProviderOptions,\n    environment: NodeJS.ProcessEnv = process.env\n  ): IRedisCobuildLockProviderOptions {\n    const finalOptions: IRedisCobuildLockProviderOptions = { ...options };\n    const missingEnvironmentVariables: Set<string> = new Set<string>();\n\n    if (finalOptions.passwordEnvironmentVariable) {\n      const password: string | undefined = environment[finalOptions.passwordEnvironmentVariable];\n      if (password !== undefined) {\n        finalOptions.password = password;\n      } else {\n        missingEnvironmentVariables.add(finalOptions.passwordEnvironmentVariable);\n      }\n      finalOptions.passwordEnvironmentVariable = undefined;\n    }\n\n    if (missingEnvironmentVariables.size) {\n      throw new Error(\n        `The \"RedisCobuildLockProvider\" tries to access missing environment variable${\n          missingEnvironmentVariables.size > 1 ? 's' : ''\n        }: ${Array.from(missingEnvironmentVariables).join(\n          ', '\n        )}\\nPlease check the configuration in rush-redis-cobuild-plugin.json file`\n      );\n    }\n    return finalOptions;\n  }\n\n  public async connectAsync(): Promise<void> {\n    try {\n      await this._redisClient.connect();\n      // Check the connection works at early stage\n      await this._redisClient.ping();\n    } catch (e) {\n      throw new Error(`Failed to connect to redis server: ${e.message}`);\n    }\n  }\n\n  public async disconnectAsync(): Promise<void> {\n    try {\n      await this._redisClient.disconnect();\n    } catch (e) {\n      throw new Error(`Failed to disconnect to redis server: ${e.message}`);\n    }\n  }\n\n  public async acquireLockAsync(context: ICobuildContext): Promise<boolean> {\n    const { _terminal: terminal } = this;\n    const lockKey: string = this.getLockKey(context);\n    let result: boolean = false;\n    try {\n      const incrResult: number = await this._redisClient.incr(lockKey);\n      result = incrResult === 1;\n      terminal.writeDebugLine(`Acquired lock for ${lockKey}: ${incrResult}, 1 is success`);\n      if (result) {\n        await this.renewLockAsync(context);\n      }\n    } catch (e) {\n      throw new Error(`Failed to acquire lock for ${lockKey}: ${e.message}`);\n    }\n    return result;\n  }\n\n  public async renewLockAsync(context: ICobuildContext): Promise<void> {\n    const { _terminal: terminal } = this;\n    const lockKey: string = this.getLockKey(context);\n    try {\n      await this._redisClient.expire(lockKey, 30);\n    } catch (e) {\n      throw new Error(`Failed to renew lock for ${lockKey}: ${e.message}`);\n    }\n    terminal.writeDebugLine(`Renewed lock for ${lockKey}`);\n  }\n\n  public async setCompletedStateAsync(\n    context: ICobuildContext,\n    state: ICobuildCompletedState\n  ): Promise<void> {\n    const { _terminal: terminal } = this;\n    const key: string = this.getCompletedStateKey(context);\n    const value: string = this._serializeCompletedState(state);\n    try {\n      await this._redisClient.set(key, value);\n    } catch (e) {\n      throw new Error(`Failed to set completed state for ${key}: ${e.message}`);\n    }\n    terminal.writeDebugLine(`Set completed state for ${key}: ${value}`);\n  }\n\n  public async getCompletedStateAsync(context: ICobuildContext): Promise<ICobuildCompletedState | undefined> {\n    const { _terminal: terminal } = this;\n    const key: string = this.getCompletedStateKey(context);\n    let state: ICobuildCompletedState | undefined;\n    try {\n      const value: string | null = await this._redisClient.get(key);\n      if (value) {\n        state = this._deserializeCompletedState(value);\n      }\n      terminal.writeDebugLine(`Get completed state for ${key}: ${value}`);\n    } catch (e) {\n      throw new Error(`Failed to get completed state for ${key}: ${e.message}`);\n    }\n    return state;\n  }\n\n  /**\n   * Returns the lock key for the given context\n   * Example: cobuild:v1:<contextId>:<cacheId>:lock\n   */\n  public getLockKey(context: ICobuildContext): string {\n    const { version, contextId, cacheId } = context;\n    let lockKey: string | undefined = this._lockKeyMap.get(context);\n    if (!lockKey) {\n      lockKey = ['cobuild', `v${version}`, contextId, cacheId, 'lock'].join(KEY_SEPARATOR);\n      this._lockKeyMap.set(context, lockKey);\n    }\n    return lockKey;\n  }\n\n  /**\n   * Returns the completed key for the given context\n   * Example: cobuild:v1:<contextId>:<cacheId>:completed\n   */\n  public getCompletedStateKey(context: ICobuildContext): string {\n    const { version, contextId, cacheId } = context;\n    let completedKey: string | undefined = this._completedKeyMap.get(context);\n    if (!completedKey) {\n      completedKey = ['cobuild', `v${version}`, contextId, cacheId, 'completed'].join(KEY_SEPARATOR);\n      this._completedKeyMap.set(context, completedKey);\n    }\n    return completedKey;\n  }\n\n  private _serializeCompletedState(state: ICobuildCompletedState): string {\n    // Example: SUCCESS;1234567890\n    // Example: FAILURE;1234567890\n    return `${state.status}${COMPLETED_STATE_SEPARATOR}${state.cacheId}`;\n  }\n\n  private _deserializeCompletedState(state: string): ICobuildCompletedState | undefined {\n    const [status, cacheId] = state.split(COMPLETED_STATE_SEPARATOR);\n    return { status: status as ICobuildCompletedState['status'], cacheId };\n  }\n}\n"]}
+{"version":3,"file":"RedisCobuildLockProvider.js","sourceRoot":"","sources":["../src/RedisCobuildLockProvider.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,0CAA6C;AA4B7C,MAAM,yBAAyB,GAAQ,GAAG,CAAC;AAE3C;;GAEG;AACH,MAAa,wBAAwB;IAcnC,YAAmB,OAAyC,EAAE,WAAwB;QAXrE,0BAAqB,GAAqC,IAAI,OAAO,EAGnF,CAAC;QACa,oCAA+B,GAAqC,IAAI,OAAO,EAG7F,CAAC;QAKF,IAAI,CAAC,QAAQ,GAAG,wBAAwB,CAAC,qCAAqC,CAAC,OAAO,CAAC,CAAC;QACxF,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC,QAAQ,CAAC;QAC5E,IAAI;YACF,IAAI,CAAC,YAAY,GAAG,IAAA,qBAAY,EAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACjD;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SAChE;IACH,CAAC;IAEM,MAAM,CAAC,qCAAqC,CACjD,OAAyC,EACzC,cAAiC,OAAO,CAAC,GAAG;QAE5C,MAAM,YAAY,qBAA0C,OAAO,CAAE,CAAC;QACtE,MAAM,2BAA2B,GAAgB,IAAI,GAAG,EAAU,CAAC;QAEnE,IAAI,YAAY,CAAC,2BAA2B,EAAE;YAC5C,MAAM,QAAQ,GAAuB,WAAW,CAAC,YAAY,CAAC,2BAA2B,CAAC,CAAC;YAC3F,IAAI,QAAQ,KAAK,SAAS,EAAE;gBAC1B,YAAY,CAAC,QAAQ,GAAG,QAAQ,CAAC;aAClC;iBAAM;gBACL,2BAA2B,CAAC,GAAG,CAAC,YAAY,CAAC,2BAA2B,CAAC,CAAC;aAC3E;YACD,YAAY,CAAC,2BAA2B,GAAG,SAAS,CAAC;SACtD;QAED,IAAI,2BAA2B,CAAC,IAAI,EAAE;YACpC,MAAM,IAAI,KAAK,CACb,8EACE,2BAA2B,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAC/C,KAAK,KAAK,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,IAAI,CAC/C,IAAI,CACL,yEAAyE,CAC3E,CAAC;SACH;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAEM,KAAK,CAAC,YAAY;QACvB,IAAI;YACF,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;YAClC,4CAA4C;YAC5C,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;SAChC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SACpE;IACH,CAAC;IAEM,KAAK,CAAC,eAAe;QAC1B,IAAI;YACF,MAAM,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;SACtC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SACvE;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gBAAgB,CAAC,OAAwB;QACpD,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QACrC,MAAM,EAAE,OAAO,EAAE,uBAAuB,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;QAC/D,IAAI,MAAM,GAAY,KAAK,CAAC;QAC5B,MAAM,iBAAiB,GAAW,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QACtE,IAAI;YACF,iGAAiG;YACjG,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE;gBAC7C,EAAE,EAAE,IAAI;gBACR,mCAAmC;gBACnC,EAAE,EAAE,uBAAuB;gBAC3B,4EAA4E;aAC7E,CAAC,CAAC;YACH,4EAA4E;YAC5E,MAAM,KAAK,GAAkB,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAClE,IAAI,KAAK,KAAK,IAAI,EAAE;gBAClB,0BAA0B;gBAC1B,MAAM,IAAI,KAAK,CAAC,yBAAyB,OAAO,EAAE,CAAC,CAAC;aACrD;YACD,MAAM,GAAG,KAAK,KAAK,QAAQ,CAAC;YAC5B,IAAI,MAAM,EAAE;gBACV,QAAQ,CAAC,cAAc,CACrB,yBAAyB,iBAAiB,cAAc,QAAQ,uBAAuB,uBAAuB,GAAG,CAClH,CAAC;aACH;iBAAM;gBACL,QAAQ,CAAC,cAAc,CAAC,qBAAqB,iBAAiB,sBAAsB,KAAK,EAAE,CAAC,CAAC;aAC9F;SACF;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,+BAA+B,iBAAiB,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SACnF;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,OAAwB;QAClD,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QACrC,MAAM,EAAE,OAAO,EAAE,uBAAuB,EAAE,GAAG,OAAO,CAAC;QACrD,MAAM,iBAAiB,GAAW,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QACtE,IAAI;YACF,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC;SAClE;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,mBAAmB,iBAAiB,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SACvE;QACD,QAAQ,CAAC,cAAc,CAAC,WAAW,iBAAiB,eAAe,uBAAuB,UAAU,CAAC,CAAC;IACxG,CAAC;IAEM,KAAK,CAAC,sBAAsB,CACjC,OAAwB,EACxB,KAA6B;QAE7B,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QACrC,MAAM,EAAE,iBAAiB,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;QAC3C,MAAM,KAAK,GAAW,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;QAC3D,MAAM,2BAA2B,GAAW,IAAI,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;QAC1F,IAAI;YACF,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SACzC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,iBAAiB,2BAA2B,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SAC/E;QACD,QAAQ,CAAC,cAAc,CAAC,OAAO,2BAA2B,KAAK,KAAK,EAAE,CAAC,CAAC;IAC1E,CAAC;IAEM,KAAK,CAAC,sBAAsB,CAAC,OAAwB;QAC1D,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QACrC,MAAM,EAAE,iBAAiB,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;QAC3C,MAAM,2BAA2B,GAAW,IAAI,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;QAC1F,IAAI,KAAyC,CAAC;QAC9C,IAAI;YACF,MAAM,KAAK,GAAkB,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC9D,IAAI,KAAK,EAAE;gBACT,KAAK,GAAG,IAAI,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;aAChD;YACD,QAAQ,CAAC,cAAc,CAAC,OAAO,2BAA2B,KAAK,KAAK,EAAE,CAAC,CAAC;SACzE;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,iBAAiB,2BAA2B,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SAC/E;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,wBAAwB,CAAC,KAA6B;QAC5D,8BAA8B;QAC9B,8BAA8B;QAC9B,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;QAClC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IAC3D,CAAC;IAEO,0BAA0B,CAAC,KAAa;QAC9C,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;QACjE,OAAO,EAAE,MAAM,EAAE,MAA0C,EAAE,OAAO,EAAE,CAAC;IACzE,CAAC;IAEO,qBAAqB,CAAC,OAAwB;QACpD,IAAI,iBAAiB,GAAuB,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACpF,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACnC,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;YACpD,iBAAiB,GAAG,QAAQ,OAAO,aAAa,WAAW,WAAW,SAAS,GAAG,CAAC;YACnF,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;SAC5D;QACD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAEO,+BAA+B,CAAC,OAAwB;QAC9D,IAAI,2BAA2B,GAAuB,IAAI,CAAC,+BAA+B,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACxG,IAAI,2BAA2B,KAAK,SAAS,EAAE;YAC7C,MAAM,EAAE,iBAAiB,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;YAC9D,2BAA2B,GAAG,mBAAmB,iBAAiB,aAAa,WAAW,WAAW,SAAS,GAAG,CAAC;YAClH,IAAI,CAAC,+BAA+B,CAAC,GAAG,CAAC,OAAO,EAAE,2BAA2B,CAAC,CAAC;SAChF;QACD,OAAO,2BAA2B,CAAC;IACrC,CAAC;CACF;AAzLD,4DAyLC","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 { createClient } from '@redis/client';\n\nimport {\n  ICobuildLockProvider,\n  ICobuildContext,\n  ICobuildCompletedState,\n  RushSession\n} from '@rushstack/rush-sdk';\nimport type {\n  RedisClientOptions,\n  RedisClientType,\n  RedisFunctions,\n  RedisModules,\n  RedisScripts\n} from '@redis/client';\nimport type { ITerminal } from '@rushstack/node-core-library';\n\n/**\n * The redis client options\n * @beta\n */\nexport interface IRedisCobuildLockProviderOptions extends RedisClientOptions {\n  /**\n   * The environment variable name for the redis password\n   */\n  passwordEnvironmentVariable?: string;\n}\n\nconst COMPLETED_STATE_SEPARATOR: ';' = ';';\n\n/**\n * @beta\n */\nexport class RedisCobuildLockProvider implements ICobuildLockProvider {\n  private readonly _options: IRedisCobuildLockProviderOptions;\n  private readonly _terminal: ITerminal;\n  private readonly _lockKeyIdentifierMap: WeakMap<ICobuildContext, string> = new WeakMap<\n    ICobuildContext,\n    string\n  >();\n  private readonly _completedStateKeyIdentifierMap: WeakMap<ICobuildContext, string> = new WeakMap<\n    ICobuildContext,\n    string\n  >();\n\n  private readonly _redisClient: RedisClientType<RedisModules, RedisFunctions, RedisScripts>;\n\n  public constructor(options: IRedisCobuildLockProviderOptions, rushSession: RushSession) {\n    this._options = RedisCobuildLockProvider.expandOptionsWithEnvironmentVariables(options);\n    this._terminal = rushSession.getLogger('RedisCobuildLockProvider').terminal;\n    try {\n      this._redisClient = createClient(this._options);\n    } catch (e) {\n      throw new Error(`Failed to create redis client: ${e.message}`);\n    }\n  }\n\n  public static expandOptionsWithEnvironmentVariables(\n    options: IRedisCobuildLockProviderOptions,\n    environment: NodeJS.ProcessEnv = process.env\n  ): IRedisCobuildLockProviderOptions {\n    const finalOptions: IRedisCobuildLockProviderOptions = { ...options };\n    const missingEnvironmentVariables: Set<string> = new Set<string>();\n\n    if (finalOptions.passwordEnvironmentVariable) {\n      const password: string | undefined = environment[finalOptions.passwordEnvironmentVariable];\n      if (password !== undefined) {\n        finalOptions.password = password;\n      } else {\n        missingEnvironmentVariables.add(finalOptions.passwordEnvironmentVariable);\n      }\n      finalOptions.passwordEnvironmentVariable = undefined;\n    }\n\n    if (missingEnvironmentVariables.size) {\n      throw new Error(\n        `The \"RedisCobuildLockProvider\" tries to access missing environment variable${\n          missingEnvironmentVariables.size > 1 ? 's' : ''\n        }: ${Array.from(missingEnvironmentVariables).join(\n          ', '\n        )}\\nPlease check the configuration in rush-redis-cobuild-plugin.json file`\n      );\n    }\n    return finalOptions;\n  }\n\n  public async connectAsync(): Promise<void> {\n    try {\n      await this._redisClient.connect();\n      // Check the connection works at early stage\n      await this._redisClient.ping();\n    } catch (e) {\n      throw new Error(`Failed to connect to redis server: ${e.message}`);\n    }\n  }\n\n  public async disconnectAsync(): Promise<void> {\n    try {\n      await this._redisClient.disconnect();\n    } catch (e) {\n      throw new Error(`Failed to disconnect to redis server: ${e.message}`);\n    }\n  }\n\n  /**\n   * Acquiring the lock based on the specific context.\n   *\n   * NOTE: this is a reentrant lock implementation\n   */\n  public async acquireLockAsync(context: ICobuildContext): Promise<boolean> {\n    const { _terminal: terminal } = this;\n    const { lockKey, lockExpireTimeInSeconds, runnerId } = context;\n    let result: boolean = false;\n    const lockKeyIdentifier: string = this._getLockKeyIdentifier(context);\n    try {\n      // According to the doc, the reply of set command is either \"OK\" or nil. The reply doesn't matter\n      await this._redisClient.set(lockKey, runnerId, {\n        NX: true,\n        // call EXPIRE in an atomic command\n        EX: lockExpireTimeInSeconds\n        // Do not specify GET here since using NX ane GET together requires Redis@7.\n      });\n      // Just read the value by lock key to see wether it equals current runner id\n      const value: string | null = await this._redisClient.get(lockKey);\n      if (value === null) {\n        // This should not happen.\n        throw new Error(`Get redis key failed: ${lockKey}`);\n      }\n      result = value === runnerId;\n      if (result) {\n        terminal.writeDebugLine(\n          `Successfully acquired ${lockKeyIdentifier} to runner(${runnerId}) and it expires in ${lockExpireTimeInSeconds}s`\n        );\n      } else {\n        terminal.writeDebugLine(`Failed to acquire ${lockKeyIdentifier}, locked by runner ${value}`);\n      }\n    } catch (e) {\n      throw new Error(`Error occurs when acquiring ${lockKeyIdentifier}: ${e.message}`);\n    }\n    return result;\n  }\n\n  public async renewLockAsync(context: ICobuildContext): Promise<void> {\n    const { _terminal: terminal } = this;\n    const { lockKey, lockExpireTimeInSeconds } = context;\n    const lockKeyIdentifier: string = this._getLockKeyIdentifier(context);\n    try {\n      await this._redisClient.expire(lockKey, lockExpireTimeInSeconds);\n    } catch (e) {\n      throw new Error(`Failed to renew ${lockKeyIdentifier}: ${e.message}`);\n    }\n    terminal.writeDebugLine(`Renewed ${lockKeyIdentifier} expires in ${lockExpireTimeInSeconds} seconds`);\n  }\n\n  public async setCompletedStateAsync(\n    context: ICobuildContext,\n    state: ICobuildCompletedState\n  ): Promise<void> {\n    const { _terminal: terminal } = this;\n    const { completedStateKey: key } = context;\n    const value: string = this._serializeCompletedState(state);\n    const completedStateKeyIdentifier: string = this._getCompletedStateKeyIdentifier(context);\n    try {\n      await this._redisClient.set(key, value);\n    } catch (e) {\n      throw new Error(`Failed to set ${completedStateKeyIdentifier}: ${e.message}`);\n    }\n    terminal.writeDebugLine(`Set ${completedStateKeyIdentifier}: ${value}`);\n  }\n\n  public async getCompletedStateAsync(context: ICobuildContext): Promise<ICobuildCompletedState | undefined> {\n    const { _terminal: terminal } = this;\n    const { completedStateKey: key } = context;\n    const completedStateKeyIdentifier: string = this._getCompletedStateKeyIdentifier(context);\n    let state: ICobuildCompletedState | undefined;\n    try {\n      const value: string | null = await this._redisClient.get(key);\n      if (value) {\n        state = this._deserializeCompletedState(value);\n      }\n      terminal.writeDebugLine(`Get ${completedStateKeyIdentifier}: ${value}`);\n    } catch (e) {\n      throw new Error(`Failed to get ${completedStateKeyIdentifier}: ${e.message}`);\n    }\n    return state;\n  }\n\n  private _serializeCompletedState(state: ICobuildCompletedState): string {\n    // Example: SUCCESS;1234567890\n    // Example: FAILURE;1234567890\n    const { status, cacheId } = state;\n    return [status, cacheId].join(COMPLETED_STATE_SEPARATOR);\n  }\n\n  private _deserializeCompletedState(state: string): ICobuildCompletedState | undefined {\n    const [status, cacheId] = state.split(COMPLETED_STATE_SEPARATOR);\n    return { status: status as ICobuildCompletedState['status'], cacheId };\n  }\n\n  private _getLockKeyIdentifier(context: ICobuildContext): string {\n    let lockKeyIdentifier: string | undefined = this._lockKeyIdentifierMap.get(context);\n    if (lockKeyIdentifier === undefined) {\n      const { lockKey, packageName, phaseName } = context;\n      lockKeyIdentifier = `lock(${lockKey})_package(${packageName})_phase(${phaseName})`;\n      this._lockKeyIdentifierMap.set(context, lockKeyIdentifier);\n    }\n    return lockKeyIdentifier;\n  }\n\n  private _getCompletedStateKeyIdentifier(context: ICobuildContext): string {\n    let completedStateKeyIdentifier: string | undefined = this._completedStateKeyIdentifierMap.get(context);\n    if (completedStateKeyIdentifier === undefined) {\n      const { completedStateKey, packageName, phaseName } = context;\n      completedStateKeyIdentifier = `completed_state(${completedStateKey})_package(${packageName})_phase(${phaseName})`;\n      this._completedStateKeyIdentifierMap.set(context, completedStateKeyIdentifier);\n    }\n    return completedStateKeyIdentifier;\n  }\n}\n"]}

package/lib/RushRedisCobuildPlugin.d.ts

@@ -3,7 +3,7 @@ import type { IRedisCobuildLockProviderOptions } from './RedisCobuildLockProvide
 /**
  * @public
  */
-export declare type IRushRedisCobuildPluginOptions = IRedisCobuildLockProviderOptions;
+export type IRushRedisCobuildPluginOptions = IRedisCobuildLockProviderOptions;
 /**
  * @public
  */

package/lib/RushRedisCobuildPlugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RushRedisCobuildPlugin.d.ts","sourceRoot":"","sources":["../src/RushRedisCobuildPlugin.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACvF,OAAO,KAAK,EAAE,gCAAgC,EAA4B,MAAM,4BAA4B,CAAC;AAS7G;;GAEG;AACH,oBAAY,8BAA8B,GAAG,gCAAgC,CAAC;AAE9E;;GAEG;AACH,qBAAa,sBAAuB,YAAW,WAAW;IACjD,UAAU,EAAE,MAAM,CAAe;IAExC,OAAO,CAAC,QAAQ,CAAiC;gBAE9B,OAAO,EAAE,8BAA8B;IAInD,KAAK,CAAC,WAAW,EAAE,WAAW,EAAE,iBAAiB,EAAE,iBAAiB,GAAG,IAAI;CAQnF"}
+{"version":3,"file":"RushRedisCobuildPlugin.d.ts","sourceRoot":"","sources":["../src/RushRedisCobuildPlugin.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACvF,OAAO,KAAK,EAAE,gCAAgC,EAA4B,MAAM,4BAA4B,CAAC;AAS7G;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,gCAAgC,CAAC;AAE9E;;GAEG;AACH,qBAAa,sBAAuB,YAAW,WAAW;IACjD,UAAU,EAAE,MAAM,CAAe;IAExC,OAAO,CAAC,QAAQ,CAAiC;gBAE9B,OAAO,EAAE,8BAA8B;IAInD,KAAK,CAAC,WAAW,EAAE,WAAW,EAAE,iBAAiB,EAAE,iBAAiB,GAAG,IAAI;CAQnF"}

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.34.4"
+      "packageVersion": "7.36.4"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-redis-cobuild-plugin",
-  "version": "5.97.1-pr3949.2",
+  "version": "5.101.0-pr3949.3",
   "description": "Rush plugin for Redis cobuild lock",
   "repository": {
     "type": "git",
@@ -13,22 +13,22 @@
   "license": "MIT",
   "dependencies": {
     "@redis/client": "~1.5.5",
-    "@rushstack/node-core-library": "3.55.2",
-    "@rushstack/rush-sdk": "5.97.1-pr3949.2"
+    "@rushstack/node-core-library": "3.59.7",
+    "@rushstack/rush-sdk": "5.101.0-pr3949.3"
   },
   "devDependencies": {
     "@types/heft-jest": "1.0.1",
     "@types/node": "14.18.36",
-    "@microsoft/rush-lib": "5.97.1-pr3949.2",
-    "@rushstack/eslint-config": "3.2.0",
-    "@rushstack/heft": "0.50.0",
-    "@rushstack/heft-node-rig": "1.12.6"
+    "@microsoft/rush-lib": "5.101.0-pr3949.3",
+    "@rushstack/eslint-config": "3.3.3",
+    "@rushstack/heft": "0.58.2",
+    "@rushstack/heft-node-rig": "2.2.22"
   },
   "scripts": {
     "build": "heft build --clean",
-    "start": "heft test --clean --watch",
-    "test": "heft test",
-    "_phase:build": "heft build --clean",
-    "_phase:test": "heft test --no-build"
+    "start": "heft test-watch",
+    "test": "heft test --clean",
+    "_phase:build": "heft run --only build -- --clean",
+    "_phase:test": "heft run --only test -- --clean"
   }
 }