@backstage/plugin-catalog-backend-module-unprocessed 0.0.0-nightly-20240319021037 → 0.0.0-nightly-20240322021005

package/CHANGELOG.md

@@ -1,13 +1,58 @@
 # @backstage/plugin-catalog-backend-module-unprocessed
 
-## 0.0.0-nightly-20240319021037
+## 0.0.0-nightly-20240322021005
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.0.0-nightly-20240322021005
+  - @backstage/plugin-auth-node@0.0.0-nightly-20240322021005
+  - @backstage/plugin-permission-node@0.0.0-nightly-20240322021005
+  - @backstage/backend-plugin-api@0.0.0-nightly-20240322021005
+  - @backstage/catalog-model@1.4.5
+  - @backstage/errors@1.2.4
+  - @backstage/plugin-catalog-unprocessed-entities-common@0.0.1
+  - @backstage/plugin-permission-common@0.7.13
+
+## 0.4.0
+
+### Minor Changes
+
+- 924c1ac: **BREAKING**- the `@backstage/plugin-catalog-backend-module-unprocessed` constructor is now private, and have been moved to using the static `.create` method instead which now requires a `PermissionService` and `DiscoveryService`.
+
+  If you're using this module in the old backend system you'll need to migrate to using the `.create` method and pass in the new required parameters in `packages/backend/src/plugins/catalog.ts`.
+
+  No changes should be required if you're using the new backend system.
+
+  ```diff
+  -  const unprocessed = new UnprocessedEntitiesModule(
+  -    await env.database.getClient(),
+  -    router,
+  -  );
+  + const unprocessed = UnprocessedEntitiesModule.create({
+  +    database: await env.database.getClient(),
+  +    router,
+  +    permissions: env.permissions,
+  +    discovery: env.discovery,
+  +  });
+
+    unprocessed.registerRoutes();
+  ```
+
+  Adds the ability to delete an unprocessed entity from the `refresh_state` table. This change requires enabling permissions for your Backstage instance.
 
 ### Patch Changes
 
 - 2bd1410: Removed unused dependencies
 - Updated dependencies
-  - @backstage/backend-plugin-api@0.0.0-nightly-20240319021037
-  - @backstage/catalog-model@0.0.0-nightly-20240319021037
+  - @backstage/backend-common@0.21.4
+  - @backstage/plugin-auth-node@0.4.9
+  - @backstage/errors@1.2.4
+  - @backstage/backend-plugin-api@0.6.14
+  - @backstage/plugin-permission-common@0.7.13
+  - @backstage/plugin-permission-node@0.7.25
+  - @backstage/plugin-catalog-unprocessed-entities-common@0.0.1
+  - @backstage/catalog-model@1.4.5
 
 ## 0.3.11-next.2
 

package/dist/index.cjs.js

