@pagerduty/backstage-plugin-entity-processor 0.1.0-next.0 → 0.1.0-next.10

package/README.md

@@ -7,12 +7,11 @@
 **Bring the power of PagerDuty to Backstage!**
 The PagerDuty plugin reduces the cognitive load on developers responsible for maintaining services in production. Instead of having to go to PagerDuty's console, you can now access the necessary information directly within Backstage. This includes finding active incidents or opening a new incident, reviewing recent changes made to the service, and checking who is on-call.
 
-The PagerDuty Scaffolder Actions package allows users to create services in PagerDuty directly from their Software Templates in a single step by leveraging the `pagerduty:service:create` custom action.
+The PagerDuty Entity Processor package allows users to map their existing PagerDuty services to existing Backstage entities by leveraging point and click instead of updating all configuration files on every single service. With this we want to ease the path for existing PagerDuty customers to integrate easily with Backstage and smoothly transition to a configuration based approach.
 
 ## Features
 
-- **Scaffolder Action for creating services** This feature enables teams to create project templates that automatically generate a corresponding service in PagerDuty. These services come with a built-in integration to Backstage, which conveniently configures the frontend plugin for your service.
-
+- **Entity processor** This feature augments Backstage entities with the appropiate PagerDuty annotations to allow easy mapping between Backstage entities and existing PagerDuty services.
 
 ## Getting Started
 
@@ -25,18 +24,17 @@ The installation of the PagerDuty plugin for Backstage is done with *yarn* as al
 To install this plugin run the following command from the Backstage root folder.
 
 ```bash
-yarn add --cwd packages/backend @pagerduty/backstage-plugin-scaffolder-actions @pagerduty/backstage-plugin-common
+yarn add --cwd packages/backend @pagerduty/backstage-plugin-entity-processor
 ```
 
 ### Configuration
 
-To use the custom actions as part of your custom project templates follow the instructions on the `Create PagerDuty service with Software Templates` section of the project's documentation [here](https://pagerduty.github.io/backstage-plugin-docs/advanced/create-service-software-template/).
+...
 
 ## Support
 
