fix: warn streaming requests are not retryable (#1092)

* fix: warn streaming requests are not retryable

* format packages/middleware-retry/src/isStreamingPayload/isStreamingPayload.browser.ts

Co-authored-by: Trivikram Kamat <[email protected]>

* format packages/middleware-retry/src/isStreamingPayload/isStreamingPayload.ts

Co-authored-by: Trivikram Kamat <[email protected]>

* formatting

---------

Co-authored-by: Trivikram Kamat <[email protected]>

Author: kuhe

.changeset/selfish-ants-care.md

@@ -0,0 +1,5 @@
+---
+"@smithy/middleware-retry": patch
+---
+
+prevent retries of streaming requests

packages/middleware-retry/package.json

@@ -18,6 +18,13 @@
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
   "types": "./dist-types/index.d.ts",
+  "browser": {
+    "./dist-es/isStreamingPayload/isStreamingPayload": "./dist-es/isStreamingPayload/isStreamingPayload.browser"
+  },
+  "react-native": {
+    "./dist-cjs/isStreamingPayload/isStreamingPayload": "./dist-cjs/isStreamingPayload/isStreamingPayload.browser",
+    "./dist-es/isStreamingPayload/isStreamingPayload": "./dist-es/isStreamingPayload/isStreamingPayload.browser"
+  },
   "author": {
     "name": "AWS SDK for JavaScript Team",
     "url": "https://aws.amazon.com/javascript/"
@@ -27,6 +34,7 @@
     "@smithy/node-config-provider": "workspace:^",
     "@smithy/protocol-http": "workspace:^",
     "@smithy/service-error-classification": "workspace:^",
+    "@smithy/smithy-client": "workspace:^",
     "@smithy/types": "workspace:^",
     "@smithy/util-middleware": "workspace:^",
     "@smithy/util-retry": "workspace:^",

packages/middleware-retry/src/isStreamingPayload/isStreamingPayload.browser.ts

@@ -0,0 +1,6 @@
+import type { HttpRequest } from "@smithy/protocol-http";
+
+/**
+ * @internal
+ */
+export const isStreamingPayload = (request: HttpRequest): boolean => request?.body instanceof ReadableStream;

packages/middleware-retry/src/isStreamingPayload/isStreamingPayload.ts

@@ -0,0 +1,9 @@
+import type { HttpRequest } from "@smithy/protocol-http";
+import { Readable } from "stream";
+
+/**
+ * @internal
+ */
+export const isStreamingPayload = (request: HttpRequest): boolean =>
+  request?.body instanceof Readable ||
+  (typeof ReadableStream !== "undefined" && request?.body instanceof ReadableStream);

packages/middleware-retry/src/retryMiddleware.ts

@@ -1,5 +1,6 @@
 import { HttpRequest, HttpResponse } from "@smithy/protocol-http";
 import { isServerError, isThrottlingError, isTransientError } from "@smithy/service-error-classification";
+import { NoOpLogger } from "@smithy/smithy-client";
 import {
   AbsoluteLocation,
   FinalizeHandler,
@@ -20,6 +21,7 @@ import { INVOCATION_ID_HEADER, REQUEST_HEADER } from "@smithy/util-retry";
 import { v4 } from "uuid";
 
 import { RetryResolvedConfig } from "./configurations";
+import { isStreamingPayload } from "./isStreamingPayload/isStreamingPayload";
 import { asSdkError } from "./util";
 
 export const retryMiddleware = (options: RetryResolvedConfig) => <Output extends MetadataBearer = MetadataBearer>(
@@ -38,12 +40,14 @@ export const retryMiddleware = (options: RetryResolvedConfig) => <Output extends
     let attempts = 0;
     let totalRetryDelay = 0;
     const { request } = args;
-    if (HttpRequest.isInstance(request)) {
+    const isRequest = HttpRequest.isInstance(request);
+
+    if (isRequest) {
       request.headers[INVOCATION_ID_HEADER] = v4();
     }
     while (true) {
       try {
-        if (HttpRequest.isInstance(request)) {
+        if (isRequest) {
           request.headers[REQUEST_HEADER] = `attempt=${attempts + 1}; max=${maxAttempts}`;
         }
         const { response, output } = await next(args);
@@ -54,6 +58,14 @@ export const retryMiddleware = (options: RetryResolvedConfig) => <Output extends
       } catch (e) {
         const retryErrorInfo = getRetryErrorInfo(e);
         lastError = asSdkError(e);
+
+        if (isRequest && isStreamingPayload(request)) {
+          (context.logger instanceof NoOpLogger ? console : context.logger)?.warn(
+            "An error was encountered in a non-retryable streaming request."
+          );
+          throw lastError;
+        }
+
         try {
           retryToken = await retryStrategy.refreshRetryTokenForRetry(retryToken, retryErrorInfo);
         } catch (refreshError) {

turbo.json

@@ -4,7 +4,7 @@
   "pipeline": {
     "build": {
       "dependsOn": ["^build"],
-      "inputs": ["src", "package.json"],
+      "inputs": ["src/**/*", "package.json"],
       "outputs": ["dist-types", "dist-cjs", "dist-es"]
     },
     "test": {

yarn.lock

@@ -2117,6 +2117,7 @@ __metadata:
     "@smithy/node-config-provider": "workspace:^"
     "@smithy/protocol-http": "workspace:^"
     "@smithy/service-error-classification": "workspace:^"
+    "@smithy/smithy-client": "workspace:^"
     "@smithy/types": "workspace:^"
     "@smithy/util-middleware": "workspace:^"
     "@smithy/util-retry": "workspace:^"