feat(catalog/awsS3): Add backend plugin

Add `awsS3EntityProviderCatalogModule` (new backend-plugin-api, alpha).

Relates-to: PR #13859
Signed-off-by: Patrick Jungermann <Patrick.Jungermann@gmail.com>

.changeset/kind-emus-juggle.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-catalog-backend-module-aws': patch
+---
+
+Add `awsS3EntityProviderCatalogModule` (new backend-plugin-api, alpha).

plugins/catalog-backend-module-aws/api-report.md

@@ -3,6 +3,7 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
 ```ts
+import { BackendFeature } from '@backstage/backend-plugin-api';
 import { CatalogProcessor } from '@backstage/plugin-catalog-backend';
 import { CatalogProcessorEmit } from '@backstage/plugin-catalog-backend';
 import { CatalogProcessorParser } from '@backstage/plugin-catalog-backend';
@@ -87,4 +88,9 @@ export class AwsS3EntityProvider implements EntityProvider {
   // (undocumented)
   refresh(logger: Logger): Promise<void>;
 }
+
+// @alpha
+export const awsS3EntityProviderCatalogModule: (
+  options?: undefined,
+) => BackendFeature;
 ```

plugins/catalog-backend-module-aws/package.json

@@ -7,6 +7,7 @@
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public",
+    "alphaTypes": "dist/index.alpha.d.ts",
     "main": "dist/index.cjs.js",
     "types": "dist/index.d.ts"
   },
@@ -23,22 +24,24 @@
     "backstage"
   ],
   "scripts": {
-    "build": "backstage-cli package build",
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build --experimental-type-build",
     "lint": "backstage-cli package lint",
     "test": "backstage-cli package test",
     "prepack": "backstage-cli package prepack",
     "postpack": "backstage-cli package postpack",
-    "clean": "backstage-cli package clean",
-    "start": "backstage-cli package start"
+    "clean": "backstage-cli package clean"
   },
   "dependencies": {
     "@backstage/backend-common": "workspace:^",
+    "@backstage/backend-plugin-api": "workspace:^",
     "@backstage/backend-tasks": "workspace:^",
     "@backstage/catalog-model": "workspace:^",
     "@backstage/config": "workspace:^",
     "@backstage/errors": "workspace:^",
     "@backstage/integration": "workspace:^",
     "@backstage/plugin-catalog-backend": "workspace:^",
+    "@backstage/plugin-catalog-node": "workspace:^",
     "@backstage/types": "workspace:^",
     "aws-sdk": "^2.840.0",
     "lodash": "^4.17.21",
@@ -47,6 +50,7 @@
     "winston": "^3.2.1"
   },
   "devDependencies": {
+    "@backstage/backend-test-utils": "workspace:^",
     "@backstage/cli": "workspace:^",
     "@types/lodash": "^4.14.151",
     "aws-sdk-mock": "^5.2.1",
@@ -54,8 +58,9 @@
     "yaml": "^2.0.0"
   },
   "files": [
-    "dist",
-    "config.d.ts"
+    "alpha",
+    "config.d.ts",
+    "dist"
   ],
   "configSchema": "config.d.ts"
 }

plugins/catalog-backend-module-aws/src/index.ts

@@ -22,4 +22,5 @@
 
 export * from './processors';
 export * from './providers';
+export { awsS3EntityProviderCatalogModule } from './service/AwsS3EntityProviderCatalogModule';
 export * from './types';

plugins/catalog-backend-module-aws/src/service/AwsS3EntityProviderCatalogModule.test.ts

