Add unit tests for streaming cache APIs and fill buffer-based test gaps

Agent-Logs-Url: https://github.com/microsoft/rushstack/sessions/86050f65-dd6c-45f4-ac41-95fdb860c053

Co-authored-by: iclanton <5010588+iclanton@users.noreply.github.com>

Author: Copilot

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

@@ -634,4 +634,187 @@ describe(AmazonS3Client.name, () => {
       );
     });
   });
+
+  describe('Streaming requests', () => {
+    let realDate: typeof Date;
+    let realSetTimeout: typeof setTimeout;
+    beforeEach(() => {
+      // mock date
+      realDate = global.Date;
+      global.Date = MockedDate as typeof Date;
+
+      // mock setTimeout
+      realSetTimeout = global.setTimeout;
+      global.setTimeout = ((callback: () => void, time: number) => {
+        return realSetTimeout(callback, 1);
+      }).bind(global) as typeof global.setTimeout;
+    });
+
+    afterEach(() => {
+      jest.restoreAllMocks();
+      global.Date = realDate;
+      global.setTimeout = realSetTimeout.bind(global);
+    });
+
+    describe('Getting an object stream', () => {
+      async function makeStreamGetRequestAsync(
+        credentials: IAmazonS3Credentials | undefined,
+        options: IAmazonS3BuildCacheProviderOptionsAdvanced,
+        objectName: string,
+        status: number,
+        statusText?: string
+      ): Promise<{ result: NodeJS.ReadableStream | undefined; spy: jest.SpyInstance }> {
+        const { Readable } = await import('node:stream');
+        const mockStream = new Readable({ read() {} });
+
+        const spy: jest.SpyInstance = jest
+          .spyOn(WebClient.prototype, 'fetchStreamAsync')
+          .mockReturnValue(
+            Promise.resolve({
+              stream: mockStream,
+              headers: {},
+              status,
+              statusText,
+              ok: status >= 200 && status < 300,
+              redirected: false
+            })
+          );
+
+        const s3Client: AmazonS3Client = new AmazonS3Client(credentials, options, webClient, terminal);
+        const result = await s3Client.getObjectStreamAsync(objectName);
+        return { result, spy };
+      }
+
+      it('Can get an object stream', async () => {
+        const { result, spy } = await makeStreamGetRequestAsync(
+          {
+            accessKeyId: 'accessKeyId',
+            secretAccessKey: 'secretAccessKey',
+            sessionToken: undefined
+          },
+          DUMMY_OPTIONS,
+          'abc123',
+          200
+        );
+        expect(result).toBeDefined();
+        expect(spy).toHaveBeenCalledTimes(1);
+        expect(spy.mock.calls[0]).toMatchSnapshot();
+        spy.mockRestore();
+      });
+
+      it('Returns undefined for a 404 (missing) object stream', async () => {
+        const { result, spy } = await makeStreamGetRequestAsync(
+          {
+            accessKeyId: 'accessKeyId',
+            secretAccessKey: 'secretAccessKey',
+            sessionToken: undefined
+          },
+          DUMMY_OPTIONS,
+          'abc123',
+          404,
+          'Not Found'
+        );
+        expect(result).toBeUndefined();
+        expect(spy).toHaveBeenCalledTimes(1);
+        spy.mockRestore();
+      });
+    });
+
+    describe('Uploading an object stream', () => {
+      it('Throws an error if credentials are not provided', async () => {
+        const { Readable } = await import('node:stream');
+        const s3Client: AmazonS3Client = new AmazonS3Client(
+          undefined,
+          { s3Endpoint: 'http://foo.bar.baz', ...DUMMY_OPTIONS_WITHOUT_ENDPOINT },
+          webClient,
+          terminal
+        );
+
+        const mockStream = new Readable({ read() {} });
+        try {
+          await s3Client.uploadObjectStreamAsync('temp', mockStream);
+          fail('Expected an exception to be thrown');
+        } catch (e) {
+          expect(e).toMatchSnapshot();
+        }
+      });
+
+      it('Uploads a stream successfully', async () => {
+        const { Readable } = await import('node:stream');
+        const mockStream = new Readable({ read() {} });
+        const responseStream = new Readable({ read() {} });
+
+        const spy: jest.SpyInstance = jest
+          .spyOn(WebClient.prototype, 'fetchStreamAsync')
+          .mockReturnValue(
+            Promise.resolve({
+              stream: responseStream,
+              headers: {},
+              status: 200,
+              statusText: 'OK',
+              ok: true,
+              redirected: false
+            })
+          );
+
+        const s3Client: AmazonS3Client = new AmazonS3Client(
+          {
+            accessKeyId: 'accessKeyId',
+            secretAccessKey: 'secretAccessKey',
+            sessionToken: undefined
+          },
+          DUMMY_OPTIONS,
+          webClient,
+          terminal
+        );
+
+        await s3Client.uploadObjectStreamAsync('abc123', mockStream);
+
+        expect(spy).toHaveBeenCalledTimes(1);
+        expect(spy.mock.calls[0]).toMatchSnapshot();
+        spy.mockRestore();
+      });
+
+      it('Does not retry on failure (stream consumed)', async () => {
+        const { Readable } = await import('node:stream');
+        const mockStream = new Readable({ read() {} });
+        const responseStream = new Readable({ read() {} });
+
+        const spy: jest.SpyInstance = jest
+          .spyOn(WebClient.prototype, 'fetchStreamAsync')
+          .mockReturnValue(
+            Promise.resolve({
+              stream: responseStream,
+              headers: {},
+              status: 500,
+              statusText: 'InternalServerError',
+              ok: false,
+              redirected: false
+            })
+          );
+
+        const s3Client: AmazonS3Client = new AmazonS3Client(
+          {
+            accessKeyId: 'accessKeyId',
+            secretAccessKey: 'secretAccessKey',
+            sessionToken: undefined
+          },
+          DUMMY_OPTIONS,
+          webClient,
+          terminal
+        );
+
+        try {
+          await s3Client.uploadObjectStreamAsync('abc123', mockStream);
+          fail('Expected an exception to be thrown');
+        } catch (e) {
+          expect((e as Error).message).toContain('500');
+        }
+
+        // Only 1 call - no retry for streams
+        expect(spy).toHaveBeenCalledTimes(1);
+        spy.mockRestore();
+      });
+    });
+  });
 });

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

