@backstage/plugin-catalog-backend 1.4.0-next.3 → 1.4.1-next.0

package/CHANGELOG.md

@@ -1,5 +1,63 @@
 # @backstage/plugin-catalog-backend
 
+## 1.4.1-next.0
+
+### Patch Changes
+
+- 8cb6e10105: Fixed a bug where entities provided without a location key would always replace existing entities, rather than updating them.
+- 63296ebcd4: Allow Placeholder value to be any value, not only string.
+- 74022e0163: Make sure to stitch entities correctly after deletion, to ensure that their relations are updated.
+- Updated dependencies
+  - @backstage/catalog-model@1.1.2-next.0
+  - @backstage/backend-plugin-api@0.1.3-next.0
+  - @backstage/catalog-client@1.1.1-next.0
+  - @backstage/plugin-catalog-node@1.1.1-next.0
+  - @backstage/plugin-scaffolder-common@1.2.1-next.0
+  - @backstage/backend-common@0.15.2-next.0
+  - @backstage/plugin-permission-node@0.6.6-next.0
+  - @backstage/config@1.0.3-next.0
+  - @backstage/errors@1.1.2-next.0
+  - @backstage/integration@1.3.2-next.0
+  - @backstage/types@1.0.0
+  - @backstage/plugin-catalog-common@1.0.7-next.0
+  - @backstage/plugin-permission-common@0.6.5-next.0
+  - @backstage/plugin-search-common@1.0.2-next.0
+
+## 1.4.0
+
+### Minor Changes
+
+- dd395335bc: Allow unknown typed location from being registered via the location service by configuration settings
+- 651c9d6800: The search index now does retain fields that have a very long value, but in the form of just a null. This makes it possible to at least filter for their existence.
+- 6e63bc43f2: Added the `refresh` function to the Connection of the entity providers.
+
+### Patch Changes
+
+- eadf56bbbf: Bump `git-url-parse` version to `^13.0.0`
+- 07dda0b746: Add optional value to `hasAnnotation` permission rule
+- 243533ecdc: Added support to mysql on some raw queries
+- ce77e78c93: Fixes a bug to be able to utilize refresh keys after the entity is loaded from cache
+- 667d917488: Updated dependency `msw` to `^0.47.0`.
+- 87ec2ba4d6: Updated dependency `msw` to `^0.46.0`.
+- bf5e9030eb: Updated dependency `msw` to `^0.45.0`.
+- 679f7c5e95: Include entity ref into error message when catalog policies fail
+- 06e2b077a1: Limit the length of error messages that get written to the database and logs - to prevent performance issues
+- 62788b2ee8: The experimental `CatalogProcessingExtensionPoint` now accepts multiple providers and processors at once.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.1.2
+  - @backstage/backend-common@0.15.1
+  - @backstage/plugin-permission-node@0.6.5
+  - @backstage/plugin-catalog-node@1.1.0
+  - @backstage/integration@1.3.1
+  - @backstage/catalog-client@1.1.0
+  - @backstage/catalog-model@1.1.1
+  - @backstage/config@1.0.2
+  - @backstage/errors@1.1.1
+  - @backstage/plugin-permission-common@0.6.4
+  - @backstage/plugin-scaffolder-common@1.2.0
+  - @backstage/plugin-catalog-common@1.0.6
+  - @backstage/plugin-search-common@1.0.1
+
 ## 1.4.0-next.3
 
 ### Minor Changes

package/alpha/package.json

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

package/dist/index.alpha.d.ts

