test(client-cloudwatch-logs): e2e test for protocol selection and event streams

Author: kuhe

clients/client-cloudwatch-logs/package.json

@@ -11,7 +11,9 @@
     "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
     "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
     "extract:docs": "api-extractor run --local",
-    "generate:client": "node ../../scripts/generate-clients/single-service --solo cloudwatch-logs"
+    "generate:client": "node ../../scripts/generate-clients/single-service --solo cloudwatch-logs",
+    "test:e2e": "yarn g:vitest run -c vitest.config.e2e.mts",
+    "test:e2e:watch": "yarn g:vitest watch -c vitest.config.e2e.mts"
   },
   "main": "./dist-cjs/index.js",
   "types": "./dist-types/index.d.ts",

clients/client-cloudwatch-logs/test/CloudWatchLogs.e2e.spec.ts

@@ -0,0 +1,73 @@
+import { CloudWatchLogs } from "@aws-sdk/client-cloudwatch-logs";
+import { AwsJson1_1Protocol, AwsSmithyRpcV2CborProtocol } from "@aws-sdk/core/protocols";
+import type { IncomingMessage } from "node:http";
+import { describe, expect, test as it } from "vitest";
+
+describe(
+  CloudWatchLogs.name,
+  () => {
+    const cwlDefault = new CloudWatchLogs({
+      region: "us-west-2",
+      protocol: new AwsJson1_1Protocol({
+        defaultNamespace: "com.amazonaws.cloudwatchlogs",
+        serviceTarget: "Logs_20140328",
+        awsQueryCompatible: false,
+      }),
+    });
+    const cwlCustom = new CloudWatchLogs({
+      region: "us-west-2",
+      protocol: new AwsSmithyRpcV2CborProtocol({ defaultNamespace: "com.amazonaws.cloudwatchlogs" }),
+    });
+
+    it("should be able to make requests with runtime protocol selection", async () => {
+      for (const cwl of [cwlDefault, cwlCustom]) {
+        const logGroups = await cwl.listLogGroups();
+
+        expect(logGroups).toMatchObject({
+          $metadata: {
+            httpStatusCode: 200,
+          },
+          logGroups: expect.any(Array),
+        });
+        expect(logGroups.nextToken ?? "").toBeTypeOf("string");
+      }
+    });
+
+    it("should be able to use an event stream to tail logs", async () => {
+      for (const cwl of [cwlDefault, cwlCustom]) {
+        const logGroups = await cwl.listLogGroups({
+          limit: 1,
+        });
+
+        const groupArn = logGroups.logGroups?.[0].logGroupArn;
+
+        if (groupArn) {
+          const liveTail = await cwl.startLiveTail({
+            logGroupIdentifiers: [groupArn],
+          });
+
+          let pagesRead = 0;
+
+          for await (const page of liveTail.responseStream ?? []) {
+            pagesRead += 1;
+
+            if (pagesRead === 1) {
+              expect(page.sessionStart?.requestId).toBeTypeOf("string");
+              expect(page.sessionStart?.sessionId).toBeTypeOf("string");
+              expect(page.sessionStart?.logGroupIdentifiers).toEqual([groupArn]);
+            } else if (pagesRead === 2) {
+              expect(page.sessionUpdate?.sessionMetadata).toMatchObject({
+                sampled: expect.any(Boolean),
+              });
+            } else if (pagesRead > 2) {
+              break;
+            }
+          }
+
+          cwl.destroy();
+        }
+      }
+    });
+  },
+  120_000
+);

clients/client-cloudwatch-logs/vitest.config.e2e.mts

@@ -0,0 +1,10 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    exclude: ["**/*.browser.e2e.spec.ts"],
+    include: ["**/*.e2e.spec.ts"],
+    environment: "node",
+  },
+  mode: "development",
+});