@backstage/plugin-catalog-backend 1.21.0 → 1.21.1-next.1

package/CHANGELOG.md

@@ -1,5 +1,84 @@
 # @backstage/plugin-catalog-backend
 
+## 1.21.1-next.1
+
+### Patch Changes
+
+- c52f7ac: Make entity collection errors a little quieter in the logs.
+
+  Instead of logging a warning line when an entity has an error
+  during processing, it will now instead emit an event on the event
+  broker.
+
+  This only removes a single log line, however it is possible to
+  add the log line back if it is required by subscribing to the
+  `CATALOG_ERRORS_TOPIC` as shown below.
+
+  ```typescript
+  env.eventBroker.subscribe({
+    supportsEventTopics(): string[] {
+      return [CATALOG_ERRORS_TOPIC];
+    },
+
+    async onEvent(
+      params: EventParams<{
+        entity: string;
+        location?: string;
+        errors: Array<Error>;
+      }>,
+    ): Promise<void> {
+      const { entity, location, errors } = params.eventPayload;
+      for (const error of errors) {
+        env.logger.warn(error.message, {
+          entity,
+          location,
+        });
+      }
+    },
+  });
+  ```
+
+- Updated dependencies
+  - @backstage/backend-common@0.21.7-next.1
+  - @backstage/backend-plugin-api@0.6.17-next.1
+  - @backstage/catalog-client@1.6.4-next.0
+  - @backstage/backend-tasks@0.5.22-next.1
+  - @backstage/plugin-events-node@0.3.3-next.1
+  - @backstage/plugin-permission-node@0.7.28-next.1
+  - @backstage/plugin-search-backend-module-catalog@0.1.22-next.1
+  - @backstage/backend-openapi-utils@0.1.10-next.1
+  - @backstage/catalog-model@1.4.5
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/integration@1.10.0-next.0
+  - @backstage/types@1.1.1
+  - @backstage/plugin-catalog-common@1.0.22
+  - @backstage/plugin-catalog-node@1.11.1-next.1
+  - @backstage/plugin-permission-common@0.7.13
+
+## 1.21.1-next.0
+
+### Patch Changes
+
+- cfdc5e7: Fixes an issue where `/analyze-location` would incorrectly throw a 500 error on an invalid url.
+- Updated dependencies
+  - @backstage/backend-common@0.21.7-next.0
+  - @backstage/integration@1.10.0-next.0
+  - @backstage/backend-openapi-utils@0.1.10-next.0
+  - @backstage/backend-plugin-api@0.6.17-next.0
+  - @backstage/backend-tasks@0.5.22-next.0
+  - @backstage/catalog-client@1.6.3
+  - @backstage/catalog-model@1.4.5
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+  - @backstage/plugin-catalog-common@1.0.22
+  - @backstage/plugin-catalog-node@1.11.1-next.0
+  - @backstage/plugin-events-node@0.3.3-next.0
+  - @backstage/plugin-permission-common@0.7.13
+  - @backstage/plugin-permission-node@0.7.28-next.0
+  - @backstage/plugin-search-backend-module-catalog@0.1.22-next.0
+
 ## 1.21.0
 
 ### Minor Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend",
-  "version": "1.21.0",
+  "version": "1.21.1-next.1",
   "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-B30bgu7A.cjs.js');
