@backstage/plugin-catalog-backend-module-aws 0.4.16 → 0.4.17-next.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @backstage/plugin-catalog-backend-module-aws
 
+## 0.4.17-next.0
+
+### Patch Changes
+
+- 05f60e1: Refactored constructor parameter properties to explicit property declarations for compatibility with TypeScript's `erasableSyntaxOnly` setting. This internal refactoring maintains all existing functionality while ensuring TypeScript compilation compatibility.
+- Updated dependencies
+  - @backstage/backend-defaults@0.13.1-next.0
+  - @backstage/config@1.3.6-next.0
+  - @backstage/catalog-model@1.7.6-next.0
+  - @backstage/integration@1.18.2-next.0
+  - @backstage/integration-aws-node@0.1.19-next.0
+  - @backstage/backend-plugin-api@1.4.5-next.0
+  - @backstage/errors@1.2.7
+  - @backstage/plugin-catalog-common@1.1.7-next.0
+  - @backstage/plugin-catalog-node@1.19.2-next.0
+  - @backstage/plugin-kubernetes-common@0.9.8-next.0
+
 ## 0.4.16
 
 ### Patch Changes

package/dist/index.d.ts

@@ -101,9 +101,6 @@ declare class AwsS3DiscoveryProcessor implements CatalogProcessor {
  * @public
  */
 declare class AwsS3EntityProvider implements EntityProvider {
-    private readonly config;
-    private readonly integration;
-    private readonly awsCredentialsManager;
     private readonly logger;
     private s3?;
     private readonly scheduleFn;
@@ -114,6 +111,9 @@ declare class AwsS3EntityProvider implements EntityProvider {
         schedule?: SchedulerServiceTaskRunner;
         scheduler?: SchedulerService;
     }): AwsS3EntityProvider[];
+    private readonly config;
+    private readonly integration;
+    private readonly awsCredentialsManager;
     private constructor();
     private createScheduleFn;
     /** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */

package/dist/providers/AwsS3EntityProvider.cjs.js

@@ -29,15 +29,6 @@ function _interopNamespaceCompat(e) {
 var uuid__namespace = /*#__PURE__*/_interopNamespaceCompat(uuid);
 
 class AwsS3EntityProvider {
-  constructor(config, integration, awsCredentialsManager, logger, taskRunner) {
-    this.config = config;
-    this.integration = integration;
-    this.awsCredentialsManager = awsCredentialsManager;
-    this.logger = logger.child({
-      target: this.getProviderName()
-    });
-    this.scheduleFn = this.createScheduleFn(taskRunner);
-  }
   logger;
   s3;
   scheduleFn;
@@ -69,6 +60,18 @@ class AwsS3EntityProvider {
       );
     });
   }
