From 340ccd698894167a48f20120c017f87db67c49d0 Mon Sep 17 00:00:00 2001 From: zeshanziya Date: Tue, 3 Dec 2024 17:25:09 +0530 Subject: [PATCH 1/7] use core database service in plave of deprecated PluginDetabaseManager Signed-off-by: zeshanziya --- .../catalog-backend-module-incremental-ingestion/src/types.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/catalog-backend-module-incremental-ingestion/src/types.ts b/plugins/catalog-backend-module-incremental-ingestion/src/types.ts index dd7854b586..f30d8349ed 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/src/types.ts +++ b/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; From 78936fd8999bdc0d3ef79de1a2c8b59b992eaa89 Mon Sep 17 00:00:00 2001 From: zeshanziya Date: Tue, 3 Dec 2024 17:26:14 +0530 Subject: [PATCH 2/7] remove deprecated error handler Signed-off-by: zeshanziya --- .../src/module/WrapperProviders.ts | 1 + .../src/router/routes.ts | 12 ++++++++++-- .../src/service/IncrementalCatalogBuilder.ts | 1 + 3 files changed, 12 insertions(+), 2 deletions(-) diff --git a/plugins/catalog-backend-module-incremental-ingestion/src/module/WrapperProviders.ts b/plugins/catalog-backend-module-incremental-ingestion/src/module/WrapperProviders.ts index d7be197bf8..08dd2a4182 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/src/module/WrapperProviders.ts +++ b/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(); } diff --git a/plugins/catalog-backend-module-incremental-ingestion/src/router/routes.ts b/plugins/catalog-backend-module-incremental-ingestion/src/router/routes.ts index d3ccb8863b..ea083b8044 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/src/router/routes.ts +++ b/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; } diff --git a/plugins/catalog-backend-module-incremental-ingestion/src/service/IncrementalCatalogBuilder.ts b/plugins/catalog-backend-module-incremental-ingestion/src/service/IncrementalCatalogBuilder.ts index 6ea2f10a64..ed4414b68b 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/src/service/IncrementalCatalogBuilder.ts +++ b/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 }; From 708e564b4a341b53310c2c9e78082c5836cf4790 Mon Sep 17 00:00:00 2001 From: zeshanziya Date: Tue, 3 Dec 2024 17:27:30 +0530 Subject: [PATCH 3/7] Move backend-default package from devDependencies to dependencies Signed-off-by: zeshanziya --- .../catalog-backend-module-incremental-ingestion/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/catalog-backend-module-incremental-ingestion/package.json b/plugins/catalog-backend-module-incremental-ingestion/package.json index a85e621015..9131c9481e 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/package.json +++ b/plugins/catalog-backend-module-incremental-ingestion/package.json @@ -52,6 +52,7 @@ }, "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 +71,6 @@ "uuid": "^11.0.0" }, "devDependencies": { - "@backstage/backend-defaults": "workspace:^", "@backstage/backend-test-utils": "workspace:^", "@backstage/cli": "workspace:^", "@types/luxon": "^3.0.0" From 4a59a59c4c985f1222730e1c65854d3554ead3bd Mon Sep 17 00:00:00 2001 From: zeshanziya Date: Tue, 3 Dec 2024 17:28:57 +0530 Subject: [PATCH 4/7] remove @backstage/backend-common package Signed-off-by: zeshanziya --- .../catalog-backend-module-incremental-ingestion/package.json | 1 - yarn.lock | 1 - 2 files changed, 2 deletions(-) diff --git a/plugins/catalog-backend-module-incremental-ingestion/package.json b/plugins/catalog-backend-module-incremental-ingestion/package.json index 9131c9481e..1e63a0beae 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/package.json +++ b/plugins/catalog-backend-module-incremental-ingestion/package.json @@ -51,7 +51,6 @@ "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:^", diff --git a/yarn.lock b/yarn.lock index 80cc9458c6..7460f610b0 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5976,7 +5976,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:^" From d42ecb0cab9913ed20ebe708df9d8cd1b979fb8c Mon Sep 17 00:00:00 2001 From: zeshanziya Date: Tue, 3 Dec 2024 17:39:30 +0530 Subject: [PATCH 5/7] add changeset Signed-off-by: zeshanziya --- .changeset/six-eels-add.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/six-eels-add.md diff --git a/.changeset/six-eels-add.md b/.changeset/six-eels-add.md new file mode 100644 index 0000000000..fa0481b757 --- /dev/null +++ b/.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 From ad1d8842a22563bd19f49fbbc827e6b9eed420aa Mon Sep 17 00:00:00 2001 From: zeshanziya Date: Tue, 3 Dec 2024 17:56:54 +0530 Subject: [PATCH 6/7] add api-report changes Signed-off-by: zeshanziya --- .../report.api.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/plugins/catalog-backend-module-incremental-ingestion/report.api.md b/plugins/catalog-backend-module-incremental-ingestion/report.api.md index a5a640205a..500ae279e8 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/report.api.md +++ b/plugins/catalog-backend-module-incremental-ingestion/report.api.md @@ -3,11 +3,10 @@ > 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 { 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 +16,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 +105,7 @@ export const incrementalIngestionProvidersExtensionPoint: ExtensionPoint Date: Wed, 4 Dec 2024 09:49:51 +0530 Subject: [PATCH 7/7] build api-reports Signed-off-by: zeshanziya --- .../catalog-backend-module-incremental-ingestion/report.api.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/plugins/catalog-backend-module-incremental-ingestion/report.api.md b/plugins/catalog-backend-module-incremental-ingestion/report.api.md index 500ae279e8..9fcb342c06 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/report.api.md +++ b/plugins/catalog-backend-module-incremental-ingestion/report.api.md @@ -3,6 +3,8 @@ > 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 { CatalogBuilder } from '@backstage/plugin-catalog-backend'; import type { Config } from '@backstage/config';