@@ -0,0 +1,84 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { getVoidLogger } from '@backstage/backend-common';
+import {
+  configServiceRef,
+  loggerServiceRef,
+  schedulerServiceRef,
+} from '@backstage/backend-plugin-api';
+import {
+  PluginTaskScheduler,
+  TaskScheduleDefinition,
+} from '@backstage/backend-tasks';
+import { startTestBackend } from '@backstage/backend-test-utils';
+import { ConfigReader } from '@backstage/config';
+import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node';
+import { Duration } from 'luxon';
+import { awsS3EntityProviderCatalogModule } from './AwsS3EntityProviderCatalogModule';
+import { AwsS3EntityProvider } from '../providers';
+
+describe('awsS3EntityProviderCatalogModule', () => {
+  it('should register provider at the catalog extension point', async () => {
+    let addedProviders: Array<AwsS3EntityProvider> | undefined;
+    let usedSchedule: TaskScheduleDefinition | undefined;
+
+    const extensionPoint = {
+      addEntityProvider: (providers: any) => {
+        addedProviders = providers;
+      },
+    };
+    const runner = jest.fn();
+    const scheduler = {
+      createScheduledTaskRunner: (schedule: TaskScheduleDefinition) => {
+        usedSchedule = schedule;
+        return runner;
+      },
+    } as unknown as PluginTaskScheduler;
+
+    const config = new ConfigReader({
+      catalog: {
+        providers: {
+          awsS3: {
+            bucketName: 'module-test',
+            schedule: {
+              frequency: 'P1M',
+              timeout: 'PT3M',
+            },
+          },
+        },
+      },
+    });
+
+    await startTestBackend({
+      extensionPoints: [[catalogProcessingExtensionPoint, extensionPoint]],
+      services: [
+        [configServiceRef, config],
+        [loggerServiceRef, getVoidLogger()],
+        [schedulerServiceRef, scheduler],
+      ],
+      features: [awsS3EntityProviderCatalogModule()],
+    });
+
+    expect(usedSchedule?.frequency).toEqual(Duration.fromISO('P1M'));
+    expect(usedSchedule?.timeout).toEqual(Duration.fromISO('PT3M'));
+    expect(addedProviders?.length).toEqual(1);
+    expect(addedProviders?.pop()?.getProviderName()).toEqual(
+      'awsS3-provider:default',
+    );
+    expect(runner).not.toHaveBeenCalled();
+  });
+});

plugins/catalog-backend-module-aws/src/service/AwsS3EntityProviderCatalogModule.ts

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+  createBackendModule,
+  loggerToWinstonLogger,
+  configServiceRef,
+  loggerServiceRef,
+  schedulerServiceRef,
+} from '@backstage/backend-plugin-api';
+import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node';
+import { AwsS3EntityProvider } from '../providers';
+
+/**
+ * Registers the AwsS3EntityProvider with the catalog processing extension point.
+ *
+ * @alpha
+ */
+export const awsS3EntityProviderCatalogModule = createBackendModule({
+  pluginId: 'catalog',
+  moduleId: 'awsS3EntityProvider',
+  register(env) {
+    env.registerInit({
+      deps: {
+        config: configServiceRef,
+        catalog: catalogProcessingExtensionPoint,
+        logger: loggerServiceRef,
+        scheduler: schedulerServiceRef,
+      },
+      async init({ config, catalog, logger, scheduler }) {
+        catalog.addEntityProvider(
+          AwsS3EntityProvider.fromConfig(config, {
+            logger: loggerToWinstonLogger(logger),
+            scheduler,
+          }),
+        );
+      },
+    });
+  },
+});

yarn.lock

@@ -4438,13 +4438,16 @@ __metadata:
   resolution: "@backstage/plugin-catalog-backend-module-aws@workspace:plugins/catalog-backend-module-aws"
   dependencies:
     "@backstage/backend-common": "workspace:^"
+    "@backstage/backend-plugin-api": "workspace:^"
     "@backstage/backend-tasks": "workspace:^"
+    "@backstage/backend-test-utils": "workspace:^"
     "@backstage/catalog-model": "workspace:^"
     "@backstage/cli": "workspace:^"
     "@backstage/config": "workspace:^"
     "@backstage/errors": "workspace:^"
     "@backstage/integration": "workspace:^"
     "@backstage/plugin-catalog-backend": "workspace:^"
+    "@backstage/plugin-catalog-node": "workspace:^"
     "@backstage/types": "workspace:^"
     "@types/lodash": ^4.14.151
     aws-sdk: ^2.840.0