Expose retry configuration for all clients (#144)

* Expose retry configuration for all clients

* Change UrlTransferClient to have same retries as the frontend one

Author: aerimagne

cloud-agnostic/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/cloud-agnostic-core",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "description": "Package that allows configuring components loaded by dependency injection",
   "keywords": [
     "Bentley",

common/config/rush/version-policies.json

@@ -2,7 +2,7 @@
   {
     "definitionName": "lockStepVersion",
     "policyName": "lockStepVersionObjectStorage",
-    "version": "3.1.0",
+    "version": "3.1.1",
     "nextBump": "prerelease"
   }
 ]

storage/azure/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/object-storage-azure",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "description": "Object storage implementation using Azure Blob Storage",
   "keywords": [
     "Bentley",

storage/azure/src/client/AzureClientStorageBindings.ts

@@ -7,24 +7,38 @@ import { DependencyConfig, DIContainer } from "@itwin/cloud-agnostic-core";
 import {
   ClientStorage,
   ClientStorageDependency,
+  RetryOptions,
   Types as CoreTypes,
 } from "@itwin/object-storage-core";
 
-import { Constants } from "../common";
+import { Constants, Types } from "../common";
 import { BlockBlobClientWrapperFactory } from "../server/wrappers/BlockBlobClientWrapperFactory";
 
 import { AzureClientStorage } from "./AzureClientStorage";
 
+export interface AzureClientStorageBindingsConfig extends DependencyConfig {
+  retryOptions?: RetryOptions;
+}
+
 export class AzureClientStorageBindings extends ClientStorageDependency {
   public readonly dependencyName: string = Constants.storageType;
 
   public override register(
     container: DIContainer,
-    _config?: DependencyConfig
+    config?: AzureClientStorageBindingsConfig
   ): void {
+    container.registerInstance<AzureClientStorageBindingsConfig>(
+      Types.AzureClient.config,
+      config ?? { dependencyName: Constants.storageType }
+    );
     container.registerFactory(
       CoreTypes.Client.clientWrapperFactory,
-      () => new BlockBlobClientWrapperFactory()
+      (c: DIContainer) =>
+        new BlockBlobClientWrapperFactory(
+          c.resolve<AzureClientStorageBindingsConfig>(
+            Types.AzureClient.config
+          ).retryOptions
+        )
     );
     container.registerFactory<ClientStorage>(
       CoreTypes.Client.clientStorage,

storage/azure/src/common/Types.ts

@@ -8,6 +8,12 @@ const types = {
   AzureServer: {
     config: Symbol.for("Types.AzureServer.Config"),
   },
+  AzureClient: {
+    config: Symbol.for("Types.AzureClient.Config"),
+  },
+  AzureFrontend: {
+    config: Symbol.for("Types.AzureFrontend.Config"),
+  },
 };
 
 export { types as Types };

storage/azure/src/common/internal/Helpers.ts

@@ -2,12 +2,15 @@
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
+import { StoragePipelineOptions } from "@azure/storage-blob";
+
 import {
   assertPrimitiveType,
   FalsyValueError,
 } from "@itwin/cloud-agnostic-core/lib/internal";
 import {
   ObjectReference,
+  RetryOptions,
   TransferConfig,
 } from "@itwin/object-storage-core/lib/common";
 import {
@@ -42,3 +45,18 @@ export function buildBlobName(reference: ObjectReference): string {
   const { relativeDirectory, objectName } = reference;
   return (relativeDirectory ? `${relativeDirectory}/` : "") + objectName;
 }
+
+export function formatRetryOptions(
+  retryOptions: RetryOptions
+): StoragePipelineOptions {
+  return {
+    retryOptions: {
+      maxTries:
+        retryOptions.maxRetries !== undefined
+          ? retryOptions.maxRetries + 1
+          : undefined,
+      retryDelayInMs: retryOptions.retryDelayMs,
+      maxRetryDelayInMs: retryOptions.maxRetryDelayMs,
+    },
+  };
+}

storage/azure/src/frontend/AzureFrontendStorageBindings.ts

@@ -4,24 +4,47 @@
  *--------------------------------------------------------------------------------------------*/
 import {
   FrontendStorage,
+  FrontendStorageBindingsConfig,
   FrontendStorageDependency,
   Types as CoreTypes,
 } from "@itwin/object-storage-core/lib/frontend";
+import { FrontendUrlTransferClient } from "@itwin/object-storage-core/lib/frontend/internal";
 
 import { DIContainer } from "@itwin/cloud-agnostic-core";
 
-import { Constants } from "../common";
+import { Constants, Types } from "../common";
 
 import { AzureFrontendStorage } from "./AzureFrontendStorage";
 import { FrontendBlockBlobClientWrapperFactory } from "./wrappers";
 
 export class AzureFrontendStorageBindings extends FrontendStorageDependency {
   public readonly dependencyName: string = Constants.storageType;
 
-  public override register(container: DIContainer): void {
+  public override register(
+    container: DIContainer,
+    config?: FrontendStorageBindingsConfig
+  ): void {
+    container.registerInstance<FrontendStorageBindingsConfig>(
+      Types.AzureFrontend.config,
+      config ?? { dependencyName: Constants.storageType }
+    );
+    container.registerFactory<FrontendUrlTransferClient>(
+      CoreTypes.Frontend.urlTransferClient,
+      (c: DIContainer) =>
+        new FrontendUrlTransferClient(
+          c.resolve<FrontendStorageBindingsConfig>(
+            Types.AzureFrontend.config
+          ).retryOptions
+        )
+    );
     container.registerFactory<FrontendBlockBlobClientWrapperFactory>(
       CoreTypes.Frontend.clientWrapperFactory,
-      () => new FrontendBlockBlobClientWrapperFactory()
+      (c: DIContainer) =>
+        new FrontendBlockBlobClientWrapperFactory(
+          c.resolve<FrontendStorageBindingsConfig>(
+            Types.AzureFrontend.config
+          ).retryOptions
+        )
     );
     container.registerFactory<FrontendStorage>(
       CoreTypes.Frontend.frontendStorage,

storage/azure/src/frontend/wrappers/FrontendBlockBlobClientWrapperFactory.ts

@@ -5,19 +5,26 @@
 import { BlockBlobClient } from "@azure/storage-blob";
 
 import { instanceOfUrlTransferInput } from "@itwin/object-storage-core/lib/common/internal";
-import { UrlTransferInput } from "@itwin/object-storage-core/lib/frontend";
+import {
+  RetryOptions,
+  UrlTransferInput,
+} from "@itwin/object-storage-core/lib/frontend";
 
 import { AzureTransferConfigInput } from "../../common";
-import { buildBlobUrl } from "../../common/internal";
+import { buildBlobUrl, formatRetryOptions } from "../../common/internal";
 
 import { FrontendBlockBlobClientWrapper } from "./FrontendBlockBlobClientWrapper";
 
 export class FrontendBlockBlobClientWrapperFactory {
+  public constructor(private readonly _retryOptions: RetryOptions = {}) {}
+
   public create(
     input: UrlTransferInput | AzureTransferConfigInput
   ): FrontendBlockBlobClientWrapper {
     const blobClient = new BlockBlobClient(
-      instanceOfUrlTransferInput(input) ? input.url : buildBlobUrl(input)
+      instanceOfUrlTransferInput(input) ? input.url : buildBlobUrl(input),
+      undefined,
+      formatRetryOptions(this._retryOptions)
     );
     return new FrontendBlockBlobClientWrapper(blobClient);
   }

storage/azure/src/server/wrappers/BlobServiceClientWrapperFactory.ts

@@ -5,12 +5,13 @@
 import {
   BlobServiceClient,
   newPipeline,
-  StoragePipelineOptions,
   StorageSharedKeyCredential,
 } from "@azure/storage-blob";
 
 import { RetryOptions } from "@itwin/object-storage-core";
 
+import { formatRetryOptions } from "../../common/internal";
+
 import { BlobServiceClientWrapper } from "./BlobServiceClientWrapper";
 
 export interface AzureBlobServiceConfig {
@@ -27,20 +28,10 @@ export class BlobServiceClientWrapperFactory {
       config.accountName,
       config.accountKey
     );
-    const pipelineOptions: StoragePipelineOptions = {
-      retryOptions: {
-        maxTries:
-          this._retryOptions.maxRetries != undefined
-            ? this._retryOptions.maxRetries + 1
-            : undefined,
-        retryDelayInMs: this._retryOptions.retryDelayMs,
-        maxRetryDelayInMs: this._retryOptions.maxRetryDelayMs,
-      },
-    };
     return new BlobServiceClientWrapper(
       new BlobServiceClient(
         config.baseUrl,
-        newPipeline(credential, pipelineOptions)
+        newPipeline(credential, formatRetryOptions(this._retryOptions))
       )
     );
   }

storage/azure/src/server/wrappers/BlockBlobClientWrapperFactory.ts

@@ -6,19 +6,23 @@ import { BlockBlobClient } from "@azure/storage-blob";
 
 import { instanceOfUrlTransferInput } from "@itwin/object-storage-core/lib/common/internal";
 
-import { UrlTransferInput } from "@itwin/object-storage-core";
+import { RetryOptions, UrlTransferInput } from "@itwin/object-storage-core";
 
 import { AzureTransferConfigInput } from "../../common";
-import { buildBlobUrl } from "../../common/internal";
+import { buildBlobUrl, formatRetryOptions } from "../../common/internal";
 
 import { BlockBlobClientWrapper } from "./BlockBlobClientWrapper";
 
 export class BlockBlobClientWrapperFactory {
+  public constructor(private readonly _retryOptions: RetryOptions = {}) {}
+
   public create(
     input: UrlTransferInput | AzureTransferConfigInput
   ): BlockBlobClientWrapper {
     const blobClient = new BlockBlobClient(
-      instanceOfUrlTransferInput(input) ? input.url : buildBlobUrl(input)
+      instanceOfUrlTransferInput(input) ? input.url : buildBlobUrl(input),
+      undefined,
+      formatRetryOptions(this._retryOptions)
     );
     return new BlockBlobClientWrapper(blobClient);
   }