@rushstack/rush-http-build-cache-plugin 5.92.0

package/lib/HttpBuildCacheProvider.js

@@ -0,0 +1,274 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpBuildCacheProvider = void 0;
+const node_core_library_1 = require("@rushstack/node-core-library");
+const rush_sdk_1 = require("@rushstack/rush-sdk");
+const node_fetch_1 = __importDefault(require("node-fetch"));
+var CredentialsOptions;
+(function (CredentialsOptions) {
+    CredentialsOptions[CredentialsOptions["Optional"] = 0] = "Optional";
+    CredentialsOptions[CredentialsOptions["Required"] = 1] = "Required";
+    CredentialsOptions[CredentialsOptions["Omit"] = 2] = "Omit";
+})(CredentialsOptions || (CredentialsOptions = {}));
+var FailureType;
+(function (FailureType) {
+    FailureType[FailureType["None"] = 0] = "None";
+    FailureType[FailureType["Informational"] = 1] = "Informational";
+    FailureType[FailureType["Warning"] = 2] = "Warning";
+    FailureType[FailureType["Error"] = 3] = "Error";
+    FailureType[FailureType["Authentication"] = 4] = "Authentication";
+})(FailureType || (FailureType = {}));
+class HttpBuildCacheProvider {
+    constructor(options, rushSession) {
+        var _a, _b, _c;
+        this._pluginName = options.pluginName;
+        this._rushSession = rushSession;
+        this._rushProjectRoot = options.rushProjectRoot;
+        this._environmentCredential = rush_sdk_1.EnvironmentConfiguration.buildCacheCredential;
+        this._isCacheWriteAllowedByConfiguration = options.isCacheWriteAllowed;
+        this._url = new URL(options.url.endsWith('/') ? options.url : options.url + '/');
+        this._uploadMethod = (_a = options.uploadMethod) !== null && _a !== void 0 ? _a : 'PUT';
+        this._headers = (_b = options.headers) !== null && _b !== void 0 ? _b : {};
+        this._tokenHandler = options.tokenHandler;
+        this._cacheKeyPrefix = (_c = options.cacheKeyPrefix) !== null && _c !== void 0 ? _c : '';
+    }
+    get isCacheWriteAllowed() {
+        var _a;
+        return (_a = rush_sdk_1.EnvironmentConfiguration.buildCacheWriteAllowed) !== null && _a !== void 0 ? _a : this._isCacheWriteAllowedByConfiguration;
+    }
+    async tryGetCacheEntryBufferByIdAsync(terminal, cacheId) {
+        try {
+            const result = await this._http({
+                terminal: terminal,
+                relUrl: `${this._cacheKeyPrefix}${cacheId}`,
+                method: 'GET',
+                body: undefined,
+                warningText: 'Could not get cache entry',
+                readBody: true
+            });
+            return Buffer.isBuffer(result) ? result : undefined;
+        }
+        catch (e) {
+            terminal.writeWarningLine(`Error getting cache entry: ${e}`);
+            return undefined;
+        }
+    }
+    async trySetCacheEntryBufferAsync(terminal, cacheId, objectBuffer) {
+        if (!this.isCacheWriteAllowed) {
+            terminal.writeErrorLine('Writing to cache is not allowed in the current configuration.');
+            return false;
+        }
+        terminal.writeDebugLine('Uploading object with cacheId: ', cacheId);
+        try {
+            const result = await this._http({
+                terminal: terminal,
+                relUrl: `${this._cacheKeyPrefix}${cacheId}`,
+                method: this._uploadMethod,
+                body: objectBuffer,
+                warningText: 'Could not write cache entry',
+                readBody: false
+            });
+            return result !== false;
+        }
+        catch (e) {
+            terminal.writeWarningLine(`Error uploading cache entry: ${e}`);
+            return false;
+        }
+    }
+    async updateCachedCredentialAsync(terminal, credential) {
+        await rush_sdk_1.CredentialCache.usingAsync({
+            supportEditing: true
+        }, async (credentialsCache) => {
+            credentialsCache.setCacheEntry(this._credentialCacheId, {
+                credential: credential
+            });
+            await credentialsCache.saveIfModifiedAsync();
+        });
+    }
+    async updateCachedCredentialInteractiveAsync(terminal) {
+        if (!this._tokenHandler) {
+            throw new Error(`The interactive cloud credentials flow is not configured.\n` +
+                `Set the 'tokenHandler' setting in 'common/config/rush-plugins/${this._pluginName}.json' to a command that writes your credentials to standard output and exits with code 0 ` +
+                `or provide your credentials to rush using the --credential flag instead. Credentials must be the ` +
+                `'Authorization' header expected by ${this._url.href}`);
+        }
+        const cmd = `${this._tokenHandler.exec} ${(this._tokenHandler.args || []).join(' ')}`;
+        terminal.writeVerboseLine(`Running '${cmd}' to get credentials`);
+        const result = node_core_library_1.Executable.spawnSync(this._tokenHandler.exec, this._tokenHandler.args || []);
+        terminal.writeErrorLine(result.stderr);
+        if (result.error) {
+            throw new Error(`Could not obtain credentials. The command '${cmd}' failed.`);
+        }
+        const credential = result.stdout.trim();
+        terminal.writeVerboseLine('Got credentials');
+        await this.updateCachedCredentialAsync(terminal, credential);
+        terminal.writeLine('Updated credentials cache');
+    }
+    async deleteCachedCredentialsAsync(terminal) {
+        await rush_sdk_1.CredentialCache.usingAsync({
+            supportEditing: true
+        }, async (credentialsCache) => {
+            credentialsCache.deleteCacheEntry(this._credentialCacheId);
+            await credentialsCache.saveIfModifiedAsync();
+        });
+    }
+    get _credentialCacheId() {
+        if (!this.__credentialCacheId) {
+            const cacheIdParts = [this._url.href];
+            if (this._isCacheWriteAllowedByConfiguration) {
+                cacheIdParts.push('cacheWriteAllowed');
+            }
+            this.__credentialCacheId = cacheIdParts.join('|');
+        }
+        return this.__credentialCacheId;
+    }
+    async _http(options) {
+        const { terminal, relUrl, method, body, warningText, readBody, credentialOptions } = options;
+        const safeCredentialOptions = credentialOptions !== null && credentialOptions !== void 0 ? credentialOptions : CredentialsOptions.Optional;
+        const credentials = await this._tryGetCredentials(safeCredentialOptions);
+        const url = new URL(relUrl, this._url).href;
+        const headers = {};
+        if (typeof credentials === 'string') {
+            headers.Authorization = credentials;
+        }
+        for (const [key, value] of Object.entries(this._headers)) {
+            if (typeof value === 'string') {
+                headers[key] = value;
+            }
+        }
+        const bodyLength = (body === null || body === void 0 ? void 0 : body.length) || 'unknown';
+        terminal.writeDebugLine(`[http-build-cache] request: ${method} ${url} ${bodyLength} bytes`);
+        const response = await (0, node_fetch_1.default)(url, {
+            method: method,
+            headers: headers,
+            body: body,
+            redirect: 'follow'
+        });
+        if (!response.ok) {
+            if (typeof credentials !== 'string' && safeCredentialOptions === CredentialsOptions.Optional) {
+                // We tried fetching the resource without credentials and that did not work out
+                // Try again but require credentials this time
+                // This will trigger the provider to request credentials
+                return await this._http(Object.assign(Object.assign({}, options), { credentialOptions: CredentialsOptions.Required }));
+            }
+            this._reportFailure(terminal, method, response, false, warningText);
+            return false;
+        }
+        const result = readBody ? Buffer.from(await response.arrayBuffer()) : true;
+        terminal.writeDebugLine(`[http-build-cache] actual response: ${response.status} ${url} ${result === true ? 'true' : result.length} bytes`);
+        return result;
+    }
+    async _tryGetCredentials(options) {
+        if (options === CredentialsOptions.Omit) {
+            return;
+        }
+        let credentials = this._environmentCredential;
+        if (credentials === undefined) {
+            credentials = await this._tryGetCredentialsFromCache();
+        }
+        if (typeof credentials !== 'string' && options === CredentialsOptions.Required) {
+            throw new Error([
+                `Credentials for ${this._url.href} have not been provided.`,
+                `In CI, verify that RUSH_BUILD_CACHE_CREDENTIAL contains a valid Authorization header value.`,
+                ``,
+                `For local developers, run:`,
+                ``,
+                `    rush update-cloud-credentials --interactive`,
+                ``
+            ].join('\n'));
+        }
+        return credentials;
+    }
+    async _tryGetCredentialsFromCache() {
+        var _a;
+        let cacheEntry;
+        await rush_sdk_1.CredentialCache.usingAsync({
+            supportEditing: false
+        }, (credentialsCache) => {
+            cacheEntry = credentialsCache.tryGetCacheEntry(this._credentialCacheId);
+        });
+        if (cacheEntry) {
+            const expirationTime = (_a = cacheEntry.expires) === null || _a === void 0 ? void 0 : _a.getTime();
+            if (!expirationTime || expirationTime >= Date.now()) {
+                return cacheEntry.credential;
+            }
+        }
+    }
+    _getFailureType(requestMethod, response, isRedirect) {
+        if (response.ok) {
+            return FailureType.None;
+        }
+        switch (response.status) {
+            case 503: {
+                // We select 503 specifically because this represents "service unavailable" and
+                // "rate limit throttle" errors, which are transient issues.
+                //
+                // There are other 5xx errors, such as 501, that can occur if the request is
+                // malformed, so as a general rule we want to let through other 5xx errors
+                // so the user can troubleshoot.
+                // Don't fail production builds with warnings for transient issues
+                return FailureType.Informational;
+            }
+            case 401:
+            case 403:
+            case 407: {
+                if (requestMethod === 'GET' && (isRedirect || response.redirected)) {
+                    // Cache misses for GET requests are not errors
+                    // This is a workaround behavior where a server can issue a redirect and we fail to authenticate at the new location.
+                    // We do not want to signal this as an authentication failure because the authorization header is not passed on to redirects.
+                    // i.e The authentication header was accepted for the first request and therefore subsequent failures
+                    // where it was not present should not be attributed to the header.
+                    // This scenario usually comes up with services that redirect to pre-signed URLS that don't actually exist.
+                    // Those services then usually treat the 404 as a 403 to prevent leaking information.
+                    return FailureType.None;
+                }
+                return FailureType.Authentication;
+            }
+            case 404: {
+                if (requestMethod === 'GET') {
+                    // Cache misses for GET requests are not errors
+                    return FailureType.None;
+                }
+            }
+        }
+        // Let dev builds succeed, let Prod builds fail
+        return FailureType.Warning;
+    }
+    _reportFailure(terminal, requestMethod, response, isRedirect, message) {
+        switch (this._getFailureType(requestMethod, response, isRedirect)) {
+            default: {
+                terminal.writeErrorLine(`${message}: HTTP ${response.status}: ${response.statusText}`);
+                break;
+            }
+            case FailureType.Warning: {
+                terminal.writeWarningLine(`${message}: HTTP ${response.status}: ${response.statusText}`);
+                break;
+            }
+            case FailureType.Informational: {
+                terminal.writeLine(`${message}: HTTP ${response.status}: ${response.statusText}`);
+                break;
+            }
+            case FailureType.None: {
+                terminal.writeDebugLine(`${message}: HTTP ${response.status}: ${response.statusText}`);
+                break;
+            }
+            case FailureType.Authentication: {
+                throw new Error([
+                    `${this._url.href} responded with ${response.status}: ${response.statusText}.`,
+                    `Credentials may be misconfigured or have expired.`,
+                    `In CI, verify that RUSH_BUILD_CACHE_CREDENTIAL contains a valid Authorization header value.`,
+                    ``,
+                    `For local developers, run:`,
+                    ``,
+                    `    rush update-cloud-credentials --interactive`,
+                    ``
+                ].join('\n'));
+            }
+        }
+    }
+}
+exports.HttpBuildCacheProvider = HttpBuildCacheProvider;
+//# sourceMappingURL=HttpBuildCacheProvider.js.map

