From cce9cae5dcb855c743bc1da9f90234e33424be03 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= <freben@gmail.com>
Date: Mon, 25 Nov 2024 16:25:49 +0100
Subject: [PATCH] deprecate IncrementalCatalogBuilder, stop using old event
 interface
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
---
 .changeset/fast-cheetahs-deliver.md                         | 5 +++++
 .../report-alpha.api.md                                     | 2 +-
 .../report.api.md                                           | 2 +-
 .../src/alpha.ts                                            | 5 ++++-
 .../src/engine/IncrementalIngestionEngine.ts                | 6 ++----
 .../src/service/IncrementalCatalogBuilder.ts                | 5 ++++-
 6 files changed, 17 insertions(+), 8 deletions(-)
 create mode 100644 .changeset/fast-cheetahs-deliver.md

diff --git a/.changeset/fast-cheetahs-deliver.md b/.changeset/fast-cheetahs-deliver.md
new file mode 100644
index 0000000000..ce87a68409
--- /dev/null
+++ b/.changeset/fast-cheetahs-deliver.md
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-catalog-backend-module-incremental-ingestion': patch
+---
+
+Deprecate old-backend-system `IncrementalCatalogBuilder`
diff --git a/plugins/catalog-backend-module-incremental-ingestion/report-alpha.api.md b/plugins/catalog-backend-module-incremental-ingestion/report-alpha.api.md
index cb1bb63d00..30717e8752 100644
--- a/plugins/catalog-backend-module-incremental-ingestion/report-alpha.api.md
+++ b/plugins/catalog-backend-module-incremental-ingestion/report-alpha.api.md
@@ -5,7 +5,7 @@
 ```ts
 import { BackendFeature } from '@backstage/backend-plugin-api';
 
-// @alpha (undocumented)
+// @alpha @deprecated (undocumented)
 const _feature: BackendFeature;
 export default _feature;
 
diff --git a/plugins/catalog-backend-module-incremental-ingestion/report.api.md b/plugins/catalog-backend-module-incremental-ingestion/report.api.md
index 30ad70164f..a5a640205a 100644
--- a/plugins/catalog-backend-module-incremental-ingestion/report.api.md
+++ b/plugins/catalog-backend-module-incremental-ingestion/report.api.md
@@ -39,7 +39,7 @@ export type EntityIteratorResult<T> =
       cursor?: T;
     };
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export class IncrementalCatalogBuilder {
   // (undocumented)
   addIncrementalEntityProvider<TCursor, TContext>(
diff --git a/plugins/catalog-backend-module-incremental-ingestion/src/alpha.ts b/plugins/catalog-backend-module-incremental-ingestion/src/alpha.ts
index cba672ce49..776dd937bf 100644
--- a/plugins/catalog-backend-module-incremental-ingestion/src/alpha.ts
+++ b/plugins/catalog-backend-module-incremental-ingestion/src/alpha.ts
@@ -16,6 +16,9 @@
 
 import { default as feature } from './module';
 
-/** @alpha */
+/**
+ * @alpha
+ * @deprecated Please import from `@backstage/plugin-catalog-backend-module-incremental-ingestion` instead
+ */
 const _feature = feature;
 export default _feature;
diff --git a/plugins/catalog-backend-module-incremental-ingestion/src/engine/IncrementalIngestionEngine.ts b/plugins/catalog-backend-module-incremental-ingestion/src/engine/IncrementalIngestionEngine.ts
index 1b72a46d17..676a175074 100644
--- a/plugins/catalog-backend-module-incremental-ingestion/src/engine/IncrementalIngestionEngine.ts
+++ b/plugins/catalog-backend-module-incremental-ingestion/src/engine/IncrementalIngestionEngine.ts
@@ -21,12 +21,10 @@ import { performance } from 'perf_hooks';
 import { Duration } from 'luxon';
 import { v4 } from 'uuid';
 import { stringifyError } from '@backstage/errors';
-import { EventParams, EventSubscriber } from '@backstage/plugin-events-node';
+import { EventParams } from '@backstage/plugin-events-node';
 import { HumanDuration } from '@backstage/types';
 
-export class IncrementalIngestionEngine
-  implements IterationEngine, EventSubscriber
-{
+export class IncrementalIngestionEngine implements IterationEngine {
   private readonly restLength: Duration;
   private readonly backoff: HumanDuration[];
 
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 04ceef2d26..b7e3164292 100644
--- a/plugins/catalog-backend-module-incremental-ingestion/src/service/IncrementalCatalogBuilder.ts
+++ b/plugins/catalog-backend-module-incremental-ingestion/src/service/IncrementalCatalogBuilder.ts
@@ -29,7 +29,10 @@ import { IncrementalIngestionDatabaseManager } from '../database/IncrementalInge
 import { IncrementalProviderRouter } from '../router/routes';
 import { EventParams, EventSubscriber } from '@backstage/plugin-events-node';
 
-/** @public */
+/**
+ * @public
+ * @deprecated Please migrate to the new backend system and import `@backstage/plugin-catalog-backend-module-incremental-ingestion` as a module, and add providers to the `incrementalIngestionProvidersExtensionPoint` instead
+ */
 export class IncrementalCatalogBuilder {
   /**
    * Creates the incremental catalog builder, which extends the regular catalog builder.