@backstage/plugin-catalog-backend-module-incremental-ingestion 0.2.2-next.0 → 0.3.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @backstage/plugin-catalog-backend-module-incremental-ingestion
 
+## 0.3.0-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-tasks@0.5.0-next.2
+  - @backstage/backend-common@0.18.3-next.2
+  - @backstage/backend-plugin-api@0.4.1-next.2
+  - @backstage/plugin-catalog-backend@1.8.0-next.2
+  - @backstage/plugin-catalog-node@1.3.4-next.2
+  - @backstage/plugin-events-node@0.2.4-next.2
+  - @backstage/config@1.0.7-next.0
+
+## 0.3.0-next.1
+
+### Minor Changes
+
+- a811bd246c4: Added endpoint to get a list of known incremental entity providers
+
+### Patch Changes
+
+- 6e612b58577: Move `@backstage/backend-defaults` to `devDependencies`
+- Updated dependencies
+  - @backstage/errors@1.1.5-next.0
+  - @backstage/backend-common@0.18.3-next.1
+  - @backstage/plugin-catalog-backend@1.8.0-next.1
+  - @backstage/plugin-permission-common@0.7.4-next.0
+  - @backstage/backend-plugin-api@0.4.1-next.1
+  - @backstage/backend-tasks@0.4.4-next.1
+  - @backstage/config@1.0.7-next.0
+  - @backstage/catalog-model@1.2.1-next.1
+  - @backstage/plugin-catalog-node@1.3.4-next.1
+  - @backstage/plugin-events-node@0.2.4-next.1
+
 ## 0.2.2-next.0
 
 ### Patch Changes

package/README.md

@@ -102,6 +102,7 @@ If you want to manage your incremental entity providers via REST endpoints, the
 | Method | Path                                       | Description                                                                                                                 |
 | ------ | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |
 | GET    | `/incremental/health`                      | Checks the health of all incremental providers. Returns array of any unhealthy ones.                                        |
+| GET    | `/incremental/providers`                   | Get a list of all known incremental entity providers                                                                        |
 | GET    | `/incremental/providers/:provider`         | Checks the status of an incremental provider (resting, interstitial, etc).                                                  |
 | POST   | `/incremental/providers/:provider/trigger` | Triggers a provider's next action immediately. E.g., if it's currently interstitial, it will trigger the next burst.        |
 | POST   | `/incremental/providers/:provider/start`   | Stop the current ingestion cycle and start a new one immediately.                                                           |

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-incremental-ingestion",
-  "version": "0.2.2-next.0",
+  "version": "0.3.0-next.2",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -819,10 +819,6 @@ class IncrementalIngestionEngine {
   }
 }
 
