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

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

@@ -0,0 +1,69 @@
+/// <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 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';
+
+/**
+ * The redis client options
+ * @beta
+ */
+export declare interface IRedisCobuildLockProviderOptions extends RedisClientOptions {
+    /**
+     * The environment variable name for the redis password
+     */
+    passwordEnvironmentVariable?: string;
+}
+
+/**
+ * @public
+ */
+declare type IRushRedisCobuildPluginOptions = IRedisCobuildLockProviderOptions;
+
+/**
+ * @beta
+ */
+export declare class RedisCobuildLockProvider implements ICobuildLockProvider {
+    private readonly _options;
+    private readonly _terminal;
+    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>;
+    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;
+}
+
+/**
+ * @public
+ */
+declare class RushRedisCobuildPlugin implements IRushPlugin {
+    pluginName: string;
+    private _options;
+    constructor(options: IRushRedisCobuildPluginOptions);
+    apply(rushSession: RushSession, rushConfiguration: RushConfiguration): void;
+}
+export default RushRedisCobuildPlugin;
+
+export { }

package/lib/RedisCobuildLockProvider.d.ts

@@ -0,0 +1,44 @@
+/// <reference types="node" />
+import type { ICobuildLockProvider, ICobuildContext, ICobuildCompletedState, RushSession } from '@rushstack/rush-sdk';
+import type { RedisClientOptions } from '@redis/client';
+/**
+ * The redis client options
+ * @beta
+ */
+export interface IRedisCobuildLockProviderOptions extends RedisClientOptions {
+    /**
+     * The environment variable name for the redis password
+     */
+    passwordEnvironmentVariable?: string;
+}
+/**
+ * @beta
+ */
+export declare class RedisCobuildLockProvider implements ICobuildLockProvider {
+    private readonly _options;
+    private readonly _terminal;
+    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>;
+    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;
+}
+//# sourceMappingURL=RedisCobuildLockProvider.d.ts.map

package/lib/RedisCobuildLockProvider.d.ts.map

@@ -0,0 +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"}

package/lib/RedisCobuildLockProvider.js

@@ -0,0 +1,154 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+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._options = RedisCobuildLockProvider.expandOptionsWithEnvironmentVariables(options);
+        this._terminal = rushSession.getLogger('RedisCobuildLockProvider').terminal;
+        try {
+            this._redisClient = (0, client_1.createClient)(this._options);
+        }
+        catch (e) {
+            throw new Error(`Failed to create redis client: ${e.message}`);
+        }
+    }
+    static expandOptionsWithEnvironmentVariables(options, environment = process.env) {
+        const finalOptions = Object.assign({}, 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}`);
+        }
+    }
+    async disconnectAsync() {
+        try {
+            await this._redisClient.disconnect();
+        }
+        catch (e) {
+            throw new Error(`Failed to disconnect to redis server: ${e.message}`);
+        }
+    }
+    async acquireLockAsync(context) {
+        const { _terminal: terminal } = this;
+        const lockKey = this.getLockKey(context);
+        let result = false;
+        try {
+            const incrResult = await this._redisClient.incr(lockKey);
+            result = incrResult === 1;
+            terminal.writeDebugLine(`Acquired lock for ${lockKey}: ${incrResult}, 1 is success`);
+            if (result) {
+                await this.renewLockAsync(context);
+            }
+        }
+        catch (e) {
+            throw new Error(`Failed to acquire lock for ${lockKey}: ${e.message}`);
+        }
+        return result;
+    }
+    async renewLockAsync(context) {
+        const { _terminal: terminal } = this;
+        const lockKey = this.getLockKey(context);
+        try {
+            await this._redisClient.expire(lockKey, 30);
+        }
+        catch (e) {
+            throw new Error(`Failed to renew lock for ${lockKey}: ${e.message}`);
+        }
+        terminal.writeDebugLine(`Renewed lock for ${lockKey}`);
+    }
+    async setCompletedStateAsync(context, state) {
+        const { _terminal: terminal } = this;
+        const key = this.getCompletedStateKey(context);
+        const value = this._serializeCompletedState(state);
+        try {
+            await this._redisClient.set(key, value);
+        }
+        catch (e) {
+            throw new Error(`Failed to set completed state for ${key}: ${e.message}`);
+        }
+        terminal.writeDebugLine(`Set completed state for ${key}: ${value}`);
+    }
+    async getCompletedStateAsync(context) {
+        const { _terminal: terminal } = this;
+        const key = this.getCompletedStateKey(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}`);
+        }
+        catch (e) {
+            throw new Error(`Failed to get completed state for ${key}: ${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}`;
+    }
+    _deserializeCompletedState(state) {
+        const [status, cacheId] = state.split(COMPLETED_STATE_SEPARATOR);
+        return { status: status, cacheId };
+    }
+}
+exports.RedisCobuildLockProvider = RedisCobuildLockProvider;
+//# sourceMappingURL=RedisCobuildLockProvider.js.map

