@backstage/plugin-catalog-backend-module-azure 0.3.20 → 0.3.22-next.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @backstage/plugin-catalog-backend-module-azure
 
+## 0.3.22-next.0
+
+### Patch Changes
+
+- 8b3c83e: Improved handling of Azure Blob Storage blob names when creating catalog locations.
+- Updated dependencies
+  - @backstage/integration@2.1.2-next.0
+  - @backstage/backend-plugin-api@1.10.1-next.0
+  - @backstage/plugin-catalog-node@2.2.5-next.0
+  - @backstage/plugin-events-node@0.4.26-next.0
+
 ## 0.3.20
 
 ### Patch Changes

package/dist/providers/AzureBlobStorageEntityProvider.cjs.js

@@ -6,6 +6,9 @@ var node_crypto = require('node:crypto');
 var config = require('./config.cjs.js');
 var integration = require('@backstage/integration');
 
+function hasDotPathSegment(path) {
+  return path.split(/[\\/]/).some((segment) => segment === "." || segment === "..");
+}
 class AzureBlobStorageEntityProvider {
   logger;
   connection;
@@ -114,7 +117,14 @@ class AzureBlobStorageEntityProvider {
     logger.info("Discovering Azure Blob Storage blobs");
     const keys = await this.listAllBlobKeys();
     logger.info(`Discovered ${keys.length} Azure Blob Storage blobs`);
-    const locations = keys.map((key) => this.createLocationSpec(key));
+    const validKeys = keys.filter((key) => !hasDotPathSegment(key));
+    const skippedKeys = keys.length - validKeys.length;
+    if (skippedKeys > 0) {
+      logger.warn(
+        `Skipped ${skippedKeys} Azure Blob Storage blobs with unsupported dot path segments`
+      );
+    }
+    const locations = validKeys.map((key) => this.createLocationSpec(key));
     await this.connection.applyMutation({
       type: "full",
       entities: locations.map((location) => {
@@ -148,8 +158,15 @@ class AzureBlobStorageEntityProvider {
     };
   }
   createObjectUrl(key) {
-    const endpoint = this.blobServiceClient?.url;
-    return `${endpoint}${this.config.containerName}/${key}`;
+    if (!this.blobServiceClient) {
+      throw new Error("Not initialized");
+    }
+    const objectUrl = new URL(
+      this.blobServiceClient.getContainerClient(this.config.containerName).getBlobClient(key).url
+    );
+    objectUrl.search = "";
+    objectUrl.hash = "";
+    return objectUrl.toString();
   }
 }
 

package/dist/providers/AzureBlobStorageEntityProvider.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"AzureBlobStorageEntityProvider.cjs.js","sources":["../../src/providers/AzureBlobStorageEntityProvider.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  AnonymousCredential,\n  BlobServiceClient,\n  ContainerClient,\n  StorageSharedKeyCredential,\n} from '@azure/storage-blob';\nimport { Config } from '@backstage/config';\nimport {\n  LoggerService,\n  SchedulerService,\n  SchedulerServiceTaskRunner,\n} from '@backstage/backend-plugin-api';\nimport {\n  EntityProvider,\n  EntityProviderConnection,\n  locationSpecToLocationEntity,\n} from '@backstage/plugin-catalog-node';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport { randomUUID } from 'node:crypto';\nimport { readAzureBlobStorageConfigs } from './config';\nimport {\n  AzureBlobStorageIntegration,\n  DefaultAzureCredentialsManager,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport { TokenCredential } from '@azure/identity';\nimport { AzureBlobStorageConfig } from './types';\n\n/**\n * Provider which discovers catalog files within an Azure Storage accounts.\n *\n * Use `AzureBlobStorageEntityProvider.fromConfig(...)` to create instances.\n *\n * @public\n */\nexport class AzureBlobStorageEntityProvider implements EntityProvider {\n  private readonly logger: LoggerService;\n  private connection?: EntityProviderConnection;\n  private blobServiceClient?: BlobServiceClient;\n  private readonly scheduleFn: () => Promise<void>;\n\n  static fromConfig(\n    configRoot: Config,\n    options: {\n      logger: LoggerService;\n      schedule?: SchedulerServiceTaskRunner;\n      scheduler?: SchedulerService;\n    },\n  ): AzureBlobStorageEntityProvider[] {\n    const providerConfigs = readAzureBlobStorageConfigs(configRoot);\n\n    const scmIntegration = ScmIntegrations.fromConfig(configRoot);\n    const credentialsProvider =\n      DefaultAzureCredentialsManager.fromIntegrations(scmIntegration);\n    if (!options.schedule && !options.scheduler) {\n      throw new Error('Either schedule or scheduler must be provided.');\n    }\n\n    return providerConfigs.map(providerConfig => {\n      const integration = scmIntegration.azureBlobStorage\n        .list()\n        .filter(\n          azureIntegration =>\n            azureIntegration.config.accountName === providerConfig.accountName,\n        )[0];\n\n      if (!options.schedule && !providerConfig.schedule) {\n        throw new Error(\n          `No schedule provided neither via code nor config for AzureBlobStorageEntityProvider:${providerConfig.id}.`,\n        );\n      }\n\n      if (!integration) {\n        throw new Error(\n          `There is no Azure blob storage integration for account. Please add a configuration entry for it under integrations.azureBlobStorage`,\n        );\n      }\n\n      const taskRunner =\n        options.schedule ??\n        options.scheduler!.createScheduledTaskRunner(providerConfig.schedule!);\n\n      return new AzureBlobStorageEntityProvider(\n        providerConfig,\n        integration,\n        credentialsProvider,\n        options.logger,\n        taskRunner,\n      );\n    });\n  }\n  private readonly config: AzureBlobStorageConfig;\n  private readonly integration: AzureBlobStorageIntegration;\n  private readonly credentialsProvider: DefaultAzureCredentialsManager;\n\n  private constructor(\n    config: AzureBlobStorageConfig,\n    integration: AzureBlobStorageIntegration,\n    credentialsProvider: DefaultAzureCredentialsManager,\n    logger: LoggerService,\n    schedule: SchedulerServiceTaskRunner,\n  ) {\n    this.config = config;\n    this.integration = integration;\n    this.credentialsProvider = credentialsProvider;\n    this.logger = logger.child({ target: this.getProviderName() });\n    this.scheduleFn = this.createScheduleFn(schedule);\n  }\n\n  private createScheduleFn(\n    taskRunner: SchedulerServiceTaskRunner,\n  ): () => Promise<void> {\n    return async () => {\n      const taskId = `${this.getProviderName()}:refresh`;\n      return taskRunner.run({\n        id: taskId,\n        fn: async () => {\n          const logger = this.logger.child({\n            class: AzureBlobStorageEntityProvider.prototype.constructor.name,\n            taskId,\n            taskInstanceId: randomUUID(),\n          });\n\n          try {\n            await this.refresh(logger);\n          } catch (error) {\n            logger.error(\n              `${this.getProviderName()} refresh failed, ${error}`,\n              error,\n            );\n          }\n        },\n      });\n    };\n  }\n\n  getProviderName(): string {\n    return `azureBlobStorage-provider:${this.config.id}`;\n  }\n\n  async connect(connection: EntityProviderConnection): Promise<void> {\n    this.connection = connection;\n    let credential:\n      | TokenCredential\n      | StorageSharedKeyCredential\n      | AnonymousCredential;\n    if (this.integration.config.accountKey) {\n      credential = new StorageSharedKeyCredential(\n        this.integration.config.accountName as string,\n        this.integration.config.accountKey as string,\n      ); // StorageSharedKeyCredential is only allowed in node.js runtime not in browser\n    } else {\n      credential = await this.credentialsProvider.getCredentials(\n        this.integration.config.accountName as string,\n      );\n    }\n    let blobServiceClientUrl: string;\n\n    if (this.integration.config.endpoint) {\n      if (this.integration.config.sasToken) {\n        blobServiceClientUrl = `${this.integration.config.endpoint}?${this.integration.config.sasToken}`;\n      } else {\n        blobServiceClientUrl = `${this.integration.config.endpoint}`;\n      }\n    } else {\n      blobServiceClientUrl = `https://${this.integration.config.accountName}.${this.integration.config.host}`;\n    }\n\n    this.blobServiceClient = new BlobServiceClient(\n      blobServiceClientUrl,\n      credential,\n    );\n    await this.scheduleFn();\n  }\n\n  async refresh(logger: LoggerService) {\n    if (!this.connection) {\n      throw new Error('Not initialized');\n    }\n\n    logger.info('Discovering Azure Blob Storage blobs');\n\n    const keys = await this.listAllBlobKeys();\n    logger.info(`Discovered ${keys.length} Azure Blob Storage blobs`);\n\n    const locations = keys.map(key => this.createLocationSpec(key));\n\n    await this.connection.applyMutation({\n      type: 'full',\n      entities: locations.map(location => {\n        return {\n          locationKey: this.getProviderName(),\n          entity: locationSpecToLocationEntity({ location }),\n        };\n      }),\n    });\n\n    logger.info(\n      `Committed ${locations.length} Locations for Azure Blob Storage blobs`,\n    );\n  }\n\n  private async listAllBlobKeys(): Promise<string[]> {\n    const keys: string[] = [];\n    const containerClient = this.blobServiceClient?.getContainerClient(\n      this.config.containerName,\n    );\n\n    for await (const blob of (\n      containerClient as ContainerClient\n    ).listBlobsFlat()) {\n      if (blob.name) {\n        keys.push(blob.name);\n      }\n    }\n\n    return keys;\n  }\n\n  private createLocationSpec(key: string): LocationSpec {\n    return {\n      type: 'url',\n      target: this.createObjectUrl(key),\n      presence: 'required',\n    };\n  }\n\n  private createObjectUrl(key: string): string {\n    const endpoint = this.blobServiceClient?.url;\n    return `${endpoint}${this.config.containerName}/${key}`;\n  }\n}\n"],"names":["readAzureBlobStorageConfigs","ScmIntegrations","DefaultAzureCredentialsManager","randomUUID","StorageSharedKeyCredential","BlobServiceClient","locationSpecToLocationEntity"],"mappings":";;;;;;;;AAmDO,MAAM,8BAAA,CAAyD;AAAA,EACnD,MAAA;AAAA,EACT,UAAA;AAAA,EACA,iBAAA;AAAA,EACS,UAAA;AAAA,EAEjB,OAAO,UAAA,CACL,UAAA,EACA,OAAA,EAKkC;AAClC,IAAA,MAAM,eAAA,GAAkBA,mCAA4B,UAAU,CAAA;AAE9D,IAAA,MAAM,cAAA,GAAiBC,2BAAA,CAAgB,UAAA,CAAW,UAAU,CAAA;AAC5D,IAAA,MAAM,mBAAA,GACJC,0CAAA,CAA+B,gBAAA,CAAiB,cAAc,CAAA;AAChE,IAAA,IAAI,CAAC,OAAA,CAAQ,QAAA,IAAY,CAAC,QAAQ,SAAA,EAAW;AAC3C,MAAA,MAAM,IAAI,MAAM,gDAAgD,CAAA;AAAA,IAClE;AAEA,IAAA,OAAO,eAAA,CAAgB,IAAI,CAAA,cAAA,KAAkB;AAC3C,MAAA,MAAM,WAAA,GAAc,cAAA,CAAe,gBAAA,CAChC,IAAA,EAAK,CACL,MAAA;AAAA,QACC,CAAA,gBAAA,KACE,gBAAA,CAAiB,MAAA,CAAO,WAAA,KAAgB,cAAA,CAAe;AAAA,QACzD,CAAC,CAAA;AAEL,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAA,IAAY,CAAC,eAAe,QAAA,EAAU;AACjD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,oFAAA,EAAuF,eAAe,EAAE,CAAA,CAAA;AAAA,SAC1G;AAAA,MACF;AAEA,MAAA,IAAI,CAAC,WAAA,EAAa;AAChB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,mIAAA;AAAA,SACF;AAAA,MACF;AAEA,MAAA,MAAM,aACJ,OAAA,CAAQ,QAAA,IACR,QAAQ,SAAA,CAAW,yBAAA,CAA0B,eAAe,QAAS,CAAA;AAEvE,MAAA,OAAO,IAAI,8BAAA;AAAA,QACT,cAAA;AAAA,QACA,WAAA;AAAA,QACA,mBAAA;AAAA,QACA,OAAA,CAAQ,MAAA;AAAA,QACR;AAAA,OACF;AAAA,IACF,CAAC,CAAA;AAAA,EACH;AAAA,EACiB,MAAA;AAAA,EACA,WAAA;AAAA,EACA,mBAAA;AAAA,EAET,WAAA,CACN,MAAA,EACA,WAAA,EACA,mBAAA,EACA,QACA,QAAA,EACA;AACA,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AACd,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AACnB,IAAA,IAAA,CAAK,mBAAA,GAAsB,mBAAA;AAC3B,IAAA,IAAA,CAAK,MAAA,GAAS,OAAO,KAAA,CAAM,EAAE,QAAQ,IAAA,CAAK,eAAA,IAAmB,CAAA;AAC7D,IAAA,IAAA,CAAK,UAAA,GAAa,IAAA,CAAK,gBAAA,CAAiB,QAAQ,CAAA;AAAA,EAClD;AAAA,EAEQ,iBACN,UAAA,EACqB;AACrB,IAAA,OAAO,YAAY;AACjB,MAAA,MAAM,MAAA,GAAS,CAAA,EAAG,IAAA,CAAK,eAAA,EAAiB,CAAA,QAAA,CAAA;AACxC,MAAA,OAAO,WAAW,GAAA,CAAI;AAAA,QACpB,EAAA,EAAI,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAA,MAAM,MAAA,GAAS,IAAA,CAAK,MAAA,CAAO,KAAA,CAAM;AAAA,YAC/B,KAAA,EAAO,8BAAA,CAA+B,SAAA,CAAU,WAAA,CAAY,IAAA;AAAA,YAC5D,MAAA;AAAA,YACA,gBAAgBC,sBAAA;AAAW,WAC5B,CAAA;AAED,UAAA,IAAI;AACF,YAAA,MAAM,IAAA,CAAK,QAAQ,MAAM,CAAA;AAAA,UAC3B,SAAS,KAAA,EAAO;AACd,YAAA,MAAA,CAAO,KAAA;AAAA,cACL,CAAA,EAAG,IAAA,CAAK,eAAA,EAAiB,oBAAoB,KAAK,CAAA,CAAA;AAAA,cAClD;AAAA,aACF;AAAA,UACF;AAAA,QACF;AAAA,OACD,CAAA;AAAA,IACH,CAAA;AAAA,EACF;AAAA,EAEA,eAAA,GAA0B;AACxB,IAAA,OAAO,CAAA,0BAAA,EAA6B,IAAA,CAAK,MAAA,CAAO,EAAE,CAAA,CAAA;AAAA,EACpD;AAAA,EAEA,MAAM,QAAQ,UAAA,EAAqD;AACjE,IAAA,IAAA,CAAK,UAAA,GAAa,UAAA;AAClB,IAAA,IAAI,UAAA;AAIJ,IAAA,IAAI,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,UAAA,EAAY;AACtC,MAAA,UAAA,GAAa,IAAIC,sCAAA;AAAA,QACf,IAAA,CAAK,YAAY,MAAA,CAAO,WAAA;AAAA,QACxB,IAAA,CAAK,YAAY,MAAA,CAAO;AAAA,OAC1B;AAAA,IACF,CAAA,MAAO;AACL,MAAA,UAAA,GAAa,MAAM,KAAK,mBAAA,CAAoB,cAAA;AAAA,QAC1C,IAAA,CAAK,YAAY,MAAA,CAAO;AAAA,OAC1B;AAAA,IACF;AACA,IAAA,IAAI,oBAAA;AAEJ,IAAA,IAAI,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,QAAA,EAAU;AACpC,MAAA,IAAI,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,QAAA,EAAU;AACpC,QAAA,oBAAA,GAAuB,CAAA,EAAG,KAAK,WAAA,CAAY,MAAA,CAAO,QAAQ,CAAA,CAAA,EAAI,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,QAAQ,CAAA,CAAA;AAAA,MAChG,CAAA,MAAO;AACL,QAAA,oBAAA,GAAuB,CAAA,EAAG,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,QAAQ,CAAA,CAAA;AAAA,MAC5D;AAAA,IACF,CAAA,MAAO;AACL,MAAA,oBAAA,GAAuB,CAAA,QAAA,EAAW,KAAK,WAAA,CAAY,MAAA,CAAO,WAAW,CAAA,CAAA,EAAI,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,IAAI,CAAA,CAAA;AAAA,IACvG;AAEA,IAAA,IAAA,CAAK,oBAAoB,IAAIC,6BAAA;AAAA,MAC3B,oBAAA;AAAA,MACA;AAAA,KACF;AACA,IAAA,MAAM,KAAK,UAAA,EAAW;AAAA,EACxB;AAAA,EAEA,MAAM,QAAQ,MAAA,EAAuB;AACnC,IAAA,IAAI,CAAC,KAAK,UAAA,EAAY;AACpB,MAAA,MAAM,IAAI,MAAM,iBAAiB,CAAA;AAAA,IACnC;AAEA,IAAA,MAAA,CAAO,KAAK,sCAAsC,CAAA;AAElD,IAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,eAAA,EAAgB;AACxC,IAAA,MAAA,CAAO,IAAA,CAAK,CAAA,WAAA,EAAc,IAAA,CAAK,MAAM,CAAA,yBAAA,CAA2B,CAAA;AAEhE,IAAA,MAAM,YAAY,IAAA,CAAK,GAAA,CAAI,SAAO,IAAA,CAAK,kBAAA,CAAmB,GAAG,CAAC,CAAA;AAE9D,IAAA,MAAM,IAAA,CAAK,WAAW,aAAA,CAAc;AAAA,MAClC,IAAA,EAAM,MAAA;AAAA,MACN,QAAA,EAAU,SAAA,CAAU,GAAA,CAAI,CAAA,QAAA,KAAY;AAClC,QAAA,OAAO;AAAA,UACL,WAAA,EAAa,KAAK,eAAA,EAAgB;AAAA,UAClC,MAAA,EAAQC,8CAAA,CAA6B,EAAE,QAAA,EAAU;AAAA,SACnD;AAAA,MACF,CAAC;AAAA,KACF,CAAA;AAED,IAAA,MAAA,CAAO,IAAA;AAAA,MACL,CAAA,UAAA,EAAa,UAAU,MAAM,CAAA,uCAAA;AAAA,KAC/B;AAAA,EACF;AAAA,EAEA,MAAc,eAAA,GAAqC;AACjD,IAAA,MAAM,OAAiB,EAAC;AACxB,IAAA,MAAM,eAAA,GAAkB,KAAK,iBAAA,EAAmB,kBAAA;AAAA,MAC9C,KAAK,MAAA,CAAO;AAAA,KACd;AAEA,IAAA,WAAA,MAAiB,IAAA,IACf,eAAA,CACA,aAAA,EAAc,EAAG;AACjB,MAAA,IAAI,KAAK,IAAA,EAAM;AACb,QAAA,IAAA,CAAK,IAAA,CAAK,KAAK,IAAI,CAAA;AAAA,MACrB;AAAA,IACF;AAEA,IAAA,OAAO,IAAA;AAAA,EACT;AAAA,EAEQ,mBAAmB,GAAA,EAA2B;AACpD,IAAA,OAAO;AAAA,MACL,IAAA,EAAM,KAAA;AAAA,MACN,MAAA,EAAQ,IAAA,CAAK,eAAA,CAAgB,GAAG,CAAA;AAAA,MAChC,QAAA,EAAU;AAAA,KACZ;AAAA,EACF;AAAA,EAEQ,gBAAgB,GAAA,EAAqB;AAC3C,IAAA,MAAM,QAAA,GAAW,KAAK,iBAAA,EAAmB,GAAA;AACzC,IAAA,OAAO,GAAG,QAAQ,CAAA,EAAG,KAAK,MAAA,CAAO,aAAa,IAAI,GAAG,CAAA,CAAA;AAAA,EACvD;AACF;;;;"}
+{"version":3,"file":"AzureBlobStorageEntityProvider.cjs.js","sources":["../../src/providers/AzureBlobStorageEntityProvider.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  AnonymousCredential,\n  BlobServiceClient,\n  ContainerClient,\n  StorageSharedKeyCredential,\n} from '@azure/storage-blob';\nimport { Config } from '@backstage/config';\nimport {\n  LoggerService,\n  SchedulerService,\n  SchedulerServiceTaskRunner,\n} from '@backstage/backend-plugin-api';\nimport {\n  EntityProvider,\n  EntityProviderConnection,\n  locationSpecToLocationEntity,\n} from '@backstage/plugin-catalog-node';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport { randomUUID } from 'node:crypto';\nimport { readAzureBlobStorageConfigs } from './config';\nimport {\n  AzureBlobStorageIntegration,\n  DefaultAzureCredentialsManager,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport { TokenCredential } from '@azure/identity';\nimport { AzureBlobStorageConfig } from './types';\n\nfunction hasDotPathSegment(path: string): boolean {\n  return path\n    .split(/[\\\\/]/)\n    .some(segment => segment === '.' || segment === '..');\n}\n\n/**\n * Provider which discovers catalog files within an Azure Storage accounts.\n *\n * Use `AzureBlobStorageEntityProvider.fromConfig(...)` to create instances.\n *\n * @public\n */\nexport class AzureBlobStorageEntityProvider implements EntityProvider {\n  private readonly logger: LoggerService;\n  private connection?: EntityProviderConnection;\n  private blobServiceClient?: BlobServiceClient;\n  private readonly scheduleFn: () => Promise<void>;\n\n  static fromConfig(\n    configRoot: Config,\n    options: {\n      logger: LoggerService;\n      schedule?: SchedulerServiceTaskRunner;\n      scheduler?: SchedulerService;\n    },\n  ): AzureBlobStorageEntityProvider[] {\n    const providerConfigs = readAzureBlobStorageConfigs(configRoot);\n\n    const scmIntegration = ScmIntegrations.fromConfig(configRoot);\n    const credentialsProvider =\n      DefaultAzureCredentialsManager.fromIntegrations(scmIntegration);\n    if (!options.schedule && !options.scheduler) {\n      throw new Error('Either schedule or scheduler must be provided.');\n    }\n\n    return providerConfigs.map(providerConfig => {\n      const integration = scmIntegration.azureBlobStorage\n        .list()\n        .filter(\n          azureIntegration =>\n            azureIntegration.config.accountName === providerConfig.accountName,\n        )[0];\n\n      if (!options.schedule && !providerConfig.schedule) {\n        throw new Error(\n          `No schedule provided neither via code nor config for AzureBlobStorageEntityProvider:${providerConfig.id}.`,\n        );\n      }\n\n      if (!integration) {\n        throw new Error(\n          `There is no Azure blob storage integration for account. Please add a configuration entry for it under integrations.azureBlobStorage`,\n        );\n      }\n\n      const taskRunner =\n        options.schedule ??\n        options.scheduler!.createScheduledTaskRunner(providerConfig.schedule!);\n\n      return new AzureBlobStorageEntityProvider(\n        providerConfig,\n        integration,\n        credentialsProvider,\n        options.logger,\n        taskRunner,\n      );\n    });\n  }\n  private readonly config: AzureBlobStorageConfig;\n  private readonly integration: AzureBlobStorageIntegration;\n  private readonly credentialsProvider: DefaultAzureCredentialsManager;\n\n  private constructor(\n    config: AzureBlobStorageConfig,\n    integration: AzureBlobStorageIntegration,\n    credentialsProvider: DefaultAzureCredentialsManager,\n    logger: LoggerService,\n    schedule: SchedulerServiceTaskRunner,\n  ) {\n    this.config = config;\n    this.integration = integration;\n    this.credentialsProvider = credentialsProvider;\n    this.logger = logger.child({ target: this.getProviderName() });\n    this.scheduleFn = this.createScheduleFn(schedule);\n  }\n\n  private createScheduleFn(\n    taskRunner: SchedulerServiceTaskRunner,\n  ): () => Promise<void> {\n    return async () => {\n      const taskId = `${this.getProviderName()}:refresh`;\n      return taskRunner.run({\n        id: taskId,\n        fn: async () => {\n          const logger = this.logger.child({\n            class: AzureBlobStorageEntityProvider.prototype.constructor.name,\n            taskId,\n            taskInstanceId: randomUUID(),\n          });\n\n          try {\n            await this.refresh(logger);\n          } catch (error) {\n            logger.error(\n              `${this.getProviderName()} refresh failed, ${error}`,\n              error,\n            );\n          }\n        },\n      });\n    };\n  }\n\n  getProviderName(): string {\n    return `azureBlobStorage-provider:${this.config.id}`;\n  }\n\n  async connect(connection: EntityProviderConnection): Promise<void> {\n    this.connection = connection;\n    let credential:\n      | TokenCredential\n      | StorageSharedKeyCredential\n      | AnonymousCredential;\n    if (this.integration.config.accountKey) {\n      credential = new StorageSharedKeyCredential(\n        this.integration.config.accountName as string,\n        this.integration.config.accountKey as string,\n      ); // StorageSharedKeyCredential is only allowed in node.js runtime not in browser\n    } else {\n      credential = await this.credentialsProvider.getCredentials(\n        this.integration.config.accountName as string,\n      );\n    }\n    let blobServiceClientUrl: string;\n\n    if (this.integration.config.endpoint) {\n      if (this.integration.config.sasToken) {\n        blobServiceClientUrl = `${this.integration.config.endpoint}?${this.integration.config.sasToken}`;\n      } else {\n        blobServiceClientUrl = `${this.integration.config.endpoint}`;\n      }\n    } else {\n      blobServiceClientUrl = `https://${this.integration.config.accountName}.${this.integration.config.host}`;\n    }\n\n    this.blobServiceClient = new BlobServiceClient(\n      blobServiceClientUrl,\n      credential,\n    );\n    await this.scheduleFn();\n  }\n\n  async refresh(logger: LoggerService) {\n    if (!this.connection) {\n      throw new Error('Not initialized');\n    }\n\n    logger.info('Discovering Azure Blob Storage blobs');\n\n    const keys = await this.listAllBlobKeys();\n    logger.info(`Discovered ${keys.length} Azure Blob Storage blobs`);\n\n    const validKeys = keys.filter(key => !hasDotPathSegment(key));\n    const skippedKeys = keys.length - validKeys.length;\n    if (skippedKeys > 0) {\n      logger.warn(\n        `Skipped ${skippedKeys} Azure Blob Storage blobs with unsupported dot path segments`,\n      );\n    }\n\n    const locations = validKeys.map(key => this.createLocationSpec(key));\n\n    await this.connection.applyMutation({\n      type: 'full',\n      entities: locations.map(location => {\n        return {\n          locationKey: this.getProviderName(),\n          entity: locationSpecToLocationEntity({ location }),\n        };\n      }),\n    });\n\n    logger.info(\n      `Committed ${locations.length} Locations for Azure Blob Storage blobs`,\n    );\n  }\n\n  private async listAllBlobKeys(): Promise<string[]> {\n    const keys: string[] = [];\n    const containerClient = this.blobServiceClient?.getContainerClient(\n      this.config.containerName,\n    );\n\n    for await (const blob of (\n      containerClient as ContainerClient\n    ).listBlobsFlat()) {\n      if (blob.name) {\n        keys.push(blob.name);\n      }\n    }\n\n    return keys;\n  }\n\n  private createLocationSpec(key: string): LocationSpec {\n    return {\n      type: 'url',\n      target: this.createObjectUrl(key),\n      presence: 'required',\n    };\n  }\n\n  private createObjectUrl(key: string): string {\n    if (!this.blobServiceClient) {\n      throw new Error('Not initialized');\n    }\n\n    const objectUrl = new URL(\n      this.blobServiceClient\n        .getContainerClient(this.config.containerName)\n        .getBlobClient(key).url,\n    );\n    objectUrl.search = '';\n    objectUrl.hash = '';\n    return objectUrl.toString();\n  }\n}\n"],"names":["readAzureBlobStorageConfigs","ScmIntegrations","DefaultAzureCredentialsManager","randomUUID","StorageSharedKeyCredential","BlobServiceClient","locationSpecToLocationEntity"],"mappings":";;;;;;;;AA4CA,SAAS,kBAAkB,IAAA,EAAuB;AAChD,EAAA,OAAO,IAAA,CACJ,MAAM,OAAO,CAAA,CACb,KAAK,CAAA,OAAA,KAAW,OAAA,KAAY,GAAA,IAAO,OAAA,KAAY,IAAI,CAAA;AACxD;AASO,MAAM,8BAAA,CAAyD;AAAA,EACnD,MAAA;AAAA,EACT,UAAA;AAAA,EACA,iBAAA;AAAA,EACS,UAAA;AAAA,EAEjB,OAAO,UAAA,CACL,UAAA,EACA,OAAA,EAKkC;AAClC,IAAA,MAAM,eAAA,GAAkBA,mCAA4B,UAAU,CAAA;AAE9D,IAAA,MAAM,cAAA,GAAiBC,2BAAA,CAAgB,UAAA,CAAW,UAAU,CAAA;AAC5D,IAAA,MAAM,mBAAA,GACJC,0CAAA,CAA+B,gBAAA,CAAiB,cAAc,CAAA;AAChE,IAAA,IAAI,CAAC,OAAA,CAAQ,QAAA,IAAY,CAAC,QAAQ,SAAA,EAAW;AAC3C,MAAA,MAAM,IAAI,MAAM,gDAAgD,CAAA;AAAA,IAClE;AAEA,IAAA,OAAO,eAAA,CAAgB,IAAI,CAAA,cAAA,KAAkB;AAC3C,MAAA,MAAM,WAAA,GAAc,cAAA,CAAe,gBAAA,CAChC,IAAA,EAAK,CACL,MAAA;AAAA,QACC,CAAA,gBAAA,KACE,gBAAA,CAAiB,MAAA,CAAO,WAAA,KAAgB,cAAA,CAAe;AAAA,QACzD,CAAC,CAAA;AAEL,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAA,IAAY,CAAC,eAAe,QAAA,EAAU;AACjD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,oFAAA,EAAuF,eAAe,EAAE,CAAA,CAAA;AAAA,SAC1G;AAAA,MACF;AAEA,MAAA,IAAI,CAAC,WAAA,EAAa;AAChB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,mIAAA;AAAA,SACF;AAAA,MACF;AAEA,MAAA,MAAM,aACJ,OAAA,CAAQ,QAAA,IACR,QAAQ,SAAA,CAAW,yBAAA,CAA0B,eAAe,QAAS,CAAA;AAEvE,MAAA,OAAO,IAAI,8BAAA;AAAA,QACT,cAAA;AAAA,QACA,WAAA;AAAA,QACA,mBAAA;AAAA,QACA,OAAA,CAAQ,MAAA;AAAA,QACR;AAAA,OACF;AAAA,IACF,CAAC,CAAA;AAAA,EACH;AAAA,EACiB,MAAA;AAAA,EACA,WAAA;AAAA,EACA,mBAAA;AAAA,EAET,WAAA,CACN,MAAA,EACA,WAAA,EACA,mBAAA,EACA,QACA,QAAA,EACA;AACA,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AACd,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AACnB,IAAA,IAAA,CAAK,mBAAA,GAAsB,mBAAA;AAC3B,IAAA,IAAA,CAAK,MAAA,GAAS,OAAO,KAAA,CAAM,EAAE,QAAQ,IAAA,CAAK,eAAA,IAAmB,CAAA;AAC7D,IAAA,IAAA,CAAK,UAAA,GAAa,IAAA,CAAK,gBAAA,CAAiB,QAAQ,CAAA;AAAA,EAClD;AAAA,EAEQ,iBACN,UAAA,EACqB;AACrB,IAAA,OAAO,YAAY;AACjB,MAAA,MAAM,MAAA,GAAS,CAAA,EAAG,IAAA,CAAK,eAAA,EAAiB,CAAA,QAAA,CAAA;AACxC,MAAA,OAAO,WAAW,GAAA,CAAI;AAAA,QACpB,EAAA,EAAI,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAA,MAAM,MAAA,GAAS,IAAA,CAAK,MAAA,CAAO,KAAA,CAAM;AAAA,YAC/B,KAAA,EAAO,8BAAA,CAA+B,SAAA,CAAU,WAAA,CAAY,IAAA;AAAA,YAC5D,MAAA;AAAA,YACA,gBAAgBC,sBAAA;AAAW,WAC5B,CAAA;AAED,UAAA,IAAI;AACF,YAAA,MAAM,IAAA,CAAK,QAAQ,MAAM,CAAA;AAAA,UAC3B,SAAS,KAAA,EAAO;AACd,YAAA,MAAA,CAAO,KAAA;AAAA,cACL,CAAA,EAAG,IAAA,CAAK,eAAA,EAAiB,oBAAoB,KAAK,CAAA,CAAA;AAAA,cAClD;AAAA,aACF;AAAA,UACF;AAAA,QACF;AAAA,OACD,CAAA;AAAA,IACH,CAAA;AAAA,EACF;AAAA,EAEA,eAAA,GAA0B;AACxB,IAAA,OAAO,CAAA,0BAAA,EAA6B,IAAA,CAAK,MAAA,CAAO,EAAE,CAAA,CAAA;AAAA,EACpD;AAAA,EAEA,MAAM,QAAQ,UAAA,EAAqD;AACjE,IAAA,IAAA,CAAK,UAAA,GAAa,UAAA;AAClB,IAAA,IAAI,UAAA;AAIJ,IAAA,IAAI,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,UAAA,EAAY;AACtC,MAAA,UAAA,GAAa,IAAIC,sCAAA;AAAA,QACf,IAAA,CAAK,YAAY,MAAA,CAAO,WAAA;AAAA,QACxB,IAAA,CAAK,YAAY,MAAA,CAAO;AAAA,OAC1B;AAAA,IACF,CAAA,MAAO;AACL,MAAA,UAAA,GAAa,MAAM,KAAK,mBAAA,CAAoB,cAAA;AAAA,QAC1C,IAAA,CAAK,YAAY,MAAA,CAAO;AAAA,OAC1B;AAAA,IACF;AACA,IAAA,IAAI,oBAAA;AAEJ,IAAA,IAAI,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,QAAA,EAAU;AACpC,MAAA,IAAI,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,QAAA,EAAU;AACpC,QAAA,oBAAA,GAAuB,CAAA,EAAG,KAAK,WAAA,CAAY,MAAA,CAAO,QAAQ,CAAA,CAAA,EAAI,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,QAAQ,CAAA,CAAA;AAAA,MAChG,CAAA,MAAO;AACL,QAAA,oBAAA,GAAuB,CAAA,EAAG,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,QAAQ,CAAA,CAAA;AAAA,MAC5D;AAAA,IACF,CAAA,MAAO;AACL,MAAA,oBAAA,GAAuB,CAAA,QAAA,EAAW,KAAK,WAAA,CAAY,MAAA,CAAO,WAAW,CAAA,CAAA,EAAI,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,IAAI,CAAA,CAAA;AAAA,IACvG;AAEA,IAAA,IAAA,CAAK,oBAAoB,IAAIC,6BAAA;AAAA,MAC3B,oBAAA;AAAA,MACA;AAAA,KACF;AACA,IAAA,MAAM,KAAK,UAAA,EAAW;AAAA,EACxB;AAAA,EAEA,MAAM,QAAQ,MAAA,EAAuB;AACnC,IAAA,IAAI,CAAC,KAAK,UAAA,EAAY;AACpB,MAAA,MAAM,IAAI,MAAM,iBAAiB,CAAA;AAAA,IACnC;AAEA,IAAA,MAAA,CAAO,KAAK,sCAAsC,CAAA;AAElD,IAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,eAAA,EAAgB;AACxC,IAAA,MAAA,CAAO,IAAA,CAAK,CAAA,WAAA,EAAc,IAAA,CAAK,MAAM,CAAA,yBAAA,CAA2B,CAAA;AAEhE,IAAA,MAAM,YAAY,IAAA,CAAK,MAAA,CAAO,SAAO,CAAC,iBAAA,CAAkB,GAAG,CAAC,CAAA;AAC5D,IAAA,MAAM,WAAA,GAAc,IAAA,CAAK,MAAA,GAAS,SAAA,CAAU,MAAA;AAC5C,IAAA,IAAI,cAAc,CAAA,EAAG;AACnB,MAAA,MAAA,CAAO,IAAA;AAAA,QACL,WAAW,WAAW,CAAA,4DAAA;AAAA,OACxB;AAAA,IACF;AAEA,IAAA,MAAM,YAAY,SAAA,CAAU,GAAA,CAAI,SAAO,IAAA,CAAK,kBAAA,CAAmB,GAAG,CAAC,CAAA;AAEnE,IAAA,MAAM,IAAA,CAAK,WAAW,aAAA,CAAc;AAAA,MAClC,IAAA,EAAM,MAAA;AAAA,MACN,QAAA,EAAU,SAAA,CAAU,GAAA,CAAI,CAAA,QAAA,KAAY;AAClC,QAAA,OAAO;AAAA,UACL,WAAA,EAAa,KAAK,eAAA,EAAgB;AAAA,UAClC,MAAA,EAAQC,8CAAA,CAA6B,EAAE,QAAA,EAAU;AAAA,SACnD;AAAA,MACF,CAAC;AAAA,KACF,CAAA;AAED,IAAA,MAAA,CAAO,IAAA;AAAA,MACL,CAAA,UAAA,EAAa,UAAU,MAAM,CAAA,uCAAA;AAAA,KAC/B;AAAA,EACF;AAAA,EAEA,MAAc,eAAA,GAAqC;AACjD,IAAA,MAAM,OAAiB,EAAC;AACxB,IAAA,MAAM,eAAA,GAAkB,KAAK,iBAAA,EAAmB,kBAAA;AAAA,MAC9C,KAAK,MAAA,CAAO;AAAA,KACd;AAEA,IAAA,WAAA,MAAiB,IAAA,IACf,eAAA,CACA,aAAA,EAAc,EAAG;AACjB,MAAA,IAAI,KAAK,IAAA,EAAM;AACb,QAAA,IAAA,CAAK,IAAA,CAAK,KAAK,IAAI,CAAA;AAAA,MACrB;AAAA,IACF;AAEA,IAAA,OAAO,IAAA;AAAA,EACT;AAAA,EAEQ,mBAAmB,GAAA,EAA2B;AACpD,IAAA,OAAO;AAAA,MACL,IAAA,EAAM,KAAA;AAAA,MACN,MAAA,EAAQ,IAAA,CAAK,eAAA,CAAgB,GAAG,CAAA;AAAA,MAChC,QAAA,EAAU;AAAA,KACZ;AAAA,EACF;AAAA,EAEQ,gBAAgB,GAAA,EAAqB;AAC3C,IAAA,IAAI,CAAC,KAAK,iBAAA,EAAmB;AAC3B,MAAA,MAAM,IAAI,MAAM,iBAAiB,CAAA;AAAA,IACnC;AAEA,IAAA,MAAM,YAAY,IAAI,GAAA;AAAA,MACpB,IAAA,CAAK,kBACF,kBAAA,CAAmB,IAAA,CAAK,OAAO,aAAa,CAAA,CAC5C,aAAA,CAAc,GAAG,CAAA,CAAE;AAAA,KACxB;AACA,IAAA,SAAA,CAAU,MAAA,GAAS,EAAA;AACnB,IAAA,SAAA,CAAU,IAAA,GAAO,EAAA;AACjB,IAAA,OAAO,UAAU,QAAA,EAAS;AAAA,EAC5B;AACF;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-azure",
-  "version": "0.3.20",
+  "version": "0.3.22-next.0",
   "description": "A Backstage catalog backend module that helps integrate towards Azure",
   "backstage": {
     "role": "backend-plugin-module",
@@ -67,17 +67,17 @@
   "dependencies": {
     "@azure/identity": "^4.0.0",
     "@azure/storage-blob": "^12.5.0",
-    "@backstage/backend-plugin-api": "^1.10.0",
-    "@backstage/config": "^1.3.8",
-    "@backstage/errors": "^1.3.1",
-    "@backstage/integration": "^2.1.0",
-    "@backstage/plugin-catalog-common": "^1.1.10",
-    "@backstage/plugin-catalog-node": "^2.2.4",
-    "@backstage/plugin-events-node": "^0.4.25"
+    "@backstage/backend-plugin-api": "1.10.1-next.0",
+    "@backstage/config": "1.3.8",
+    "@backstage/errors": "1.3.1",
+    "@backstage/integration": "2.1.2-next.0",
+    "@backstage/plugin-catalog-common": "1.1.10",
+    "@backstage/plugin-catalog-node": "2.2.5-next.0",
+    "@backstage/plugin-events-node": "0.4.26-next.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^1.11.6",
-    "@backstage/cli": "^0.36.5",
+    "@backstage/backend-test-utils": "1.11.7-next.0",
+    "@backstage/cli": "0.36.6-next.0",
     "msw": "^2.0.0"
   },
   "configSchema": "config.schema.json"