@backstage/plugin-catalog-backend 1.24.1-next.3 → 1.25.1

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # @backstage/plugin-catalog-backend
 
+## 1.25.1
+
+### Patch Changes
+
+- 2fb4670: Fixed an issue with the by-query call, where ordering by a field that does not exist on all entities led to not all results being returned
+
+## 1.25.0
+
+### Minor Changes
+
+- 163ba08: Deprecated `RouterOptions`, `CatalogBuilder`, and `CatalogEnvironment`. Please make sure to upgrade to the new backend system.
+- fc24d9e: Stop using `@backstage/backend-tasks` as it will be deleted in near future.
+
+### Patch Changes
+
+- 776eb56: `ProcessorOutputCollector` returns an error when receiving deferred entities that have an invalid `metadata.annotations` format.
+
+  This allows to return an error on an actual validation issue instead of reporting that the location annotations are missing afterwards, which is misleading for the users.
+
+- 389f5a4: Update deprecated url-reader-related imports.
+- 93095ee: Make sure node-fetch is version 2.7.0 or greater
+- a629fb2: Added setAllowedLocationTypes while introducing a new extension point called CatalogLocationsExtensionPoint
+- 51240ee: Preserve default `allowedLocationTypes` when `setAllowedLocationTypes()` of `CatalogLocationsExtensionPoint` is not called.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.8.0
+  - @backstage/backend-common@0.24.0
+  - @backstage/plugin-permission-common@0.8.1
+  - @backstage/plugin-permission-node@0.8.1
+  - @backstage/plugin-search-backend-module-catalog@0.2.0
+  - @backstage/plugin-catalog-node@1.12.5
+  - @backstage/integration@1.14.0
+  - @backstage/catalog-model@1.6.0
+  - @backstage/backend-openapi-utils@0.1.16
+  - @backstage/catalog-client@1.6.6
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+  - @backstage/plugin-catalog-common@1.0.26
+  - @backstage/plugin-events-node@0.3.9
+
 ## 1.24.1-next.3
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend__alpha",
-  "version": "1.24.1-next.3",
+  "version": "1.25.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-D0vAEZa8.cjs.js');
+var CatalogBuilder = require('./cjs/CatalogBuilder-C7ANIkk3.cjs.js');
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var pluginEventsNode = require('@backstage/plugin-events-node');
 var alpha$1 = require('@backstage/plugin-catalog-node/alpha');

package/dist/cjs/{CatalogBuilder-D0vAEZa8.cjs.js → CatalogBuilder-C7ANIkk3.cjs.js}

@@ -2496,9 +2496,18 @@ class DefaultEntitiesCatalog {
       ...cursor.orderFields[0]
     };
     const [prevItemOrderFieldValue, prevItemUid] = cursor.orderFieldValues || [];
-    const dbQuery = db("search").join("final_entities", "search.entity_id", "final_entities.entity_id").where("search.key", sortField.field);
+    const dbQuery = db("final_entities").leftOuterJoin(
+      "search",
+      (qb) => qb.on("search.entity_id", "final_entities.entity_id").andOnVal("search.key", sortField.field)
+    );
     if (cursor.filter) {
-      parseFilter(cursor.filter, dbQuery, db, false, "search.entity_id");
+      parseFilter(
+        cursor.filter,
+        dbQuery,
+        db,
+        false,
+        "final_entities.entity_id"
+      );
     }
     const normalizedFullTextFilterTerm = cursor.fullTextFilter?.term?.trim();
     const textFilterFields = cursor.fullTextFilter?.fields ?? [sortField.field];
@@ -2515,7 +2524,7 @@ class DefaultEntitiesCatalog {
             `%${normalizedFullTextFilterTerm.toLocaleLowerCase("en-US")}%`
           );
         });
-        dbQuery.andWhere("search.entity_id", "in", matchQuery);
+        dbQuery.andWhere("final_entities.entity_id", "in", matchQuery);
       }
     }
     const countQuery = dbQuery.clone();
