warn user if 403 error when no credentials are set

Author: ricsam

build-tests/rush-amazon-s3-build-cache-plugin-integration-test/README.md

@@ -17,7 +17,7 @@ In this folder run `docker-compose down`
 rushx read-s3-object
 ```
 
-# Test retries
+# Testing retries
 
 To test that requests can be retried start the proxy server which will fail every second request:
 

rush-plugins/rush-amazon-s3-build-cache-plugin/src/AmazonS3Client.ts

@@ -152,6 +152,12 @@ export class AmazonS3Client {
       ) {
         // unauthorized due to not providing credentials,
         // silence error for better DX when e.g. running locally without credentials
+        this._writeWarningLine(
+          `No credentials found and received a ${response.status}`,
+          ' response code from the cloud storage.',
+          ' Maybe run rush update-cloud-credentials',
+          ' or set the RUSH_BUILD_CACHE_CREDENTIAL env'
+        );
         return {
           hasNetworkError: false,
           response: undefined
@@ -193,7 +199,16 @@ export class AmazonS3Client {
     try {
       this._terminal.writeDebugLine(...messageParts);
     } catch (err) {
-      //
+      // ignore error
+    }
+  }
+
+  private _writeWarningLine(...messageParts: (string | IColorableSequence)[]): void {
+    // if the terminal has been closed then don't bother sending a warning message
+    try {
+      this._terminal.writeWarningLine(...messageParts);
+    } catch (err) {
+      // ignore error
     }
   }
 

rush-plugins/rush-amazon-s3-build-cache-plugin/src/test/AmazonS3Client.test.ts

@@ -452,10 +452,15 @@ describe(AmazonS3Client.name, () => {
 
         for (const code of [400, 401, 403]) {
           it(`Handles missing credentials object when ${code}`, async () => {
-            const result: Buffer | undefined = await makeGetRequestAsync(
+            let warningSpy: jest.SpyInstance<any, unknown[]> | undefined;
+            const result: Buffer | undefined = await makeS3ClientRequestAsync(
               undefined,
               DUMMY_OPTIONS,
-              'abc123',
+              async (s3Client) => {
+                (s3Client as any)._writeWarningLine = () => {};
+                warningSpy = jest.spyOn(s3Client as any, '_writeWarningLine');
+                return await s3Client.getObjectAsync('abc123');
+              },
               {
                 responseInit: {
                   status: code,
@@ -467,6 +472,13 @@ describe(AmazonS3Client.name, () => {
               }
             );
             expect(result).toBeUndefined();
+            expect(warningSpy).toHaveBeenNthCalledWith(
+              1,
+              `No credentials found and received a ${code}`,
+              ' response code from the cloud storage.',
+              ' Maybe run rush update-cloud-credentials',
+              ' or set the RUSH_BUILD_CACHE_CREDENTIAL env'
+            );
           });
         }
       });