@backstage/plugin-catalog-backend 1.6.0 → 1.7.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @backstage/plugin-catalog-backend
 
+## 1.7.0-next.0
+
+### Minor Changes
+
+- f75bf76330: Implemented server side ordering in the entities endpoint
+
+### Patch Changes
+
+- d136793ff0: Fixed an issue where internal references in the catalog would stick around for longer than expected, causing entities to not be deleted or orphaned as expected.
+- Updated dependencies
+  - @backstage/catalog-model@1.1.5-next.0
+  - @backstage/plugin-scaffolder-common@1.2.4-next.0
+  - @backstage/catalog-client@1.3.0-next.0
+  - @backstage/backend-common@0.17.0
+  - @backstage/backend-plugin-api@0.2.0
+  - @backstage/config@1.0.5
+  - @backstage/errors@1.1.4
+  - @backstage/integration@1.4.1
+  - @backstage/types@1.0.2
+  - @backstage/plugin-catalog-common@1.0.10-next.0
+  - @backstage/plugin-catalog-node@1.3.1-next.0
+  - @backstage/plugin-permission-common@0.7.2
+  - @backstage/plugin-permission-node@0.7.2
+  - @backstage/plugin-search-common@1.2.0
+
 ## 1.6.0
 
 ### Minor Changes

package/alpha/package.json

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

package/dist/index.cjs.js

@@ -1725,7 +1725,6 @@ class DefaultProcessingDatabase {
   async addUnprocessedEntities(txOpaque, options) {
     const tx = txOpaque;
     const stateReferences = new Array();
-    const conflictingStateReferences = new Array();
     for (const { entity, locationKey } of options.entities) {
       const entityRef = catalogModel.stringifyEntityRef(entity);
       const hash = generateStableHash$1(entity);
@@ -1759,10 +1758,9 @@ class DefaultProcessingDatabase {
         this.options.logger.warn(
           `Detected conflicting entityRef ${entityRef} already referenced by ${conflictingKey} and now also ${locationKey}`
         );
-        conflictingStateReferences.push(entityRef);
       }
     }
-    await tx("refresh_state_references").whereNotIn("target_entity_ref", conflictingStateReferences).andWhere({ source_entity_ref: options.sourceEntityRef }).delete();
+    await tx("refresh_state_references").andWhere({ source_entity_ref: options.sourceEntityRef }).delete();
     await tx.batchInsert(
       "refresh_state_references",
       stateReferences.map((entityRef) => ({
@@ -2249,7 +2247,7 @@ function stringifyPagination(input) {
   return base64;
 }
 function addCondition(queryBuilder, db, filter, negate = false, entityIdField = "entity_id") {
-  const matchQuery = db("search").select(entityIdField).where({ key: filter.key.toLowerCase() }).andWhere(function keyFilter() {
+  const matchQuery = db("search").select("search.entity_id").where({ key: filter.key.toLowerCase() }).andWhere(function keyFilter() {
     if (filter.values) {
       if (filter.values.length === 1) {
         this.where({ value: filter.values[0].toLowerCase() });
@@ -2305,12 +2303,41 @@ class DefaultEntitiesCatalog {
     this.stitcher = stitcher;
   }
   async entities(request) {
+    var _a, _b;
     const db = this.database;
     let entitiesQuery = db("final_entities").select("final_entities.*");
+    (_a = request == null ? void 0 : request.order) == null ? void 0 : _a.forEach(({ field }, index) => {
+      const alias = `order_${index}`;
+      entitiesQuery = entitiesQuery.leftOuterJoin(
+        { [alias]: "search" },
+        function search(inner) {
+          inner.on(`${alias}.entity_id`, "final_entities.entity_id").andOn(`${alias}.key`, db.raw("?", [field]));
+        }
+      );
+    });
+    entitiesQuery = entitiesQuery.whereNotNull("final_entities.final_entity");
     if (request == null ? void 0 : request.filter) {
-      entitiesQuery = parseFilter(request.filter, entitiesQuery, db);
+      entitiesQuery = parseFilter(
+        request.filter,
+        entitiesQuery,
+        db,
+        false,
+        "final_entities.entity_id"
+      );
     }
-    entitiesQuery = entitiesQuery.whereNotNull("final_entities.final_entity").orderBy("entity_id", "asc");
+    (_b = request == null ? void 0 : request.order) == null ? void 0 : _b.forEach(({ order }, index) => {
+      if (db.client.config.client === "pg") {
+        entitiesQuery = entitiesQuery.orderBy([
+          { column: `order_${index}.value`, order, nulls: "last" }
+        ]);
+      } else {
+        entitiesQuery = entitiesQuery.orderBy([
+          { column: `order_${index}.value`, order: void 0, nulls: "last" },
+          { column: `order_${index}.value`, order }
+        ]);
+      }
+    });
+    entitiesQuery = entitiesQuery.orderBy("final_entities.entity_id", "asc");
     const { limit, offset } = parsePagination(request == null ? void 0 : request.pagination);
     if (limit !== void 0) {
       entitiesQuery = entitiesQuery.limit(limit + 1);
@@ -3282,6 +3309,22 @@ function parseEntityFacetParams(params) {
   throw new errors.InputError("Missing facet parameter");
 }
 
+function parseEntityOrderParams(params) {
+  var _a;
+  return (_a = parseStringsParam(params.order, "order")) == null ? void 0 : _a.map((item) => {
+    const match = item.match(/^(asc|desc):(.+)$/);
+    if (!match) {
+      throw new errors.InputError(
+        `Invalid order parameter "${item}", expected "<asc or desc>:<field name>"`
+      );
+    }
+    return {
+      order: match[1],
+      field: match[2]
+    };
+  });
+}
+
 async function requireRequestBody(req) {
   const contentType = req.header("content-type");
   if (!contentType) {
@@ -3353,6 +3396,7 @@ async function createRouter(options) {
       const { entities, pageInfo } = await entitiesCatalog.entities({
         filter: parseEntityFilterParams(req.query),
         fields: parseEntityTransformParams(req.query),
+        order: parseEntityOrderParams(req.query),
         pagination: parseEntityPaginationParams(req.query),
         authorizationToken: getBearerToken(req.header("authorization"))
       });
@@ -4089,6 +4133,7 @@ class DefaultProviderDatabase {
               logger: this.options.logger
             });
           }
+          await tx("refresh_state_references").where("target_entity_ref", entityRef).andWhere({ source_key: options.sourceKey }).delete();
           if (ok) {
             await tx(
               "refresh_state_references"