@backstage/plugin-catalog-backend 1.13.0-next.3 → 1.13.1

package/CHANGELOG.md

@@ -1,5 +1,68 @@
 # @backstage/plugin-catalog-backend
 
+## 1.13.1
+
+### Patch Changes
+
+- e77bbde41b99: Fixes a bug where eagerly deleted entities did not properly trigger re-stitching of entities that they had relations to.
+
+## 1.13.0
+
+### Minor Changes
+
+- 62f448edb0b5: Allow configuring the processing interval in your app-config, under the `catalog.processingInterval` key.
+- 09cfc3cf467d: set azure annotation `dev.azure.com/project-repo` in `AnnotateScmSlugEntityProcessor` to find the project and repo information for the repos that contains `dev.azure.com` in the url
+
+### Patch Changes
+
+- 149361e81622: Fix to the `limit` parameter on entity queries.
+- 1fd2109739c1: Changed the processing loop task pipeline implementation from recursive to iterative
+- 71114ac50e02: The export for the new backend system has been moved to be the `default` export.
+
+  For example, if you are currently importing the plugin using the following pattern:
+
+  ```ts
+  import { examplePlugin } from '@backstage/plugin-example-backend';
+
+  backend.add(examplePlugin);
+  ```
+
+  It should be migrated to this:
+
+  ```ts
+  backend.add(import('@backstage/plugin-example-backend'));
+  ```
+
+- 0f8a97777489: Update OpenAPI schema to relax the encoding validation of all request parameters.
+- 0198aa596fd9: Fixed a link to the frontend Backstage plugin that had pointed to itself.
+- 2d32d8a611e3: Fixed validation of the `fullTextFilterFields` query parameter.
+- acffa17027b6: Added some examples to the catalog OpenAPI definition
+- 45947d3b2759: Fixes an issue where `order` was not a recognized parameter for the `/entities` endpoint.
+- 41d1b2d628ea: Fix OpenAPI schema for the facets endpoint
+- 618257f3e413: Fix issue with `catalogFileName` not being a required property for `/analyze-location`
+- cfc3ca6ce060: Changes needed to support MySQL
+- 814feeed7343: Update to handle invalid luxon values
+- Updated dependencies
+  - @backstage/plugin-search-backend-module-catalog@0.1.7
+  - @backstage/backend-tasks@0.5.8
+  - @backstage/backend-common@0.19.5
+  - @backstage/plugin-auth-node@0.3.0
+  - @backstage/config@1.1.0
+  - @backstage/catalog-client@1.4.4
+  - @backstage/catalog-model@1.4.2
+  - @backstage/errors@1.2.2
+  - @backstage/integration@1.7.0
+  - @backstage/plugin-catalog-common@1.0.16
+  - @backstage/plugin-permission-common@0.7.8
+  - @backstage/plugin-scaffolder-common@1.4.1
+  - @backstage/plugin-search-common@1.2.6
+  - @backstage/types@1.1.1
+  - @backstage/plugin-permission-node@0.7.14
+  - @backstage/backend-plugin-api@0.6.3
+  - @backstage/plugin-catalog-node@1.4.4
+  - @backstage/backend-openapi-utils@0.0.4
+  - @backstage/plugin-events-node@0.2.12
+
 ## 1.13.0-next.3
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend",
-  "version": "1.13.0-next.3",
+  "version": "1.13.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-c40214f8.cjs.js');
+var CatalogBuilder = require('./cjs/CatalogBuilder-60d67596.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/alpha.d.ts

@@ -68,7 +68,7 @@ declare const catalogConditions: _backstage_plugin_permission_node.Conditions<{
  *
  * @alpha
  */
-declare const createCatalogConditionalDecision: (permission: _backstage_plugin_permission_common.ResourcePermission<"catalog-entity">, conditions: _backstage_plugin_permission_common.PermissionCriteria<_backstage_plugin_permission_common.PermissionCondition<"catalog-entity", _backstage_plugin_permission_common.PermissionRuleParams>>) => _backstage_plugin_permission_common.ConditionalPolicyDecision;
+declare const createCatalogConditionalDecision: (permission: _backstage_plugin_permission_common.ResourcePermission<"catalog-entity">, conditions: _backstage_plugin_permission_common.PermissionCriteria<_backstage_plugin_permission_common.PermissionCondition<"catalog-entity">>) => _backstage_plugin_permission_common.ConditionalPolicyDecision;
 
 /**
  * Convenience type for {@link @backstage/plugin-permission-node#PermissionRule}

package/dist/cjs/{CatalogBuilder-c40214f8.cjs.js → CatalogBuilder-60d67596.cjs.js}

@@ -5891,57 +5891,113 @@ async function deleteWithEagerPruningOfChildren(options) {
   const { knex, entityRefs, sourceKey } = options;
   let removedCount = 0;
   for (const refs of lodash__default["default"].chunk(entityRefs, 1e3)) {
-    removedCount += await knex.delete().from("refresh_state").whereIn(
-      "entity_ref",
-      (orphans) => orphans.withRecursive(
-        "descendants",
-        ["entity_ref"],
-        (initial) => initial.select("target_entity_ref").from("refresh_state_references").where("source_key", "=", sourceKey).whereIn("target_entity_ref", refs).union(
-          (recursive) => recursive.select("refresh_state_references.target_entity_ref").from("descendants").join(
-            "refresh_state_references",
-            "descendants.entity_ref",
-            "refresh_state_references.source_entity_ref"
-          )
+    const { orphanEntityRefs } = await findDescendantsThatWouldHaveBeenOrphanedByDeletion({
+      knex: options.knex,
+      refs,
+      sourceKey
+    });
+    for (const refsToDelete of lodash__default["default"].chunk(orphanEntityRefs, 1e3)) {
+      await markEntitiesAffectedByDeletionForStitching({
+        knex: options.knex,
+        entityRefs: refsToDelete
+      });
+      await knex.delete().from("refresh_state").whereIn("entity_ref", refsToDelete);
+    }
+    await knex("refresh_state_references").where("source_key", "=", sourceKey).whereIn("target_entity_ref", refs).delete();
+    removedCount += orphanEntityRefs.length;
+  }
+  return removedCount;
+}
+async function findDescendantsThatWouldHaveBeenOrphanedByDeletion(options) {
+  const { knex, refs, sourceKey } = options;
+  const orphans = (
+    // First find all nodes that can be reached downwards from the roots
+    // (deletion targets), including the roots themselves, by traversing
+    // down the refresh_state_references table. Note that this query
+    // starts with a condition that source_key = our source key, and
+    // target_entity_ref is one of the deletion targets. This has two
+    // effects: it won't match attempts at deleting something that didn't
+    // originate from us in the first place, and also won't match non-root
+    // entities (source_key would be null for those).
+    //
+    //   KeyA - R1 - R2        Legend:
+    //                 \       -----------------------------------------
+    //                  R3     Key*    Source key
+    //                 /       R*      Entity ref
+    //   KeyA - R4 - R5        lines   Individual references; sources to
+    //              /                  the left and targets to the right
+    //   KeyB --- R6
+    //
+    // The scenario is that KeyA wants to delete R1.
+    //
+    // The query starts with the KeyA-R1 reference, and then traverses
+    // down to also find R2 and R3. It uses union instead of union all,
+    // because it wants to find the set of unique descendants even if
+    // the tree has unexpected loops etc.
+    await knex.withRecursive(
+      "descendants",
+      ["entity_ref"],
+      (initial) => initial.select("target_entity_ref").from("refresh_state_references").where("source_key", "=", sourceKey).whereIn("target_entity_ref", refs).union(
+        (recursive) => recursive.select("refresh_state_references.target_entity_ref").from("descendants").join(
+          "refresh_state_references",
+          "descendants.entity_ref",
+          "refresh_state_references.source_entity_ref"
         )
-      ).withRecursive(
-        "ancestors",
-        ["source_key", "source_entity_ref", "target_entity_ref", "subject"],
-        (initial) => initial.select(
+      )
+    ).withRecursive(
+      "ancestors",
+      ["source_key", "source_entity_ref", "target_entity_ref", "subject"],
+      (initial) => initial.select(
+        "refresh_state_references.source_key",
+        "refresh_state_references.source_entity_ref",
+        "refresh_state_references.target_entity_ref",
+        "descendants.entity_ref"
+      ).from("descendants").join(
+        "refresh_state_references",
+        "refresh_state_references.target_entity_ref",
+        "descendants.entity_ref"
+      ).union(
+        (recursive) => recursive.select(
           "refresh_state_references.source_key",
           "refresh_state_references.source_entity_ref",
           "refresh_state_references.target_entity_ref",
-          "descendants.entity_ref"
-        ).from("descendants").join(
+          "ancestors.subject"
+        ).from("ancestors").join(
           "refresh_state_references",
           "refresh_state_references.target_entity_ref",
-          "descendants.entity_ref"
-        ).union(
-          (recursive) => recursive.select(
-            "refresh_state_references.source_key",
-            "refresh_state_references.source_entity_ref",
-            "refresh_state_references.target_entity_ref",
-            "ancestors.subject"
-          ).from("ancestors").join(
-            "refresh_state_references",
-            "refresh_state_references.target_entity_ref",
-            "ancestors.source_entity_ref"
-          )
-        )
-      ).with(
-        "retained",
-        ["entity_ref"],
-        (notPartOfDeletion) => notPartOfDeletion.select("subject").from("ancestors").whereNotNull("ancestors.source_key").where(
-          (foreignKeyOrRef) => foreignKeyOrRef.where("ancestors.source_key", "!=", sourceKey).orWhereNotIn("ancestors.target_entity_ref", refs)
+          "ancestors.source_entity_ref"
         )
-      ).select("descendants.entity_ref").from("descendants").leftOuterJoin(
-        "retained",
-        "retained.entity_ref",
-        "descendants.entity_ref"
-      ).whereNull("retained.entity_ref")
-    );
-    await knex("refresh_state_references").where("source_key", "=", sourceKey).whereIn("target_entity_ref", refs).delete();
+      )
+    ).with(
+      "retained",
+      ["entity_ref"],
+      (notPartOfDeletion) => notPartOfDeletion.select("subject").from("ancestors").whereNotNull("ancestors.source_key").where(
+        (foreignKeyOrRef) => foreignKeyOrRef.where("ancestors.source_key", "!=", sourceKey).orWhereNotIn("ancestors.target_entity_ref", refs)
+      )
+    ).select("descendants.entity_ref AS entity_ref").from("descendants").leftOuterJoin(
+      "retained",
+      "retained.entity_ref",
+      "descendants.entity_ref"
+    ).whereNull("retained.entity_ref").then((rows) => rows.map((row) => row.entity_ref))
+  );
+  return { orphanEntityRefs: orphans };
+}
+async function markEntitiesAffectedByDeletionForStitching(options) {
+  const { knex, entityRefs } = options;
+  const affectedIds = await knex.select("refresh_state.entity_id AS entity_id").from("relations").join(
+    "refresh_state",
+    "relations.source_entity_ref",
+    "refresh_state.entity_ref"
+  ).whereIn("relations.target_entity_ref", entityRefs).then((rows) => rows.map((row) => row.entity_id));
+  for (const ids of lodash__default["default"].chunk(affectedIds, 1e3)) {
+    await knex.table("final_entities").update({
+      hash: "force-stitching"
+    }).whereIn("entity_id", ids);
+    await knex.table("refresh_state").update({
+      result_hash: "force-stitching",
+      next_update_at: knex.fn.now()
+    }).whereIn("entity_id", ids);
   }
-  return removedCount;
 }
 
 async function refreshByRefreshKeys(options) {
@@ -6750,4 +6806,4 @@ exports.createCatalogPermissionRule = createCatalogPermissionRule;
 exports.createRandomProcessingInterval = createRandomProcessingInterval;
 exports.parseEntityYaml = parseEntityYaml;
 exports.permissionRules = permissionRules;
-//# sourceMappingURL=CatalogBuilder-c40214f8.cjs.js.map
+//# sourceMappingURL=CatalogBuilder-60d67596.cjs.js.map