@@ -548,3 +548,55 @@ exports[`AmazonS3Client Rejects invalid S3 endpoint values 9`] = `"Invalid S3 en
 exports[`AmazonS3Client Rejects invalid S3 endpoint values 10`] = `"Invalid S3 endpoint. Some part of the hostname contains invalid characters or is too long"`;
 
 exports[`AmazonS3Client Rejects invalid S3 endpoint values 11`] = `"Invalid S3 endpoint. Some part of the hostname contains invalid characters or is too long"`;
+
+exports[`AmazonS3Client Streaming requests Getting an object stream Can get an object stream 1`] = `
+Array [
+  "http://localhost:9000/abc123",
+  Object {
+    "headers": Object {
+      "Authorization": "AWS4-HMAC-SHA256 Credential=accessKeyId/20200418/us-east-1/s3/aws4_request,SignedHeaders=host;x-amz-content-sha256;x-amz-date,Signature=194608e9e7ba6d8aa4a019b3b6fd237e6b09ef1f45ff7fa60cbb81c1875538be",
+      "x-amz-content-sha256": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+      "x-amz-date": "20200418T123242Z",
+    },
+    "verb": "GET",
+  },
+]
+`;
+
+exports[`AmazonS3Client Streaming requests Uploading an object stream Throws an error if credentials are not provided 1`] = `[Error: Credentials are required to upload objects to S3.]`;
+
+exports[`AmazonS3Client Streaming requests Uploading an object stream Uploads a stream successfully 1`] = `
+Array [
+  "http://localhost:9000/abc123",
+  Object {
+    "body": Readable {
+      "_events": Object {
+        "close": undefined,
+        "data": undefined,
+        "end": undefined,
+        "error": undefined,
+        "readable": undefined,
+      },
+      "_maxListeners": undefined,
+      "_read": [Function],
+      "_readableState": ReadableState {
+        "awaitDrainWriters": null,
+        "buffer": Array [],
+        "bufferIndex": 0,
+        "highWaterMark": 65536,
+        "length": 0,
+        "pipes": Array [],
+        Symbol(kState): 1052940,
+      },
+      Symbol(shapeMode): true,
+      Symbol(kCapture): false,
+    },
+    "headers": Object {
+      "Authorization": "AWS4-HMAC-SHA256 Credential=accessKeyId/20200418/us-east-1/s3/aws4_request,SignedHeaders=host;x-amz-content-sha256;x-amz-date,Signature=bfc5ee97ccfdb44b7f351c0b550a1ac9c2cdb661606dbba8a74c11be6b5b2b72",
+      "x-amz-content-sha256": "UNSIGNED-PAYLOAD",
+      "x-amz-date": "20200418T123242Z",
+    },
+    "verb": "PUT",
+  },
+]
+`;