+  config;
+  integration;
+  awsCredentialsManager;
+  constructor(config, integration, awsCredentialsManager, logger, taskRunner) {
+    this.config = config;
+    this.integration = integration;
+    this.awsCredentialsManager = awsCredentialsManager;
+    this.logger = logger.child({
+      target: this.getProviderName()
+    });
+    this.scheduleFn = this.createScheduleFn(taskRunner);
+  }
   createScheduleFn(taskRunner) {
     return async () => {
       const taskId = `${this.getProviderName()}:refresh`;

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

@@ -1 +1 @@
-{"version":3,"file":"AwsS3EntityProvider.cjs.js","sources":["../../src/providers/AwsS3EntityProvider.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 { Config } from '@backstage/config';\nimport { AwsS3Integration, ScmIntegrations } from '@backstage/integration';\nimport {\n  EntityProvider,\n  EntityProviderConnection,\n  locationSpecToLocationEntity,\n} from '@backstage/plugin-catalog-node';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport { readAwsS3Configs } from './config';\nimport { AwsS3Config } from './types';\nimport {\n  ListObjectsV2Command,\n  ListObjectsV2Output,\n  S3,\n} from '@aws-sdk/client-s3';\nimport * as uuid from 'uuid';\nimport { getEndpointFromInstructions } from '@aws-sdk/middleware-endpoint';\nimport {\n  AwsCredentialsManager,\n  DefaultAwsCredentialsManager,\n} from '@backstage/integration-aws-node';\nimport {\n  LoggerService,\n  SchedulerService,\n  SchedulerServiceTaskRunner,\n} from '@backstage/backend-plugin-api';\n\n// TODO: event-based updates using S3 events (+ queue like SQS)?\n/**\n * Provider which discovers catalog files (any name) within an S3 bucket.\n *\n * Use `AwsS3EntityProvider.fromConfig(...)` to create instances.\n *\n * @public\n */\nexport class AwsS3EntityProvider implements EntityProvider {\n  private readonly logger: LoggerService;\n  private s3?: S3;\n  private readonly scheduleFn: () => Promise<void>;\n  private connection?: EntityProviderConnection;\n  private endpoint?: string;\n\n  static fromConfig(\n    configRoot: Config,\n    options: {\n      logger: LoggerService;\n      schedule?: SchedulerServiceTaskRunner;\n      scheduler?: SchedulerService;\n    },\n  ): AwsS3EntityProvider[] {\n    const providerConfigs = readAwsS3Configs(configRoot);\n\n    // Even though the awsS3 integration allows a config array\n    // there is no *real* support for multiple configs.\n    // Usually, there will be just the integration for the default host.\n    // In case, a custom endpoint is used, the host from this endpoint\n    // will be extracted and used as host (e.g., localhost when used with LocalStack)\n    // and the default integration will be added as second integration.\n    // In this case, we still want the first one though, but have no means to select it\n    // just from the bucket name (and region).\n    const integration = ScmIntegrations.fromConfig(configRoot).awsS3.list()[0];\n    if (!integration) {\n      throw new Error('No integration found for awsS3');\n    }\n\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      if (!options.schedule && !providerConfig.schedule) {\n        throw new Error(\n          `No schedule provided neither via code nor config for awsS3-provider:${providerConfig.id}.`,\n        );\n      }\n      const awsCredentialsManager =\n        DefaultAwsCredentialsManager.fromConfig(configRoot);\n      const taskRunner =\n        options.schedule ??\n        options.scheduler!.createScheduledTaskRunner(providerConfig.schedule!);\n\n      return new AwsS3EntityProvider(\n        providerConfig,\n        integration,\n        awsCredentialsManager,\n        options.logger,\n        taskRunner,\n      );\n    });\n  }\n\n  private constructor(\n    private readonly config: AwsS3Config,\n    private readonly integration: AwsS3Integration,\n    private readonly awsCredentialsManager: AwsCredentialsManager,\n    logger: LoggerService,\n    taskRunner: SchedulerServiceTaskRunner,\n  ) {\n    this.logger = logger.child({\n      target: this.getProviderName(),\n    });\n\n    this.scheduleFn = this.createScheduleFn(taskRunner);\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: AwsS3EntityProvider.prototype.constructor.name,\n            taskId,\n            taskInstanceId: uuid.v4(),\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  /** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */\n  getProviderName(): string {\n    return `awsS3-provider:${this.config.id}`;\n  }\n\n  /** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */\n  async connect(connection: EntityProviderConnection): Promise<void> {\n    this.connection = connection;\n    const { accountId, region, bucketName } = this.config;\n    const credProvider = await this.awsCredentialsManager.getCredentialProvider(\n      accountId ? { accountId } : undefined,\n    );\n    this.s3 = new S3({\n      customUserAgent: 'backstage-aws-catalog-s3-entity-provider',\n      apiVersion: '2006-03-01',\n      credentialDefaultProvider: () => credProvider.sdkCredentialProvider,\n      endpoint: this.integration.config.endpoint,\n      region,\n      forcePathStyle: this.integration.config.s3ForcePathStyle,\n    });\n\n    // https://github.com/aws/aws-sdk-js-v3/issues/4122#issuecomment-1298968804\n    const endpoint = await getEndpointFromInstructions(\n      {\n        Bucket: bucketName,\n      },\n      ListObjectsV2Command,\n      this.s3.config as unknown as Record<string, unknown>,\n    );\n    if (endpoint?.url)\n      this.endpoint = endpoint.url.href.endsWith('/')\n        ? endpoint.url.href\n        : `${endpoint.url.href}/`;\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 AWS S3 objects');\n\n    const keys = await this.listAllObjectKeys();\n    logger.info(`Discovered ${keys.length} AWS S3 objects`);\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(`Committed ${locations.length} Locations for AWS S3 objects`);\n  }\n\n  private async listAllObjectKeys(): Promise<string[]> {\n    if (!this.s3) {\n      throw new Error('Not initialized');\n    }\n\n    const keys: string[] = [];\n\n    let continuationToken: string | undefined = undefined;\n    let output: ListObjectsV2Output;\n    do {\n      output = await this.s3.listObjectsV2({\n        Bucket: this.config.bucketName,\n        ContinuationToken: continuationToken,\n        Prefix: this.config.prefix,\n      });\n\n      if (output.Contents) {\n        output.Contents.forEach(item => {\n          if (item.Key && !item.Key.endsWith('/')) {\n            keys.push(item.Key);\n          }\n        });\n      }\n      continuationToken = output.NextContinuationToken;\n    } while (continuationToken);\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    return new URL(key, this.endpoint).href;\n  }\n}\n"],"names":["readAwsS3Configs","integration","ScmIntegrations","DefaultAwsCredentialsManager","uuid","S3","getEndpointFromInstructions","ListObjectsV2Command","locationSpecToLocationEntity"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmDO,MAAM,mBAAA,CAA8C;AAAA,EAwDjD,WAAA,CACW,MAAA,EACA,WAAA,EACA,qBAAA,EACjB,QACA,UAAA,EACA;AALiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,WAAA,GAAA,WAAA;AACA,IAAA,IAAA,CAAA,qBAAA,GAAA,qBAAA;AAIjB,IAAA,IAAA,CAAK,MAAA,GAAS,OAAO,KAAA,CAAM;AAAA,MACzB,MAAA,EAAQ,KAAK,eAAA;AAAgB,KAC9B,CAAA;AAED,IAAA,IAAA,CAAK,UAAA,GAAa,IAAA,CAAK,gBAAA,CAAiB,UAAU,CAAA;AAAA,EACpD;AAAA,EAnEiB,MAAA;AAAA,EACT,EAAA;AAAA,EACS,UAAA;AAAA,EACT,UAAA;AAAA,EACA,QAAA;AAAA,EAER,OAAO,UAAA,CACL,UAAA,EACA,OAAA,EAKuB;AACvB,IAAA,MAAM,eAAA,GAAkBA,wBAAiB,UAAU,CAAA;AAUnD,IAAA,MAAMC,aAAA,GAAcC,4BAAgB,UAAA,CAAW,UAAU,EAAE,KAAA,CAAM,IAAA,GAAO,CAAC,CAAA;AACzE,IAAA,IAAI,CAACD,aAAA,EAAa;AAChB,MAAA,MAAM,IAAI,MAAM,gCAAgC,CAAA;AAAA,IAClD;AAEA,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,IAAI,CAAC,OAAA,CAAQ,QAAA,IAAY,CAAC,eAAe,QAAA,EAAU;AACjD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,oEAAA,EAAuE,eAAe,EAAE,CAAA,CAAA;AAAA,SAC1F;AAAA,MACF;AACA,MAAA,MAAM,qBAAA,GACJE,+CAAA,CAA6B,UAAA,CAAW,UAAU,CAAA;AACpD,MAAA,MAAM,aACJ,OAAA,CAAQ,QAAA,IACR,QAAQ,SAAA,CAAW,yBAAA,CAA0B,eAAe,QAAS,CAAA;AAEvE,MAAA,OAAO,IAAI,mBAAA;AAAA,QACT,cAAA;AAAA,QACAF,aAAA;AAAA,QACA,qBAAA;AAAA,QACA,OAAA,CAAQ,MAAA;AAAA,QACR;AAAA,OACF;AAAA,IACF,CAAC,CAAA;AAAA,EACH;AAAA,EAgBQ,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,mBAAA,CAAoB,SAAA,CAAU,WAAA,CAAY,IAAA;AAAA,YACjD,MAAA;AAAA,YACA,cAAA,EAAgBG,gBAAK,EAAA;AAAG,WACzB,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;AAAA,EAGA,eAAA,GAA0B;AACxB,IAAA,OAAO,CAAA,eAAA,EAAkB,IAAA,CAAK,MAAA,CAAO,EAAE,CAAA,CAAA;AAAA,EACzC;AAAA;AAAA,EAGA,MAAM,QAAQ,UAAA,EAAqD;AACjE,IAAA,IAAA,CAAK,UAAA,GAAa,UAAA;AAClB,IAAA,MAAM,EAAE,SAAA,EAAW,MAAA,EAAQ,UAAA,KAAe,IAAA,CAAK,MAAA;AAC/C,IAAA,MAAM,YAAA,GAAe,MAAM,IAAA,CAAK,qBAAA,CAAsB,qBAAA;AAAA,MACpD,SAAA,GAAY,EAAE,SAAA,EAAU,GAAI;AAAA,KAC9B;AACA,IAAA,IAAA,CAAK,EAAA,GAAK,IAAIC,WAAA,CAAG;AAAA,MACf,eAAA,EAAiB,0CAAA;AAAA,MACjB,UAAA,EAAY,YAAA;AAAA,MACZ,yBAAA,EAA2B,MAAM,YAAA,CAAa,qBAAA;AAAA,MAC9C,QAAA,EAAU,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,QAAA;AAAA,MAClC,MAAA;AAAA,MACA,cAAA,EAAgB,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO;AAAA,KACzC,CAAA;AAGD,IAAA,MAAM,WAAW,MAAMC,8CAAA;AAAA,MACrB;AAAA,QACE,MAAA,EAAQ;AAAA,OACV;AAAA,MACAC,6BAAA;AAAA,MACA,KAAK,EAAA,CAAG;AAAA,KACV;AACA,IAAA,IAAI,QAAA,EAAU,GAAA;AACZ,MAAA,IAAA,CAAK,QAAA,GAAW,QAAA,CAAS,GAAA,CAAI,IAAA,CAAK,QAAA,CAAS,GAAG,CAAA,GAC1C,QAAA,CAAS,GAAA,CAAI,IAAA,GACb,CAAA,EAAG,QAAA,CAAS,IAAI,IAAI,CAAA,CAAA,CAAA;AAC1B,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,4BAA4B,CAAA;AAExC,IAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,iBAAA,EAAkB;AAC1C,IAAA,MAAA,CAAO,IAAA,CAAK,CAAA,WAAA,EAAc,IAAA,CAAK,MAAM,CAAA,eAAA,CAAiB,CAAA;AAEtD,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,CAAK,CAAA,UAAA,EAAa,SAAA,CAAU,MAAM,CAAA,6BAAA,CAA+B,CAAA;AAAA,EAC1E;AAAA,EAEA,MAAc,iBAAA,GAAuC;AACnD,IAAA,IAAI,CAAC,KAAK,EAAA,EAAI;AACZ,MAAA,MAAM,IAAI,MAAM,iBAAiB,CAAA;AAAA,IACnC;AAEA,IAAA,MAAM,OAAiB,EAAC;AAExB,IAAA,IAAI,iBAAA,GAAwC,MAAA;AAC5C,IAAA,IAAI,MAAA;AACJ,IAAA,GAAG;AACD,MAAA,MAAA,GAAS,MAAM,IAAA,CAAK,EAAA,CAAG,aAAA,CAAc;AAAA,QACnC,MAAA,EAAQ,KAAK,MAAA,CAAO,UAAA;AAAA,QACpB,iBAAA,EAAmB,iBAAA;AAAA,QACnB,MAAA,EAAQ,KAAK,MAAA,CAAO;AAAA,OACrB,CAAA;AAED,MAAA,IAAI,OAAO,QAAA,EAAU;AACnB,QAAA,MAAA,CAAO,QAAA,CAAS,QAAQ,CAAA,IAAA,KAAQ;AAC9B,UAAA,IAAI,KAAK,GAAA,IAAO,CAAC,KAAK,GAAA,CAAI,QAAA,CAAS,GAAG,CAAA,EAAG;AACvC,YAAA,IAAA,CAAK,IAAA,CAAK,KAAK,GAAG,CAAA;AAAA,UACpB;AAAA,QACF,CAAC,CAAA;AAAA,MACH;AACA,MAAA,iBAAA,GAAoB,MAAA,CAAO,qBAAA;AAAA,IAC7B,CAAA,QAAS,iBAAA;AAET,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,OAAO,IAAI,GAAA,CAAI,GAAA,EAAK,IAAA,CAAK,QAAQ,CAAA,CAAE,IAAA;AAAA,EACrC;AACF;;;;"}
+{"version":3,"file":"AwsS3EntityProvider.cjs.js","sources":["../../src/providers/AwsS3EntityProvider.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 { Config } from '@backstage/config';\nimport { AwsS3Integration, ScmIntegrations } from '@backstage/integration';\nimport {\n  EntityProvider,\n  EntityProviderConnection,\n  locationSpecToLocationEntity,\n} from '@backstage/plugin-catalog-node';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport { readAwsS3Configs } from './config';\nimport { AwsS3Config } from './types';\nimport {\n  ListObjectsV2Command,\n  ListObjectsV2Output,\n  S3,\n} from '@aws-sdk/client-s3';\nimport * as uuid from 'uuid';\nimport { getEndpointFromInstructions } from '@aws-sdk/middleware-endpoint';\nimport {\n  AwsCredentialsManager,\n  DefaultAwsCredentialsManager,\n} from '@backstage/integration-aws-node';\nimport {\n  LoggerService,\n  SchedulerService,\n  SchedulerServiceTaskRunner,\n} from '@backstage/backend-plugin-api';\n\n// TODO: event-based updates using S3 events (+ queue like SQS)?\n/**\n * Provider which discovers catalog files (any name) within an S3 bucket.\n *\n * Use `AwsS3EntityProvider.fromConfig(...)` to create instances.\n *\n * @public\n */\nexport class AwsS3EntityProvider implements EntityProvider {\n  private readonly logger: LoggerService;\n  private s3?: S3;\n  private readonly scheduleFn: () => Promise<void>;\n  private connection?: EntityProviderConnection;\n  private endpoint?: string;\n\n  static fromConfig(\n    configRoot: Config,\n    options: {\n      logger: LoggerService;\n      schedule?: SchedulerServiceTaskRunner;\n      scheduler?: SchedulerService;\n    },\n  ): AwsS3EntityProvider[] {\n    const providerConfigs = readAwsS3Configs(configRoot);\n\n    // Even though the awsS3 integration allows a config array\n    // there is no *real* support for multiple configs.\n    // Usually, there will be just the integration for the default host.\n    // In case, a custom endpoint is used, the host from this endpoint\n    // will be extracted and used as host (e.g., localhost when used with LocalStack)\n    // and the default integration will be added as second integration.\n    // In this case, we still want the first one though, but have no means to select it\n    // just from the bucket name (and region).\n    const integration = ScmIntegrations.fromConfig(configRoot).awsS3.list()[0];\n    if (!integration) {\n      throw new Error('No integration found for awsS3');\n    }\n\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      if (!options.schedule && !providerConfig.schedule) {\n        throw new Error(\n          `No schedule provided neither via code nor config for awsS3-provider:${providerConfig.id}.`,\n        );\n      }\n      const awsCredentialsManager =\n        DefaultAwsCredentialsManager.fromConfig(configRoot);\n      const taskRunner =\n        options.schedule ??\n        options.scheduler!.createScheduledTaskRunner(providerConfig.schedule!);\n\n      return new AwsS3EntityProvider(\n        providerConfig,\n        integration,\n        awsCredentialsManager,\n        options.logger,\n        taskRunner,\n      );\n    });\n  }\n\n  private readonly config: AwsS3Config;\n  private readonly integration: AwsS3Integration;\n  private readonly awsCredentialsManager: AwsCredentialsManager;\n\n  private constructor(\n    config: AwsS3Config,\n    integration: AwsS3Integration,\n    awsCredentialsManager: AwsCredentialsManager,\n    logger: LoggerService,\n    taskRunner: SchedulerServiceTaskRunner,\n  ) {\n    this.config = config;\n    this.integration = integration;\n    this.awsCredentialsManager = awsCredentialsManager;\n    this.logger = logger.child({\n      target: this.getProviderName(),\n    });\n\n    this.scheduleFn = this.createScheduleFn(taskRunner);\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: AwsS3EntityProvider.prototype.constructor.name,\n            taskId,\n            taskInstanceId: uuid.v4(),\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  /** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */\n  getProviderName(): string {\n    return `awsS3-provider:${this.config.id}`;\n  }\n\n  /** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */\n  async connect(connection: EntityProviderConnection): Promise<void> {\n    this.connection = connection;\n    const { accountId, region, bucketName } = this.config;\n    const credProvider = await this.awsCredentialsManager.getCredentialProvider(\n      accountId ? { accountId } : undefined,\n    );\n    this.s3 = new S3({\n      customUserAgent: 'backstage-aws-catalog-s3-entity-provider',\n      apiVersion: '2006-03-01',\n      credentialDefaultProvider: () => credProvider.sdkCredentialProvider,\n      endpoint: this.integration.config.endpoint,\n      region,\n      forcePathStyle: this.integration.config.s3ForcePathStyle,\n    });\n\n    // https://github.com/aws/aws-sdk-js-v3/issues/4122#issuecomment-1298968804\n    const endpoint = await getEndpointFromInstructions(\n      {\n        Bucket: bucketName,\n      },\n      ListObjectsV2Command,\n      this.s3.config as unknown as Record<string, unknown>,\n    );\n    if (endpoint?.url)\n      this.endpoint = endpoint.url.href.endsWith('/')\n        ? endpoint.url.href\n        : `${endpoint.url.href}/`;\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 AWS S3 objects');\n\n    const keys = await this.listAllObjectKeys();\n    logger.info(`Discovered ${keys.length} AWS S3 objects`);\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(`Committed ${locations.length} Locations for AWS S3 objects`);\n  }\n\n  private async listAllObjectKeys(): Promise<string[]> {\n    if (!this.s3) {\n      throw new Error('Not initialized');\n    }\n\n    const keys: string[] = [];\n\n    let continuationToken: string | undefined = undefined;\n    let output: ListObjectsV2Output;\n    do {\n      output = await this.s3.listObjectsV2({\n        Bucket: this.config.bucketName,\n        ContinuationToken: continuationToken,\n        Prefix: this.config.prefix,\n      });\n\n      if (output.Contents) {\n        output.Contents.forEach(item => {\n          if (item.Key && !item.Key.endsWith('/')) {\n            keys.push(item.Key);\n          }\n        });\n      }\n      continuationToken = output.NextContinuationToken;\n    } while (continuationToken);\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    return new URL(key, this.endpoint).href;\n  }\n}\n"],"names":["readAwsS3Configs","integration","ScmIntegrations","DefaultAwsCredentialsManager","uuid","S3","getEndpointFromInstructions","ListObjectsV2Command","locationSpecToLocationEntity"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmDO,MAAM,mBAAA,CAA8C;AAAA,EACxC,MAAA;AAAA,EACT,EAAA;AAAA,EACS,UAAA;AAAA,EACT,UAAA;AAAA,EACA,QAAA;AAAA,EAER,OAAO,UAAA,CACL,UAAA,EACA,OAAA,EAKuB;AACvB,IAAA,MAAM,eAAA,GAAkBA,wBAAiB,UAAU,CAAA;AAUnD,IAAA,MAAMC,aAAA,GAAcC,4BAAgB,UAAA,CAAW,UAAU,EAAE,KAAA,CAAM,IAAA,GAAO,CAAC,CAAA;AACzE,IAAA,IAAI,CAACD,aAAA,EAAa;AAChB,MAAA,MAAM,IAAI,MAAM,gCAAgC,CAAA;AAAA,IAClD;AAEA,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,IAAI,CAAC,OAAA,CAAQ,QAAA,IAAY,CAAC,eAAe,QAAA,EAAU;AACjD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,oEAAA,EAAuE,eAAe,EAAE,CAAA,CAAA;AAAA,SAC1F;AAAA,MACF;AACA,MAAA,MAAM,qBAAA,GACJE,+CAAA,CAA6B,UAAA,CAAW,UAAU,CAAA;AACpD,MAAA,MAAM,aACJ,OAAA,CAAQ,QAAA,IACR,QAAQ,SAAA,CAAW,yBAAA,CAA0B,eAAe,QAAS,CAAA;AAEvE,MAAA,OAAO,IAAI,mBAAA;AAAA,QACT,cAAA;AAAA,QACAF,aAAA;AAAA,QACA,qBAAA;AAAA,QACA,OAAA,CAAQ,MAAA;AAAA,QACR;AAAA,OACF;AAAA,IACF,CAAC,CAAA;AAAA,EACH;AAAA,EAEiB,MAAA;AAAA,EACA,WAAA;AAAA,EACA,qBAAA;AAAA,EAET,WAAA,CACN,MAAA,EACA,WAAA,EACA,qBAAA,EACA,QACA,UAAA,EACA;AACA,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AACd,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AACnB,IAAA,IAAA,CAAK,qBAAA,GAAwB,qBAAA;AAC7B,IAAA,IAAA,CAAK,MAAA,GAAS,OAAO,KAAA,CAAM;AAAA,MACzB,MAAA,EAAQ,KAAK,eAAA;AAAgB,KAC9B,CAAA;AAED,IAAA,IAAA,CAAK,UAAA,GAAa,IAAA,CAAK,gBAAA,CAAiB,UAAU,CAAA;AAAA,EACpD;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,mBAAA,CAAoB,SAAA,CAAU,WAAA,CAAY,IAAA;AAAA,YACjD,MAAA;AAAA,YACA,cAAA,EAAgBG,gBAAK,EAAA;AAAG,WACzB,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;AAAA,EAGA,eAAA,GAA0B;AACxB,IAAA,OAAO,CAAA,eAAA,EAAkB,IAAA,CAAK,MAAA,CAAO,EAAE,CAAA,CAAA;AAAA,EACzC;AAAA;AAAA,EAGA,MAAM,QAAQ,UAAA,EAAqD;AACjE,IAAA,IAAA,CAAK,UAAA,GAAa,UAAA;AAClB,IAAA,MAAM,EAAE,SAAA,EAAW,MAAA,EAAQ,UAAA,KAAe,IAAA,CAAK,MAAA;AAC/C,IAAA,MAAM,YAAA,GAAe,MAAM,IAAA,CAAK,qBAAA,CAAsB,qBAAA;AAAA,MACpD,SAAA,GAAY,EAAE,SAAA,EAAU,GAAI;AAAA,KAC9B;AACA,IAAA,IAAA,CAAK,EAAA,GAAK,IAAIC,WAAA,CAAG;AAAA,MACf,eAAA,EAAiB,0CAAA;AAAA,MACjB,UAAA,EAAY,YAAA;AAAA,MACZ,yBAAA,EAA2B,MAAM,YAAA,CAAa,qBAAA;AAAA,MAC9C,QAAA,EAAU,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,QAAA;AAAA,MAClC,MAAA;AAAA,MACA,cAAA,EAAgB,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO;AAAA,KACzC,CAAA;AAGD,IAAA,MAAM,WAAW,MAAMC,8CAAA;AAAA,MACrB;AAAA,QACE,MAAA,EAAQ;AAAA,OACV;AAAA,MACAC,6BAAA;AAAA,MACA,KAAK,EAAA,CAAG;AAAA,KACV;AACA,IAAA,IAAI,QAAA,EAAU,GAAA;AACZ,MAAA,IAAA,CAAK,QAAA,GAAW,QAAA,CAAS,GAAA,CAAI,IAAA,CAAK,QAAA,CAAS,GAAG,CAAA,GAC1C,QAAA,CAAS,GAAA,CAAI,IAAA,GACb,CAAA,EAAG,QAAA,CAAS,IAAI,IAAI,CAAA,CAAA,CAAA;AAC1B,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,4BAA4B,CAAA;AAExC,IAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,iBAAA,EAAkB;AAC1C,IAAA,MAAA,CAAO,IAAA,CAAK,CAAA,WAAA,EAAc,IAAA,CAAK,MAAM,CAAA,eAAA,CAAiB,CAAA;AAEtD,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,CAAK,CAAA,UAAA,EAAa,SAAA,CAAU,MAAM,CAAA,6BAAA,CAA+B,CAAA;AAAA,EAC1E;AAAA,EAEA,MAAc,iBAAA,GAAuC;AACnD,IAAA,IAAI,CAAC,KAAK,EAAA,EAAI;AACZ,MAAA,MAAM,IAAI,MAAM,iBAAiB,CAAA;AAAA,IACnC;AAEA,IAAA,MAAM,OAAiB,EAAC;AAExB,IAAA,IAAI,iBAAA,GAAwC,MAAA;AAC5C,IAAA,IAAI,MAAA;AACJ,IAAA,GAAG;AACD,MAAA,MAAA,GAAS,MAAM,IAAA,CAAK,EAAA,CAAG,aAAA,CAAc;AAAA,QACnC,MAAA,EAAQ,KAAK,MAAA,CAAO,UAAA;AAAA,QACpB,iBAAA,EAAmB,iBAAA;AAAA,QACnB,MAAA,EAAQ,KAAK,MAAA,CAAO;AAAA,OACrB,CAAA;AAED,MAAA,IAAI,OAAO,QAAA,EAAU;AACnB,QAAA,MAAA,CAAO,QAAA,CAAS,QAAQ,CAAA,IAAA,KAAQ;AAC9B,UAAA,IAAI,KAAK,GAAA,IAAO,CAAC,KAAK,GAAA,CAAI,QAAA,CAAS,GAAG,CAAA,EAAG;AACvC,YAAA,IAAA,CAAK,IAAA,CAAK,KAAK,GAAG,CAAA;AAAA,UACpB;AAAA,QACF,CAAC,CAAA;AAAA,MACH;AACA,MAAA,iBAAA,GAAoB,MAAA,CAAO,qBAAA;AAAA,IAC7B,CAAA,QAAS,iBAAA;AAET,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,OAAO,IAAI,GAAA,CAAI,GAAA,EAAK,IAAA,CAAK,QAAQ,CAAA,CAAE,IAAA;AAAA,EACrC;AACF;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-aws",
-  "version": "0.4.16",
+  "version": "0.4.17-next.0",
   "description": "A Backstage catalog backend module that helps integrate towards AWS",
   "backstage": {
     "role": "backend-plugin-module",
@@ -70,23 +70,23 @@
     "@aws-sdk/client-s3": "^3.350.0",
     "@aws-sdk/middleware-endpoint": "^3.347.0",
     "@aws-sdk/types": "^3.347.0",
-    "@backstage/backend-defaults": "^0.13.0",
-    "@backstage/backend-plugin-api": "^1.4.4",
-    "@backstage/catalog-model": "^1.7.5",
-    "@backstage/config": "^1.3.5",
-    "@backstage/errors": "^1.2.7",
-    "@backstage/integration": "^1.18.1",
-    "@backstage/integration-aws-node": "^0.1.18",
-    "@backstage/plugin-catalog-common": "^1.1.6",
-    "@backstage/plugin-catalog-node": "^1.19.1",
-    "@backstage/plugin-kubernetes-common": "^0.9.7",
+    "@backstage/backend-defaults": "0.13.1-next.0",
+    "@backstage/backend-plugin-api": "1.4.5-next.0",
+    "@backstage/catalog-model": "1.7.6-next.0",
+    "@backstage/config": "1.3.6-next.0",
+    "@backstage/errors": "1.2.7",
+    "@backstage/integration": "1.18.2-next.0",
+    "@backstage/integration-aws-node": "0.1.19-next.0",
+    "@backstage/plugin-catalog-common": "1.1.7-next.0",
+    "@backstage/plugin-catalog-node": "1.19.2-next.0",
+    "@backstage/plugin-kubernetes-common": "0.9.8-next.0",
     "p-limit": "^3.0.2",
     "uuid": "^11.0.0"
   },
   "devDependencies": {
     "@aws-sdk/util-stream-node": "^3.350.0",
-    "@backstage/backend-test-utils": "^1.9.1",
-    "@backstage/cli": "^0.34.4",
+    "@backstage/backend-test-utils": "1.10.0-next.0",
+    "@backstage/cli": "0.34.5-next.0",
     "aws-sdk-client-mock": "^4.0.0",
     "aws-sdk-client-mock-jest": "^4.0.0",
     "yaml": "^2.0.0"