@backstage/plugin-catalog-backend 1.0.0 → 1.0.1-next.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @backstage/plugin-catalog-backend
 
+## 1.0.1-next.0
+
+### Patch Changes
+
+- 9fe24b0fc8: Adjust the error messages when entities fail validation, to clearly state what entity that failed it
+- 95408dbe99: Enable internal batching of very large deletions, to not run into SQL binding limits
+- ffec894ed0: add gitlab to AnnotateScmSlugEntityProcessor
+- Updated dependencies
+  - @backstage/catalog-model@1.0.1-next.0
+  - @backstage/plugin-search-common@0.3.3-next.0
+  - @backstage/backend-common@0.13.2-next.0
+  - @backstage/integration@1.0.1-next.0
+  - @backstage/catalog-client@1.0.1-next.0
+  - @backstage/plugin-scaffolder-common@1.0.1-next.0
+  - @backstage/plugin-permission-node@0.5.6-next.0
+  - @backstage/plugin-catalog-common@1.0.1-next.0
+
 ## 1.0.0
 
 ### Major Changes

package/alpha/package.json

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

package/dist/index.cjs.js

@@ -237,6 +237,7 @@ class AnnotateLocationEntityProcessor {
 }
 
 const GITHUB_ACTIONS_ANNOTATION = "github.com/project-slug";
