@rushstack/rush-redis-cobuild-plugin 5.167.0 → 5.169.0

package/{lib → lib-dts}/tsdoc-metadata.json

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

package/lib-esm/RedisCobuildLockProvider.js

@@ -0,0 +1,182 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { createClient } from '@redis/client';
+const COMPLETED_STATE_SEPARATOR = ';';
+/**
+ * @beta
+ */
+export class RedisCobuildLockProvider {
+    constructor(options, rushSession) {
+        this._lockKeyIdentifierMap = new WeakMap();
+        this._completedStateKeyIdentifierMap = new WeakMap();
+        this._options = RedisCobuildLockProvider.expandOptionsWithEnvironmentVariables(options);
+        // Provide a default reconnect strategy that prevents more than 5 reconnect attempts.
+        this._options.socket = {
+            reconnectStrategy: (count) => {
+                this._terminal.writeErrorLine(`Redis client reconnecting attempt #${count}`);
+                return count < 5 ? count * 1000 : false;
+            },
+            ...this._options.socket
+        };
+        this._terminal = rushSession.getLogger('RedisCobuildLockProvider').terminal;
+        try {
+            this._redisClient = createClient(this._options);
+        }
+        catch (e) {
+            throw new Error(`Failed to create redis client: ${e.message}`);
+        }
+    }
+    static expandOptionsWithEnvironmentVariables(options, environment = process.env) {
+        const finalOptions = { ...options };
+        const missingEnvironmentVariables = new Set();
+        if (finalOptions.passwordEnvironmentVariable) {
+            const password = environment[finalOptions.passwordEnvironmentVariable];
+            if (password !== undefined) {
+                finalOptions.password = password;
+            }
+            else {
+                missingEnvironmentVariables.add(finalOptions.passwordEnvironmentVariable);
+            }
+            finalOptions.passwordEnvironmentVariable = undefined;
+        }
+        if (missingEnvironmentVariables.size) {
+            throw new Error(`The "RedisCobuildLockProvider" tries to access missing environment variable${missingEnvironmentVariables.size > 1 ? 's' : ''}: ${Array.from(missingEnvironmentVariables).join(', ')}\nPlease check the configuration in rush-redis-cobuild-plugin.json file`);
+        }
+        return finalOptions;
+    }
+    async connectAsync() {
+        try {
+            await this._redisClient.connect();
+            // Check the connection works at early stage
+            await this._redisClient.ping();
+        }
+        catch (e) {
+            throw new Error(`Failed to connect to redis server: ${e.message}`);
+        }
+        // Register error event handler to avoid process exit when redis client error occurs.
+        this._redisClient.on('error', (e) => {
+            if (e.message) {
+                this._terminal.writeErrorLine(`Redis client error: ${e.message}`);
+            }
+            else {
+                this._terminal.writeErrorLine(`Redis client error: ${e}`);
+            }
+        });
+    }
+    async disconnectAsync() {
+        try {
+            await this._redisClient.destroy();
+        }
+        catch (e) {
+            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, lockExpireTimeInSeconds, runnerId } = context;
+        let result = false;
+        const lockKeyIdentifier = this._getLockKeyIdentifier(context);
+        try {
+            // 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) {
+                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(`Error occurs when acquiring ${lockKeyIdentifier}: ${e.message}`);
+        }
+        return result;
+    }
+    async renewLockAsync(context) {
+        const { _terminal: terminal } = this;
+        const { lockKey, lockExpireTimeInSeconds } = context;
+        const lockKeyIdentifier = this._getLockKeyIdentifier(context);
+        try {
+            await this._redisClient.expire(lockKey, lockExpireTimeInSeconds);
+        }
+        catch (e) {
+            throw new Error(`Failed to renew ${lockKeyIdentifier}: ${e.message}`);
+        }
+        terminal.writeDebugLine(`Renewed ${lockKeyIdentifier} expires in ${lockExpireTimeInSeconds} seconds`);
+    }
+    async setCompletedStateAsync(context, state) {
+        const { _terminal: terminal } = this;
+        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 ${completedStateKeyIdentifier}: ${e.message}`);
+        }
+        terminal.writeDebugLine(`Set ${completedStateKeyIdentifier}: ${value}`);
+    }
+    async getCompletedStateAsync(context) {
+        const { _terminal: terminal } = this;
+        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 ${completedStateKeyIdentifier}: ${value}`);
+        }
+        catch (e) {
+            throw new Error(`Failed to get ${completedStateKeyIdentifier}: ${e.message}`);
+        }
+        return state;
+    }
+    _serializeCompletedState(state) {
+        // Example: SUCCESS;1234567890
+        // Example: FAILURE;1234567890
+        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;
+    }
+}
+//# sourceMappingURL=RedisCobuildLockProvider.js.map