package/lib/RedisCobuildLockProvider.js.map

@@ -0,0 +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"]}

package/lib/RushRedisCobuildPlugin.d.ts

@@ -0,0 +1,16 @@
+import type { IRushPlugin, RushSession, RushConfiguration } from '@rushstack/rush-sdk';
+import type { IRedisCobuildLockProviderOptions } from './RedisCobuildLockProvider';
+/**
+ * @public
+ */
+export declare type IRushRedisCobuildPluginOptions = IRedisCobuildLockProviderOptions;
+/**
+ * @public
+ */
+export declare class RushRedisCobuildPlugin implements IRushPlugin {
+    pluginName: string;
+    private _options;
+    constructor(options: IRushRedisCobuildPluginOptions);
+    apply(rushSession: RushSession, rushConfiguration: RushConfiguration): void;
+}
+//# sourceMappingURL=RushRedisCobuildPlugin.d.ts.map

package/lib/RushRedisCobuildPlugin.d.ts.map

@@ -0,0 +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"}

package/lib/RushRedisCobuildPlugin.js

@@ -0,0 +1,27 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RushRedisCobuildPlugin = void 0;
+const node_core_library_1 = require("@rushstack/node-core-library");
+const RedisCobuildLockProviderModule = node_core_library_1.Import.lazy('./RedisCobuildLockProvider', require);
+const PLUGIN_NAME = 'RedisCobuildPlugin';
+/**
+ * @public
+ */
+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);
+            });
+        });
+    }
+}
+exports.RushRedisCobuildPlugin = RushRedisCobuildPlugin;
+//# sourceMappingURL=RushRedisCobuildPlugin.js.map

package/lib/RushRedisCobuildPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RushRedisCobuildPlugin.js","sourceRoot":"","sources":["../src/RushRedisCobuildPlugin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,oEAAsD;AAItD,MAAM,8BAA8B,GAAgD,0BAAM,CAAC,IAAI,CAC7F,4BAA4B,EAC5B,OAAO,CACR,CAAC;AAEF,MAAM,WAAW,GAAW,oBAAoB,CAAC;AAOjD;;GAEG;AACH,MAAa,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;AAjBD,wDAiBC","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';\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/index.d.ts

@@ -0,0 +1,5 @@
+import { RushRedisCobuildPlugin } from './RushRedisCobuildPlugin';
+export default RushRedisCobuildPlugin;
+export { RedisCobuildLockProvider } from './RedisCobuildLockProvider';
+export { IRedisCobuildLockProviderOptions } from './RedisCobuildLockProvider';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,eAAe,sBAAsB,CAAC;AACtC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,gCAAgC,EAAE,MAAM,4BAA4B,CAAC"}

package/lib/index.js

@@ -0,0 +1,10 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisCobuildLockProvider = void 0;
+const RushRedisCobuildPlugin_1 = require("./RushRedisCobuildPlugin");
+exports.default = RushRedisCobuildPlugin_1.RushRedisCobuildPlugin;
+var RedisCobuildLockProvider_1 = require("./RedisCobuildLockProvider");
+Object.defineProperty(exports, "RedisCobuildLockProvider", { enumerable: true, get: function () { return RedisCobuildLockProvider_1.RedisCobuildLockProvider; } });
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,qEAAkE;AAElE,kBAAe,+CAAsB,CAAC;AACtC,uEAAsE;AAA7D,oIAAA,wBAAwB,OAAA","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 { RushRedisCobuildPlugin } from './RushRedisCobuildPlugin';\n\nexport default RushRedisCobuildPlugin;\nexport { RedisCobuildLockProvider } from './RedisCobuildLockProvider';\nexport { IRedisCobuildLockProviderOptions } from './RedisCobuildLockProvider';\n"]}

package/lib/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/lib/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.34.4"
+    }
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-redis-cobuild-plugin",
-  "version": "5.97.1-pr3949.0",
+  "version": "5.97.1-pr3949.2",
   "description": "Rush plugin for Redis cobuild lock",
   "repository": {
     "type": "git",
@@ -14,12 +14,12 @@
   "dependencies": {
     "@redis/client": "~1.5.5",
     "@rushstack/node-core-library": "3.55.2",
-    "@rushstack/rush-sdk": "5.97.1-pr3949.0"
+    "@rushstack/rush-sdk": "5.97.1-pr3949.2"
   },
   "devDependencies": {
     "@types/heft-jest": "1.0.1",
     "@types/node": "14.18.36",
-    "@microsoft/rush-lib": "5.97.1-pr3949.0",
+    "@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"