@rushstack/rush-http-build-cache-plugin 5.110.0 → 5.110.1

package/src/RushHttpBuildCachePlugin.ts

@@ -1,81 +1,81 @@
-// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
-// See LICENSE in the project root for license information.
-
-import type { IRushPlugin, RushSession, RushConfiguration } from '@rushstack/rush-sdk';
-import type { HttpBuildCacheProvider, IHttpBuildCacheProviderOptions } from './HttpBuildCacheProvider';
-
-const PLUGIN_NAME: string = 'HttpBuildCachePlugin';
-
-/**
- * @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 class RushHttpBuildCachePlugin implements IRushPlugin {
-  public readonly pluginName: string = PLUGIN_NAME;
-
-  public apply(rushSession: RushSession, rushConfig: RushConfiguration): void {
-    rushSession.hooks.initialize.tap(this.pluginName, () => {
-      rushSession.registerCloudBuildCacheProviderFactory('http', async (buildCacheConfig) => {
-        const config: IRushHttpBuildCachePluginConfig = (
-          buildCacheConfig as typeof buildCacheConfig & {
-            httpConfiguration: IRushHttpBuildCachePluginConfig;
-          }
-        ).httpConfiguration;
-
-        const { url, uploadMethod, headers, tokenHandler, cacheKeyPrefix, isCacheWriteAllowed } = config;
-
-        const options: IHttpBuildCacheProviderOptions = {
-          pluginName: this.pluginName,
-          rushJsonFolder: rushConfig.rushJsonFolder,
-          url: url,
-          uploadMethod: uploadMethod,
-          headers: headers,
-          tokenHandler: tokenHandler,
-          cacheKeyPrefix: cacheKeyPrefix,
-          isCacheWriteAllowed: !!isCacheWriteAllowed
-        };
-
-        const { HttpBuildCacheProvider } = await import('./HttpBuildCacheProvider');
-        return new HttpBuildCacheProvider(options, rushSession);
-      });
-    });
-  }
-}
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import type { IRushPlugin, RushSession, RushConfiguration } from '@rushstack/rush-sdk';
+import type { HttpBuildCacheProvider, IHttpBuildCacheProviderOptions } from './HttpBuildCacheProvider';
+
+const PLUGIN_NAME: string = 'HttpBuildCachePlugin';
+
+/**
+ * @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 class RushHttpBuildCachePlugin implements IRushPlugin {
+  public readonly pluginName: string = PLUGIN_NAME;
+
+  public apply(rushSession: RushSession, rushConfig: RushConfiguration): void {
+    rushSession.hooks.initialize.tap(this.pluginName, () => {
+      rushSession.registerCloudBuildCacheProviderFactory('http', async (buildCacheConfig) => {
+        const config: IRushHttpBuildCachePluginConfig = (
+          buildCacheConfig as typeof buildCacheConfig & {
+            httpConfiguration: IRushHttpBuildCachePluginConfig;
+          }
+        ).httpConfiguration;
+
+        const { url, uploadMethod, headers, tokenHandler, cacheKeyPrefix, isCacheWriteAllowed } = config;
+
+        const options: IHttpBuildCacheProviderOptions = {
+          pluginName: this.pluginName,
+          rushJsonFolder: rushConfig.rushJsonFolder,
+          url: url,
+          uploadMethod: uploadMethod,
+          headers: headers,
+          tokenHandler: tokenHandler,
+          cacheKeyPrefix: cacheKeyPrefix,
+          isCacheWriteAllowed: !!isCacheWriteAllowed
+        };
+
+        const { HttpBuildCacheProvider } = await import('./HttpBuildCacheProvider');
+        return new HttpBuildCacheProvider(options, rushSession);
+      });
+    });
+  }
+}

package/src/index.ts

@@ -1,4 +1,4 @@
-import { RushHttpBuildCachePlugin } from './RushHttpBuildCachePlugin';
-
-export default RushHttpBuildCachePlugin;
-export { IHttpBuildCacheProviderOptions } from './HttpBuildCacheProvider';
+import { RushHttpBuildCachePlugin } from './RushHttpBuildCachePlugin';
+
+export default RushHttpBuildCachePlugin;
+export { IHttpBuildCacheProviderOptions } from './HttpBuildCacheProvider';

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

@@ -1,52 +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."
-    }
-  }
-}
+{
+  "$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/src/test/HttpBuildCacheProvider.test.ts

@@ -1,115 +1,115 @@
-// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
-// See LICENSE in the project root for license information.
-
-jest.mock('node-fetch', function () {
-  return Object.assign(jest.fn(), jest.requireActual('node-fetch'));
-});
-
-import fetch, { Response } from 'node-fetch';
-import { RushSession, EnvironmentConfiguration } from '@rushstack/rush-sdk';
-import { StringBufferTerminalProvider, Terminal } from '@rushstack/node-core-library';
-
-import { HttpBuildCacheProvider, type IHttpBuildCacheProviderOptions } from '../HttpBuildCacheProvider';
-
-const EXAMPLE_OPTIONS: IHttpBuildCacheProviderOptions = {
-  url: 'https://buildcache.example.acme.com',
-  tokenHandler: {
-    exec: 'node',
-    args: ['tokenHandler.js']
-  },
-  uploadMethod: 'POST',
-  isCacheWriteAllowed: false,
-  pluginName: 'example-plugin',
-  rushJsonFolder: '/repo',
-  minHttpRetryDelayMs: 1
-};
-
-describe('HttpBuildCacheProvider', () => {
-  let terminalBuffer: StringBufferTerminalProvider;
-  let terminal!: Terminal;
-
-  beforeEach(() => {
-    terminalBuffer = new StringBufferTerminalProvider();
-    terminal = new Terminal(terminalBuffer);
-  });
-
-  describe('tryGetCacheEntryBufferByIdAsync', () => {
-    it('prints warning if read credentials are not available', async () => {
-      jest.spyOn(EnvironmentConfiguration, 'buildCacheCredential', 'get').mockReturnValue(undefined);
-
-      const session: RushSession = {} as RushSession;
-      const provider = new HttpBuildCacheProvider(EXAMPLE_OPTIONS, session);
-
-      mocked(fetch).mockResolvedValue(
-        new Response('Unauthorized', {
-          status: 401,
-          statusText: 'Unauthorized'
-        })
-      );
-
-      const result = await provider.tryGetCacheEntryBufferByIdAsync(terminal, 'some-key');
-      expect(result).toBe(undefined);
-      expect(fetch).toHaveBeenCalledTimes(1);
-      expect(fetch).toHaveBeenNthCalledWith(1, '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]"`
-      );
-    });
-
-    it('attempts up to 3 times to download a cache entry', async () => {
-      jest.spyOn(EnvironmentConfiguration, 'buildCacheCredential', 'get').mockReturnValue(undefined);
-
-      const session: RushSession = {} as RushSession;
-      const provider = new HttpBuildCacheProvider(EXAMPLE_OPTIONS, session);
-
-      mocked(fetch).mockResolvedValueOnce(
-        new Response('InternalServiceError', {
-          status: 500,
-          statusText: 'InternalServiceError'
-        })
-      );
-      mocked(fetch).mockResolvedValueOnce(
-        new Response('ServiceUnavailable', {
-          status: 503,
-          statusText: 'ServiceUnavailable'
-        })
-      );
-      mocked(fetch).mockResolvedValueOnce(
-        new Response('BadGateway', {
-          status: 504,
-          statusText: 'BadGateway'
-        })
-      );
-
-      const result = await provider.tryGetCacheEntryBufferByIdAsync(terminal, 'some-key');
-      expect(result).toBe(undefined);
-      expect(fetch).toHaveBeenCalledTimes(3);
-      expect(fetch).toHaveBeenNthCalledWith(1, 'https://buildcache.example.acme.com/some-key', {
-        body: undefined,
-        headers: {},
-        method: 'GET',
-        redirect: 'follow'
-      });
-      expect(fetch).toHaveBeenNthCalledWith(2, 'https://buildcache.example.acme.com/some-key', {
-        body: undefined,
-        headers: {},
-        method: 'GET',
-        redirect: 'follow'
-      });
-      expect(fetch).toHaveBeenNthCalledWith(3, 'https://buildcache.example.acme.com/some-key', {
-        body: undefined,
-        headers: {},
-        method: 'GET',
-        redirect: 'follow'
-      });
-      expect(terminalBuffer.getWarningOutput()).toMatchInlineSnapshot(
-        `"Could not get cache entry: HTTP 504: BadGateway[n]"`
-      );
-    });
-  });
-});
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+jest.mock('node-fetch', function () {
+  return Object.assign(jest.fn(), jest.requireActual('node-fetch'));
+});
+
+import fetch, { Response } from 'node-fetch';
+import { RushSession, EnvironmentConfiguration } from '@rushstack/rush-sdk';
+import { StringBufferTerminalProvider, Terminal } from '@rushstack/node-core-library';
+
+import { HttpBuildCacheProvider, type IHttpBuildCacheProviderOptions } from '../HttpBuildCacheProvider';
+
+const EXAMPLE_OPTIONS: IHttpBuildCacheProviderOptions = {
+  url: 'https://buildcache.example.acme.com',
+  tokenHandler: {
+    exec: 'node',
+    args: ['tokenHandler.js']
+  },
+  uploadMethod: 'POST',
+  isCacheWriteAllowed: false,
+  pluginName: 'example-plugin',
+  rushJsonFolder: '/repo',
+  minHttpRetryDelayMs: 1
+};
+
+describe('HttpBuildCacheProvider', () => {
+  let terminalBuffer: StringBufferTerminalProvider;
+  let terminal!: Terminal;
+
+  beforeEach(() => {
+    terminalBuffer = new StringBufferTerminalProvider();
+    terminal = new Terminal(terminalBuffer);
+  });
+
+  describe('tryGetCacheEntryBufferByIdAsync', () => {
+    it('prints warning if read credentials are not available', async () => {
+      jest.spyOn(EnvironmentConfiguration, 'buildCacheCredential', 'get').mockReturnValue(undefined);
+
+      const session: RushSession = {} as RushSession;
+      const provider = new HttpBuildCacheProvider(EXAMPLE_OPTIONS, session);
+
+      mocked(fetch).mockResolvedValue(
+        new Response('Unauthorized', {
+          status: 401,
+          statusText: 'Unauthorized'
+        })
+      );
+
+      const result = await provider.tryGetCacheEntryBufferByIdAsync(terminal, 'some-key');
+      expect(result).toBe(undefined);
+      expect(fetch).toHaveBeenCalledTimes(1);
+      expect(fetch).toHaveBeenNthCalledWith(1, '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]"`
+      );
+    });
+
+    it('attempts up to 3 times to download a cache entry', async () => {
+      jest.spyOn(EnvironmentConfiguration, 'buildCacheCredential', 'get').mockReturnValue(undefined);
+
+      const session: RushSession = {} as RushSession;
+      const provider = new HttpBuildCacheProvider(EXAMPLE_OPTIONS, session);
+
+      mocked(fetch).mockResolvedValueOnce(
+        new Response('InternalServiceError', {
+          status: 500,
+          statusText: 'InternalServiceError'
+        })
+      );
+      mocked(fetch).mockResolvedValueOnce(
+        new Response('ServiceUnavailable', {
+          status: 503,
+          statusText: 'ServiceUnavailable'
+        })
+      );
+      mocked(fetch).mockResolvedValueOnce(
+        new Response('BadGateway', {
+          status: 504,
+          statusText: 'BadGateway'
+        })
+      );
+
+      const result = await provider.tryGetCacheEntryBufferByIdAsync(terminal, 'some-key');
+      expect(result).toBe(undefined);
+      expect(fetch).toHaveBeenCalledTimes(3);
+      expect(fetch).toHaveBeenNthCalledWith(1, 'https://buildcache.example.acme.com/some-key', {
+        body: undefined,
+        headers: {},
+        method: 'GET',
+        redirect: 'follow'
+      });
+      expect(fetch).toHaveBeenNthCalledWith(2, 'https://buildcache.example.acme.com/some-key', {
+        body: undefined,
+        headers: {},
+        method: 'GET',
+        redirect: 'follow'
+      });
+      expect(fetch).toHaveBeenNthCalledWith(3, 'https://buildcache.example.acme.com/some-key', {
+        body: undefined,
+        headers: {},
+        method: 'GET',
+        redirect: 'follow'
+      });
+      expect(terminalBuffer.getWarningOutput()).toMatchInlineSnapshot(
+        `"Could not get cache entry: HTTP 504: BadGateway[n]"`
+      );
+    });
+  });
+});