package/lib-esm/RedisCobuildLockProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedisCobuildLockProvider.js","sourceRoot":"","sources":["../src/RedisCobuildLockProvider.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AA4B7C,MAAM,yBAAyB,GAAQ,GAAG,CAAC;AAE3C;;GAEG;AACH,MAAM,OAAO,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,qFAAqF;QACrF,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG;YACrB,iBAAiB,EAAE,CAAC,KAAa,EAAE,EAAE;gBACnC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,sCAAsC,KAAK,EAAE,CAAC,CAAC;gBAC7E,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;YAC1C,CAAC;YACD,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM;SACxB,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC,QAAQ,CAAC;QAC5E,IAAI,CAAC;YACH,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,qCAAqC,CACjD,OAAyC,EACzC,cAAiC,OAAO,CAAC,GAAG;QAE5C,MAAM,YAAY,GAAqC,EAAE,GAAG,OAAO,EAAE,CAAC;QACtE,MAAM,2BAA2B,GAAgB,IAAI,GAAG,EAAU,CAAC;QAEnE,IAAI,YAAY,CAAC,2BAA2B,EAAE,CAAC;YAC7C,MAAM,QAAQ,GAAuB,WAAW,CAAC,YAAY,CAAC,2BAA2B,CAAC,CAAC;YAC3F,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC3B,YAAY,CAAC,QAAQ,GAAG,QAAQ,CAAC;YACnC,CAAC;iBAAM,CAAC;gBACN,2BAA2B,CAAC,GAAG,CAAC,YAAY,CAAC,2BAA2B,CAAC,CAAC;YAC5E,CAAC;YACD,YAAY,CAAC,2BAA2B,GAAG,SAAS,CAAC;QACvD,CAAC;QAED,IAAI,2BAA2B,CAAC,IAAI,EAAE,CAAC;YACrC,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;QACJ,CAAC;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAEM,KAAK,CAAC,YAAY;QACvB,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;YAClC,4CAA4C;YAC5C,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;QACjC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACrE,CAAC;QAED,qFAAqF;QACrF,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAQ,EAAE,EAAE;YACzC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;gBACd,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,uBAAuB,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;YACpE,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,eAAe;QAC1B,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;QACpC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACxE,CAAC;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,CAAC;YACH,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,CAAC;gBACnB,0BAA0B;gBAC1B,MAAM,IAAI,KAAK,CAAC,yBAAyB,OAAO,EAAE,CAAC,CAAC;YACtD,CAAC;YACD,MAAM,GAAG,KAAK,KAAK,QAAQ,CAAC;YAC5B,IAAI,MAAM,EAAE,CAAC;gBACX,QAAQ,CAAC,cAAc,CACrB,yBAAyB,iBAAiB,cAAc,QAAQ,uBAAuB,uBAAuB,GAAG,CAClH,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,cAAc,CAAC,qBAAqB,iBAAiB,sBAAsB,KAAK,EAAE,CAAC,CAAC;YAC/F,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,+BAA+B,iBAAiB,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACpF,CAAC;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,CAAC;YACH,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC;QACnE,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,mBAAmB,iBAAiB,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACxE,CAAC;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,CAAC;YACH,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC1C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,iBAAiB,2BAA2B,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAChF,CAAC;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,CAAC;YACH,MAAM,KAAK,GAAkB,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC9D,IAAI,KAAK,EAAE,CAAC;gBACV,KAAK,GAAG,IAAI,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;YACjD,CAAC;YACD,QAAQ,CAAC,cAAc,CAAC,OAAO,2BAA2B,KAAK,KAAK,EAAE,CAAC,CAAC;QAC1E,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,iBAAiB,2BAA2B,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAChF,CAAC;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,CAAC;YACpC,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;QAC7D,CAAC;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,CAAC;YAC9C,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;QACjF,CAAC;QACD,OAAO,2BAA2B,CAAC;IACrC,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 { createClient } from '@redis/client';\nimport type {\n  RedisClientOptions,\n  RedisClientType,\n  RedisFunctions,\n  RedisModules,\n  RedisScripts\n} from '@redis/client';\n\nimport type {\n  ICobuildLockProvider,\n  ICobuildContext,\n  ICobuildCompletedState,\n  RushSession\n} from '@rushstack/rush-sdk';\nimport type { ITerminal } from '@rushstack/terminal';\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, 2 | 3>;\n\n  public constructor(options: IRedisCobuildLockProviderOptions, rushSession: RushSession) {\n    this._options = RedisCobuildLockProvider.expandOptionsWithEnvironmentVariables(options);\n    // Provide a default reconnect strategy that prevents more than 5 reconnect attempts.\n    this._options.socket = {\n      reconnectStrategy: (count: number) => {\n        this._terminal.writeErrorLine(`Redis client reconnecting attempt #${count}`);\n        return count < 5 ? count * 1000 : false;\n      },\n      ...this._options.socket\n    };\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    // Register error event handler to avoid process exit when redis client error occurs.\n    this._redisClient.on('error', (e: Error) => {\n      if (e.message) {\n        this._terminal.writeErrorLine(`Redis client error: ${e.message}`);\n      } else {\n        this._terminal.writeErrorLine(`Redis client error: ${e}`);\n      }\n    });\n  }\n\n  public async disconnectAsync(): Promise<void> {\n    try {\n      await this._redisClient.destroy();\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-esm/RushRedisCobuildPlugin.js

@@ -0,0 +1,23 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { Import } from '@rushstack/node-core-library';
+const RedisCobuildLockProviderModule = Import.lazy('./RedisCobuildLockProvider', require);
+const PLUGIN_NAME = 'RedisCobuildPlugin';
+/**
+ * @public
+ */
+export class RushRedisCobuildPlugin {
+    constructor(options) {
+        this.pluginName = PLUGIN_NAME;
+        this._options = options;
+    }
+    apply(rushSession, rushConfiguration) {
+        rushSession.hooks.initialize.tap(PLUGIN_NAME, () => {
+            rushSession.registerCobuildLockProviderFactory('redis', () => {
+                const options = this._options;
+                return new RedisCobuildLockProviderModule.RedisCobuildLockProvider(options, rushSession);
+            });
+        });
+    }
+}
+//# sourceMappingURL=RushRedisCobuildPlugin.js.map

package/lib-esm/RushRedisCobuildPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RushRedisCobuildPlugin.js","sourceRoot":"","sources":["../src/RushRedisCobuildPlugin.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAKtD,MAAM,8BAA8B,GAAgD,MAAM,CAAC,IAAI,CAC7F,4BAA4B,EAC5B,OAAO,CACR,CAAC;AAEF,MAAM,WAAW,GAAW,oBAAoB,CAAC;AAOjD;;GAEG;AACH,MAAM,OAAO,sBAAsB;IAKjC,YAAmB,OAAuC;QAJnD,eAAU,GAAW,WAAW,CAAC;QAKtC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAEM,KAAK,CAAC,WAAwB,EAAE,iBAAoC;QACzE,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,EAAE;YACjD,WAAW,CAAC,kCAAkC,CAAC,OAAO,EAAE,GAA6B,EAAE;gBACrF,MAAM,OAAO,GAAmC,IAAI,CAAC,QAAQ,CAAC;gBAC9D,OAAO,IAAI,8BAA8B,CAAC,wBAAwB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;YAC3F,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,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 { Import } from '@rushstack/node-core-library';\nimport type { IRushPlugin, RushSession, RushConfiguration } from '@rushstack/rush-sdk';\n\nimport type { IRedisCobuildLockProviderOptions, RedisCobuildLockProvider } from './RedisCobuildLockProvider';\n\nconst RedisCobuildLockProviderModule: typeof import('./RedisCobuildLockProvider') = Import.lazy(\n  './RedisCobuildLockProvider',\n  require\n);\n\nconst PLUGIN_NAME: string = 'RedisCobuildPlugin';\n\n/**\n * @public\n */\nexport type IRushRedisCobuildPluginOptions = IRedisCobuildLockProviderOptions;\n\n/**\n * @public\n */\nexport class RushRedisCobuildPlugin implements IRushPlugin {\n  public pluginName: string = PLUGIN_NAME;\n\n  private _options: IRushRedisCobuildPluginOptions;\n\n  public constructor(options: IRushRedisCobuildPluginOptions) {\n    this._options = options;\n  }\n\n  public apply(rushSession: RushSession, rushConfiguration: RushConfiguration): void {\n    rushSession.hooks.initialize.tap(PLUGIN_NAME, () => {\n      rushSession.registerCobuildLockProviderFactory('redis', (): RedisCobuildLockProvider => {\n        const options: IRushRedisCobuildPluginOptions = this._options;\n        return new RedisCobuildLockProviderModule.RedisCobuildLockProvider(options, rushSession);\n      });\n    });\n  }\n}\n"]}

package/lib-esm/index.js

@@ -0,0 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+/// <reference types="node" preserve="true" />
+export { RushRedisCobuildPlugin as default } from './RushRedisCobuildPlugin';
+export { RedisCobuildLockProvider } from './RedisCobuildLockProvider';
+//# sourceMappingURL=index.js.map

package/lib-esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,8CAA8C;AAE9C,OAAO,EACL,sBAAsB,IAAI,OAAO,EAElC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\n/// <reference types=\"node\" preserve=\"true\" />\n\nexport {\n  RushRedisCobuildPlugin as default,\n  type IRushRedisCobuildPluginOptions\n} from './RushRedisCobuildPlugin';\nexport { RedisCobuildLockProvider } from './RedisCobuildLockProvider';\nexport type { IRedisCobuildLockProviderOptions } from './RedisCobuildLockProvider';\n"]}

package/lib-esm/schemas/redis-config.schema.json

@@ -0,0 +1,70 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Configuration for cobuild lock with Redis configuration\n\nhttps://github.com/redis/node-redis/blob/master/docs/client-configuration.md",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "url": {
+      "type": "string",
+      "description": "redis[s]://[[username][:password]@][host][:port][/db-number]\n\n See the following links for more information:\n\nredis: https://www.iana.org/assignments/uri-schemes/prov/redis\n\nrediss: https://www.iana.org/assignments/uri-schemes/prov/rediss"
+    },
+    "socket": {
+      "type": "object",
+      "description": "Socket connection properties. Unlisted net.connect properties (and tls.connect) are also supported",
+      "properties": {
+        "port": {
+          "description": "Redis server port. Default value is 6379",
+          "type": "number"
+        },
+        "host": {
+          "description": "Redis server host. Default value is localhost",
+          "type": "string"
+        },
+        "family": {
+          "description": "IP Stack version (one of 4 | 6 | 0). Default value is 0",
+          "type": "number"
+        },
+        "path": {
+          "description": "path to the UNIX Socket",
+          "type": "string"
+        },
+        "connectTimeout": {
+          "description": "Connection timeout in milliseconds. Default value is 5000",
+          "type": "number"
+        },
+        "noDelay": {
+          "description": "Toggle Nagle's algorithm. Default value is true",
+          "type": "boolean"
+        },
+        "keepAlive": {
+          "description": "Toggle keep alive on the socket",
+          "type": "boolean"
+        }
+      }
+    },
+    "username": {
+      "description": "ACL username",
+      "type": "string"
+    },
+    "passwordEnvironmentVariable": {
+      "description": "The environment variable used to get the ACL password",
+      "type": "string"
+    },
+    "name": {
+      "description": "Redis client name",
+      "type": "string"
+    },
+    "database": {
+      "description": "Redis database number",
+      "type": "number"
+    },
+    "legacyMode": {
+      "description": "Maintain some backwards compatibility",
+      "type": "boolean"
+    },
+    "pingInterval": {
+      "description": "Send PING command at interval (in ms). Useful with \"Azure Cache for Redis\".",
+      "type": "number"
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-redis-cobuild-plugin",
-  "version": "5.167.0",
+  "version": "5.169.0",
   "description": "Rush plugin for Redis cobuild lock",
   "repository": {
     "type": "git",
@@ -8,21 +8,45 @@
     "directory": "rush-plugins/rush-redis-cobuild-plugin"
   },
   "homepage": "https://rushjs.io",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "main": "./lib-commonjs/index.js",
+  "module": "./lib-esm/index.js",
+  "types": "./lib-dts/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib-dts/index.d.ts",
+      "import": "./lib-esm/index.js",
+      "require": "./lib-commonjs/index.js"
+    },
+    "./lib/*.schema.json": "./lib-commonjs/*.schema.json",
+    "./lib/*": {
+      "types": "./lib-dts/*.d.ts",
+      "import": "./lib-esm/*.js",
+      "require": "./lib-commonjs/*.js"
+    },
+    "./rush-plugin-manifest.json": "./rush-plugin-manifest.json",
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "lib/*": [
+        "lib-dts/*"
+      ]
+    }
+  },
   "license": "MIT",
   "dependencies": {
     "@redis/client": "~5.8.2",
-    "@rushstack/node-core-library": "5.19.1",
-    "@rushstack/rush-sdk": "5.167.0"
+    "@rushstack/node-core-library": "5.20.0",
+    "@rushstack/rush-sdk": "5.169.0"
   },
   "devDependencies": {
     "eslint": "~9.37.0",
-    "@rushstack/heft": "1.1.13",
-    "@rushstack/terminal": "0.21.0",
-    "@microsoft/rush-lib": "5.167.0",
+    "@microsoft/rush-lib": "5.169.0",
+    "@rushstack/heft": "1.2.0",
+    "@rushstack/terminal": "0.22.0",
     "local-node-rig": "1.0.0"
   },
+  "sideEffects": false,
   "scripts": {
     "build": "heft build --clean",
     "start": "heft test-watch",

package/rush-plugin-manifest.json

@@ -4,8 +4,8 @@
     {
       "pluginName": "rush-redis-cobuild-plugin",
       "description": "Rush plugin for Redis cobuild lock",
-      "entryPoint": "lib/index.js",
-      "optionsSchema": "lib/schemas/redis-config.schema.json"
+      "entryPoint": "./lib-commonjs/index.js",
+      "optionsSchema": "./lib-commonjs/schemas/redis-config.schema.json"
     }
   ]
 }