-const PROVIDER_CLEANUP = "/incremental/cleanup";
-const PROVIDER_HEALTH = "/incremental/health";
-const PROVIDER_BASE_PATH = "/incremental/providers/:provider";
-
 class IncrementalProviderRouter {
   constructor(manager, logger) {
     this.manager = manager;
@@ -831,7 +827,7 @@ class IncrementalProviderRouter {
   async createRouter() {
     const router = Router__default["default"]();
     router.use(express__default["default"].json());
-    router.get(PROVIDER_HEALTH, async (_, res) => {
+    router.get("/incremental/health", async (_, res) => {
       const records = await this.manager.healthcheck();
       const providers = records.map((record) => record.provider_name);
       const duplicates = [
@@ -843,11 +839,11 @@ class IncrementalProviderRouter {
         res.json({ healthy: true });
       }
     });
-    router.post(PROVIDER_CLEANUP, async (_, res) => {
+    router.post("/incremental/cleanup", async (_, res) => {
       const result = await this.manager.cleanupProviders();
       res.json(result);
     });
-    router.get(PROVIDER_BASE_PATH, async (req, res) => {
+    router.get("/incremental/providers/:provider", async (req, res) => {
       const { provider } = req.params;
       const record = await this.manager.getCurrentIngestionRecord(provider);
       if (record) {
@@ -880,32 +876,35 @@ class IncrementalProviderRouter {
         }
       }
     });
-    router.post(`${PROVIDER_BASE_PATH}/trigger`, async (req, res) => {
-      const { provider } = req.params;
-      const record = await this.manager.getCurrentIngestionRecord(provider);
-      if (record) {
-        await this.manager.triggerNextProviderAction(provider);
-        res.json({
-          success: true,
-          message: `${provider}: Next action triggered.`
-        });
-      } else {
-        const providers = await this.manager.listProviders();
-        if (providers.includes(provider)) {
-          this.logger.debug(`${provider} - Ingestion record found`);
+    router.post(
+      `/incremental/providers/:provider/trigger`,
+      async (req, res) => {
+        const { provider } = req.params;
+        const record = await this.manager.getCurrentIngestionRecord(provider);
+        if (record) {
+          await this.manager.triggerNextProviderAction(provider);
           res.json({
             success: true,
-            message: "Unable to trigger next action (provider is restarting)"
+            message: `${provider}: Next action triggered.`
           });
         } else {
-          res.status(404).json({
-            success: false,
-            message: `Provider '${provider}' not found`
-          });
+          const providers = await this.manager.listProviders();
+          if (providers.includes(provider)) {
+            this.logger.debug(`${provider} - Ingestion record found`);
+            res.json({
+              success: true,
+              message: "Unable to trigger next action (provider is restarting)"
+            });
+          } else {
+            res.status(404).json({
+              success: false,
+              message: `Provider '${provider}' not found`
+            });
+          }
         }
       }
-    });
-    router.post(`${PROVIDER_BASE_PATH}/start`, async (req, res) => {
+    );
+    router.post(`/incremental/providers/:provider/start`, async (req, res) => {
       const { provider } = req.params;
       const record = await this.manager.getCurrentIngestionRecord(provider);
       if (record) {
@@ -935,7 +934,14 @@ class IncrementalProviderRouter {
         }
       }
     });
-    router.post(`${PROVIDER_BASE_PATH}/cancel`, async (req, res) => {
+    router.get(`/incremental/providers`, async (_req, res) => {
+      const providers = await this.manager.listProviders();
+      res.json({
+        success: true,
+        providers
+      });
+    });
+    router.post(`/incremental/providers/:provider/cancel`, async (req, res) => {
       const { provider } = req.params;
       const record = await this.manager.getCurrentIngestionRecord(provider);
       if (record) {
@@ -967,12 +973,12 @@ class IncrementalProviderRouter {
         }
       }
     });
-    router.delete(PROVIDER_BASE_PATH, async (req, res) => {
+    router.delete("/incremental/providers/:provider", async (req, res) => {
       const { provider } = req.params;
       const result = await this.manager.purgeAndResetProvider(provider);
       res.json(result);
     });
-    router.get(`${PROVIDER_BASE_PATH}/marks`, async (req, res) => {
+    router.get(`/incremental/providers/:provider/marks`, async (req, res) => {
       const { provider } = req.params;
       const record = await this.manager.getCurrentIngestionRecord(provider);
       if (record) {
@@ -999,15 +1005,18 @@ class IncrementalProviderRouter {
         }
       }
     });
-    router.delete(`${PROVIDER_BASE_PATH}/marks`, async (req, res) => {
-      const { provider } = req.params;
-      const deletions = await this.manager.clearFinishedIngestions(provider);
-      res.json({
-        success: true,
-        message: `Expired marks for provider '${provider}' removed.`,
-        deletions
-      });
-    });
+    router.delete(
+      `/incremental/providers/:provider/marks`,
+      async (req, res) => {
+        const { provider } = req.params;
+        const deletions = await this.manager.clearFinishedIngestions(provider);
+        res.json({
+          success: true,
+          message: `Expired marks for provider '${provider}' removed.`,
+          deletions
+        });
+      }
+    );
     router.use(backendCommon.errorHandler());
     return router;
   }