@@ -2527,23 +2536,43 @@ class DefaultEntitiesCatalog {
           isFetchingBackwards !== isOrderingDescending ? "<" : ">",
           prevItemOrderFieldValue
         ).orWhere("value", "=", prevItemOrderFieldValue).andWhere(
-          "search.entity_id",
+          "final_entities.entity_id",
           isFetchingBackwards !== isOrderingDescending ? "<" : ">",
           prevItemUid
         );
       });
     }
-    dbQuery.orderBy([
-      {
-        column: "value",
-        order: isFetchingBackwards ? invertOrder(sortField.order) : sortField.order
-      },
-      {
-        column: "search.entity_id",
-        order: isFetchingBackwards ? invertOrder(sortField.order) : sortField.order
-      }
-    ]).limit(isFetchingBackwards ? limit : limit + 1);
-    countQuery.count("search.entity_id", { as: "count" });
+    if (db.client.config.client === "pg") {
+      dbQuery.orderBy([
+        {
+          column: "search.value",
+          order: isFetchingBackwards ? invertOrder(sortField.order) : sortField.order,
+          nulls: "last"
+        },
+        {
+          column: "final_entities.entity_id",
+          order: isFetchingBackwards ? invertOrder(sortField.order) : sortField.order
+        }
+      ]);
+    } else {
+      dbQuery.orderBy([
+        {
+          column: "search.value",
+          order: void 0,
+          nulls: "last"
+        },
+        {
+          column: "search.value",
+          order: isFetchingBackwards ? invertOrder(sortField.order) : sortField.order
+        },
+        {
+          column: "final_entities.entity_id",
+          order: isFetchingBackwards ? invertOrder(sortField.order) : sortField.order
+        }
+      ]);
+    }
+    dbQuery.limit(isFetchingBackwards ? limit : limit + 1);
+    countQuery.count("final_entities.entity_id", { as: "count" });
     const [rows, [{ count }]] = await Promise.all([
       limit > 0 ? dbQuery : [],
       // for performance reasons we invoke the countQuery
@@ -2787,20 +2816,24 @@ class ProcessorOutputCollector {
         return;
       }
       const annotations = entity.metadata.annotations || {};
-      if (typeof annotations === "object" && !Array.isArray(annotations)) {
-        const originLocation = getEntityOriginLocationRef(this.parentEntity);
-        entity = {
-          ...entity,
-          metadata: {
-            ...entity.metadata,
-            annotations: {
-              ...annotations,
-              [catalogModel.ANNOTATION_ORIGIN_LOCATION]: originLocation,
-              [catalogModel.ANNOTATION_LOCATION]: location
-            }
-          }
-        };
+      if (typeof annotations !== "object" || Array.isArray(annotations)) {
+        this.errors.push(
+          new Error("metadata.annotations must be a valid object")
+        );
+        return;
       }
+      const originLocation = getEntityOriginLocationRef(this.parentEntity);
+      entity = {
+        ...entity,
+        metadata: {
+          ...entity.metadata,
+          annotations: {
+            ...annotations,
+            [catalogModel.ANNOTATION_ORIGIN_LOCATION]: originLocation,
+            [catalogModel.ANNOTATION_LOCATION]: location
+          }
+        }
+      };
       this.deferredEntities.push({ entity, locationKey: location });
     } else if (i.type === "location") {
       const entity = locationSpecToLocationEntity({
@@ -7255,4 +7288,4 @@ exports.createCatalogPermissionRule = createCatalogPermissionRule;
 exports.createRandomProcessingInterval = createRandomProcessingInterval;
 exports.parseEntityYaml = parseEntityYaml;
 exports.permissionRules = permissionRules;
-//# sourceMappingURL=CatalogBuilder-D0vAEZa8.cjs.js.map
+//# sourceMappingURL=CatalogBuilder-C7ANIkk3.cjs.js.map