@drodil/backstage-plugin-catalog-backend-module-qeta 3.35.2

package/README.md

@@ -0,0 +1,19 @@
+# @internal/plugin-catalog-backend-module-qeta
+
+The qeta backend module for the catalog plugin.
+
+## Installation
+
+In your `packages/backend/src/index.ts` make the following changes:
+
+```diff
+  import { createBackend } from '@backstage/backend-defaults';
+  const backend = createBackend();
+  // ... other feature additions
++ backend.add(import('@drodil/backstage-plugin-catalog-backend-module-qeta'));
+  backend.start();
+```
+
+## Processors
+
+- `CatalogEntityLinkProcessor`: Adds `qeta` links in catalog entities.

package/dist/index.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var module$1 = require('./module.cjs.js');
+
+
+
+exports.default = module$1.catalogModuleQeta;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+
+declare const catalogModuleQeta: _backstage_backend_plugin_api.BackendFeature;
+
+export { catalogModuleQeta as default };

package/dist/module.cjs.js

@@ -0,0 +1,29 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha = require('@backstage/plugin-catalog-node/alpha');
+var CatalogEntityLinkProcessor = require('./processors/CatalogEntityLinkProcessor.cjs.js');
+
+const catalogModuleQeta = backendPluginApi.createBackendModule({
+  pluginId: "catalog",
+  moduleId: "qeta",
+  register(reg) {
+    reg.registerInit({
+      deps: {
+        builder: alpha.catalogProcessingExtensionPoint,
+        cache: backendPluginApi.coreServices.cache,
+        auth: backendPluginApi.coreServices.auth,
+        logger: backendPluginApi.coreServices.logger,
+        discovery: backendPluginApi.coreServices.discovery
+      },
+      async init({ builder, cache, auth, logger, discovery }) {
+        builder.addProcessor(
+          new CatalogEntityLinkProcessor.CatalogEntityLinkProcessor(auth, cache, logger, discovery)
+        );
+      }
+    });
+  }
+});
+
+exports.catalogModuleQeta = catalogModuleQeta;
+//# sourceMappingURL=module.cjs.js.map

