@backstage/plugin-catalog-backend 1.9.2-next.1 → 1.10.0

package/CHANGELOG.md

@@ -1,5 +1,64 @@
 # @backstage/plugin-catalog-backend
 
+## 1.10.0
+
+### Minor Changes
+
+- 44c7ad6b8e11: Adds an optional `EventBroker` that is used for sending an event when there are conflicts, with details of the conflict so that it can be handled elsewhere.
+
+### Patch Changes
+
+- 77e04a2d55be: Replace getBearerToken with library function of same
+- ee411e7c2623: Update OpenAPI specs to be in line with linting standards.
+- b8374d5d93b6: Add a base plate for performance testing of the catalog
+- Updated dependencies
+  - @backstage/backend-common@0.19.0
+  - @backstage/catalog-client@1.4.2
+  - @backstage/types@1.1.0
+  - @backstage/integration@1.5.0
+  - @backstage/catalog-model@1.4.0
+  - @backstage/errors@1.2.0
+  - @backstage/backend-plugin-api@0.5.3
+  - @backstage/backend-tasks@0.5.3
+  - @backstage/plugin-auth-node@0.2.15
+  - @backstage/plugin-catalog-node@1.3.7
+  - @backstage/plugin-permission-node@0.7.9
+  - @backstage/plugin-search-backend-module-catalog@0.1.2
+  - @backstage/config@1.0.8
+  - @backstage/plugin-catalog-common@1.0.14
+  - @backstage/plugin-events-node@0.2.7
+  - @backstage/plugin-permission-common@0.7.6
+  - @backstage/plugin-scaffolder-common@1.3.1
+  - @backstage/plugin-search-common@1.2.4
+
+## 1.10.0-next.2
+
+### Minor Changes
+
+- 44c7ad6b8e11: Adds an optional `EventBroker` that is used for sending an event when there are conflicts, with details of the conflict so that it can be handled elsewhere.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.19.0-next.2
+  - @backstage/catalog-model@1.4.0-next.1
+  - @backstage/backend-plugin-api@0.5.3-next.2
+  - @backstage/backend-tasks@0.5.3-next.2
+  - @backstage/catalog-client@1.4.2-next.2
+  - @backstage/config@1.0.7
+  - @backstage/errors@1.2.0-next.0
+  - @backstage/integration@1.5.0-next.0
+  - @backstage/types@1.0.2
+  - @backstage/plugin-auth-node@0.2.15-next.2
+  - @backstage/plugin-catalog-common@1.0.14-next.1
+  - @backstage/plugin-catalog-node@1.3.7-next.2
+  - @backstage/plugin-events-node@0.2.7-next.2
+  - @backstage/plugin-permission-common@0.7.6-next.0
+  - @backstage/plugin-permission-node@0.7.9-next.2
+  - @backstage/plugin-scaffolder-common@1.3.1-next.1
+  - @backstage/plugin-search-backend-module-catalog@0.1.2-next.2
+  - @backstage/plugin-search-common@1.2.4-next.0
+
 ## 1.9.2-next.1
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend",
-  "version": "1.9.2-next.1",
+  "version": "1.10.0",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var alpha = require('@backstage/plugin-catalog-common/alpha');
 var pluginPermissionNode = require('@backstage/plugin-permission-node');
-var CatalogBuilder = require('./cjs/CatalogBuilder-99a535c6.cjs.js');
+var CatalogBuilder = require('./cjs/CatalogBuilder-26406e82.cjs.js');
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var alpha$1 = require('@backstage/plugin-catalog-node/alpha');
 var backendCommon = require('@backstage/backend-common');

package/dist/cjs/{CatalogBuilder-99a535c6.cjs.js → CatalogBuilder-26406e82.cjs.js}

@@ -1220,6 +1220,8 @@ function generateStableHash$1(entity) {
   return crypto.createHash("sha1").update(stableStringify__default["default"]({ ...entity })).digest("hex");
 }
 
+const CATALOG_CONFLICTS_TOPIC = "experimental.catalog.conflict";
+
 const BATCH_SIZE$2 = 50;
 class DefaultProcessingDatabase {
   constructor(options) {
@@ -1389,6 +1391,7 @@ class DefaultProcessingDatabase {
    * The entities will be added at the front of the processing queue.
    */
   async addUnprocessedEntities(txOpaque, options) {
+    var _a;
     const tx = txOpaque;
     const stateReferences = new Array();
     for (const { entity, locationKey } of options.entities) {
@@ -1424,6 +1427,19 @@ class DefaultProcessingDatabase {
         this.options.logger.warn(
           `Detected conflicting entityRef ${entityRef} already referenced by ${conflictingKey} and now also ${locationKey}`
         );
+        if (this.options.eventBroker && locationKey) {
+          const eventParams = {
+            topic: CATALOG_CONFLICTS_TOPIC,
+            eventPayload: {
+              unprocessedEntity: entity,
+              entityRef,
+              newLocationKey: locationKey,
+              existingLocationKey: conflictingKey,
+              lastConflictAt: luxon.DateTime.now().toISO()
+            }
+          };
+          await ((_a = this.options.eventBroker) == null ? void 0 : _a.publish(eventParams));
+        }
       }
     }
     await tx("refresh_state_references").andWhere({ source_entity_ref: options.sourceEntityRef }).delete();
@@ -4794,6 +4810,13 @@ class CatalogBuilder {
     this.legacySingleProcessorValidation = true;
     return this;
   }
+  /**
+   * Enables the publishing of events for cloflicts in the DefaultProcessingDatabase
+   */
+  setEventBroker(broker) {
+    this.eventBroker = broker;
+    return this;
+  }
   /**
    * Wires up and returns all of the component parts of the catalog
    */
@@ -4811,7 +4834,8 @@ class CatalogBuilder {
     const processingDatabase = new DefaultProcessingDatabase({
       database: dbClient,
       logger,
-      refreshInterval: this.processingInterval
+      refreshInterval: this.processingInterval,
+      eventBroker: this.eventBroker
     });
     const providerDatabase = new DefaultProviderDatabase({
       database: dbClient,
@@ -5068,6 +5092,7 @@ class CatalogBuilder {
 
 exports.AnnotateLocationEntityProcessor = AnnotateLocationEntityProcessor;
 exports.BuiltinKindsEntityProcessor = BuiltinKindsEntityProcessor;
+exports.CATALOG_CONFLICTS_TOPIC = CATALOG_CONFLICTS_TOPIC;
 exports.CatalogBuilder = CatalogBuilder;
 exports.CodeOwnersProcessor = CodeOwnersProcessor;
 exports.FileReaderProcessor = FileReaderProcessor;
@@ -5077,4 +5102,4 @@ exports.createCatalogPermissionRule = createCatalogPermissionRule;
 exports.createRandomProcessingInterval = createRandomProcessingInterval;
 exports.parseEntityYaml = parseEntityYaml;
 exports.permissionRules = permissionRules;
-//# sourceMappingURL=CatalogBuilder-99a535c6.cjs.js.map
+//# sourceMappingURL=CatalogBuilder-26406e82.cjs.js.map