@@ -4,10 +4,15 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var Router = require('express-promise-router');
+var pluginPermissionCommon = require('@backstage/plugin-permission-common');
+var pluginPermissionNode = require('@backstage/plugin-permission-node');
+var pluginCatalogUnprocessedEntitiesCommon = require('@backstage/plugin-catalog-unprocessed-entities-common');
+var errors = require('@backstage/errors');
+var backendCommon = require('@backstage/backend-common');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
-var Router__default = /*#__PURE__*/_interopDefaultLegacy(Router);
+var Router__default = /*#__PURE__*/_interopDefaultCompat(Router);
 
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
@@ -16,12 +21,27 @@ var __publicField = (obj, key, value) => {
   return value;
 };
 class UnprocessedEntitiesModule {
-  constructor(database, router) {
+  constructor(database, router, permissions, discovery, httpAuth) {
     this.database = database;
     this.router = router;
+    this.permissions = permissions;
     __publicField(this, "moduleRouter");
-    this.moduleRouter = Router__default["default"]();
+    __publicField(this, "httpAuth");
+    this.moduleRouter = Router__default.default();
     this.router.use(this.moduleRouter);
+    this.httpAuth = backendCommon.createLegacyAuthAdapters({
+      discovery,
+      httpAuth
+    }).httpAuth;
+  }
+  static create(options) {
+    return new UnprocessedEntitiesModule(
+      options.database,
+      options.router,
+      options.permissions,
+      options.discovery,
+      options.httpAuth
+    );
   }
   async unprocessed(request) {
     if (request.reason === "pending") {
@@ -75,21 +95,44 @@ class UnprocessedEntitiesModule {
     return res;
   }
   registerRoutes() {
+    const permissionIntegrationRouter = pluginPermissionNode.createPermissionIntegrationRouter({
+      permissions: [pluginCatalogUnprocessedEntitiesCommon.unprocessedEntitiesDeletePermission]
+    });
+    const isRequestAuthorized = async (req, permission) => {
+      const decision = (await this.permissions.authorize([{ permission }], {
+        credentials: await this.httpAuth.credentials(req)
+      }))[0];
+      return decision.result !== pluginPermissionCommon.AuthorizeResult.DENY;
+    };
+    this.router.use(permissionIntegrationRouter);
     this.moduleRouter.get("/entities/unprocessed/failed", async (req, res) => {
       return res.json(
         await this.unprocessed({
           reason: "failed",
-          owner: req.query.owner
+          owner: String(req.query.owner)
         })
       );
     }).get("/entities/unprocessed/pending", async (req, res) => {
       return res.json(
         await this.unprocessed({
           reason: "pending",
-          owner: req.query.owner
+          owner: String(req.query.owner)
         })
       );
-    });
+    }).delete(
+      "/entities/unprocessed/delete/:entity_id",
+      async (request, response) => {
+        const authorized = await isRequestAuthorized(
+          request,
+          pluginCatalogUnprocessedEntitiesCommon.unprocessedEntitiesDeletePermission
+        );
+        if (!authorized) {
+          throw new errors.NotAllowedError("Unauthorized");
+        }
+        await this.database("refresh_state").where({ entity_id: request.params.entity_id }).delete();
+        response.status(204).send();
+      }
+    );
   }
 }
 
@@ -101,13 +144,26 @@ const catalogModuleUnprocessedEntities = backendPluginApi.createBackendModule({
       deps: {
         database: backendPluginApi.coreServices.database,
         router: backendPluginApi.coreServices.httpRouter,
-        logger: backendPluginApi.coreServices.logger
+        logger: backendPluginApi.coreServices.logger,
+        httpAuth: backendPluginApi.coreServices.httpAuth,
+        discovery: backendPluginApi.coreServices.discovery,
+        permissions: backendPluginApi.coreServices.permissions
       },
-      async init({ database, router, logger }) {
-        const module = new UnprocessedEntitiesModule(
-          await database.getClient(),
-          router
-        );
+      async init({
+        database,
+        router,
+        logger,
+        permissions,
+        httpAuth,
+        discovery
+      }) {
+        const module = UnprocessedEntitiesModule.create({
+          database: await database.getClient(),
+          router,
+          permissions,
+          discovery,
+          httpAuth
+        });
         module.registerRoutes();
         logger.info(
           "registered additional routes for catalogModuleUnprocessedEntities"
@@ -118,5 +174,5 @@ const catalogModuleUnprocessedEntities = backendPluginApi.createBackendModule({
 });
 
 exports.UnprocessedEntitiesModule = UnprocessedEntitiesModule;
-exports["default"] = catalogModuleUnprocessedEntities;
+exports.default = catalogModuleUnprocessedEntities;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/UnprocessedEntitiesModule.ts","../src/module.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  HydratedRefreshState,\n  RefreshState,\n  UnprocessedEntitiesRequest,\n  UnprocessedEntitiesResponse,\n} from './types';\nimport { Knex } from 'knex';\nimport { HttpRouterService } from '@backstage/backend-plugin-api';\nimport Router from 'express-promise-router';\n\n/**\n * Module providing Unprocessed Entities API endpoints\n *\n * @public\n */\nexport class UnprocessedEntitiesModule {\n  private readonly moduleRouter;\n\n  constructor(\n    private readonly database: Knex,\n    private readonly router: Pick<HttpRouterService, 'use'>,\n  ) {\n    this.moduleRouter = Router();\n    this.router.use(this.moduleRouter);\n  }\n\n  private async unprocessed(\n    request: UnprocessedEntitiesRequest,\n  ): Promise<UnprocessedEntitiesResponse> {\n    if (request.reason === 'pending') {\n      return {\n        type: 'pending',\n        entities: await this.pending(request.owner),\n      };\n    }\n    return {\n      type: 'failed',\n      entities: await this.failed(request.owner),\n    };\n  }\n\n  private hydrateRefreshState(r: RefreshState): HydratedRefreshState {\n    return {\n      ...r,\n      unprocessed_entity: JSON.parse(r.unprocessed_entity),\n      ...(r.processed_entity && {\n        processed_entity: JSON.parse(r.processed_entity),\n      }),\n      ...(r.errors && { errors: JSON.parse(r.errors) }),\n      ...(r.cache && { cache: JSON.parse(r.cache) }),\n    };\n  }\n\n  private async pending(owner?: string): Promise<HydratedRefreshState[]> {\n    const res = (\n      await this.database('refresh_state.*')\n        .from('refresh_state')\n        .leftJoin(\n          'final_entities',\n          'final_entities.entity_id',\n          'refresh_state.entity_id',\n        )\n        .whereNull('final_entities.entity_id')\n    ).map(this.hydrateRefreshState);\n    if (owner) {\n      return res.filter(r => r.unprocessed_entity.spec?.owner === owner);\n    }\n\n    return res;\n  }\n\n  private async failed(owner?: string): Promise<HydratedRefreshState[]> {\n    const res = (\n      await this.database('refresh_state.*')\n        .from('refresh_state')\n        .rightJoin(\n          'final_entities',\n          'final_entities.entity_id',\n          'refresh_state.entity_id',\n        )\n        .whereNull('final_entities.final_entity')\n    ).map(this.hydrateRefreshState);\n    if (owner) {\n      return res.filter(r => r.unprocessed_entity.spec?.owner === owner);\n    }\n\n    return res;\n  }\n\n  registerRoutes() {\n    this.moduleRouter\n      .get('/entities/unprocessed/failed', async (req, res) => {\n        return res.json(\n          await this.unprocessed({\n            reason: 'failed',\n            owner: req.query.owner as string,\n          }),\n        );\n      })\n      .get('/entities/unprocessed/pending', async (req, res) => {\n        return res.json(\n          await this.unprocessed({\n            reason: 'pending',\n            owner: req.query.owner as string,\n          }),\n        );\n      });\n  }\n}\n","/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { UnprocessedEntitiesModule } from './UnprocessedEntitiesModule';\n\n/**\n * Catalog Module for Unprocessed Entities\n *\n * @public\n */\nexport const catalogModuleUnprocessedEntities = createBackendModule({\n  pluginId: 'catalog',\n  moduleId: 'catalog-module-unprocessed-entities',\n  register(env) {\n    env.registerInit({\n      deps: {\n        database: coreServices.database,\n        router: coreServices.httpRouter,\n        logger: coreServices.logger,\n      },\n      async init({ database, router, logger }) {\n        const module = new UnprocessedEntitiesModule(\n          await database.getClient(),\n          router,\n        );\n\n        module.registerRoutes();\n        logger.info(\n          'registered additional routes for catalogModuleUnprocessedEntities',\n        );\n      },\n    });\n  },\n});\n"],"names":["Router","createBackendModule","coreServices"],"mappings":";;;;;;;;;;;;;;;;;AA+BO,MAAM,yBAA0B,CAAA;AAAA,EAGrC,WAAA,CACmB,UACA,MACjB,EAAA;AAFiB,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA,CAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AAJnB,IAAiB,aAAA,CAAA,IAAA,EAAA,cAAA,CAAA,CAAA;AAMf,IAAA,IAAA,CAAK,eAAeA,0BAAO,EAAA,CAAA;AAC3B,IAAK,IAAA,CAAA,MAAA,CAAO,GAAI,CAAA,IAAA,CAAK,YAAY,CAAA,CAAA;AAAA,GACnC;AAAA,EAEA,MAAc,YACZ,OACsC,EAAA;AACtC,IAAI,IAAA,OAAA,CAAQ,WAAW,SAAW,EAAA;AAChC,MAAO,OAAA;AAAA,QACL,IAAM,EAAA,SAAA;AAAA,QACN,QAAU,EAAA,MAAM,IAAK,CAAA,OAAA,CAAQ,QAAQ,KAAK,CAAA;AAAA,OAC5C,CAAA;AAAA,KACF;AACA,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,QAAA;AAAA,MACN,QAAU,EAAA,MAAM,IAAK,CAAA,MAAA,CAAO,QAAQ,KAAK,CAAA;AAAA,KAC3C,CAAA;AAAA,GACF;AAAA,EAEQ,oBAAoB,CAAuC,EAAA;AACjE,IAAO,OAAA;AAAA,MACL,GAAG,CAAA;AAAA,MACH,kBAAoB,EAAA,IAAA,CAAK,KAAM,CAAA,CAAA,CAAE,kBAAkB,CAAA;AAAA,MACnD,GAAI,EAAE,gBAAoB,IAAA;AAAA,QACxB,gBAAkB,EAAA,IAAA,CAAK,KAAM,CAAA,CAAA,CAAE,gBAAgB,CAAA;AAAA,OACjD;AAAA,MACA,GAAI,EAAE,MAAU,IAAA,EAAE,QAAQ,IAAK,CAAA,KAAA,CAAM,CAAE,CAAA,MAAM,CAAE,EAAA;AAAA,MAC/C,GAAI,EAAE,KAAS,IAAA,EAAE,OAAO,IAAK,CAAA,KAAA,CAAM,CAAE,CAAA,KAAK,CAAE,EAAA;AAAA,KAC9C,CAAA;AAAA,GACF;AAAA,EAEA,MAAc,QAAQ,KAAiD,EAAA;AACrE,IAAM,MAAA,GAAA,GAAA,CACJ,MAAM,IAAK,CAAA,QAAA,CAAS,iBAAiB,CAClC,CAAA,IAAA,CAAK,eAAe,CACpB,CAAA,QAAA;AAAA,MACC,gBAAA;AAAA,MACA,0BAAA;AAAA,MACA,yBAAA;AAAA,MAED,SAAU,CAAA,0BAA0B,CACvC,EAAA,GAAA,CAAI,KAAK,mBAAmB,CAAA,CAAA;AAC9B,IAAA,IAAI,KAAO,EAAA;AACT,MAAO,OAAA,GAAA,CAAI,OAAO,CAAE,CAAA,KAAA;AAjF1B,QAAA,IAAA,EAAA,CAAA;AAiF6B,QAAE,OAAA,CAAA,CAAA,EAAA,GAAA,CAAA,CAAA,kBAAA,CAAmB,IAArB,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAA2B,KAAU,MAAA,KAAA,CAAA;AAAA,OAAK,CAAA,CAAA;AAAA,KACnE;AAEA,IAAO,OAAA,GAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAc,OAAO,KAAiD,EAAA;AACpE,IAAM,MAAA,GAAA,GAAA,CACJ,MAAM,IAAK,CAAA,QAAA,CAAS,iBAAiB,CAClC,CAAA,IAAA,CAAK,eAAe,CACpB,CAAA,SAAA;AAAA,MACC,gBAAA;AAAA,MACA,0BAAA;AAAA,MACA,yBAAA;AAAA,MAED,SAAU,CAAA,6BAA6B,CAC1C,EAAA,GAAA,CAAI,KAAK,mBAAmB,CAAA,CAAA;AAC9B,IAAA,IAAI,KAAO,EAAA;AACT,MAAO,OAAA,GAAA,CAAI,OAAO,CAAE,CAAA,KAAA;AAnG1B,QAAA,IAAA,EAAA,CAAA;AAmG6B,QAAE,OAAA,CAAA,CAAA,EAAA,GAAA,CAAA,CAAA,kBAAA,CAAmB,IAArB,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAA2B,KAAU,MAAA,KAAA,CAAA;AAAA,OAAK,CAAA,CAAA;AAAA,KACnE;AAEA,IAAO,OAAA,GAAA,CAAA;AAAA,GACT;AAAA,EAEA,cAAiB,GAAA;AACf,IAAA,IAAA,CAAK,YACF,CAAA,GAAA,CAAI,8BAAgC,EAAA,OAAO,KAAK,GAAQ,KAAA;AACvD,MAAA,OAAO,GAAI,CAAA,IAAA;AAAA,QACT,MAAM,KAAK,WAAY,CAAA;AAAA,UACrB,MAAQ,EAAA,QAAA;AAAA,UACR,KAAA,EAAO,IAAI,KAAM,CAAA,KAAA;AAAA,SAClB,CAAA;AAAA,OACH,CAAA;AAAA,KACD,CACA,CAAA,GAAA,CAAI,+BAAiC,EAAA,OAAO,KAAK,GAAQ,KAAA;AACxD,MAAA,OAAO,GAAI,CAAA,IAAA;AAAA,QACT,MAAM,KAAK,WAAY,CAAA;AAAA,UACrB,MAAQ,EAAA,SAAA;AAAA,UACR,KAAA,EAAO,IAAI,KAAM,CAAA,KAAA;AAAA,SAClB,CAAA;AAAA,OACH,CAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACL;AACF;;ACjGO,MAAM,mCAAmCC,oCAAoB,CAAA;AAAA,EAClE,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,qCAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,UAAUC,6BAAa,CAAA,QAAA;AAAA,QACvB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,OACvB;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,QAAU,EAAA,MAAA,EAAQ,QAAU,EAAA;AACvC,QAAA,MAAM,SAAS,IAAI,yBAAA;AAAA,UACjB,MAAM,SAAS,SAAU,EAAA;AAAA,UACzB,MAAA;AAAA,SACF,CAAA;AAEA,QAAA,MAAA,CAAO,cAAe,EAAA,CAAA;AACtB,QAAO,MAAA,CAAA,IAAA;AAAA,UACL,mEAAA;AAAA,SACF,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/UnprocessedEntitiesModule.ts","../src/module.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  HydratedRefreshState,\n  RefreshState,\n  UnprocessedEntitiesRequest,\n  UnprocessedEntitiesResponse,\n} from './types';\nimport { Knex } from 'knex';\nimport {\n  DiscoveryService,\n  HttpAuthService,\n  HttpRouterService,\n  PermissionsService,\n} from '@backstage/backend-plugin-api';\nimport Router from 'express-promise-router';\nimport type { Request } from 'express';\n\nimport {\n  AuthorizeResult,\n  BasicPermission,\n} from '@backstage/plugin-permission-common';\nimport { createPermissionIntegrationRouter } from '@backstage/plugin-permission-node';\nimport { unprocessedEntitiesDeletePermission } from '@backstage/plugin-catalog-unprocessed-entities-common';\nimport { NotAllowedError } from '@backstage/errors';\nimport { createLegacyAuthAdapters } from '@backstage/backend-common';\n\n/**\n * Module providing Unprocessed Entities API endpoints\n *\n * @public\n */\nexport class UnprocessedEntitiesModule {\n  private readonly moduleRouter;\n\n  private readonly httpAuth: HttpAuthService;\n\n  private constructor(\n    private readonly database: Knex,\n    private readonly router: Pick<HttpRouterService, 'use'>,\n    private readonly permissions: PermissionsService,\n    discovery: DiscoveryService,\n    httpAuth?: HttpAuthService,\n  ) {\n    this.moduleRouter = Router();\n    this.router.use(this.moduleRouter);\n\n    this.httpAuth = createLegacyAuthAdapters({\n      discovery,\n      httpAuth,\n    }).httpAuth;\n  }\n\n  static create(options: {\n    router: Pick<HttpRouterService, 'use'>;\n    database: Knex;\n    discovery: DiscoveryService;\n    permissions: PermissionsService;\n    httpAuth?: HttpAuthService;\n  }) {\n    return new UnprocessedEntitiesModule(\n      options.database,\n      options.router,\n      options.permissions,\n      options.discovery,\n      options.httpAuth,\n    );\n  }\n\n  private async unprocessed(\n    request: UnprocessedEntitiesRequest,\n  ): Promise<UnprocessedEntitiesResponse> {\n    if (request.reason === 'pending') {\n      return {\n        type: 'pending',\n        entities: await this.pending(request.owner),\n      };\n    }\n    return {\n      type: 'failed',\n      entities: await this.failed(request.owner),\n    };\n  }\n\n  private hydrateRefreshState(r: RefreshState): HydratedRefreshState {\n    return {\n      ...r,\n      unprocessed_entity: JSON.parse(r.unprocessed_entity),\n      ...(r.processed_entity && {\n        processed_entity: JSON.parse(r.processed_entity),\n      }),\n      ...(r.errors && { errors: JSON.parse(r.errors) }),\n      ...(r.cache && { cache: JSON.parse(r.cache) }),\n    };\n  }\n\n  private async pending(owner?: string): Promise<HydratedRefreshState[]> {\n    const res = (\n      await this.database('refresh_state.*')\n        .from('refresh_state')\n        .leftJoin(\n          'final_entities',\n          'final_entities.entity_id',\n          'refresh_state.entity_id',\n        )\n        .whereNull('final_entities.entity_id')\n    ).map(this.hydrateRefreshState);\n    if (owner) {\n      return res.filter(r => r.unprocessed_entity.spec?.owner === owner);\n    }\n\n    return res;\n  }\n\n  private async failed(owner?: string): Promise<HydratedRefreshState[]> {\n    const res = (\n      await this.database('refresh_state.*')\n        .from('refresh_state')\n        .rightJoin(\n          'final_entities',\n          'final_entities.entity_id',\n          'refresh_state.entity_id',\n        )\n        .whereNull('final_entities.final_entity')\n    ).map(this.hydrateRefreshState);\n    if (owner) {\n      return res.filter(r => r.unprocessed_entity.spec?.owner === owner);\n    }\n\n    return res;\n  }\n\n  registerRoutes() {\n    const permissionIntegrationRouter = createPermissionIntegrationRouter({\n      permissions: [unprocessedEntitiesDeletePermission],\n    });\n\n    const isRequestAuthorized = async (\n      req: Request,\n      permission: BasicPermission,\n    ): Promise<boolean> => {\n      const decision = (\n        await this.permissions.authorize([{ permission }], {\n          credentials: await this.httpAuth.credentials(req),\n        })\n      )[0];\n\n      return decision.result !== AuthorizeResult.DENY;\n    };\n\n    this.router.use(permissionIntegrationRouter);\n\n    this.moduleRouter\n      .get('/entities/unprocessed/failed', async (req, res) => {\n        return res.json(\n          await this.unprocessed({\n            reason: 'failed',\n            owner: String(req.query.owner),\n          }),\n        );\n      })\n      .get('/entities/unprocessed/pending', async (req, res) => {\n        return res.json(\n          await this.unprocessed({\n            reason: 'pending',\n            owner: String(req.query.owner),\n          }),\n        );\n      })\n      .delete(\n        '/entities/unprocessed/delete/:entity_id',\n        async (request, response) => {\n          const authorized = await isRequestAuthorized(\n            request,\n            unprocessedEntitiesDeletePermission,\n          );\n\n          if (!authorized) {\n            throw new NotAllowedError('Unauthorized');\n          }\n\n          await this.database('refresh_state')\n            .where({ entity_id: request.params.entity_id })\n            .delete();\n\n          response.status(204).send();\n        },\n      );\n  }\n}\n","/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { UnprocessedEntitiesModule } from './UnprocessedEntitiesModule';\n\n/**\n * Catalog Module for Unprocessed Entities\n *\n * @public\n */\nexport const catalogModuleUnprocessedEntities = createBackendModule({\n  pluginId: 'catalog',\n  moduleId: 'catalog-module-unprocessed-entities',\n  register(env) {\n    env.registerInit({\n      deps: {\n        database: coreServices.database,\n        router: coreServices.httpRouter,\n        logger: coreServices.logger,\n        httpAuth: coreServices.httpAuth,\n        discovery: coreServices.discovery,\n        permissions: coreServices.permissions,\n      },\n      async init({\n        database,\n        router,\n        logger,\n        permissions,\n        httpAuth,\n        discovery,\n      }) {\n        const module = UnprocessedEntitiesModule.create({\n          database: await database.getClient(),\n          router,\n          permissions,\n          discovery,\n          httpAuth,\n        });\n\n        module.registerRoutes();\n\n        logger.info(\n          'registered additional routes for catalogModuleUnprocessedEntities',\n        );\n      },\n    });\n  },\n});\n"],"names":["Router","createLegacyAuthAdapters","createPermissionIntegrationRouter","unprocessedEntitiesDeletePermission","AuthorizeResult","NotAllowedError","createBackendModule","coreServices"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AA8CO,MAAM,yBAA0B,CAAA;AAAA,EAK7B,WACW,CAAA,QAAA,EACA,MACA,EAAA,WAAA,EACjB,WACA,QACA,EAAA;AALiB,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA,CAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,WAAA,GAAA,WAAA,CAAA;AAPnB,IAAiB,aAAA,CAAA,IAAA,EAAA,cAAA,CAAA,CAAA;AAEjB,IAAiB,aAAA,CAAA,IAAA,EAAA,UAAA,CAAA,CAAA;AASf,IAAA,IAAA,CAAK,eAAeA,uBAAO,EAAA,CAAA;AAC3B,IAAK,IAAA,CAAA,MAAA,CAAO,GAAI,CAAA,IAAA,CAAK,YAAY,CAAA,CAAA;AAEjC,IAAA,IAAA,CAAK,WAAWC,sCAAyB,CAAA;AAAA,MACvC,SAAA;AAAA,MACA,QAAA;AAAA,KACD,CAAE,CAAA,QAAA,CAAA;AAAA,GACL;AAAA,EAEA,OAAO,OAAO,OAMX,EAAA;AACD,IAAA,OAAO,IAAI,yBAAA;AAAA,MACT,OAAQ,CAAA,QAAA;AAAA,MACR,OAAQ,CAAA,MAAA;AAAA,MACR,OAAQ,CAAA,WAAA;AAAA,MACR,OAAQ,CAAA,SAAA;AAAA,MACR,OAAQ,CAAA,QAAA;AAAA,KACV,CAAA;AAAA,GACF;AAAA,EAEA,MAAc,YACZ,OACsC,EAAA;AACtC,IAAI,IAAA,OAAA,CAAQ,WAAW,SAAW,EAAA;AAChC,MAAO,OAAA;AAAA,QACL,IAAM,EAAA,SAAA;AAAA,QACN,QAAU,EAAA,MAAM,IAAK,CAAA,OAAA,CAAQ,QAAQ,KAAK,CAAA;AAAA,OAC5C,CAAA;AAAA,KACF;AACA,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,QAAA;AAAA,MACN,QAAU,EAAA,MAAM,IAAK,CAAA,MAAA,CAAO,QAAQ,KAAK,CAAA;AAAA,KAC3C,CAAA;AAAA,GACF;AAAA,EAEQ,oBAAoB,CAAuC,EAAA;AACjE,IAAO,OAAA;AAAA,MACL,GAAG,CAAA;AAAA,MACH,kBAAoB,EAAA,IAAA,CAAK,KAAM,CAAA,CAAA,CAAE,kBAAkB,CAAA;AAAA,MACnD,GAAI,EAAE,gBAAoB,IAAA;AAAA,QACxB,gBAAkB,EAAA,IAAA,CAAK,KAAM,CAAA,CAAA,CAAE,gBAAgB,CAAA;AAAA,OACjD;AAAA,MACA,GAAI,EAAE,MAAU,IAAA,EAAE,QAAQ,IAAK,CAAA,KAAA,CAAM,CAAE,CAAA,MAAM,CAAE,EAAA;AAAA,MAC/C,GAAI,EAAE,KAAS,IAAA,EAAE,OAAO,IAAK,CAAA,KAAA,CAAM,CAAE,CAAA,KAAK,CAAE,EAAA;AAAA,KAC9C,CAAA;AAAA,GACF;AAAA,EAEA,MAAc,QAAQ,KAAiD,EAAA;AACrE,IAAM,MAAA,GAAA,GAAA,CACJ,MAAM,IAAK,CAAA,QAAA,CAAS,iBAAiB,CAClC,CAAA,IAAA,CAAK,eAAe,CACpB,CAAA,QAAA;AAAA,MACC,gBAAA;AAAA,MACA,0BAAA;AAAA,MACA,yBAAA;AAAA,MAED,SAAU,CAAA,0BAA0B,CACvC,EAAA,GAAA,CAAI,KAAK,mBAAmB,CAAA,CAAA;AAC9B,IAAA,IAAI,KAAO,EAAA;AACT,MAAO,OAAA,GAAA,CAAI,OAAO,CAAE,CAAA,KAAA;AA1H1B,QAAA,IAAA,EAAA,CAAA;AA0H6B,QAAE,OAAA,CAAA,CAAA,EAAA,GAAA,CAAA,CAAA,kBAAA,CAAmB,IAArB,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAA2B,KAAU,MAAA,KAAA,CAAA;AAAA,OAAK,CAAA,CAAA;AAAA,KACnE;AAEA,IAAO,OAAA,GAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAc,OAAO,KAAiD,EAAA;AACpE,IAAM,MAAA,GAAA,GAAA,CACJ,MAAM,IAAK,CAAA,QAAA,CAAS,iBAAiB,CAClC,CAAA,IAAA,CAAK,eAAe,CACpB,CAAA,SAAA;AAAA,MACC,gBAAA;AAAA,MACA,0BAAA;AAAA,MACA,yBAAA;AAAA,MAED,SAAU,CAAA,6BAA6B,CAC1C,EAAA,GAAA,CAAI,KAAK,mBAAmB,CAAA,CAAA;AAC9B,IAAA,IAAI,KAAO,EAAA;AACT,MAAO,OAAA,GAAA,CAAI,OAAO,CAAE,CAAA,KAAA;AA5I1B,QAAA,IAAA,EAAA,CAAA;AA4I6B,QAAE,OAAA,CAAA,CAAA,EAAA,GAAA,CAAA,CAAA,kBAAA,CAAmB,IAArB,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAA2B,KAAU,MAAA,KAAA,CAAA;AAAA,OAAK,CAAA,CAAA;AAAA,KACnE;AAEA,IAAO,OAAA,GAAA,CAAA;AAAA,GACT;AAAA,EAEA,cAAiB,GAAA;AACf,IAAA,MAAM,8BAA8BC,sDAAkC,CAAA;AAAA,MACpE,WAAA,EAAa,CAACC,0EAAmC,CAAA;AAAA,KAClD,CAAA,CAAA;AAED,IAAM,MAAA,mBAAA,GAAsB,OAC1B,GAAA,EACA,UACqB,KAAA;AACrB,MAAM,MAAA,QAAA,GAAA,CACJ,MAAM,IAAK,CAAA,WAAA,CAAY,UAAU,CAAC,EAAE,UAAW,EAAC,CAAG,EAAA;AAAA,QACjD,WAAa,EAAA,MAAM,IAAK,CAAA,QAAA,CAAS,YAAY,GAAG,CAAA;AAAA,OACjD,GACD,CAAC,CAAA,CAAA;AAEH,MAAO,OAAA,QAAA,CAAS,WAAWC,sCAAgB,CAAA,IAAA,CAAA;AAAA,KAC7C,CAAA;AAEA,IAAK,IAAA,CAAA,MAAA,CAAO,IAAI,2BAA2B,CAAA,CAAA;AAE3C,IAAA,IAAA,CAAK,YACF,CAAA,GAAA,CAAI,8BAAgC,EAAA,OAAO,KAAK,GAAQ,KAAA;AACvD,MAAA,OAAO,GAAI,CAAA,IAAA;AAAA,QACT,MAAM,KAAK,WAAY,CAAA;AAAA,UACrB,MAAQ,EAAA,QAAA;AAAA,UACR,KAAO,EAAA,MAAA,CAAO,GAAI,CAAA,KAAA,CAAM,KAAK,CAAA;AAAA,SAC9B,CAAA;AAAA,OACH,CAAA;AAAA,KACD,CACA,CAAA,GAAA,CAAI,+BAAiC,EAAA,OAAO,KAAK,GAAQ,KAAA;AACxD,MAAA,OAAO,GAAI,CAAA,IAAA;AAAA,QACT,MAAM,KAAK,WAAY,CAAA;AAAA,UACrB,MAAQ,EAAA,SAAA;AAAA,UACR,KAAO,EAAA,MAAA,CAAO,GAAI,CAAA,KAAA,CAAM,KAAK,CAAA;AAAA,SAC9B,CAAA;AAAA,OACH,CAAA;AAAA,KACD,CACA,CAAA,MAAA;AAAA,MACC,yCAAA;AAAA,MACA,OAAO,SAAS,QAAa,KAAA;AAC3B,QAAA,MAAM,aAAa,MAAM,mBAAA;AAAA,UACvB,OAAA;AAAA,UACAD,0EAAA;AAAA,SACF,CAAA;AAEA,QAAA,IAAI,CAAC,UAAY,EAAA;AACf,UAAM,MAAA,IAAIE,uBAAgB,cAAc,CAAA,CAAA;AAAA,SAC1C;AAEA,QAAA,MAAM,IAAK,CAAA,QAAA,CAAS,eAAe,CAAA,CAChC,KAAM,CAAA,EAAE,SAAW,EAAA,OAAA,CAAQ,MAAO,CAAA,SAAA,EAAW,CAAA,CAC7C,MAAO,EAAA,CAAA;AAEV,QAAS,QAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,EAAA,CAAA;AAAA,OAC5B;AAAA,KACF,CAAA;AAAA,GACJ;AACF;;AChLO,MAAM,mCAAmCC,oCAAoB,CAAA;AAAA,EAClE,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,qCAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,UAAUC,6BAAa,CAAA,QAAA;AAAA,QACvB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,aAAaA,6BAAa,CAAA,WAAA;AAAA,OAC5B;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,QAAA;AAAA,QACA,MAAA;AAAA,QACA,MAAA;AAAA,QACA,WAAA;AAAA,QACA,QAAA;AAAA,QACA,SAAA;AAAA,OACC,EAAA;AACD,QAAM,MAAA,MAAA,GAAS,0BAA0B,MAAO,CAAA;AAAA,UAC9C,QAAA,EAAU,MAAM,QAAA,CAAS,SAAU,EAAA;AAAA,UACnC,MAAA;AAAA,UACA,WAAA;AAAA,UACA,SAAA;AAAA,UACA,QAAA;AAAA,SACD,CAAA,CAAA;AAED,QAAA,MAAA,CAAO,cAAe,EAAA,CAAA;AAEtB,QAAO,MAAA,CAAA,IAAA;AAAA,UACL,mEAAA;AAAA,SACF,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { HttpRouterService } from '@backstage/backend-plugin-api';
+import { HttpRouterService, DiscoveryService, PermissionsService, HttpAuthService } from '@backstage/backend-plugin-api';
 import { Knex } from 'knex';
 
 /**
@@ -17,8 +17,17 @@ declare const catalogModuleUnprocessedEntities: () => _backstage_backend_plugin_
 declare class UnprocessedEntitiesModule {
     private readonly database;
     private readonly router;
+    private readonly permissions;
     private readonly moduleRouter;
-    constructor(database: Knex, router: Pick<HttpRouterService, 'use'>);
+    private readonly httpAuth;
+    private constructor();
+    static create(options: {
+        router: Pick<HttpRouterService, 'use'>;
+        database: Knex;
+        discovery: DiscoveryService;
+        permissions: PermissionsService;
+        httpAuth?: HttpAuthService;
+    }): UnprocessedEntitiesModule;
     private unprocessed;
     private hydrateRefreshState;
     private pending;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-unprocessed",
   "description": "Backstage Catalog module to view unprocessed entities",
-  "version": "0.0.0-nightly-20240319021037",
+  "version": "0.0.0-nightly-20240322021005",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -28,14 +28,21 @@
     "postpack": "backstage-cli package postpack"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.0.0-nightly-20240319021037"
+    "@backstage/cli": "^0.0.0-nightly-20240322021005",
+    "@types/express": "^4.17.6"
   },
   "files": [
     "dist"
   ],
   "dependencies": {
-    "@backstage/backend-plugin-api": "^0.0.0-nightly-20240319021037",
-    "@backstage/catalog-model": "^0.0.0-nightly-20240319021037",
+    "@backstage/backend-common": "^0.0.0-nightly-20240322021005",
+    "@backstage/backend-plugin-api": "^0.0.0-nightly-20240322021005",
+    "@backstage/catalog-model": "^1.4.5",
+    "@backstage/errors": "^1.2.4",
+    "@backstage/plugin-auth-node": "^0.0.0-nightly-20240322021005",
+    "@backstage/plugin-catalog-unprocessed-entities-common": "^0.0.1",
+    "@backstage/plugin-permission-common": "^0.7.13",
+    "@backstage/plugin-permission-node": "^0.0.0-nightly-20240322021005",
     "express-promise-router": "^4.1.1",
     "knex": "^3.0.0"
   }