@@ -326,7 +326,7 @@ export declare class CatalogBuilder {
  * @alpha
  */
 export declare const catalogConditions: Conditions<    {
-hasAnnotation: PermissionRule<Entity, EntitiesSearchFilter, "catalog-entity", [annotation: string]>;
+hasAnnotation: PermissionRule<Entity, EntitiesSearchFilter, "catalog-entity", [annotation: string, value?: string | undefined]>;
 hasLabel: PermissionRule<Entity, EntitiesSearchFilter, "catalog-entity", [label: string]>;
 hasMetadata: PermissionRule<Entity, EntitiesSearchFilter, "catalog-entity", [key: string, value?: string | undefined]>;
 hasSpec: PermissionRule<Entity, EntitiesSearchFilter, "catalog-entity", [key: string, value?: string | undefined]>;
@@ -603,7 +603,7 @@ export declare function parseEntityYaml(data: Buffer, location: LocationSpec): I
  * @alpha
  */
 export declare const permissionRules: {
-    hasAnnotation: PermissionRule<Entity, EntitiesSearchFilter, "catalog-entity", [annotation: string]>;
+    hasAnnotation: PermissionRule<Entity, EntitiesSearchFilter, "catalog-entity", [annotation: string, value?: string | undefined]>;
     hasLabel: PermissionRule<Entity, EntitiesSearchFilter, "catalog-entity", [label: string]>;
     hasMetadata: PermissionRule<Entity, EntitiesSearchFilter, "catalog-entity", [key: string, value?: string | undefined]>;
     hasSpec: PermissionRule<Entity, EntitiesSearchFilter, "catalog-entity", [key: string, value?: string | undefined]>;

package/dist/index.cjs.js

@@ -608,7 +608,7 @@ class PlaceholderProcessor {
       const resolverKey = keys[0].substr(1);
       const resolverValue = data[keys[0]];
       const resolver = this.options.resolvers[resolverKey];
-      if (!resolver || typeof resolverValue !== "string") {
+      if (!resolver) {
         return [data, false];
       }
       const read = async (url) => {
@@ -830,13 +830,16 @@ const hasAnnotation = createCatalogPermissionRule({
   name: "HAS_ANNOTATION",
   description: "Allow entities which are annotated with the specified annotation",
   resourceType: pluginCatalogCommon.RESOURCE_TYPE_CATALOG_ENTITY,
-  apply: (resource, annotation) => {
-    var _a;
-    return !!((_a = resource.metadata.annotations) == null ? void 0 : _a.hasOwnProperty(annotation));
+  apply: (resource, annotation, value) => {
+    var _a, _b;
+    return !!((_a = resource.metadata.annotations) == null ? void 0 : _a.hasOwnProperty(annotation)) && (value === void 0 ? true : ((_b = resource.metadata.annotations) == null ? void 0 : _b[annotation]) === value);
   },
-  toQuery: (annotation) => ({
+  toQuery: (annotation, value) => value === void 0 ? {
     key: `metadata.annotations.${annotation}`
-  })
+  } : {
+    key: `metadata.annotations.${annotation}`,
+    values: [value]
+  }
 });
 
 const isEntityKind = createCatalogPermissionRule({
@@ -1869,6 +1872,7 @@ class DefaultProcessingDatabase {
     );
   }
   async createDelta(tx, options) {
+    var _a, _b;
     if (options.type === "delta") {
       return {
         toAdd: [],
@@ -1911,7 +1915,7 @@ class DefaultProcessingDatabase {
       const upsertItem = { deferred: item.deferred, hash: item.hash };
       if (!oldRef) {
         toAdd.push(upsertItem);
-      } else if (oldRef.locationKey !== item.deferred.locationKey) {
+      } else if (((_a = oldRef == null ? void 0 : oldRef.locationKey) != null ? _a : void 0) !== ((_b = item.deferred.locationKey) != null ? _b : void 0)) {
         toRemove.push(item.ref);
         toAdd.push(upsertItem);
       } else if (oldRef.oldEntityHash !== item.hash) {
@@ -2029,7 +2033,7 @@ function startTaskPipeline(options) {
 
 const CACHE_TTL = 5;
 class DefaultCatalogProcessingEngine {
-  constructor(logger, processingDatabase, orchestrator, stitcher, createHash, pollingIntervalMs = 1e3, onProcessingError) {
+  constructor(logger, processingDatabase, orchestrator, stitcher, createHash, pollingIntervalMs = 1e3, onProcessingError, tracker = progressTracker()) {
     this.logger = logger;
     this.processingDatabase = processingDatabase;
     this.orchestrator = orchestrator;
@@ -2037,7 +2041,7 @@ class DefaultCatalogProcessingEngine {
     this.createHash = createHash;
     this.pollingIntervalMs = pollingIntervalMs;
     this.onProcessingError = onProcessingError;
-    this.tracker = progressTracker();
+    this.tracker = tracker;
   }
   async start() {
     if (this.stopFunc) {
@@ -2440,8 +2444,9 @@ function parseFilter(filter, query, db, negate = false) {
   });
 }
 class DefaultEntitiesCatalog {
-  constructor(database) {
+  constructor(database, stitcher) {
     this.database = database;
+    this.stitcher = stitcher;
   }
   async entities(request) {
     const db = this.database;
@@ -2493,13 +2498,22 @@ class DefaultEntitiesCatalog {
   }
   async removeEntityByUid(uid) {
     await this.database("refresh_state").update({
-      result_hash: "child-was-deleted"
+      result_hash: "child-was-deleted",
+      next_update_at: this.database.fn.now()
     }).whereIn("entity_ref", function parents(builder) {
       return builder.from("refresh_state").innerJoin("refresh_state_references", {
         "refresh_state_references.target_entity_ref": "refresh_state.entity_ref"
       }).where("refresh_state.entity_id", "=", uid).select("refresh_state_references.source_entity_ref");
     });
+    const relationPeers = await this.database.from("relations").innerJoin("refresh_state", {
+      "refresh_state.entity_ref": "relations.target_entity_ref"
+    }).where("relations.originating_entity_id", "=", uid).andWhere("refresh_state.entity_id", "!=", uid).select({ ref: "relations.target_entity_ref" }).union(
+      (other) => other.from("relations").innerJoin("refresh_state", {
+        "refresh_state.entity_ref": "relations.source_entity_ref"
+      }).where("relations.originating_entity_id", "=", uid).andWhere("refresh_state.entity_id", "!=", uid).select({ ref: "relations.source_entity_ref" })
+    );
     await this.database("refresh_state").where("entity_id", uid).delete();
+    await this.stitcher.stitch(new Set(relationPeers.map((p) => p.ref)));
   }
   async entityAncestry(rootRef) {
     const [rootRow] = await this.database("refresh_state").leftJoin("final_entities", {
@@ -4047,7 +4061,11 @@ class CatalogBuilder {
       parser,
       policy
     });
-    const unauthorizedEntitiesCatalog = new DefaultEntitiesCatalog(dbClient);
+    const stitcher = new Stitcher(dbClient, logger);
+    const unauthorizedEntitiesCatalog = new DefaultEntitiesCatalog(
+      dbClient,
+      stitcher
+    );
     let permissionEvaluator;
     if ("authorizeConditional" in permissions) {
       permissionEvaluator = permissions;
@@ -4085,7 +4103,6 @@ class CatalogBuilder {
       permissions: pluginCatalogCommon.catalogPermissions,
       rules: this.permissionRules
     });
-    const stitcher = new Stitcher(dbClient, logger);
     const locationStore = new DefaultLocationStore(dbClient);
     const configLocationProvider = new ConfigLocationEntityProvider(config);
     const entityProviders = lodash__default["default"].uniqBy(