package/dist/module.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.cjs.js","sources":["../src/module.ts"],"sourcesContent":["import {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport { CatalogEntityLinkProcessor } from './processors/CatalogEntityLinkProcessor.ts';\n\nexport const catalogModuleQeta = createBackendModule({\n  pluginId: 'catalog',\n  moduleId: 'qeta',\n  register(reg) {\n    reg.registerInit({\n      deps: {\n        builder: catalogProcessingExtensionPoint,\n        cache: coreServices.cache,\n        auth: coreServices.auth,\n        logger: coreServices.logger,\n        discovery: coreServices.discovery,\n      },\n      async init({ builder, cache, auth, logger, discovery }) {\n        builder.addProcessor(\n          new CatalogEntityLinkProcessor(auth, cache, logger, discovery),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","catalogProcessingExtensionPoint","coreServices","CatalogEntityLinkProcessor"],"mappings":";;;;;;AAOO,MAAM,oBAAoBA,oCAAoB,CAAA;AAAA,EACnD,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,MAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,OAAS,EAAAC,qCAAA;AAAA,QACT,OAAOC,6BAAa,CAAA,KAAA;AAAA,QACpB,MAAMA,6BAAa,CAAA,IAAA;AAAA,QACnB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA;AAAA,OAC1B;AAAA,MACA,MAAM,KAAK,EAAE,OAAA,EAAS,OAAO,IAAM,EAAA,MAAA,EAAQ,WAAa,EAAA;AACtD,QAAQ,OAAA,CAAA,YAAA;AAAA,UACN,IAAIC,qDAAA,CAA2B,IAAM,EAAA,KAAA,EAAO,QAAQ,SAAS;AAAA,SAC/D;AAAA;AACF,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}

package/dist/processors/CatalogEntityLinkProcessor.cjs.js

@@ -0,0 +1,67 @@
+'use strict';
+
+var catalogModel = require('@backstage/catalog-model');
+var backstagePluginQetaCommon = require('@drodil/backstage-plugin-qeta-common');
+
+class CatalogEntityLinkProcessor {
+  constructor(auth, cache, logger, discovery) {
+    this.auth = auth;
+    this.cache = cache;
+    this.logger = logger;
+    this.client = new backstagePluginQetaCommon.QetaClient({ discoveryApi: discovery });
+  }
+  client;
+  getProcessorName() {
+    return "CatalogEntityLinkProcessor";
+  }
+  async postProcessEntity(entity) {
+    const entityRef = catalogModel.stringifyEntityRef(entity);
+    const entityLinks = await this.getEntityLinks();
+    const links = entityLinks.filter((link) => link.entityRef === entityRef).map((link) => link.links).flat();
+    if (!links || links.length === 0) {
+      return entity;
+    }
+    const existingLinks = entity.metadata.links ?? [];
+    const uniqueLinks = [...existingLinks].filter((link) => link.type !== "qeta");
+    for (const link of links) {
+      if (!existingLinks.find((l) => l.url === link.url)) {
+        uniqueLinks.push(link);
+      }
+    }
+    this.logger.debug(
+      `Adding total of ${uniqueLinks.length}, new ${uniqueLinks.length - existingLinks.length} links to entity ${entityRef}`
+    );
+    return {
+      ...entity,
+      metadata: {
+        ...entity.metadata,
+        links: uniqueLinks
+      }
+    };
+  }
+  async getEntityLinks() {
+    const cached = await this.cache.get("qeta-entity-links");
+    if (cached) {
+      try {
+        return JSON.parse(cached);
+      } catch (e) {
+        this.logger.warn(`Failed to parse cached entity links: ${e}`);
+      }
+    }
+    this.logger.info(`Fetching entity links from Qeta`);
+    const credentials = await this.auth.getOwnServiceCredentials();
+    const { token } = await this.auth.getPluginRequestToken({
+      onBehalfOf: credentials,
+      targetPluginId: "qeta"
+    });
+    const links = await this.client.getEntityLinks({ token });
+    await this.cache.set("qeta-entity-links", JSON.stringify(links), {
+      ttl: 60 * 60
+      // cache for 1 hour
+    });
+    return links;
+  }
+}
+
+exports.CatalogEntityLinkProcessor = CatalogEntityLinkProcessor;
+//# sourceMappingURL=CatalogEntityLinkProcessor.cjs.js.map

package/dist/processors/CatalogEntityLinkProcessor.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CatalogEntityLinkProcessor.cjs.js","sources":["../../src/processors/CatalogEntityLinkProcessor.ts"],"sourcesContent":["import { CatalogProcessor } from '@backstage/plugin-catalog-node';\nimport { Entity, stringifyEntityRef } from '@backstage/catalog-model';\nimport {\n  AuthService,\n  CacheService,\n  DiscoveryService,\n  LoggerService,\n} from '@backstage/backend-plugin-api';\nimport {\n  EntityLinks,\n  QetaApi,\n  QetaClient,\n} from '@drodil/backstage-plugin-qeta-common';\n\nexport class CatalogEntityLinkProcessor implements CatalogProcessor {\n  private readonly client: QetaApi;\n\n  constructor(\n    private readonly auth: AuthService,\n    private readonly cache: CacheService,\n    private readonly logger: LoggerService,\n    discovery: DiscoveryService,\n  ) {\n    this.client = new QetaClient({ discoveryApi: discovery });\n  }\n\n  getProcessorName(): string {\n    return 'CatalogEntityLinkProcessor';\n  }\n\n  async postProcessEntity(entity: Entity): Promise<Entity> {\n    const entityRef = stringifyEntityRef(entity);\n    const entityLinks = await this.getEntityLinks();\n    const links = entityLinks\n      .filter(link => link.entityRef === entityRef)\n      .map(link => link.links)\n      .flat();\n    if (!links || links.length === 0) {\n      return entity;\n    }\n\n    const existingLinks = entity.metadata.links ?? [];\n    const uniqueLinks = [...existingLinks].filter(link => link.type !== 'qeta');\n    for (const link of links) {\n      if (!existingLinks.find(l => l.url === link.url)) {\n        uniqueLinks.push(link);\n      }\n    }\n\n    this.logger.debug(\n      `Adding total of ${uniqueLinks.length}, new ${\n        uniqueLinks.length - existingLinks.length\n      } links to entity ${entityRef}`,\n    );\n\n    return {\n      ...entity,\n      metadata: {\n        ...entity.metadata,\n        links: uniqueLinks,\n      },\n    };\n  }\n\n  private async getEntityLinks(): Promise<EntityLinks[]> {\n    const cached = await this.cache.get<string>('qeta-entity-links');\n    if (cached) {\n      try {\n        return JSON.parse(cached);\n      } catch (e) {\n        this.logger.warn(`Failed to parse cached entity links: ${e}`);\n      }\n    }\n\n    this.logger.info(`Fetching entity links from Qeta`);\n    const credentials = await this.auth.getOwnServiceCredentials();\n    const { token } = await this.auth.getPluginRequestToken({\n      onBehalfOf: credentials,\n      targetPluginId: 'qeta',\n    });\n    const links = await this.client.getEntityLinks({ token });\n    await this.cache.set('qeta-entity-links', JSON.stringify(links), {\n      ttl: 60 * 60, // cache for 1 hour\n    });\n    return links;\n  }\n}\n"],"names":["QetaClient","stringifyEntityRef"],"mappings":";;;;;AAcO,MAAM,0BAAuD,CAAA;AAAA,EAGlE,WACmB,CAAA,IAAA,EACA,KACA,EAAA,MAAA,EACjB,SACA,EAAA;AAJiB,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AACA,IAAA,IAAA,CAAA,KAAA,GAAA,KAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AAGjB,IAAA,IAAA,CAAK,SAAS,IAAIA,oCAAA,CAAW,EAAE,YAAA,EAAc,WAAW,CAAA;AAAA;AAC1D,EATiB,MAAA;AAAA,EAWjB,gBAA2B,GAAA;AACzB,IAAO,OAAA,4BAAA;AAAA;AACT,EAEA,MAAM,kBAAkB,MAAiC,EAAA;AACvD,IAAM,MAAA,SAAA,GAAYC,gCAAmB,MAAM,CAAA;AAC3C,IAAM,MAAA,WAAA,GAAc,MAAM,IAAA,CAAK,cAAe,EAAA;AAC9C,IAAA,MAAM,KAAQ,GAAA,WAAA,CACX,MAAO,CAAA,CAAA,IAAA,KAAQ,IAAK,CAAA,SAAA,KAAc,SAAS,CAAA,CAC3C,GAAI,CAAA,CAAA,IAAA,KAAQ,IAAK,CAAA,KAAK,EACtB,IAAK,EAAA;AACR,IAAA,IAAI,CAAC,KAAA,IAAS,KAAM,CAAA,MAAA,KAAW,CAAG,EAAA;AAChC,MAAO,OAAA,MAAA;AAAA;AAGT,IAAA,MAAM,aAAgB,GAAA,MAAA,CAAO,QAAS,CAAA,KAAA,IAAS,EAAC;AAChD,IAAM,MAAA,WAAA,GAAc,CAAC,GAAG,aAAa,EAAE,MAAO,CAAA,CAAA,IAAA,KAAQ,IAAK,CAAA,IAAA,KAAS,MAAM,CAAA;AAC1E,IAAA,KAAA,MAAW,QAAQ,KAAO,EAAA;AACxB,MAAI,IAAA,CAAC,cAAc,IAAK,CAAA,CAAA,CAAA,KAAK,EAAE,GAAQ,KAAA,IAAA,CAAK,GAAG,CAAG,EAAA;AAChD,QAAA,WAAA,CAAY,KAAK,IAAI,CAAA;AAAA;AACvB;AAGF,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACV,CAAA,gBAAA,EAAmB,YAAY,MAAM,CAAA,MAAA,EACnC,YAAY,MAAS,GAAA,aAAA,CAAc,MACrC,CAAA,iBAAA,EAAoB,SAAS,CAAA;AAAA,KAC/B;AAEA,IAAO,OAAA;AAAA,MACL,GAAG,MAAA;AAAA,MACH,QAAU,EAAA;AAAA,QACR,GAAG,MAAO,CAAA,QAAA;AAAA,QACV,KAAO,EAAA;AAAA;AACT,KACF;AAAA;AACF,EAEA,MAAc,cAAyC,GAAA;AACrD,IAAA,MAAM,MAAS,GAAA,MAAM,IAAK,CAAA,KAAA,CAAM,IAAY,mBAAmB,CAAA;AAC/D,IAAA,IAAI,MAAQ,EAAA;AACV,MAAI,IAAA;AACF,QAAO,OAAA,IAAA,CAAK,MAAM,MAAM,CAAA;AAAA,eACjB,CAAG,EAAA;AACV,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAAwC,qCAAA,EAAA,CAAC,CAAE,CAAA,CAAA;AAAA;AAC9D;AAGF,IAAK,IAAA,CAAA,MAAA,CAAO,KAAK,CAAiC,+BAAA,CAAA,CAAA;AAClD,IAAA,MAAM,WAAc,GAAA,MAAM,IAAK,CAAA,IAAA,CAAK,wBAAyB,EAAA;AAC7D,IAAA,MAAM,EAAE,KAAM,EAAA,GAAI,MAAM,IAAA,CAAK,KAAK,qBAAsB,CAAA;AAAA,MACtD,UAAY,EAAA,WAAA;AAAA,MACZ,cAAgB,EAAA;AAAA,KACjB,CAAA;AACD,IAAA,MAAM,QAAQ,MAAM,IAAA,CAAK,OAAO,cAAe,CAAA,EAAE,OAAO,CAAA;AACxD,IAAA,MAAM,KAAK,KAAM,CAAA,GAAA,CAAI,qBAAqB,IAAK,CAAA,SAAA,CAAU,KAAK,CAAG,EAAA;AAAA,MAC/D,KAAK,EAAK,GAAA;AAAA;AAAA,KACX,CAAA;AACD,IAAO,OAAA,KAAA;AAAA;AAEX;;;;"}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@drodil/backstage-plugin-catalog-backend-module-qeta",
+  "version": "3.35.2",
+  "license": "MIT",
+  "description": "The qeta backend module for the catalog plugin.",
+  "keywords": [
+    "backstage",
+    "plugin",
+    "backend",
+    "backstage.io"
+  ],
+  "homepage": "https://github.com/drodil/backstage-plugin-qeta",
+  "prepublishOnly": "yarn tsc && yarn build",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "bugs": {
+    "url": "https://github.com/drodil/backstage-plugin-qeta/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/drodil/backstage-plugin-qeta.git"
+  },
+  "backstage": {
+    "role": "backend-plugin-module",
+    "pluginId": "catalog",
+    "pluginPackage": "@backstage/plugin-catalog-backend",
+    "features": {
+      ".": "@backstage/BackendFeature"
+    }
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "tsc": "tsc"
+  },
+  "dependencies": {
+    "@backstage/backend-plugin-api": "^1.4.3",
+    "@backstage/catalog-model": "^1.7.5",
+    "@backstage/plugin-catalog-node": "^1.19.0",
+    "@drodil/backstage-plugin-qeta-common": "^3.36.1"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "^1.9.0",
+    "@backstage/cli": "^0.34.3"
+  },
+  "files": [
+    "dist"
+  ],
+  "typesVersions": {
+    "*": {
+      "package.json": [
+        "package.json"
+      ]
+    }
+  }
+}