package/lib/HttpBuildCacheProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpBuildCacheProvider.js","sourceRoot":"","sources":["../src/HttpBuildCacheProvider.ts"],"names":[],"mappings":";;;;;;AAAA,oEAAqE;AACrE,kDAM6B;AAC7B,4DAAuD;AAEvD,IAAK,kBAIJ;AAJD,WAAK,kBAAkB;IACrB,mEAAQ,CAAA;IACR,mEAAQ,CAAA;IACR,2DAAI,CAAA;AACN,CAAC,EAJI,kBAAkB,KAAlB,kBAAkB,QAItB;AAED,IAAK,WAMJ;AAND,WAAK,WAAW;IACd,6CAAI,CAAA;IACJ,+DAAa,CAAA;IACb,mDAAO,CAAA;IACP,+CAAK,CAAA;IACL,iEAAc,CAAA;AAChB,CAAC,EANI,WAAW,KAAX,WAAW,QAMf;AAqBD,MAAa,sBAAsB;IAiBjC,YAAmB,OAAuC,EAAE,WAAwB;;QAClF,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;QACtC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;QAEhD,IAAI,CAAC,sBAAsB,GAAG,mCAAwB,CAAC,oBAAoB,CAAC;QAC5E,IAAI,CAAC,mCAAmC,GAAG,OAAO,CAAC,mBAAmB,CAAC;QACvE,IAAI,CAAC,IAAI,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC;QACjF,IAAI,CAAC,aAAa,GAAG,MAAA,OAAO,CAAC,YAAY,mCAAI,KAAK,CAAC;QACnD,IAAI,CAAC,QAAQ,GAAG,MAAA,OAAO,CAAC,OAAO,mCAAI,EAAE,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;QAC1C,IAAI,CAAC,eAAe,GAAG,MAAA,OAAO,CAAC,cAAc,mCAAI,EAAE,CAAC;IACtD,CAAC;IAhBD,IAAW,mBAAmB;;QAC5B,OAAO,MAAA,mCAAwB,CAAC,sBAAsB,mCAAI,IAAI,CAAC,mCAAmC,CAAC;IACrG,CAAC;IAgBM,KAAK,CAAC,+BAA+B,CAC1C,QAAmB,EACnB,OAAe;QAEf,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC;gBAC9B,QAAQ,EAAE,QAAQ;gBAClB,MAAM,EAAE,GAAG,IAAI,CAAC,eAAe,GAAG,OAAO,EAAE;gBAC3C,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,2BAA2B;gBACxC,QAAQ,EAAE,IAAI;aACf,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;SACrD;QAAC,OAAO,CAAC,EAAE;YACV,QAAQ,CAAC,gBAAgB,CAAC,8BAA8B,CAAC,EAAE,CAAC,CAAC;YAC7D,OAAO,SAAS,CAAC;SAClB;IACH,CAAC;IAEM,KAAK,CAAC,2BAA2B,CACtC,QAAmB,EACnB,OAAe,EACf,YAAoB;QAEpB,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE;YAC7B,QAAQ,CAAC,cAAc,CAAC,+DAA+D,CAAC,CAAC;YACzF,OAAO,KAAK,CAAC;SACd;QAED,QAAQ,CAAC,cAAc,CAAC,iCAAiC,EAAE,OAAO,CAAC,CAAC;QAEpE,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC;gBAC9B,QAAQ,EAAE,QAAQ;gBAClB,MAAM,EAAE,GAAG,IAAI,CAAC,eAAe,GAAG,OAAO,EAAE;gBAC3C,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,IAAI,EAAE,YAAY;gBAClB,WAAW,EAAE,6BAA6B;gBAC1C,QAAQ,EAAE,KAAK;aAChB,CAAC,CAAC;YAEH,OAAO,MAAM,KAAK,KAAK,CAAC;SACzB;QAAC,OAAO,CAAC,EAAE;YACV,QAAQ,CAAC,gBAAgB,CAAC,gCAAgC,CAAC,EAAE,CAAC,CAAC;YAC/D,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IAEM,KAAK,CAAC,2BAA2B,CAAC,QAAmB,EAAE,UAAkB;QAC9E,MAAM,0BAAe,CAAC,UAAU,CAC9B;YACE,cAAc,EAAE,IAAI;SACrB,EACD,KAAK,EAAE,gBAAiC,EAAE,EAAE;YAC1C,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,kBAAkB,EAAE;gBACtD,UAAU,EAAE,UAAU;aACvB,CAAC,CAAC;YACH,MAAM,gBAAgB,CAAC,mBAAmB,EAAE,CAAC;QAC/C,CAAC,CACF,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,sCAAsC,CAAC,QAAmB;QACrE,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;YACvB,MAAM,IAAI,KAAK,CACb,6DAA6D;gBAC3D,iEAAiE,IAAI,CAAC,WAAW,4FAA4F;gBAC7K,mGAAmG;gBACnG,sCAAsC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CACzD,CAAC;SACH;QAED,MAAM,GAAG,GAAW,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC9F,QAAQ,CAAC,gBAAgB,CAAC,YAAY,GAAG,sBAAsB,CAAC,CAAC;QACjE,MAAM,MAAM,GAAG,8BAAU,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;QAE5F,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAEvC,IAAI,MAAM,CAAC,KAAK,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,8CAA8C,GAAG,WAAW,CAAC,CAAC;SAC/E;QAED,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACxC,QAAQ,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;QAE7C,MAAM,IAAI,CAAC,2BAA2B,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAE7D,QAAQ,CAAC,SAAS,CAAC,2BAA2B,CAAC,CAAC;IAClD,CAAC;IAEM,KAAK,CAAC,4BAA4B,CAAC,QAAmB;QAC3D,MAAM,0BAAe,CAAC,UAAU,CAC9B;YACE,cAAc,EAAE,IAAI;SACrB,EACD,KAAK,EAAE,gBAAiC,EAAE,EAAE;YAC1C,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YAC3D,MAAM,gBAAgB,CAAC,mBAAmB,EAAE,CAAC;QAC/C,CAAC,CACF,CAAC;IACJ,CAAC;IAED,IAAY,kBAAkB;QAC5B,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE;YAC7B,MAAM,YAAY,GAAa,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEhD,IAAI,IAAI,CAAC,mCAAmC,EAAE;gBAC5C,YAAY,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;aACxC;YAED,IAAI,CAAC,mBAAmB,GAAG,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACnD;QAED,OAAO,IAAI,CAAC,mBAAmB,CAAC;IAClC,CAAC;IAEO,KAAK,CAAC,KAAK,CAAC,OAQnB;QACC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC;QAC7F,MAAM,qBAAqB,GAAG,iBAAiB,aAAjB,iBAAiB,cAAjB,iBAAiB,GAAI,kBAAkB,CAAC,QAAQ,CAAC;QAC/E,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,qBAAqB,CAAC,CAAC;QACzE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;QAE5C,MAAM,OAAO,GAA2B,EAAE,CAAC;QAC3C,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;YACnC,OAAO,CAAC,aAAa,GAAG,WAAW,CAAC;SACrC;QAED,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YACxD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBAC7B,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;aACtB;SACF;QAED,MAAM,UAAU,GAAG,CAAC,IAA2B,aAA3B,IAAI,uBAAJ,IAAI,CAAyB,MAAM,KAAI,SAAS,CAAC;QAErE,QAAQ,CAAC,cAAc,CAAC,+BAA+B,MAAM,IAAI,GAAG,IAAI,UAAU,QAAQ,CAAC,CAAC;QAE5F,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAK,EAAC,GAAG,EAAE;YAChC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,QAAQ;SACnB,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,qBAAqB,KAAK,kBAAkB,CAAC,QAAQ,EAAE;gBAC5F,+EAA+E;gBAC/E,8CAA8C;gBAC9C,wDAAwD;gBACxD,OAAO,MAAM,IAAI,CAAC,KAAK,iCAAM,OAAO,KAAE,iBAAiB,EAAE,kBAAkB,CAAC,QAAQ,IAAG,CAAC;aACzF;YAED,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;YACpE,OAAO,KAAK,CAAC;SACd;QAED,MAAM,MAAM,GAAqB,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAE7F,QAAQ,CAAC,cAAc,CACrB,uCAAuC,QAAQ,CAAC,MAAM,IAAI,GAAG,IAC3D,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MACpC,QAAQ,CACT,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC;IAMO,KAAK,CAAC,kBAAkB,CAAC,OAA2B;QAC1D,IAAI,OAAO,KAAK,kBAAkB,CAAC,IAAI,EAAE;YACvC,OAAO;SACR;QAED,IAAI,WAAW,GAAuB,IAAI,CAAC,sBAAsB,CAAC;QAElE,IAAI,WAAW,KAAK,SAAS,EAAE;YAC7B,WAAW,GAAG,MAAM,IAAI,CAAC,2BAA2B,EAAE,CAAC;SACxD;QAED,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,OAAO,KAAK,kBAAkB,CAAC,QAAQ,EAAE;YAC9E,MAAM,IAAI,KAAK,CACb;gBACE,mBAAmB,IAAI,CAAC,IAAI,CAAC,IAAI,0BAA0B;gBAC3D,6FAA6F;gBAC7F,EAAE;gBACF,4BAA4B;gBAC5B,EAAE;gBACF,iDAAiD;gBACjD,EAAE;aACH,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;SACH;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAEO,KAAK,CAAC,2BAA2B;;QACvC,IAAI,UAA6C,CAAC;QAElD,MAAM,0BAAe,CAAC,UAAU,CAC9B;YACE,cAAc,EAAE,KAAK;SACtB,EACD,CAAC,gBAAiC,EAAE,EAAE;YACpC,UAAU,GAAG,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC1E,CAAC,CACF,CAAC;QAEF,IAAI,UAAU,EAAE;YACd,MAAM,cAAc,GAAuB,MAAA,UAAU,CAAC,OAAO,0CAAE,OAAO,EAAE,CAAC;YACzE,IAAI,CAAC,cAAc,IAAI,cAAc,IAAI,IAAI,CAAC,GAAG,EAAE,EAAE;gBACnD,OAAO,UAAU,CAAC,UAAU,CAAC;aAC9B;SACF;IACH,CAAC;IAEO,eAAe,CAAC,aAAqB,EAAE,QAAkB,EAAE,UAAmB;QACpF,IAAI,QAAQ,CAAC,EAAE,EAAE;YACf,OAAO,WAAW,CAAC,IAAI,CAAC;SACzB;QAED,QAAQ,QAAQ,CAAC,MAAM,EAAE;YACvB,KAAK,GAAG,CAAC,CAAC;gBACR,+EAA+E;gBAC/E,4DAA4D;gBAC5D,EAAE;gBACF,4EAA4E;gBAC5E,0EAA0E;gBAC1E,gCAAgC;gBAEhC,kEAAkE;gBAClE,OAAO,WAAW,CAAC,aAAa,CAAC;aAClC;YAED,KAAK,GAAG,CAAC;YACT,KAAK,GAAG,CAAC;YACT,KAAK,GAAG,CAAC,CAAC;gBACR,IAAI,aAAa,KAAK,KAAK,IAAI,CAAC,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC,EAAE;oBAClE,+CAA+C;oBAC/C,qHAAqH;oBACrH,6HAA6H;oBAC7H,qGAAqG;oBACrG,mEAAmE;oBACnE,2GAA2G;oBAC3G,qFAAqF;oBACrF,OAAO,WAAW,CAAC,IAAI,CAAC;iBACzB;gBAED,OAAO,WAAW,CAAC,cAAc,CAAC;aACnC;YAED,KAAK,GAAG,CAAC,CAAC;gBACR,IAAI,aAAa,KAAK,KAAK,EAAE;oBAC3B,+CAA+C;oBAC/C,OAAO,WAAW,CAAC,IAAI,CAAC;iBACzB;aACF;SACF;QAED,+CAA+C;QAC/C,OAAO,WAAW,CAAC,OAAO,CAAC;IAC7B,CAAC;IAEO,cAAc,CACpB,QAAmB,EACnB,aAAqB,EACrB,QAAkB,EAClB,UAAmB,EACnB,OAAe;QAEf,QAAQ,IAAI,CAAC,eAAe,CAAC,aAAa,EAAE,QAAQ,EAAE,UAAU,CAAC,EAAE;YACjE,OAAO,CAAC,CAAC;gBACP,QAAQ,CAAC,cAAc,CAAC,GAAG,OAAO,UAAU,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;gBACvF,MAAM;aACP;YAED,KAAK,WAAW,CAAC,OAAO,CAAC,CAAC;gBACxB,QAAQ,CAAC,gBAAgB,CAAC,GAAG,OAAO,UAAU,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;gBACzF,MAAM;aACP;YAED,KAAK,WAAW,CAAC,aAAa,CAAC,CAAC;gBAC9B,QAAQ,CAAC,SAAS,CAAC,GAAG,OAAO,UAAU,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;gBAClF,MAAM;aACP;YAED,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC;gBACrB,QAAQ,CAAC,cAAc,CAAC,GAAG,OAAO,UAAU,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;gBACvF,MAAM;aACP;YAED,KAAK,WAAW,CAAC,cAAc,CAAC,CAAC;gBAC/B,MAAM,IAAI,KAAK,CACb;oBACE,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,mBAAmB,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,GAAG;oBAC9E,mDAAmD;oBACnD,6FAA6F;oBAC7F,EAAE;oBACF,4BAA4B;oBAC5B,EAAE;oBACF,iDAAiD;oBACjD,EAAE;iBACH,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;aACH;SACF;IACH,CAAC;CACF;AA/VD,wDA+VC","sourcesContent":["import { ITerminal, Executable } from '@rushstack/node-core-library';\nimport {\n  ICloudBuildCacheProvider,\n  ICredentialCacheEntry,\n  CredentialCache,\n  RushSession,\n  EnvironmentConfiguration\n} from '@rushstack/rush-sdk';\nimport fetch, { BodyInit, Response } from 'node-fetch';\n\nenum CredentialsOptions {\n  Optional,\n  Required,\n  Omit\n}\n\nenum FailureType {\n  None,\n  Informational,\n  Warning,\n  Error,\n  Authentication\n}\n\nexport interface IHttpBuildCacheTokenHandler {\n  exec: string;\n  args?: string[];\n}\n\n/**\n * @public\n */\nexport interface IHttpBuildCacheProviderOptions {\n  url: string;\n  tokenHandler?: IHttpBuildCacheTokenHandler;\n  uploadMethod?: string;\n  headers?: Record<string, string>;\n  cacheKeyPrefix?: string;\n  isCacheWriteAllowed: boolean;\n  pluginName: string;\n  rushProjectRoot: string;\n}\n\nexport class HttpBuildCacheProvider implements ICloudBuildCacheProvider {\n  private readonly _pluginName: string;\n  private readonly _rushSession: RushSession;\n  private readonly _rushProjectRoot: string;\n  private readonly _environmentCredential: string | undefined;\n  private readonly _isCacheWriteAllowedByConfiguration: boolean;\n  private readonly _url: URL;\n  private readonly _uploadMethod: string;\n  private readonly _headers: Record<string, string>;\n  private readonly _cacheKeyPrefix: string;\n  private readonly _tokenHandler: IHttpBuildCacheTokenHandler | undefined;\n  private __credentialCacheId: string | undefined;\n\n  public get isCacheWriteAllowed(): boolean {\n    return EnvironmentConfiguration.buildCacheWriteAllowed ?? this._isCacheWriteAllowedByConfiguration;\n  }\n\n  public constructor(options: IHttpBuildCacheProviderOptions, rushSession: RushSession) {\n    this._pluginName = options.pluginName;\n    this._rushSession = rushSession;\n    this._rushProjectRoot = options.rushProjectRoot;\n\n    this._environmentCredential = EnvironmentConfiguration.buildCacheCredential;\n    this._isCacheWriteAllowedByConfiguration = options.isCacheWriteAllowed;\n    this._url = new URL(options.url.endsWith('/') ? options.url : options.url + '/');\n    this._uploadMethod = options.uploadMethod ?? 'PUT';\n    this._headers = options.headers ?? {};\n    this._tokenHandler = options.tokenHandler;\n    this._cacheKeyPrefix = options.cacheKeyPrefix ?? '';\n  }\n\n  public async tryGetCacheEntryBufferByIdAsync(\n    terminal: ITerminal,\n    cacheId: string\n  ): Promise<Buffer | undefined> {\n    try {\n      const result = await this._http({\n        terminal: terminal,\n        relUrl: `${this._cacheKeyPrefix}${cacheId}`,\n        method: 'GET',\n        body: undefined,\n        warningText: 'Could not get cache entry',\n        readBody: true\n      });\n\n      return Buffer.isBuffer(result) ? result : undefined;\n    } catch (e) {\n      terminal.writeWarningLine(`Error getting cache entry: ${e}`);\n      return undefined;\n    }\n  }\n\n  public async trySetCacheEntryBufferAsync(\n    terminal: ITerminal,\n    cacheId: string,\n    objectBuffer: Buffer\n  ): Promise<boolean> {\n    if (!this.isCacheWriteAllowed) {\n      terminal.writeErrorLine('Writing to cache is not allowed in the current configuration.');\n      return false;\n    }\n\n    terminal.writeDebugLine('Uploading object with cacheId: ', cacheId);\n\n    try {\n      const result = await this._http({\n        terminal: terminal,\n        relUrl: `${this._cacheKeyPrefix}${cacheId}`,\n        method: this._uploadMethod,\n        body: objectBuffer,\n        warningText: 'Could not write cache entry',\n        readBody: false\n      });\n\n      return result !== false;\n    } catch (e) {\n      terminal.writeWarningLine(`Error uploading cache entry: ${e}`);\n      return false;\n    }\n  }\n\n  public async updateCachedCredentialAsync(terminal: ITerminal, credential: string): Promise<void> {\n    await CredentialCache.usingAsync(\n      {\n        supportEditing: true\n      },\n      async (credentialsCache: CredentialCache) => {\n        credentialsCache.setCacheEntry(this._credentialCacheId, {\n          credential: credential\n        });\n        await credentialsCache.saveIfModifiedAsync();\n      }\n    );\n  }\n\n  public async updateCachedCredentialInteractiveAsync(terminal: ITerminal): Promise<void> {\n    if (!this._tokenHandler) {\n      throw new Error(\n        `The interactive cloud credentials flow is not configured.\\n` +\n          `Set the 'tokenHandler' setting in 'common/config/rush-plugins/${this._pluginName}.json' to a command that writes your credentials to standard output and exits with code 0 ` +\n          `or provide your credentials to rush using the --credential flag instead. Credentials must be the ` +\n          `'Authorization' header expected by ${this._url.href}`\n      );\n    }\n\n    const cmd: string = `${this._tokenHandler.exec} ${(this._tokenHandler.args || []).join(' ')}`;\n    terminal.writeVerboseLine(`Running '${cmd}' to get credentials`);\n    const result = Executable.spawnSync(this._tokenHandler.exec, this._tokenHandler.args || []);\n\n    terminal.writeErrorLine(result.stderr);\n\n    if (result.error) {\n      throw new Error(`Could not obtain credentials. The command '${cmd}' failed.`);\n    }\n\n    const credential = result.stdout.trim();\n    terminal.writeVerboseLine('Got credentials');\n\n    await this.updateCachedCredentialAsync(terminal, credential);\n\n    terminal.writeLine('Updated credentials cache');\n  }\n\n  public async deleteCachedCredentialsAsync(terminal: ITerminal): Promise<void> {\n    await CredentialCache.usingAsync(\n      {\n        supportEditing: true\n      },\n      async (credentialsCache: CredentialCache) => {\n        credentialsCache.deleteCacheEntry(this._credentialCacheId);\n        await credentialsCache.saveIfModifiedAsync();\n      }\n    );\n  }\n\n  private get _credentialCacheId(): string {\n    if (!this.__credentialCacheId) {\n      const cacheIdParts: string[] = [this._url.href];\n\n      if (this._isCacheWriteAllowedByConfiguration) {\n        cacheIdParts.push('cacheWriteAllowed');\n      }\n\n      this.__credentialCacheId = cacheIdParts.join('|');\n    }\n\n    return this.__credentialCacheId;\n  }\n\n  private async _http(options: {\n    terminal: ITerminal;\n    relUrl: string;\n    method: string;\n    body: BodyInit | undefined;\n    warningText: string;\n    readBody: boolean;\n    credentialOptions?: CredentialsOptions;\n  }): Promise<Buffer | boolean> {\n    const { terminal, relUrl, method, body, warningText, readBody, credentialOptions } = options;\n    const safeCredentialOptions = credentialOptions ?? CredentialsOptions.Optional;\n    const credentials = await this._tryGetCredentials(safeCredentialOptions);\n    const url = new URL(relUrl, this._url).href;\n\n    const headers: Record<string, string> = {};\n    if (typeof credentials === 'string') {\n      headers.Authorization = credentials;\n    }\n\n    for (const [key, value] of Object.entries(this._headers)) {\n      if (typeof value === 'string') {\n        headers[key] = value;\n      }\n    }\n\n    const bodyLength = (body as { length: number })?.length || 'unknown';\n\n    terminal.writeDebugLine(`[http-build-cache] request: ${method} ${url} ${bodyLength} bytes`);\n\n    const response = await fetch(url, {\n      method: method,\n      headers: headers,\n      body: body,\n      redirect: 'follow'\n    });\n\n    if (!response.ok) {\n      if (typeof credentials !== 'string' && safeCredentialOptions === CredentialsOptions.Optional) {\n        // We tried fetching the resource without credentials and that did not work out\n        // Try again but require credentials this time\n        // This will trigger the provider to request credentials\n        return await this._http({ ...options, credentialOptions: CredentialsOptions.Required });\n      }\n\n      this._reportFailure(terminal, method, response, false, warningText);\n      return false;\n    }\n\n    const result: Buffer | boolean = readBody ? Buffer.from(await response.arrayBuffer()) : true;\n\n    terminal.writeDebugLine(\n      `[http-build-cache] actual response: ${response.status} ${url} ${\n        result === true ? 'true' : result.length\n      } bytes`\n    );\n\n    return result;\n  }\n\n  private async _tryGetCredentials(options: CredentialsOptions.Required): Promise<string>;\n  private async _tryGetCredentials(options: CredentialsOptions.Optional): Promise<string | undefined>;\n  private async _tryGetCredentials(options: CredentialsOptions.Omit): Promise<undefined>;\n  private async _tryGetCredentials(options: CredentialsOptions): Promise<string | undefined>;\n  private async _tryGetCredentials(options: CredentialsOptions): Promise<string | undefined> {\n    if (options === CredentialsOptions.Omit) {\n      return;\n    }\n\n    let credentials: string | undefined = this._environmentCredential;\n\n    if (credentials === undefined) {\n      credentials = await this._tryGetCredentialsFromCache();\n    }\n\n    if (typeof credentials !== 'string' && options === CredentialsOptions.Required) {\n      throw new Error(\n        [\n          `Credentials for ${this._url.href} have not been provided.`,\n          `In CI, verify that RUSH_BUILD_CACHE_CREDENTIAL contains a valid Authorization header value.`,\n          ``,\n          `For local developers, run:`,\n          ``,\n          `    rush update-cloud-credentials --interactive`,\n          ``\n        ].join('\\n')\n      );\n    }\n\n    return credentials;\n  }\n\n  private async _tryGetCredentialsFromCache(): Promise<string | undefined> {\n    let cacheEntry: ICredentialCacheEntry | undefined;\n\n    await CredentialCache.usingAsync(\n      {\n        supportEditing: false\n      },\n      (credentialsCache: CredentialCache) => {\n        cacheEntry = credentialsCache.tryGetCacheEntry(this._credentialCacheId);\n      }\n    );\n\n    if (cacheEntry) {\n      const expirationTime: number | undefined = cacheEntry.expires?.getTime();\n      if (!expirationTime || expirationTime >= Date.now()) {\n        return cacheEntry.credential;\n      }\n    }\n  }\n\n  private _getFailureType(requestMethod: string, response: Response, isRedirect: boolean): FailureType {\n    if (response.ok) {\n      return FailureType.None;\n    }\n\n    switch (response.status) {\n      case 503: {\n        // We select 503 specifically because this represents \"service unavailable\" and\n        // \"rate limit throttle\" errors, which are transient issues.\n        //\n        // There are other 5xx errors, such as 501, that can occur if the request is\n        // malformed, so as a general rule we want to let through other 5xx errors\n        // so the user can troubleshoot.\n\n        // Don't fail production builds with warnings for transient issues\n        return FailureType.Informational;\n      }\n\n      case 401:\n      case 403:\n      case 407: {\n        if (requestMethod === 'GET' && (isRedirect || response.redirected)) {\n          // Cache misses for GET requests are not errors\n          // This is a workaround behavior where a server can issue a redirect and we fail to authenticate at the new location.\n          // We do not want to signal this as an authentication failure because the authorization header is not passed on to redirects.\n          // i.e The authentication header was accepted for the first request and therefore subsequent failures\n          // where it was not present should not be attributed to the header.\n          // This scenario usually comes up with services that redirect to pre-signed URLS that don't actually exist.\n          // Those services then usually treat the 404 as a 403 to prevent leaking information.\n          return FailureType.None;\n        }\n\n        return FailureType.Authentication;\n      }\n\n      case 404: {\n        if (requestMethod === 'GET') {\n          // Cache misses for GET requests are not errors\n          return FailureType.None;\n        }\n      }\n    }\n\n    // Let dev builds succeed, let Prod builds fail\n    return FailureType.Warning;\n  }\n\n  private _reportFailure(\n    terminal: ITerminal,\n    requestMethod: string,\n    response: Response,\n    isRedirect: boolean,\n    message: string\n  ): void {\n    switch (this._getFailureType(requestMethod, response, isRedirect)) {\n      default: {\n        terminal.writeErrorLine(`${message}: HTTP ${response.status}: ${response.statusText}`);\n        break;\n      }\n\n      case FailureType.Warning: {\n        terminal.writeWarningLine(`${message}: HTTP ${response.status}: ${response.statusText}`);\n        break;\n      }\n\n      case FailureType.Informational: {\n        terminal.writeLine(`${message}: HTTP ${response.status}: ${response.statusText}`);\n        break;\n      }\n\n      case FailureType.None: {\n        terminal.writeDebugLine(`${message}: HTTP ${response.status}: ${response.statusText}`);\n        break;\n      }\n\n      case FailureType.Authentication: {\n        throw new Error(\n          [\n            `${this._url.href} responded with ${response.status}: ${response.statusText}.`,\n            `Credentials may be misconfigured or have expired.`,\n            `In CI, verify that RUSH_BUILD_CACHE_CREDENTIAL contains a valid Authorization header value.`,\n            ``,\n            `For local developers, run:`,\n            ``,\n            `    rush update-cloud-credentials --interactive`,\n            ``\n          ].join('\\n')\n        );\n      }\n    }\n  }\n}\n"]}

package/lib/HttpBuildCacheProvider.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=HttpBuildCacheProvider.test.d.ts.map

package/lib/HttpBuildCacheProvider.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpBuildCacheProvider.test.d.ts","sourceRoot":"","sources":["../src/HttpBuildCacheProvider.test.ts"],"names":[],"mappings":""}

package/lib/HttpBuildCacheProvider.test.js

@@ -0,0 +1,72 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+jest.mock('node-fetch', function () {
+    return Object.assign(jest.fn(), jest.requireActual('node-fetch'));
+});
+const node_fetch_1 = __importStar(require("node-fetch"));
+const HttpBuildCacheProvider_1 = require("./HttpBuildCacheProvider");
+const rush_sdk_1 = require("@rushstack/rush-sdk");
+const node_core_library_1 = require("@rushstack/node-core-library");
+const EXAMPLE_OPTIONS = {
+    url: 'https://buildcache.example.acme.com',
+    tokenHandler: {
+        exec: 'node',
+        args: ['tokenHandler.js']
+    },
+    uploadMethod: 'POST',
+    isCacheWriteAllowed: false,
+    pluginName: 'example-plugin',
+    rushProjectRoot: '/repo'
+};
+describe('HttpBuildCacheProvider', () => {
+    let terminalBuffer;
+    let terminal;
+    beforeEach(() => {
+        terminalBuffer = new node_core_library_1.StringBufferTerminalProvider();
+        terminal = new node_core_library_1.Terminal(terminalBuffer);
+    });
+    describe('tryGetCacheEntryBufferByIdAsync', () => {
+        it('prints warning if read credentials are not available', async () => {
+            jest.spyOn(rush_sdk_1.EnvironmentConfiguration, 'buildCacheCredential', 'get').mockReturnValue(undefined);
+            const session = {};
+            const provider = new HttpBuildCacheProvider_1.HttpBuildCacheProvider(EXAMPLE_OPTIONS, session);
+            mocked(node_fetch_1.default).mockResolvedValue(new node_fetch_1.Response('Unauthorized', {
+                status: 401,
+                statusText: 'Unauthorized'
+            }));
+            const result = await provider.tryGetCacheEntryBufferByIdAsync(terminal, 'some-key');
+            expect(result).toBe(undefined);
+            expect(node_fetch_1.default).toHaveBeenCalledWith('https://buildcache.example.acme.com/some-key', {
+                body: undefined,
+                headers: {},
+                method: 'GET',
+                redirect: 'follow'
+            });
+            expect(terminalBuffer.getWarningOutput()).toMatchInlineSnapshot(`"Error getting cache entry: Error: Credentials for https://buildcache.example.acme.com/ have not been provided.[n]In CI, verify that RUSH_BUILD_CACHE_CREDENTIAL contains a valid Authorization header value.[n][n]For local developers, run:[n][n]    rush update-cloud-credentials --interactive[n][n]"`);
+        });
+    });
+});
+//# sourceMappingURL=HttpBuildCacheProvider.test.js.map

package/lib/HttpBuildCacheProvider.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpBuildCacheProvider.test.js","sourceRoot":"","sources":["../src/HttpBuildCacheProvider.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;IACtB,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC;AACpE,CAAC,CAAC,CAAC;AAEH,yDAA6C;AAC7C,qEAAkE;AAClE,kDAA4E;AAC5E,oEAAsF;AAEtF,MAAM,eAAe,GAAG;IACtB,GAAG,EAAE,qCAAqC;IAC1C,YAAY,EAAE;QACZ,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,CAAC,iBAAiB,CAAC;KAC1B;IACD,YAAY,EAAE,MAAM;IACpB,mBAAmB,EAAE,KAAK;IAC1B,UAAU,EAAE,gBAAgB;IAC5B,eAAe,EAAE,OAAO;CACzB,CAAC;AAEF,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;IACtC,IAAI,cAA4C,CAAC;IACjD,IAAI,QAAmB,CAAC;IAExB,UAAU,CAAC,GAAG,EAAE;QACd,cAAc,GAAG,IAAI,gDAA4B,EAAE,CAAC;QACpD,QAAQ,GAAG,IAAI,4BAAQ,CAAC,cAAc,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;QAC/C,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;YACpE,IAAI,CAAC,KAAK,CAAC,mCAAwB,EAAE,sBAAsB,EAAE,KAAK,CAAC,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;YAE/F,MAAM,OAAO,GAAgB,EAAiB,CAAC;YAC/C,MAAM,QAAQ,GAAG,IAAI,+CAAsB,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;YAEtE,MAAM,CAAC,oBAAK,CAAC,CAAC,iBAAiB,CAC7B,IAAI,qBAAQ,CAAC,cAAc,EAAE;gBAC3B,MAAM,EAAE,GAAG;gBACX,UAAU,EAAE,cAAc;aAC3B,CAAC,CACH,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,+BAA+B,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YACpF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/B,MAAM,CAAC,oBAAK,CAAC,CAAC,oBAAoB,CAAC,8CAA8C,EAAE;gBACjF,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,EAAE;gBACX,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,QAAQ;aACnB,CAAC,CAAC;YACH,MAAM,CAAC,cAAc,CAAC,gBAAgB,EAAE,CAAC,CAAC,qBAAqB,CAC7D,2SAA2S,CAC5S,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["jest.mock('node-fetch', function () {\n  return Object.assign(jest.fn(), jest.requireActual('node-fetch'));\n});\n\nimport fetch, { Response } from 'node-fetch';\nimport { HttpBuildCacheProvider } from './HttpBuildCacheProvider';\nimport { RushSession, EnvironmentConfiguration } from '@rushstack/rush-sdk';\nimport { StringBufferTerminalProvider, Terminal } from '@rushstack/node-core-library';\n\nconst EXAMPLE_OPTIONS = {\n  url: 'https://buildcache.example.acme.com',\n  tokenHandler: {\n    exec: 'node',\n    args: ['tokenHandler.js']\n  },\n  uploadMethod: 'POST',\n  isCacheWriteAllowed: false,\n  pluginName: 'example-plugin',\n  rushProjectRoot: '/repo'\n};\n\ndescribe('HttpBuildCacheProvider', () => {\n  let terminalBuffer: StringBufferTerminalProvider;\n  let terminal!: Terminal;\n\n  beforeEach(() => {\n    terminalBuffer = new StringBufferTerminalProvider();\n    terminal = new Terminal(terminalBuffer);\n  });\n\n  describe('tryGetCacheEntryBufferByIdAsync', () => {\n    it('prints warning if read credentials are not available', async () => {\n      jest.spyOn(EnvironmentConfiguration, 'buildCacheCredential', 'get').mockReturnValue(undefined);\n\n      const session: RushSession = {} as RushSession;\n      const provider = new HttpBuildCacheProvider(EXAMPLE_OPTIONS, session);\n\n      mocked(fetch).mockResolvedValue(\n        new Response('Unauthorized', {\n          status: 401,\n          statusText: 'Unauthorized'\n        })\n      );\n\n      const result = await provider.tryGetCacheEntryBufferByIdAsync(terminal, 'some-key');\n      expect(result).toBe(undefined);\n      expect(fetch).toHaveBeenCalledWith('https://buildcache.example.acme.com/some-key', {\n        body: undefined,\n        headers: {},\n        method: 'GET',\n        redirect: 'follow'\n      });\n      expect(terminalBuffer.getWarningOutput()).toMatchInlineSnapshot(\n        `\"Error getting cache entry: Error: Credentials for https://buildcache.example.acme.com/ have not been provided.[n]In CI, verify that RUSH_BUILD_CACHE_CREDENTIAL contains a valid Authorization header value.[n][n]For local developers, run:[n][n]    rush update-cloud-credentials --interactive[n][n]\"`\n      );\n    });\n  });\n});\n"]}

package/lib/RushHttpBuildCachePlugin.d.ts

@@ -0,0 +1,42 @@
+import type { IRushPlugin, RushSession, RushConfiguration } from '@rushstack/rush-sdk';
+/**
+ * @public
+ */
+export interface IRushHttpBuildCachePluginConfig {
+    /**
+     * The URL of the server that stores the caches (e.g. "https://build-caches.example.com").
+     */
+    url: string;
+    /**
+     * The HTTP method to use when writing to the cache (defaults to PUT).
+     */
+    uploadMethod?: string;
+    /**
+     * An optional set of HTTP headers to pass to the cache server.
+     */
+    headers?: Record<string, string>;
+    /**
+     * An optional command that prints the endpoint's credentials to stdout. Provide the
+     * command or script to execute and, optionally, any arguments to pass to the script.
+     */
+    tokenHandler?: {
+        exec: string;
+        args?: string[];
+    };
+    /**
+     * Prefix for cache keys.
+     */
+    cacheKeyPrefix?: string;
+    /**
+     * If set to true, allow writing to the cache. Defaults to false.
+     */
+    isCacheWriteAllowed?: boolean;
+}
+/**
+ * @public
+ */
+export declare class RushHttpBuildCachePlugin implements IRushPlugin {
+    readonly pluginName: string;
+    apply(rushSession: RushSession, rushConfig: RushConfiguration): void;
+}
+//# sourceMappingURL=RushHttpBuildCachePlugin.d.ts.map

package/lib/RushHttpBuildCachePlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RushHttpBuildCachePlugin.d.ts","sourceRoot":"","sources":["../src/RushHttpBuildCachePlugin.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAUvF;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;;OAGG;IACH,YAAY,CAAC,EAAE;QACb,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC;IAEF;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;GAEG;AACH,qBAAa,wBAAyB,YAAW,WAAW;IAC1D,SAAgB,UAAU,EAAE,MAAM,CAAe;IAE1C,KAAK,CAAC,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,iBAAiB,GAAG,IAAI;CA6B5E"}

package/lib/RushHttpBuildCachePlugin.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RushHttpBuildCachePlugin = void 0;
+const node_core_library_1 = require("@rushstack/node-core-library");
+const HttpBuildCacheProviderModule = node_core_library_1.Import.lazy('./HttpBuildCacheProvider', require);
+const PLUGIN_NAME = 'HttpBuildCachePlugin';
+/**
+ * @public
+ */
+class RushHttpBuildCachePlugin {
+    constructor() {
+        this.pluginName = PLUGIN_NAME;
+    }
+    apply(rushSession, rushConfig) {
+        rushSession.hooks.initialize.tap(this.pluginName, () => {
+            rushSession.registerCloudBuildCacheProviderFactory('http', (buildCacheConfig) => {
+                const config = buildCacheConfig.httpConfiguration;
+                const { url, uploadMethod, headers, tokenHandler, cacheKeyPrefix, isCacheWriteAllowed } = config;
+                const options = {
+                    pluginName: this.pluginName,
+                    rushProjectRoot: rushConfig.rushJsonFolder,
+                    url: url,
+                    uploadMethod: uploadMethod,
+                    headers: headers,
+                    tokenHandler: tokenHandler,
+                    cacheKeyPrefix: cacheKeyPrefix,
+                    isCacheWriteAllowed: !!isCacheWriteAllowed
+                };
+                return new HttpBuildCacheProviderModule.HttpBuildCacheProvider(options, rushSession);
+            });
+        });
+    }
+}
+exports.RushHttpBuildCachePlugin = RushHttpBuildCachePlugin;
+//# sourceMappingURL=RushHttpBuildCachePlugin.js.map

package/lib/RushHttpBuildCachePlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RushHttpBuildCachePlugin.js","sourceRoot":"","sources":["../src/RushHttpBuildCachePlugin.ts"],"names":[],"mappings":";;;AAAA,oEAAsD;AAItD,MAAM,4BAA4B,GAA8C,0BAAM,CAAC,IAAI,CACzF,0BAA0B,EAC1B,OAAO,CACR,CAAC;AAEF,MAAM,WAAW,GAAW,sBAAsB,CAAC;AAyCnD;;GAEG;AACH,MAAa,wBAAwB;IAArC;QACkB,eAAU,GAAW,WAAW,CAAC;IA+BnD,CAAC;IA7BQ,KAAK,CAAC,WAAwB,EAAE,UAA6B;QAClE,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,EAAE;YACrD,WAAW,CAAC,sCAAsC,CAChD,MAAM,EACN,CAAC,gBAAgB,EAA0B,EAAE;gBAC3C,MAAM,MAAM,GACV,gBAGD,CAAC,iBAAiB,CAAC;gBAEpB,MAAM,EAAE,GAAG,EAAE,YAAY,EAAE,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;gBAEjG,MAAM,OAAO,GAAmC;oBAC9C,UAAU,EAAE,IAAI,CAAC,UAAU;oBAC3B,eAAe,EAAE,UAAU,CAAC,cAAc;oBAC1C,GAAG,EAAE,GAAG;oBACR,YAAY,EAAE,YAAY;oBAC1B,OAAO,EAAE,OAAO;oBAChB,YAAY,EAAE,YAAY;oBAC1B,cAAc,EAAE,cAAc;oBAC9B,mBAAmB,EAAE,CAAC,CAAC,mBAAmB;iBAC3C,CAAC;gBAEF,OAAO,IAAI,4BAA4B,CAAC,sBAAsB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;YACvF,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAhCD,4DAgCC","sourcesContent":["import { Import } from '@rushstack/node-core-library';\nimport type { IRushPlugin, RushSession, RushConfiguration } from '@rushstack/rush-sdk';\nimport type { HttpBuildCacheProvider, IHttpBuildCacheProviderOptions } from './HttpBuildCacheProvider';\n\nconst HttpBuildCacheProviderModule: typeof import('./HttpBuildCacheProvider') = Import.lazy(\n  './HttpBuildCacheProvider',\n  require\n);\n\nconst PLUGIN_NAME: string = 'HttpBuildCachePlugin';\n\n/**\n * @public\n */\nexport interface IRushHttpBuildCachePluginConfig {\n  /**\n   * The URL of the server that stores the caches (e.g. \"https://build-caches.example.com\").\n   */\n  url: string;\n\n  /**\n   * The HTTP method to use when writing to the cache (defaults to PUT).\n   */\n  uploadMethod?: string;\n\n  /**\n   * An optional set of HTTP headers to pass to the cache server.\n   */\n  headers?: Record<string, string>;\n\n  /**\n   * An optional command that prints the endpoint's credentials to stdout. Provide the\n   * command or script to execute and, optionally, any arguments to pass to the script.\n   */\n  tokenHandler?: {\n    exec: string;\n    args?: string[];\n  };\n\n  /**\n   * Prefix for cache keys.\n   */\n  cacheKeyPrefix?: string;\n\n  /**\n   * If set to true, allow writing to the cache. Defaults to false.\n   */\n  isCacheWriteAllowed?: boolean;\n}\n\n/**\n * @public\n */\nexport class RushHttpBuildCachePlugin implements IRushPlugin {\n  public readonly pluginName: string = PLUGIN_NAME;\n\n  public apply(rushSession: RushSession, rushConfig: RushConfiguration): void {\n    rushSession.hooks.initialize.tap(this.pluginName, () => {\n      rushSession.registerCloudBuildCacheProviderFactory(\n        'http',\n        (buildCacheConfig): HttpBuildCacheProvider => {\n          const config: IRushHttpBuildCachePluginConfig = (\n            buildCacheConfig as typeof buildCacheConfig & {\n              httpConfiguration: IRushHttpBuildCachePluginConfig;\n            }\n          ).httpConfiguration;\n\n          const { url, uploadMethod, headers, tokenHandler, cacheKeyPrefix, isCacheWriteAllowed } = config;\n\n          const options: IHttpBuildCacheProviderOptions = {\n            pluginName: this.pluginName,\n            rushProjectRoot: rushConfig.rushJsonFolder,\n            url: url,\n            uploadMethod: uploadMethod,\n            headers: headers,\n            tokenHandler: tokenHandler,\n            cacheKeyPrefix: cacheKeyPrefix,\n            isCacheWriteAllowed: !!isCacheWriteAllowed\n          };\n\n          return new HttpBuildCacheProviderModule.HttpBuildCacheProvider(options, rushSession);\n        }\n      );\n    });\n  }\n}\n"]}

package/lib/index.d.ts

@@ -0,0 +1,4 @@
+import { RushHttpBuildCachePlugin } from './RushHttpBuildCachePlugin';
+export default RushHttpBuildCachePlugin;
+export { IHttpBuildCacheProviderOptions } from './HttpBuildCacheProvider';
+//# 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":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,eAAe,wBAAwB,CAAC;AACxC,OAAO,EAAE,8BAA8B,EAAE,MAAM,0BAA0B,CAAC"}

package/lib/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const RushHttpBuildCachePlugin_1 = require("./RushHttpBuildCachePlugin");
+exports.default = RushHttpBuildCachePlugin_1.RushHttpBuildCachePlugin;
+//# 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,yEAAsE;AAEtE,kBAAe,mDAAwB,CAAC","sourcesContent":["import { RushHttpBuildCachePlugin } from './RushHttpBuildCachePlugin';\n\nexport default RushHttpBuildCachePlugin;\nexport { IHttpBuildCacheProviderOptions } from './HttpBuildCacheProvider';\n"]}

package/lib/schemas/plugin-config.schema.json

@@ -0,0 +1,52 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Configuration for build cache with HTTPS server",
+  "type": "object",
+  "required": ["url"],
+  "properties": {
+    "url": {
+      "type": "string",
+      "description": "(Required) The URL of the server that stores the caches (e.g. \"https://build-caches.example.com\").",
+      "format": "uri"
+    },
+    "uploadMethod": {
+      "type": "string",
+      "description": "(Optional) The HTTP method to use when writing to the cache (defaults to PUT).",
+      "enum": ["PUT", "POST", "PATCH"],
+      "default": "PUT"
+    },
+    "headers": {
+      "type": "object",
+      "description": "(Optional) HTTP headers to pass to the cache server",
+      "properties": {},
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
+    "tokenHandler": {
+      "type": "object",
+      "description": "(Optional) Shell command that prints the authorization token needed to communicate with the HTTPS server and exits with code 0. This command will be executed from the root of the monorepo.",
+      "properties": {
+        "exec": {
+          "type": "string",
+          "description": "(Required) The command or script to execute."
+        },
+        "args": {
+          "type": "array",
+          "description": "(Optional) Arguments to pass to the command or script.",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "cacheKeyPrefix": {
+      "type": "string",
+      "description": "(Optional) prefix for cache keys."
+    },
+    "isCacheWriteAllowed": {
+      "type": "boolean",
+      "description": "(Optional) If set to true, allow writing to the cache. Defaults to false."
+    }
+  }
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@rushstack/rush-http-build-cache-plugin",
+  "version": "5.92.0",
+  "description": "Rush plugin for generic HTTP cloud build cache",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/rushstack",
+    "directory": "rush-plugins/rush-http-build-cache-plugin"
+  },
+  "homepage": "https://rushjs.io",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "license": "MIT",
+  "dependencies": {
+    "https-proxy-agent": "~5.0.0",
+    "node-fetch": "2.6.7",
+    "@rushstack/node-core-library": "3.55.2",
+    "@rushstack/rush-sdk": "5.97.1"
+  },
+  "devDependencies": {
+    "@types/heft-jest": "1.0.1",
+    "@types/node": "14.18.36",
+    "@types/node-fetch": "2.6.2",
+    "@microsoft/rush-lib": "5.97.1",
+    "@rushstack/eslint-config": "3.2.0",
+    "@rushstack/heft": "0.50.0",
+    "@rushstack/heft-node-rig": "1.12.6"
+  },
+  "scripts": {
+    "build": "heft build --clean",
+    "start": "heft test --clean --watch",
+    "test": "heft test",
+    "_phase:build": "heft build --clean",
+    "_phase:test": "heft test --no-build"
+  }
+}

package/rush-logs/rush-http-build-cache-plugin._phase_build.log

@@ -0,0 +1,5 @@
+Build cache hit.
+Clearing cached folders: dist, lib, lib-commonjs, temp
+Successfully restored output from the build cache.
+
+Restoring cached log file at /home/vsts/work/1/s/rush-plugins/rush-http-build-cache-plugin/.rush/temp/operation/_phase_build/all.log