Merge pull request backstage#27972 from zeshanziya/remove-backend-common-from-incremental-ingestion

Remove backend-common package from incremental-ingestion plugin

Author: freben

.changeset/six-eels-add.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-catalog-backend-module-incremental-ingestion': patch
+---
+
+Remove backend-common package from incremental-ingestion plugin and update related code

plugins/catalog-backend-module-incremental-ingestion/package.json

@@ -51,7 +51,7 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.25.0",
+    "@backstage/backend-defaults": "workspace:^",
     "@backstage/backend-plugin-api": "workspace:^",
     "@backstage/catalog-model": "workspace:^",
     "@backstage/config": "workspace:^",
@@ -70,7 +70,6 @@
     "uuid": "^11.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-defaults": "workspace:^",
     "@backstage/backend-test-utils": "workspace:^",
     "@backstage/cli": "workspace:^",
     "@types/luxon": "^3.0.0"

plugins/catalog-backend-module-incremental-ingestion/report.api.md

@@ -8,6 +8,7 @@
 import { BackendFeature } from '@backstage/backend-plugin-api';
 import { CatalogBuilder } from '@backstage/plugin-catalog-backend';
 import type { Config } from '@backstage/config';
+import { DatabaseService } from '@backstage/backend-plugin-api';
 import type { DeferredEntity } from '@backstage/plugin-catalog-node';
 import { EventParams } from '@backstage/plugin-events-node';
 import { EventSubscriber } from '@backstage/plugin-events-node';
@@ -17,7 +18,6 @@ import { IncrementalEntityProvider as IncrementalEntityProvider_2 } from '@backs
 import { IncrementalEntityProviderOptions as IncrementalEntityProviderOptions_2 } from '@backstage/plugin-catalog-backend-module-incremental-ingestion';
 import type { Logger } from 'winston';
 import type { PermissionEvaluator } from '@backstage/plugin-permission-common';
-import type { PluginDatabaseManager } from '@backstage/backend-common';
 import { Router } from 'express';
 import { SchedulerService } from '@backstage/backend-plugin-api';
 import { UrlReaderService } from '@backstage/backend-plugin-api';
@@ -107,7 +107,7 @@ export const incrementalIngestionProvidersExtensionPoint: ExtensionPoint<Increme
 // @public (undocumented)
 export type PluginEnvironment = {
   logger: Logger;
-  database: PluginDatabaseManager;
+  database: DatabaseService;
   scheduler: SchedulerService;
   config: Config;
   reader: UrlReaderService;

plugins/catalog-backend-module-incremental-ingestion/src/module/WrapperProviders.ts

@@ -79,6 +79,7 @@ export class WrapperProviders {
     return await new IncrementalProviderRouter(
       new IncrementalIngestionDatabaseManager({ client: this.options.client }),
       this.options.logger,
+      this.options.config,
     ).createRouter();
   }
 

plugins/catalog-backend-module-incremental-ingestion/src/router/routes.ts

@@ -14,22 +14,26 @@
  * limitations under the License.
  */
 
-import { errorHandler } from '@backstage/backend-common';
 import express from 'express';
 import Router from 'express-promise-router';
 import { IncrementalIngestionDatabaseManager } from '../database/IncrementalIngestionDatabaseManager';
 import { LoggerService } from '@backstage/backend-plugin-api';
+import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';
+import { Config } from '@backstage/config';
 
 export class IncrementalProviderRouter {
   private manager: IncrementalIngestionDatabaseManager;
   private logger: LoggerService;
+  private config: Config;
 
   constructor(
     manager: IncrementalIngestionDatabaseManager,
     logger: LoggerService,
+    config: Config,
   ) {
     this.manager = manager;
     this.logger = logger;
+    this.config = config;
   }
 
   async createRouter() {
@@ -249,7 +253,11 @@ export class IncrementalProviderRouter {
       },
     );
 
-    router.use(errorHandler());
+    const middleware = MiddlewareFactory.create({
+      logger: this.logger,
+      config: this.config,
+    });
+    router.use(middleware.error());
 
     return router;
   }

plugins/catalog-backend-module-incremental-ingestion/src/service/IncrementalCatalogBuilder.ts

@@ -66,6 +66,7 @@ export class IncrementalCatalogBuilder {
     const incrementalAdminRouter = await new IncrementalProviderRouter(
       this.manager,
       routerLogger,
+      this.env.config,
     ).createRouter();
 
     return { incrementalAdminRouter };

plugins/catalog-backend-module-incremental-ingestion/src/types.ts

@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 
-import type { PluginDatabaseManager } from '@backstage/backend-common';
 import type { Config } from '@backstage/config';
 import type {
   DeferredEntity,
@@ -29,6 +28,7 @@ import {
   UrlReaderService,
   SchedulerService,
   SchedulerServiceTaskFunction,
+  DatabaseService,
 } from '@backstage/backend-plugin-api';
 import { HumanDuration } from '@backstage/types';
 
@@ -187,7 +187,7 @@ export interface IncrementalEntityProviderOptions {
 /** @public */
 export type PluginEnvironment = {
   logger: Logger;
-  database: PluginDatabaseManager;
+  database: DatabaseService;
   scheduler: SchedulerService;
   config: Config;
   reader: UrlReaderService;

yarn.lock

@@ -6000,7 +6000,6 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@backstage/plugin-catalog-backend-module-incremental-ingestion@workspace:plugins/catalog-backend-module-incremental-ingestion"
   dependencies:
-    "@backstage/backend-common": ^0.25.0
     "@backstage/backend-defaults": "workspace:^"
     "@backstage/backend-plugin-api": "workspace:^"
     "@backstage/backend-test-utils": "workspace:^"