+const GITLAB_ACTIONS_ANNOTATION = "gitlab.com/project-slug";
 class AnnotateScmSlugEntityProcessor {
   constructor(opts) {
     this.opts = opts;
@@ -255,18 +256,29 @@ class AnnotateScmSlugEntityProcessor {
       return entity;
     }
     const scmIntegration = this.opts.scmIntegrationRegistry.byUrl(location.target);
-    if (!scmIntegration || scmIntegration.type !== "github") {
+    if (!scmIntegration) {
       return entity;
     }
-    const gitUrl = parseGitUrl__default["default"](location.target);
-    let githubProjectSlug = (_a = entity.metadata.annotations) == null ? void 0 : _a[GITHUB_ACTIONS_ANNOTATION];
-    if (!githubProjectSlug) {
-      githubProjectSlug = `${gitUrl.owner}/${gitUrl.name}`;
+    let annotation;
+    switch (scmIntegration.type) {
+      case "github":
+        annotation = GITHUB_ACTIONS_ANNOTATION;
+        break;
+      case "gitlab":
+        annotation = GITLAB_ACTIONS_ANNOTATION;
+        break;
+      default:
+        return entity;
+    }
+    let projectSlug = (_a = entity.metadata.annotations) == null ? void 0 : _a[annotation];
+    if (!projectSlug) {
+      const gitUrl = parseGitUrl__default["default"](location.target);
+      projectSlug = `${gitUrl.owner}/${gitUrl.name}`;
     }
     return lodash.merge({
       metadata: {
         annotations: lodash.pickBy({
-          [GITHUB_ACTIONS_ANNOTATION]: githubProjectSlug
+          [annotation]: projectSlug
         }, lodash.identity)
       }
     }, entity);
@@ -1230,37 +1242,40 @@ class DefaultProcessingDatabase {
     const tx = txOpaque;
     const { toAdd, toUpsert, toRemove } = await this.createDelta(tx, options);
     if (toRemove.length) {
-      const removedCount = await tx("refresh_state").whereIn("entity_ref", function orphanedEntityRefs(orphans) {
-        return orphans.withRecursive("descendants", function descendants(outer) {
-          return outer.select({ root_id: "id", entity_ref: "target_entity_ref" }).from("refresh_state_references").where("source_key", options.sourceKey).whereIn("target_entity_ref", toRemove).union(function recursive(inner) {
-            return inner.select({
-              root_id: "descendants.root_id",
-              entity_ref: "refresh_state_references.target_entity_ref"
-            }).from("descendants").join("refresh_state_references", {
-              "descendants.entity_ref": "refresh_state_references.source_entity_ref"
+      let removedCount = 0;
+      for (const refs of lodash__default["default"].chunk(toRemove, 1e3)) {
+        removedCount += await tx("refresh_state").whereIn("entity_ref", function orphanedEntityRefs(orphans) {
+          return orphans.withRecursive("descendants", function descendants(outer) {
+            return outer.select({ root_id: "id", entity_ref: "target_entity_ref" }).from("refresh_state_references").where("source_key", options.sourceKey).whereIn("target_entity_ref", refs).union(function recursive(inner) {
+              return inner.select({
+                root_id: "descendants.root_id",
+                entity_ref: "refresh_state_references.target_entity_ref"
+              }).from("descendants").join("refresh_state_references", {
+                "descendants.entity_ref": "refresh_state_references.source_entity_ref"
+              });
             });
-          });
-        }).withRecursive("ancestors", function ancestors(outer) {
-          return outer.select({
-            root_id: tx.raw("CAST(NULL as INT)", []),
-            via_entity_ref: "entity_ref",
-            to_entity_ref: "entity_ref"
-          }).from("descendants").union(function recursive(inner) {
-            return inner.select({
-              root_id: tx.raw("CASE WHEN source_key IS NOT NULL THEN id ELSE NULL END", []),
-              via_entity_ref: "source_entity_ref",
-              to_entity_ref: "ancestors.to_entity_ref"
-            }).from("ancestors").join("refresh_state_references", {
-              target_entity_ref: "ancestors.via_entity_ref"
+          }).withRecursive("ancestors", function ancestors(outer) {
+            return outer.select({
+              root_id: tx.raw("CAST(NULL as INT)", []),
+              via_entity_ref: "entity_ref",
+              to_entity_ref: "entity_ref"
+            }).from("descendants").union(function recursive(inner) {
+              return inner.select({
+                root_id: tx.raw("CASE WHEN source_key IS NOT NULL THEN id ELSE NULL END", []),
+                via_entity_ref: "source_entity_ref",
+                to_entity_ref: "ancestors.to_entity_ref"
+              }).from("ancestors").join("refresh_state_references", {
+                target_entity_ref: "ancestors.via_entity_ref"
+              });
             });
-          });
-        }).select("descendants.entity_ref").from("descendants").leftOuterJoin("ancestors", function keepaliveRoots() {
-          this.on("ancestors.to_entity_ref", "=", "descendants.entity_ref");
-          this.andOnNotNull("ancestors.root_id");
-          this.andOn("ancestors.root_id", "!=", "descendants.root_id");
-        }).whereNull("ancestors.root_id");
-      }).delete();
-      await tx("refresh_state_references").where("source_key", "=", options.sourceKey).whereIn("target_entity_ref", toRemove).delete();
+          }).select("descendants.entity_ref").from("descendants").leftOuterJoin("ancestors", function keepaliveRoots() {
+            this.on("ancestors.to_entity_ref", "=", "descendants.entity_ref");
+            this.andOnNotNull("ancestors.root_id");
+            this.andOn("ancestors.root_id", "!=", "descendants.root_id");
+          }).whereNull("ancestors.root_id");
+        }).delete();
+        await tx("refresh_state_references").where("source_key", "=", options.sourceKey).whereIn("target_entity_ref", refs).delete();
+      }
       this.options.logger.debug(`removed, ${removedCount} entities: ${JSON.stringify(toRemove)}`);
     }
     if (toAdd.length) {
@@ -2297,7 +2312,7 @@ class DefaultCatalogProcessingOrchestrator {
     try {
       validateEntity(entity);
     } catch (e) {
-      throw new errors.ConflictError(`Entity envelope failed validation after preprocessing`, e);
+      throw new errors.ConflictError(`Entity envelope for ${context.entityRef} failed validation after preprocessing`, e);
     }
     let foundKind = false;
     for (const processor of this.options.processors) {
@@ -2308,12 +2323,12 @@ class DefaultCatalogProcessingOrchestrator {
             break;
           }
         } catch (e) {
-          throw new errors.InputError(`Processor ${processor.constructor.name} threw an error while validating the entity`, e);
+          throw new errors.InputError(`Processor ${processor.constructor.name} threw an error while validating the entity ${context.entityRef}`, e);
         }
       }
     }
     if (!foundKind) {
-      throw new errors.InputError("No processor recognized the entity as valid, possibly caused by a foreign kind or apiVersion");
+      throw new errors.InputError(`No processor recognized the entity ${context.entityRef} as valid, possibly caused by a foreign kind or apiVersion`);
     }
   }
   async runSpecialLocationStep(entity, context) {