Use the Executable module that exists, skip the shell by default

spring6225 · Mar 31, 2023 · 120eee9 · 120eee9
1 parent 769bb07
commit 120eee9
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 60 deletions.
diff --git a/rush-plugins/rush-http-build-cache-plugin/src/HttpBuildCacheProvider.test.ts b/rush-plugins/rush-http-build-cache-plugin/src/HttpBuildCacheProvider.test.ts
@@ -9,7 +9,10 @@ import { StringBufferTerminalProvider, Terminal } from '@rushstack/node-core-lib
 
 const EXAMPLE_OPTIONS = {
   url: 'https://buildcache.example.acme.com',
-  tokenHandler: 'node tokenHandler.js',
+  tokenHandler: {
+    exec: 'node',
+    args: ['tokenHandler.js']
+  },
   uploadMethod: 'POST',
   isCacheWriteAllowed: false,
   pluginName: 'example-plugin',

diff --git a/rush-plugins/rush-http-build-cache-plugin/src/HttpBuildCacheProvider.ts b/rush-plugins/rush-http-build-cache-plugin/src/HttpBuildCacheProvider.ts
@@ -1,4 +1,4 @@
-import { ITerminal } from '@rushstack/node-core-library';
+import { ITerminal, Executable } from '@rushstack/node-core-library';
 import {
   ICloudBuildCacheProvider,
   ICredentialCacheEntry,
@@ -7,7 +7,6 @@ import {
   EnvironmentConfiguration
 } from '@rushstack/rush-sdk';
 import fetch, { BodyInit, Response } from 'node-fetch';
-import { exec } from './exec';
 
 enum CredentialsOptions {
   Optional,
@@ -23,12 +22,17 @@ enum FailureType {
   Authentication
 }
 
+export interface IHttpBuildCacheTokenHandler {
+  exec: string;
+  args?: string[];
+}
+
 /**
  * @public
  */
 export interface IHttpBuildCacheProviderOptions {
   url: string;
-  tokenHandler?: string;
+  tokenHandler?: IHttpBuildCacheTokenHandler;
   uploadMethod?: string;
   headers?: Record<string, string>;
   cacheKeyPrefix?: string;
@@ -47,7 +51,7 @@ export class HttpBuildCacheProvider implements ICloudBuildCacheProvider {
   private readonly _uploadMethod: string;
   private readonly _headers: Record<string, string>;
   private readonly _cacheKeyPrefix: string;
-  private readonly _tokenHandler: string | undefined;
+  private readonly _tokenHandler: IHttpBuildCacheTokenHandler | undefined;
   private __credentialCacheId: string | undefined;
 
   public get isCacheWriteAllowed(): boolean {
@@ -133,7 +137,7 @@ export class HttpBuildCacheProvider implements ICloudBuildCacheProvider {
   }
 
   public async updateCachedCredentialInteractiveAsync(terminal: ITerminal): Promise<void> {
-    if (typeof this._tokenHandler !== 'string') {
+    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 ` +
@@ -142,9 +146,9 @@ export class HttpBuildCacheProvider implements ICloudBuildCacheProvider {
       );
     }
 
-    const cmd: string = this._tokenHandler;
+    const cmd: string = `${this._tokenHandler.exec} ${(this._tokenHandler.args || []).join(' ')}`;
     terminal.writeVerboseLine(`Running '${cmd}' to get credentials`);
-    const result = await exec(cmd, this._rushProjectRoot);
+    const result = Executable.spawnSync(this._tokenHandler.exec, this._tokenHandler.args || []);
 
     terminal.writeErrorLine(result.stderr);
 

diff --git a/rush-plugins/rush-http-build-cache-plugin/src/RushHttpBuildCachePlugin.ts b/rush-plugins/rush-http-build-cache-plugin/src/RushHttpBuildCachePlugin.ts
@@ -29,9 +29,13 @@ export interface IRushHttpBuildCachePluginOptions {
   headers?: Record<string, string>;
 
   /**
-   * An optional command that prints the endpoint's credentials to stdout.
+   * 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?: string;
+  tokenHandler?: {
+    exec: string;
+    args?: string[];
+  };
 
   /**
    * Prefix for cache keys.

diff --git a/rush-plugins/rush-http-build-cache-plugin/src/exec.test.ts b/rush-plugins/rush-http-build-cache-plugin/src/exec.test.ts
diff --git a/rush-plugins/rush-http-build-cache-plugin/src/exec.ts b/rush-plugins/rush-http-build-cache-plugin/src/exec.ts
diff --git a/rush-plugins/rush-http-build-cache-plugin/src/schemas/plugin-config.schema.json b/rush-plugins/rush-http-build-cache-plugin/src/schemas/plugin-config.schema.json
@@ -24,8 +24,21 @@
       }
     },
     "tokenHandler": {
-      "type": "string",
-      "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."
+      "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",