chore(eventstream-handler-node): eventstream code maintenance (#7708)

Author: kuhe

.eslintrc.js

@@ -28,18 +28,26 @@ module.exports = {
     /** Errors */
     "simple-import-sort/imports": "error",
     "sort-export-all/sort-export-all": "error",
+    "@typescript-eslint/consistent-type-imports": "error",
   },
   ignorePatterns: [
     "packages/nested-clients/src/submodules/**/protocols/*.ts",
     "packages/nested-clients/src/submodules/**/models/*.ts",
   ],
   overrides: [
     {
-      files: ["lib/*/src/**/*.ts", "clients/*/src/**/*.ts", "packages/*/src/**/*.ts", "private/*/src/**/*.ts"],
+      files: [
+        "lib/*/src/**/*.ts",
+        "clients/*/src/**/*.ts",
+        "packages/*/src/**/*.ts",
+        "packages-internal/*/src/**/*.ts",
+        "private/*/src/**/*.ts",
+      ],
       excludedFiles: [
         "lib/*/src/**/*.spec.ts",
         "clients/*/src/**/*.spec.ts",
         "packages/*/src/**/*.spec.ts",
+        "packages-internal/*/src/**/*.spec.ts",
         "private/*/src/**/*.spec.ts",
       ],
       rules: {

package.json

@@ -140,7 +140,7 @@
     }
   },
   "lint-staged": {
-    "{lib,packages}/**/src/**/*.ts": [
+    "{lib,packages,packages-internal}/**/src/**/*.ts": [
       "eslint --fix",
       "prettier --write"
     ],

…dler-node/src/EventSigningStream.spec.ts …/src/EventSigningTransformStream.spec.tspackages-internal/eventstream-handler-node/src/EventSigningStream.spec.ts renamed to packages-internal/eventstream-handler-node/src/EventSigningTransformStream.spec.ts packages-internal/eventstream-handler-node/src/EventSigningStream.spec.ts renamed to packages-internal/eventstream-handler-node/src/EventSigningTransformStream.spec.ts

@@ -1,9 +1,9 @@
 import { EventStreamCodec } from "@smithy/eventstream-codec";
-import { Message, MessageHeaders, SignedMessage } from "@smithy/types";
+import type { Message, MessageHeaders, SignedMessage } from "@smithy/types";
 import { fromUtf8, toUtf8 } from "@smithy/util-utf8";
 import { afterEach, describe, expect, test as it, vi } from "vitest";
 
-import { EventSigningStream } from "./EventSigningStream";
+import { EventSigningTransformStream } from "./EventSigningTransformStream";
 
 describe("EventSigningStream", () => {
   const originalDate = Date;
@@ -53,7 +53,7 @@ describe("EventSigningStream", () => {
     MockDate.now = () => MockDate().getTime();
     global.Date = MockDate as any;
 
-    const signingStream = new EventSigningStream({
+    const signingStream = new EventSigningTransformStream({
       priorSignature: "initial",
       messageSigner: {
         sign: mockMessageSigner,

…m-handler-node/src/EventSigningStream.ts …-node/src/EventSigningTransformStream.tspackages-internal/eventstream-handler-node/src/EventSigningStream.ts renamed to packages-internal/eventstream-handler-node/src/EventSigningTransformStream.ts packages-internal/eventstream-handler-node/src/EventSigningStream.ts renamed to packages-internal/eventstream-handler-node/src/EventSigningTransformStream.ts

@@ -1,6 +1,6 @@
-import { EventStreamCodec } from "@smithy/eventstream-codec";
-import { MessageHeaders, MessageSigner, Provider } from "@smithy/types";
-import { Transform, TransformCallback, TransformOptions } from "stream";
+import type { EventStreamCodec } from "@smithy/eventstream-codec";
+import type { MessageHeaders, MessageSigner, Provider } from "@smithy/types";
+import { type TransformCallback, type TransformOptions, Transform } from "node:stream";
 
 /**
  * @internal
@@ -13,11 +13,10 @@ export interface EventSigningStreamOptions extends TransformOptions {
 }
 
 /**
+ * A transform stream that signs the eventstream.
  * @internal
- *
- * A transform stream that signs the eventstream
  */
-export class EventSigningStream extends Transform {
+export class EventSigningTransformStream extends Transform {
   private priorSignature: string;
   private messageSigner: MessageSigner;
   private eventStreamCodec: EventStreamCodec;

packages-internal/eventstream-handler-node/src/EventStreamPayloadHandler.spec.ts

@@ -1,12 +1,19 @@
 import { EventStreamCodec } from "@smithy/eventstream-codec";
-import { Decoder, Encoder, FinalizeHandler, FinalizeHandlerArguments, HttpRequest, MessageSigner } from "@smithy/types";
-import { PassThrough, Readable } from "stream";
+import type {
+  Decoder,
+  Encoder,
+  FinalizeHandler,
+  FinalizeHandlerArguments,
+  HttpRequest,
+  MessageSigner,
+} from "@smithy/types";
+import { type Readable, PassThrough } from "node:stream";
 import { afterEach, beforeEach, describe, expect, test as it, vi } from "vitest";
 
-import { EventSigningStream } from "./EventSigningStream";
+import { EventSigningTransformStream } from "./EventSigningTransformStream";
 import { EventStreamPayloadHandler } from "./EventStreamPayloadHandler";
 
-vi.mock("./EventSigningStream");
+vi.mock("./EventSigningTransformStream");
 vi.mock("@smithy/eventstream-codec");
 
 describe(EventStreamPayloadHandler.name, () => {
@@ -28,7 +35,7 @@ describe(EventStreamPayloadHandler.name, () => {
   const mockNextHandler: FinalizeHandler<any, any> = vi.fn();
 
   beforeEach(() => {
-    (EventSigningStream as unknown as any).mockImplementation(function () {
+    (EventSigningTransformStream as unknown as any).mockImplementation(function () {
       return new PassThrough();
     });
     vi.mocked(EventStreamCodec).mockImplementation(function () {} as any);
@@ -97,8 +104,8 @@ describe(EventStreamPayloadHandler.name, () => {
       input: {},
     });
 
-    expect(EventSigningStream).toHaveBeenCalledTimes(1);
-    expect(EventSigningStream).toHaveBeenCalledWith({
+    expect(EventSigningTransformStream).toHaveBeenCalledTimes(1);
+    expect(EventSigningTransformStream).toHaveBeenCalledWith({
       priorSignature,
       eventStreamCodec: expect.anything(),
       messageSigner: expect.anything(),
@@ -129,8 +136,8 @@ describe(EventStreamPayloadHandler.name, () => {
       input: {},
     });
 
-    expect(EventSigningStream).toHaveBeenCalledTimes(1);
-    expect(EventSigningStream).toHaveBeenCalledWith({
+    expect(EventSigningTransformStream).toHaveBeenCalledTimes(1);
+    expect(EventSigningTransformStream).toHaveBeenCalledWith({
       priorSignature,
       eventStreamCodec: expect.anything(),
       messageSigner: expect.anything(),
@@ -224,7 +231,7 @@ describe(EventStreamPayloadHandler.name, () => {
 
     const pipelineError = new Error("ERR_STREAM_PREMATURE_CLOSE");
 
-    (EventSigningStream as unknown as any).mockImplementationOnce(function () {
+    (EventSigningTransformStream as unknown as any).mockImplementationOnce(function () {
       const stream = new PassThrough();
       // destroy stream after a short delay to simulate premature close
       setTimeout(() => stream.destroy(pipelineError), 10);

packages-internal/eventstream-handler-node/src/EventStreamPayloadHandler.ts

@@ -1,5 +1,5 @@
 import { EventStreamCodec } from "@smithy/eventstream-codec";
-import {
+import type {
   Decoder,
   Encoder,
   EventStreamPayloadHandler as IEventStreamPayloadHandler,
@@ -12,9 +12,9 @@ import {
   MetadataBearer,
   Provider,
 } from "@smithy/types";
-import { PassThrough, pipeline, Readable } from "stream";
+import { PassThrough, pipeline, Readable } from "node:stream";
 
-import { EventSigningStream } from "./EventSigningStream";
+import { EventSigningTransformStream } from "./EventSigningTransformStream";
 
 /**
  * @internal
@@ -28,12 +28,6 @@ export interface EventStreamPayloadHandlerOptions {
 
 /**
  * @internal
- *
- * A handler that control the eventstream payload flow:
- * 1. Pause stream for initial attempt.
- * 2. Close the stream is attempt fails.
- * 3. Start piping payload when connection is established.
- * 4. Sign the payload after payload stream starting to flow.
  */
 export class EventStreamPayloadHandler implements IEventStreamPayloadHandler {
   private readonly messageSigner: Provider<MessageSigner>;
@@ -67,7 +61,7 @@ export class EventStreamPayloadHandler implements IEventStreamPayloadHandler {
     const match = request.headers?.authorization?.match(/Signature=([\w]+)$/);
     // Sign the eventstream based on the signature from initial request.
     const priorSignature = match?.[1] ?? (query?.["X-Amz-Signature"] as string) ?? "";
-    const signingStream = new EventSigningStream({
+    const signingStream = new EventSigningTransformStream({
       priorSignature,
       eventStreamCodec: this.eventStreamCodec,
       messageSigner: await this.messageSigner(),

…/eventstream-payload-handler-provider.ts …src/eventStreamPayloadHandlerProvider.tspackages-internal/middleware-websocket/src/eventstream-payload-handler-provider.ts renamed to packages-internal/eventstream-handler-node/src/eventStreamPayloadHandlerProvider.ts packages-internal/middleware-websocket/src/eventstream-payload-handler-provider.ts renamed to packages-internal/eventstream-handler-node/src/eventStreamPayloadHandlerProvider.ts

@@ -1,4 +1,4 @@
-import { Decoder, Encoder, EventStreamPayloadHandlerProvider, MessageSigner, Provider } from "@smithy/types";
+import type { Decoder, Encoder, EventStreamPayloadHandlerProvider, MessageSigner, Provider } from "@smithy/types";
 
 import { EventStreamPayloadHandler } from "./EventStreamPayloadHandler";
 

packages-internal/eventstream-handler-node/src/index.ts

@@ -1,4 +1,4 @@
 /**
  * @internal
  */
-export { eventStreamPayloadHandlerProvider } from "./provider";
+export { eventStreamPayloadHandlerProvider } from "./eventStreamPayloadHandlerProvider";

packages-internal/middleware-websocket/package.json

@@ -32,7 +32,9 @@
     "@smithy/protocol-http": "^5.3.8",
     "@smithy/signature-v4": "^5.3.8",
     "@smithy/types": "^4.12.0",
+    "@smithy/util-base64": "^4.3.0",
     "@smithy/util-hex-encoding": "^4.2.0",
+    "@smithy/util-utf8": "^4.2.0",
     "tslib": "^2.6.2"
   },
   "devDependencies": {

…cket/src/websocket-fetch-handler.spec.ts …socket/src/WebSocketFetchHandler.spec.tspackages-internal/middleware-websocket/src/websocket-fetch-handler.spec.ts renamed to packages-internal/middleware-websocket/src/WebSocketFetchHandler.spec.ts packages-internal/middleware-websocket/src/websocket-fetch-handler.spec.ts renamed to packages-internal/middleware-websocket/src/WebSocketFetchHandler.spec.ts

@@ -1,11 +1,11 @@
 import { FetchHttpHandler } from "@smithy/fetch-http-handler";
 import { HttpRequest } from "@smithy/protocol-http";
 import { WebSocket } from "mock-socket";
-import { PassThrough } from "stream";
+import { PassThrough } from "node:stream";
 import { afterEach, beforeEach, describe, expect, test as it, vi } from "vitest";
 import WS from "vitest-websocket-mock";
 
-import { WebSocketFetchHandler } from "./websocket-fetch-handler";
+import { WebSocketFetchHandler } from "./WebSocketFetchHandler";
 
 vi.mock("@smithy/fetch-http-handler");