-If you need help with this plugin, please open an issue in [GitHub](https://github.com/PagerDuty/backstage-plugin-scaffolder-actions), reach out on the [Backstage Discord server](https://discord.gg/backstage-687207715902193673) or [PagerDuty's community forum](https://community.pagerduty.com).
+If you need help with this plugin, please open an issue in [GitHub](https://github.com/PagerDuty/backstage-plugin-entity-provider), reach out on the [Backstage Discord server](https://discord.gg/backstage-687207715902193673) or [PagerDuty's community forum](https://community.pagerduty.com).
 
 ## Contributing
 
 If you are interested in contributing to this project, please refer to our [Contributing Guidelines](https://github.com/PagerDuty/backstage-plugin-backend/blob/main/CONTRIBUTING.md).
-

package/dist/index.cjs.js

@@ -2,6 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha = require('@backstage/plugin-catalog-node/alpha');
+
 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;
 var __publicField = (obj, key, value) => {
@@ -9,12 +12,14 @@ var __publicField = (obj, key, value) => {
   return value;
 };
 class PagerDutyEntityProcessor {
-  // private shouldProcessEntity: ShouldProcessEntity = (entity: Entity) => {
-  //     return entity.kind === 'Component';
-  // }
-  constructor(logger) {
+  constructor({ logger, store }) {
     __publicField(this, "logger");
+    __publicField(this, "store");
+    __publicField(this, "shouldProcessEntity", (entity) => {
+      return entity.kind === "Component";
+    });
     this.logger = logger;
+    this.store = store;
   }
   getProcessorName() {
     return "PagerDutyEntityProcessor";
@@ -22,17 +27,60 @@ class PagerDutyEntityProcessor {
   // static fromConfig(): PagerDutyEntityProcessor {
   //     return new PagerDutyEntityProcessor();
   // }
-  async preProcessEntity(entity) {
-    this.logger.info(`Processing entity: ${entity.metadata.name}`);
-    if (entity.metadata.annotations) {
-      entity.metadata.annotations = {
-        "pagerduty.com/integration-key": "123",
-        "pagerduty.com/service-id": "123"
-      };
+  async postProcessEntity(entity) {
+    if (this.shouldProcessEntity(entity)) {
+      this.logger.info(`Processing entity: ${JSON.stringify(entity)}`);
+      const entityRef = `${entity.kind}:${entity.metadata.namespace}/${entity.metadata.name}`.toLowerCase();
+      this.logger.info(`Looking for entity mapping with ref: ${entityRef}`);
+      try {
+        const mapping = await this.store.findEntityMappingByEntityRef("e4657ba9-bdc4-4375-b46c-fd7dc188090e");
+        if (mapping) {
+          this.logger.info(`Found mapping for entity: ${entity.metadata.name}`);
+          entity.metadata.annotations["pagerduty.com/service-id"] = mapping.serviceId;
+        } else {
+          this.logger.info(`No mapping found for entity: ${entity.metadata.name}`);
+        }
+      } catch (error) {
+        this.logger.error(`Error processing entity: ${entity.metadata.name}`);
+        this.logger.error(JSON.stringify(error));
+      }
     }
     return entity;
   }
 }
 
-exports.PagerDutyEntityProcessor = PagerDutyEntityProcessor;
+class PagerDutyBackendDatabase {
+  constructor(db) {
+    this.db = db;
+  }
+  static async create(knex) {
+    return new PagerDutyBackendDatabase(knex);
+  }
+  async findEntityMappingByEntityRef(entityRef) {
+    const rawEntity = await this.db("pagerduty_entity_mapping").where("entityRef", entityRef).first();
+    return rawEntity;
+  }
+}
+
+const pagerDutyEntityProcessor = backendPluginApi.createBackendModule({
+  pluginId: "catalog",
+  moduleId: "pagerduty-entity-processor",
+  register(env) {
+    env.registerInit({
+      deps: {
+        logger: backendPluginApi.coreServices.logger,
+        database: backendPluginApi.coreServices.database,
+        catalog: alpha.catalogProcessingExtensionPoint
+      },
+      async init({ logger, database, catalog }) {
+        const store = await PagerDutyBackendDatabase.create(
+          await database.getClient()
+        );
+        catalog.addProcessor(new PagerDutyEntityProcessor({ logger, store }));
+      }
+    });
+  }
+});
+
+exports["default"] = pagerDutyEntityProcessor;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/processor/PagerDutyEntityProcessor.ts"],"sourcesContent":["import { LoggerService } from \"@backstage/backend-plugin-api\";\nimport { Entity } from \"@backstage/catalog-model\";\nimport { CatalogProcessor } from \"@backstage/plugin-catalog-node\";\n\n/**\n * A function which given an entity, determines if it should be processed for linguist tags.\n * @public\n */\n// export type ShouldProcessEntity = (entity: Entity) => boolean;\n\nexport class PagerDutyEntityProcessor implements CatalogProcessor {\n    private logger: LoggerService;\n    // private shouldProcessEntity: ShouldProcessEntity = (entity: Entity) => {\n    //     return entity.kind === 'Component';\n    // }\n\n    constructor(logger: LoggerService) {\n        this.logger = logger;\n    }\n\n    getProcessorName(): string {\n        return \"PagerDutyEntityProcessor\";\n    }\n\n    // static fromConfig(): PagerDutyEntityProcessor {\n    //     return new PagerDutyEntityProcessor();\n    // }\n\n    async preProcessEntity(entity: Entity): Promise<Entity> {\n        // if (this.shouldProcessEntity(entity)) {\n            this.logger.info(`Processing entity: ${entity.metadata.name}`);\n            if(entity.metadata.annotations){\n                entity.metadata.annotations = {\n                    \"pagerduty.com/integration-key\": \"123\",\n                    \"pagerduty.com/service-id\": \"123\",\n                }                \n            }\n        // }\n\n        return entity;\n    }\n}"],"names":[],"mappings":";;;;;;;;;;AAUO,MAAM,wBAAqD,CAAA;AAAA;AAAA;AAAA;AAAA,EAM9D,YAAY,MAAuB,EAAA;AALnC,IAAQ,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AAMJ,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AAAA,GAClB;AAAA,EAEA,gBAA2B,GAAA;AACvB,IAAO,OAAA,0BAAA,CAAA;AAAA,GACX;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,iBAAiB,MAAiC,EAAA;AAEhD,IAAA,IAAA,CAAK,OAAO,IAAK,CAAA,CAAA,mBAAA,EAAsB,MAAO,CAAA,QAAA,CAAS,IAAI,CAAE,CAAA,CAAA,CAAA;AAC7D,IAAG,IAAA,MAAA,CAAO,SAAS,WAAY,EAAA;AAC3B,MAAA,MAAA,CAAO,SAAS,WAAc,GAAA;AAAA,QAC1B,+BAAiC,EAAA,KAAA;AAAA,QACjC,0BAA4B,EAAA,KAAA;AAAA,OAChC,CAAA;AAAA,KACJ;AAGJ,IAAO,OAAA,MAAA,CAAA;AAAA,GACX;AACJ;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/processor/PagerDutyEntityProcessor.ts","../src/db/PagerDutyBackendDatabase.ts","../src/module.ts"],"sourcesContent":["import { LoggerService } from \"@backstage/backend-plugin-api\";\nimport { Entity } from \"@backstage/catalog-model\";\nimport { CatalogProcessor } from \"@backstage/plugin-catalog-node\";\nimport { PagerDutyBackendStore } from \"../db\";\n\n/**\n * A function which given an entity, determines if it should be processed for linguist tags.\n * @public\n */\nexport type ShouldProcessEntity = (entity: Entity) => boolean;\n\nexport interface PagerDutyEntityProcessorOptions {\n    logger: LoggerService;\n    store: PagerDutyBackendStore;\n};\n\nexport class PagerDutyEntityProcessor implements CatalogProcessor {\n    private logger: LoggerService;\n    private store: PagerDutyBackendStore;\n    private shouldProcessEntity: ShouldProcessEntity = (entity: Entity) => {\n        return entity.kind === 'Component';\n    }\n\n    constructor({ logger, store }: PagerDutyEntityProcessorOptions) {\n        this.logger = logger;\n        this.store = store;\n    }\n\n    getProcessorName(): string {\n        return \"PagerDutyEntityProcessor\";\n    }\n\n    // static fromConfig(): PagerDutyEntityProcessor {\n    //     return new PagerDutyEntityProcessor();\n    // }\n\n    async postProcessEntity(entity: Entity): Promise<Entity> {\n        if (this.shouldProcessEntity(entity)) {\n            this.logger.info(`Processing entity: ${JSON.stringify(entity)}`);\n\n            const entityRef = `${entity.kind}:${entity.metadata.namespace}/${entity.metadata.name}`.toLowerCase();\n            this.logger.info(`Looking for entity mapping with ref: ${entityRef}`);\n\n            try{\n                const mapping = await this.store.findEntityMappingByEntityRef(\"e4657ba9-bdc4-4375-b46c-fd7dc188090e\");\n                if (mapping) {\n                    this.logger.info(`Found mapping for entity: ${entity.metadata.name}`);\n                    entity.metadata.annotations![\"pagerduty.com/service-id\"] = mapping.serviceId;\n                } else {\n                    this.logger.info(`No mapping found for entity: ${entity.metadata.name}`);\n                }\n            } catch (error) {\n                this.logger.error(`Error processing entity: ${entity.metadata.name}`);\n                this.logger.error(JSON.stringify(error));\n            }        \n        }\n\n        return entity;\n    }\n}","import { Knex } from 'knex';\n\nexport type RawDbEntityResultRow = {\n    id: string;\n    entityRef: string;\n    serviceId: string;\n    processedDate?: Date;\n};\n\n/** @public */\nexport interface PagerDutyBackendStore {\n    findEntityMappingByEntityRef(entityRef: string): Promise<RawDbEntityResultRow | undefined>\n}\n\n\n/** @public */\nexport class PagerDutyBackendDatabase implements PagerDutyBackendStore {\n    static async create(knex: Knex): Promise<PagerDutyBackendStore> {\n        \n        return new PagerDutyBackendDatabase(knex);\n    }\n\n    constructor(private readonly db: Knex) { }\n\n    async findEntityMappingByEntityRef(entityRef: string): Promise<RawDbEntityResultRow | undefined> {\n        const rawEntity = await this.db<RawDbEntityResultRow>('pagerduty_entity_mapping')\n            .where('entityRef', entityRef)\n            .first();\n\n        return rawEntity;\n    }\n}","import { coreServices, createBackendModule } from \"@backstage/backend-plugin-api\";\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport { PagerDutyEntityProcessor } from \"./processor\";\nimport { PagerDutyBackendDatabase, PagerDutyBackendStore } from \"./db/PagerDutyBackendDatabase\";\n\n\n\n/** @public */\nexport const pagerDutyEntityProcessor = createBackendModule({\n    pluginId: 'catalog',\n    moduleId: 'pagerduty-entity-processor',\n    register(env) {\n        env.registerInit({\n            deps: {\n                logger: coreServices.logger,\n                database: coreServices.database,\n                catalog: catalogProcessingExtensionPoint,\n            },\n            async init({ logger, database, catalog }) {\n\n                const store: PagerDutyBackendStore = await PagerDutyBackendDatabase.create(\n                    await database.getClient(),\n                );\n\n                catalog.addProcessor(new PagerDutyEntityProcessor({ logger, store}));\n            },\n        });\n    },\n});\n"],"names":["createBackendModule","coreServices","catalogProcessingExtensionPoint"],"mappings":";;;;;;;;;;;;;AAgBO,MAAM,wBAAqD,CAAA;AAAA,EAO9D,WAAY,CAAA,EAAE,MAAQ,EAAA,KAAA,EAA0C,EAAA;AANhE,IAAQ,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,OAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,qBAAA,EAA2C,CAAC,MAAmB,KAAA;AACnE,MAAA,OAAO,OAAO,IAAS,KAAA,WAAA,CAAA;AAAA,KAC3B,CAAA,CAAA;AAGI,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAA,IAAA,CAAK,KAAQ,GAAA,KAAA,CAAA;AAAA,GACjB;AAAA,EAEA,gBAA2B,GAAA;AACvB,IAAO,OAAA,0BAAA,CAAA;AAAA,GACX;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,kBAAkB,MAAiC,EAAA;AACrD,IAAI,IAAA,IAAA,CAAK,mBAAoB,CAAA,MAAM,CAAG,EAAA;AAClC,MAAA,IAAA,CAAK,OAAO,IAAK,CAAA,CAAA,mBAAA,EAAsB,KAAK,SAAU,CAAA,MAAM,CAAC,CAAE,CAAA,CAAA,CAAA;AAE/D,MAAA,MAAM,SAAY,GAAA,CAAA,EAAG,MAAO,CAAA,IAAI,CAAI,CAAA,EAAA,MAAA,CAAO,QAAS,CAAA,SAAS,CAAI,CAAA,EAAA,MAAA,CAAO,QAAS,CAAA,IAAI,GAAG,WAAY,EAAA,CAAA;AACpG,MAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAAwC,qCAAA,EAAA,SAAS,CAAE,CAAA,CAAA,CAAA;AAEpE,MAAG,IAAA;AACC,QAAA,MAAM,OAAU,GAAA,MAAM,IAAK,CAAA,KAAA,CAAM,6BAA6B,sCAAsC,CAAA,CAAA;AACpG,QAAA,IAAI,OAAS,EAAA;AACT,UAAA,IAAA,CAAK,OAAO,IAAK,CAAA,CAAA,0BAAA,EAA6B,MAAO,CAAA,QAAA,CAAS,IAAI,CAAE,CAAA,CAAA,CAAA;AACpE,UAAA,MAAA,CAAO,QAAS,CAAA,WAAA,CAAa,0BAA0B,CAAA,GAAI,OAAQ,CAAA,SAAA,CAAA;AAAA,SAChE,MAAA;AACH,UAAA,IAAA,CAAK,OAAO,IAAK,CAAA,CAAA,6BAAA,EAAgC,MAAO,CAAA,QAAA,CAAS,IAAI,CAAE,CAAA,CAAA,CAAA;AAAA,SAC3E;AAAA,eACK,KAAO,EAAA;AACZ,QAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,yBAAA,EAA4B,MAAO,CAAA,QAAA,CAAS,IAAI,CAAE,CAAA,CAAA,CAAA;AACpE,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,IAAK,CAAA,SAAA,CAAU,KAAK,CAAC,CAAA,CAAA;AAAA,OAC3C;AAAA,KACJ;AAEA,IAAO,OAAA,MAAA,CAAA;AAAA,GACX;AACJ;;AC3CO,MAAM,wBAA0D,CAAA;AAAA,EAMnE,YAA6B,EAAU,EAAA;AAAV,IAAA,IAAA,CAAA,EAAA,GAAA,EAAA,CAAA;AAAA,GAAY;AAAA,EALzC,aAAa,OAAO,IAA4C,EAAA;AAE5D,IAAO,OAAA,IAAI,yBAAyB,IAAI,CAAA,CAAA;AAAA,GAC5C;AAAA,EAIA,MAAM,6BAA6B,SAA8D,EAAA;AAC7F,IAAM,MAAA,SAAA,GAAY,MAAM,IAAA,CAAK,EAAyB,CAAA,0BAA0B,EAC3E,KAAM,CAAA,WAAA,EAAa,SAAS,CAAA,CAC5B,KAAM,EAAA,CAAA;AAEX,IAAO,OAAA,SAAA,CAAA;AAAA,GACX;AACJ;;ACvBO,MAAM,2BAA2BA,oCAAoB,CAAA;AAAA,EACxD,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,4BAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACV,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACb,IAAM,EAAA;AAAA,QACF,QAAQC,6BAAa,CAAA,MAAA;AAAA,QACrB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,OAAS,EAAAC,qCAAA;AAAA,OACb;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,MAAQ,EAAA,QAAA,EAAU,SAAW,EAAA;AAEtC,QAAM,MAAA,KAAA,GAA+B,MAAM,wBAAyB,CAAA,MAAA;AAAA,UAChE,MAAM,SAAS,SAAU,EAAA;AAAA,SAC7B,CAAA;AAEA,QAAA,OAAA,CAAQ,aAAa,IAAI,wBAAA,CAAyB,EAAE,MAAQ,EAAA,KAAA,EAAM,CAAC,CAAA,CAAA;AAAA,OACvE;AAAA,KACH,CAAA,CAAA;AAAA,GACL;AACJ,CAAC;;;;"}

package/dist/index.d.ts

@@ -1,16 +1,6 @@
-import { LoggerService } from '@backstage/backend-plugin-api';
-import { Entity } from '@backstage/catalog-model';
-import { CatalogProcessor } from '@backstage/plugin-catalog-node';
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
 
-/**
- * A function which given an entity, determines if it should be processed for linguist tags.
- * @public
- */
-declare class PagerDutyEntityProcessor implements CatalogProcessor {
-    private logger;
-    constructor(logger: LoggerService);
-    getProcessorName(): string;
-    preProcessEntity(entity: Entity): Promise<Entity>;
-}
+/** @public */
+declare const pagerDutyEntityProcessor: _backstage_backend_plugin_api.BackendFeatureCompat;
 
-export { PagerDutyEntityProcessor };
+export { pagerDutyEntityProcessor as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pagerduty/backstage-plugin-entity-processor",
-  "version": "0.1.0-next.0",
+  "version": "0.1.0-next.10",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -24,21 +24,18 @@
   "dependencies": {
     "@backstage/backend-common": "^0.21.6",
     "@backstage/backend-defaults": "^0.2.16",
-    "@backstage/backend-plugin-api": "^0.6.16",
+    "@backstage/backend-plugin-api": "^0.6.20",
     "@backstage/config": "^1.2.0",
     "@backstage/plugin-catalog-node": "^1.12.2",
+    "@pagerduty/backstage-plugin-common": "0.1.5-next.8",
     "@rjsf/core": "^5.14.3",
     "node-fetch": "^2.6.7",
     "winston": "^3.2.1",
     "yn": "^4.0.0",
     "zod": "^3.22.4"
   },
-  "peerDependencies": {
-    "@pagerduty/backstage-plugin-common": "^0.1.4"
-  },
   "devDependencies": {
     "@backstage/cli": "^0.24.0",
-    "@pagerduty/backstage-plugin-common": "^0.1.4",
     "@types/node": "^20.9.2",
     "@types/node-fetch": "2.6.11",
     "@types/supertest": "^2.0.12",