Add retry to runtime extension

Author: AndrewFossAWS

.changeset/chilled-lies-care.md

@@ -0,0 +1,6 @@
+---
+"@smithy/smithy-client": minor
+"@smithy/types": minor
+---
+
+Add retry to runtime extension

packages/smithy-client/src/extensions/checksum.ts

@@ -6,25 +6,28 @@ export { AlgorithmId, ChecksumAlgorithm, ChecksumConfiguration };
 /**
  * @internal
  */
-export const getChecksumConfiguration = (
-  runtimeConfig: Partial<{
-    sha256: ChecksumConstructor | HashConstructor;
-    md5: ChecksumConstructor | HashConstructor;
-  }>
-) => {
-  const checksumAlgorithms: ChecksumAlgorithm[] = [];
+export type PartialChecksumRuntimeConfigType = Partial<{
+  sha256: ChecksumConstructor | HashConstructor;
+  md5: ChecksumConstructor | HashConstructor;
+  crc32: ChecksumConstructor | HashConstructor;
+  crc32c: ChecksumConstructor | HashConstructor;
+  sha1: ChecksumConstructor | HashConstructor;
+}>;
 
-  if (runtimeConfig.sha256 !== undefined) {
-    checksumAlgorithms.push({
-      algorithmId: () => AlgorithmId.SHA256,
-      checksumConstructor: () => runtimeConfig.sha256!,
-    });
-  }
+/**
+ * @internal
+ */
+export const getChecksumConfiguration = (runtimeConfig: PartialChecksumRuntimeConfigType) => {
+  const checksumAlgorithms: ChecksumAlgorithm[] = [];
 
-  if (runtimeConfig.md5 != undefined) {
+  for (const id in AlgorithmId) {
+    const algorithmId = AlgorithmId[id as keyof typeof AlgorithmId];
+    if (runtimeConfig[algorithmId] === undefined) {
+      continue;
+    }
     checksumAlgorithms.push({
-      algorithmId: () => AlgorithmId.MD5,
-      checksumConstructor: () => runtimeConfig.md5!,
+      algorithmId: () => algorithmId,
+      checksumConstructor: () => runtimeConfig[algorithmId]!,
     });
   }
 
@@ -42,9 +45,8 @@ export const getChecksumConfiguration = (
 /**
  * @internal
  */
-export const resolveChecksumRuntimeConfig = (clientConfig: ChecksumConfiguration) => {
-  const runtimeConfig: Partial<Record<AlgorithmId, HashConstructor | ChecksumConstructor>> = {};
-
+export const resolveChecksumRuntimeConfig = (clientConfig: ChecksumConfiguration): PartialChecksumRuntimeConfigType => {
+  const runtimeConfig: PartialChecksumRuntimeConfigType = {};
   clientConfig.checksumAlgorithms().forEach((checksumAlgorithm) => {
     runtimeConfig[checksumAlgorithm.algorithmId()] = checksumAlgorithm.checksumConstructor();
   });

packages/smithy-client/src/extensions/defaultExtensionConfiguration.ts

@@ -1,20 +1,22 @@
 import type { DefaultExtensionConfiguration } from "@smithy/types";
 
-import { getChecksumConfiguration, resolveChecksumRuntimeConfig } from "./checksum";
+import { getChecksumConfiguration, PartialChecksumRuntimeConfigType, resolveChecksumRuntimeConfig } from "./checksum";
+import { getRetryConfiguration, PartialRetryRuntimeConfigType, resolveRetryRuntimeConfig } from "./retry";
 
 /**
  * @internal
  */
-export type DefaultExtensionConfigType = Parameters<typeof getChecksumConfiguration>[0];
+export type DefaultExtensionRuntimeConfigType = PartialRetryRuntimeConfigType & PartialChecksumRuntimeConfigType;
 
 /**
  * @internal
  *
  * Helper function to resolve default extension configuration from runtime config
  */
-export const getDefaultExtensionConfiguration = (runtimeConfig: DefaultExtensionConfigType) => {
+export const getDefaultExtensionConfiguration = (runtimeConfig: DefaultExtensionRuntimeConfigType) => {
   return {
     ...getChecksumConfiguration(runtimeConfig),
+    ...getRetryConfiguration(runtimeConfig),
   };
 };
 
@@ -31,8 +33,11 @@ export const getDefaultClientConfiguration = getDefaultExtensionConfiguration;
  *
  * Helper function to resolve runtime config from default extension configuration
  */
-export const resolveDefaultRuntimeConfig = (config: DefaultExtensionConfiguration) => {
+export const resolveDefaultRuntimeConfig = (
+  config: DefaultExtensionConfiguration
+): DefaultExtensionRuntimeConfigType => {
   return {
     ...resolveChecksumRuntimeConfig(config),
+    ...resolveRetryRuntimeConfig(config),
   };
 };

packages/smithy-client/src/extensions/retry.ts

@@ -0,0 +1,29 @@
+import { Provider, RetryStrategy, RetryStrategyConfiguration, RetryStrategyV2 } from "@smithy/types";
+
+export type PartialRetryRuntimeConfigType = Partial<{ retryStrategy: Provider<RetryStrategyV2 | RetryStrategy> }>;
+
+/**
+ * @internal
+ */
+export const getRetryConfiguration = (runtimeConfig: PartialRetryRuntimeConfigType) => {
+  let _retryStrategy = runtimeConfig.retryStrategy!;
+  return {
+    setRetryStrategy(retryStrategy: Provider<RetryStrategyV2 | RetryStrategy>): void {
+      _retryStrategy = retryStrategy;
+    },
+    retryStrategy(): Provider<RetryStrategyV2 | RetryStrategy> {
+      return _retryStrategy;
+    },
+  };
+};
+
+/**
+ * @internal
+ */
+export const resolveRetryRuntimeConfig = (
+  retryStrategyConfiguration: RetryStrategyConfiguration
+): PartialRetryRuntimeConfigType => {
+  const runtimeConfig: PartialRetryRuntimeConfigType = {};
+  runtimeConfig.retryStrategy = retryStrategyConfiguration.retryStrategy();
+  return runtimeConfig;
+};

packages/types/src/extensions/defaultExtensionConfiguration.ts

@@ -1,10 +1,9 @@
 import { ChecksumConfiguration } from "./checksum";
+import { RetryStrategyConfiguration } from "./retry";
 
 /**
  * @internal
  *
  * Default extension configuration consisting various configurations for modifying a service client
  */
-export interface DefaultExtensionConfiguration extends ChecksumConfiguration {}
-
-type GetDefaultConfigurationType = (runtimeConfig: any) => DefaultExtensionConfiguration;
+export interface DefaultExtensionConfiguration extends ChecksumConfiguration, RetryStrategyConfiguration {}

packages/types/src/extensions/index.ts

@@ -1,3 +1,4 @@
 export * from "./defaultClientConfiguration";
 export * from "./defaultExtensionConfiguration";
 export { AlgorithmId, ChecksumAlgorithm, ChecksumConfiguration } from "./checksum";
+export { RetryStrategyConfiguration } from "./retry";

packages/types/src/extensions/retry.ts

@@ -0,0 +1,20 @@
+import { RetryStrategyV2 } from "../retry";
+import { Provider, RetryStrategy } from "../util";
+
+/**
+ * A configuration interface with methods called by runtime extension
+ * @internal
+ */
+export interface RetryStrategyConfiguration {
+  /**
+   * Set retry strategy used for all http requests
+   * @param retryStrategy
+   */
+  setRetryStrategy(retryStrategy: Provider<RetryStrategyV2 | RetryStrategy>): void;
+
+  /**
+   * Get retry strategy used for all http requests
+   * @param retryStrategy
+   */
+  retryStrategy(): Provider<RetryStrategyV2 | RetryStrategy>;
+}