+var CatalogBuilder = require('./cjs/CatalogBuilder-WfXI1o7H.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-B30bgu7A.cjs.js → CatalogBuilder-WfXI1o7H.cjs.js}

@@ -1267,6 +1267,7 @@ function generateStableHash$1(entity) {
 }
 
 const CATALOG_CONFLICTS_TOPIC = "experimental.catalog.conflict";
+const CATALOG_ERRORS_TOPIC = "experimental.catalog.errors";
 
 const BATCH_SIZE$2 = 50;
 class DefaultProcessingDatabase {
@@ -1785,6 +1786,7 @@ class DefaultCatalogProcessingEngine {
     __publicField$8(this, "orphanCleanupIntervalMs");
     __publicField$8(this, "onProcessingError");
     __publicField$8(this, "tracker");
+    __publicField$8(this, "eventBroker");
     __publicField$8(this, "stopFunc");
     var _a, _b, _c;
     this.config = options.config;
@@ -1799,6 +1801,7 @@ class DefaultCatalogProcessingEngine {
     this.orphanCleanupIntervalMs = (_b = options.orphanCleanupIntervalMs) != null ? _b : 3e4;
     this.onProcessingError = options.onProcessingError;
     this.tracker = (_c = options.tracker) != null ? _c : progressTracker$1();
+    this.eventBroker = options.eventBroker;
     this.stopFunc = void 0;
   }
   async start() {
@@ -1840,7 +1843,7 @@ class DefaultCatalogProcessingEngine {
       },
       processTask: async (item) => {
         await withActiveSpan(tracer$1, "ProcessingRun", async (span) => {
-          var _a, _b;
+          var _a, _b, _c;
           const track = this.tracker.processStart(item, this.logger);
           addEntityAttributes(span, item.unprocessedEntity);
           try {
@@ -1881,10 +1884,14 @@ class DefaultCatalogProcessingEngine {
               });
             }
             const location = (_b = (_a = unprocessedEntity == null ? void 0 : unprocessedEntity.metadata) == null ? void 0 : _a.annotations) == null ? void 0 : _b[catalogModel.ANNOTATION_LOCATION];
-            for (const error of result.errors) {
-              this.logger.warn(error.message, {
-                entity: entityRef,
-                location
+            if (result.errors.length) {
+              (_c = this.eventBroker) == null ? void 0 : _c.publish({
+                topic: CATALOG_ERRORS_TOPIC,
+                eventPayload: {
+                  entity: entityRef,
+                  location,
+                  errors: result.errors
+                }
               });
             }
             const errorsString = JSON.stringify(
@@ -5423,7 +5430,7 @@ const spec = {
           "400": {
             description: "Validation errors.",
             content: {
-              "application/json; charset=utf-8": {
+              "application/json": {
                 schema: {
                   type: "object",
                   properties: {
@@ -5690,8 +5697,19 @@ async function createRouter(options) {
         location: locationInput,
         catalogFilename: zod.z.string().optional()
       });
-      const output = await locationAnalyzer.analyzeLocation(schema.parse(body));
-      res.status(200).json(output);
+      const parsedBody = schema.parse(body);
+      try {
+        const output = await locationAnalyzer.analyzeLocation(parsedBody);
+        res.status(200).json(output);
+      } catch (err) {
+        if (
+          // Catch errors from parse-url library.
+          err.name === "Error" && "subject_url" in err
+        ) {
+          throw new errors.InputError("The given location.target is not a URL");
+        }
+        throw err;
+      }
     });
   }
   if (orchestrator) {
@@ -7156,7 +7174,8 @@ class CatalogBuilder {
       onProcessingError: (event) => {
         var _a2;
         (_a2 = this.onProcessingError) == null ? void 0 : _a2.call(this, event);
-      }
+      },
+      eventBroker: this.eventBroker
     });
     const locationAnalyzer = (_b = this.locationAnalyzer) != null ? _b : new RepoLocationAnalyzer(logger, integrations, this.locationAnalyzers);
     const locationService = new AuthorizedLocationService(
@@ -7363,6 +7382,7 @@ class CatalogBuilder {
 exports.AnnotateLocationEntityProcessor = AnnotateLocationEntityProcessor;
 exports.BuiltinKindsEntityProcessor = BuiltinKindsEntityProcessor;
 exports.CATALOG_CONFLICTS_TOPIC = CATALOG_CONFLICTS_TOPIC;
+exports.CATALOG_ERRORS_TOPIC = CATALOG_ERRORS_TOPIC;
 exports.CatalogBuilder = CatalogBuilder;
 exports.CodeOwnersProcessor = CodeOwnersProcessor;
 exports.FileReaderProcessor = FileReaderProcessor;
@@ -7372,4 +7392,4 @@ exports.createCatalogPermissionRule = createCatalogPermissionRule;
 exports.createRandomProcessingInterval = createRandomProcessingInterval;
 exports.parseEntityYaml = parseEntityYaml;
 exports.permissionRules = permissionRules;
-//# sourceMappingURL=CatalogBuilder-B30bgu7A.cjs.js.map
+//# sourceMappingURL=CatalogBuilder-WfXI1o7H.cjs.js.map