@backstage/plugin-catalog-backend 3.6.1-next.0 → 3.6.1

package/CHANGELOG.md

@@ -1,34 +1,10 @@
 # @backstage/plugin-catalog-backend
 
-## 3.6.1-next.0
+## 3.6.1
 
 ### Patch Changes
 
-- b33f845: Fixed several database migration `down` functions that were not properly reversible, causing the SQL report to show warnings:
-
-  - `20241003170511_alter_target_in_locations.js`: both `up` and `down` now include `.notNullable()` when altering the `locations.target` column, preventing the `NOT NULL` constraint from being accidentally dropped when widening the column type from `varchar(255)` to `text`.
-  - `20220116144621_remove_legacy.js`: the `down` function now properly recreates the three dropped legacy tables (`entities`, `entities_search`, `entities_relations`) with correct columns and indices.
-  - `20210302150147_refresh_state.js`: the `down` function now drops dependent tables in the correct order (avoiding a FK constraint violation) and fixes a typo where the table was referred to as `references` instead of `refresh_state_references`.
-  - `20201005122705_add_entity_full_name.js`: the `down` function now drops the `full_name` column from `entities` (not `entities_search`), and restores the `entities_unique_name` index with the correct column order `(kind, name, namespace)`.
-  - `20200702153613_entities.js`: the `down` function now uses `table.integer('generation')` instead of `table.string('generation')`, restoring the correct column type.
-
-- cf195de: Fixed a performance regression in the `/entity-facets` endpoint when filters or permission conditions are applied, by routing the EXISTS-based filter through `final_entities` instead of correlating against the much larger `search` table.
-- 744fa1f: Removed duplicated entries that appeared in both `dependencies` and `devDependencies`.
-- Updated dependencies
-  - @backstage/errors@1.3.1-next.0
-  - @backstage/integration@2.0.2-next.0
-  - @backstage/backend-openapi-utils@0.6.9-next.0
-  - @backstage/backend-plugin-api@1.9.1-next.0
-  - @backstage/catalog-client@1.15.1-next.0
-  - @backstage/catalog-model@1.8.1-next.0
-  - @backstage/config@1.3.8-next.0
-  - @backstage/filter-predicates@0.1.3-next.0
-  - @backstage/plugin-catalog-node@2.2.1-next.0
-  - @backstage/plugin-events-node@0.4.22-next.0
-  - @backstage/plugin-permission-common@0.9.9-next.0
-  - @backstage/plugin-permission-node@0.10.13-next.0
-  - @backstage/types@1.2.2
-  - @backstage/plugin-catalog-common@1.1.10-next.0
+- 250778e: Fixed a performance regression in the `/entity-facets` endpoint when filters or permission conditions are applied, by routing the EXISTS-based filter through `final_entities` instead of correlating against the much larger `search` table.
 
 ## 3.6.0
 

package/migrations/20200702153613_entities.js

@@ -169,7 +169,7 @@ exports.down = async function down(knex) {
           'An opaque string that changes for each update operation to any part of the entity, including metadata.',
         );
       table
-        .integer('generation')
+        .string('generation')
         .notNullable()
         .unsigned()
         .comment(

package/migrations/20201005122705_add_entity_full_name.js

@@ -52,12 +52,12 @@ exports.down = async function down(knex) {
   await knex.schema.alterTable('entities', table => {
     // https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta
     table.dropUnique([], 'entities_unique_full_name');
-    table.unique(['kind', 'name', 'namespace'], {
+    table.unique(['kind', 'namespace', 'name'], {
       indexName: 'entities_unique_name',
     });
   });
 
-  await knex.schema.alterTable('entities', table => {
+  await knex.schema.alterTable('entities_search', table => {
     table.dropColumn('full_name');
   });
 };

package/migrations/20210302150147_refresh_state.js

@@ -175,10 +175,33 @@ exports.up = async function up(knex) {
  * @param {import('knex').Knex} knex
  */
 exports.down = async function down(knex) {
-  // Drop tables that have FK constraints referencing refresh_state first.
-  await knex.schema.dropTable('refresh_state_references');
+  await knex.schema.alterTable('refresh_state_references', table => {
+    table.dropIndex([], 'refresh_state_references_source_key_idx');
+    table.dropIndex([], 'refresh_state_references_source_entity_ref_idx');
+    table.dropIndex([], 'refresh_state_references_target_entity_ref_idx');
+  });
+  await knex.schema.alterTable('refresh_state', table => {
+    table.dropUnique([], 'refresh_state_entity_ref_uniq');
+    table.dropIndex([], 'refresh_state_entity_id_idx');
+    table.dropIndex([], 'refresh_state_entity_ref_idx');
+    table.dropIndex([], 'refresh_state_next_update_at_idx');
+  });
+  await knex.schema.alterTable('final_entities', table => {
+    table.dropIndex([], 'final_entities_entity_id_idx');
+  });
+  await knex.schema.alterTable('relations', table => {
+    table.index('source_entity_ref', 'relations_source_entity_ref_idx');
+    table.index('originating_entity_id', 'relations_source_entity_id_idx');
+  });
+  await knex.schema.alterTable('search', table => {
+    table.dropIndex([], 'search_entity_id_idx');
+    table.dropIndex([], 'search_key_idx');
+    table.dropIndex([], 'search_value_idx');
+  });
+
   await knex.schema.dropTable('search');
   await knex.schema.dropTable('final_entities');
   await knex.schema.dropTable('relations');
+  await knex.schema.dropTable('references');
   await knex.schema.dropTable('refresh_state');
 };

package/migrations/20220116144621_remove_legacy.js

@@ -25,89 +25,4 @@ exports.up = async function up(knex) {
   await knex.schema.dropTable('entities');
 };
 
-/**
- * @param {import('knex').Knex} knex
- */
-exports.down = async function down(knex) {
-  await knex.schema.createTable('entities', table => {
-    table.comment('All entities currently stored in the catalog');
-    table.uuid('id').primary().comment('Auto-generated ID of the entity');
-    table
-      .uuid('location_id')
-      .references('id')
-      .inTable('locations')
-      .nullable()
-      .comment('The location that originated the entity');
-    table
-      .string('etag')
-      .notNullable()
-      .comment(
-        'An opaque string that changes for each update operation to any part of the entity, including metadata.',
-      );
-    table
-      .integer('generation')
-      .notNullable()
-      .unsigned()
-      .comment(
-        'A positive nonzero number that indicates the current generation of data for this entity; the value is incremented each time the spec changes.',
-      );
-    table
-      .string('full_name')
-      .notNullable()
-      .comment('The full name of the entity');
-    table
-      .text('data')
-      .notNullable()
-      .comment('The entire JSON data blob of the entity');
-    table.unique(['full_name'], { indexName: 'entities_unique_full_name' });
-    table.index('location_id', 'entity_location_id_idx');
-  });
-
-  await knex.schema.createTable('entities_search', table => {
-    table.comment(
-      'Flattened key-values from the entities, used for quick filtering',
-    );
-    table
-      .uuid('entity_id')
-      .references('id')
-      .inTable('entities')
-      .onDelete('CASCADE')
-      .comment('The entity that matches this key/value');
-    table
-      .string('key')
-      .notNullable()
-      .comment('A key that occurs in the entity');
-    table
-      .string('value')
-      .nullable()
-      .comment('The corresponding value to match on');
-    table.index(['key'], 'entities_search_key');
-    table.index(['value'], 'entities_search_value');
-    table.index(['entity_id'], 'entity_id_idx');
-  });
-
-  await knex.schema.createTable('entities_relations', table => {
-    table.comment('All relations between entities in the catalog');
-    table
-      .uuid('originating_entity_id')
-      .references('id')
-      .inTable('entities')
-      .onDelete('CASCADE')
-      .notNullable()
-      .comment('The entity that provided the relation');
-    table
-      .string('source_full_name')
-      .notNullable()
-      .comment('The full name of the source entity of the relation');
-    table
-      .string('type')
-      .notNullable()
-      .comment('The type of the relation between the entities');
-    table
-      .string('target_full_name')
-      .notNullable()
-      .comment('The full name of the target entity of the relation');
-    table.index('source_full_name', 'source_full_name_idx');
-    table.index('originating_entity_id', 'originating_entity_id_idx');
-  });
-};
+exports.down = async function down() {};

package/migrations/20241003170511_alter_target_in_locations.js

@@ -22,7 +22,7 @@
  */
 exports.up = async function up(knex) {
   await knex.schema.alterTable('locations', table => {
-    table.text('target').notNullable().alter();
+    table.text('target').alter();
   });
 };
 
@@ -42,6 +42,6 @@ exports.down = async function down(knex) {
   }
 
   await knex.schema.alterTable('locations', table => {
-    table.string('target').notNullable().alter();
+    table.string('target').alter();
   });
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend",
-  "version": "3.6.1-next.0",
+  "version": "3.6.1",
   "description": "The Backstage backend plugin that provides the Backstage catalog",
   "backstage": {
     "role": "backend-plugin",
@@ -76,20 +76,20 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-openapi-utils": "0.6.9-next.0",
-    "@backstage/backend-plugin-api": "1.9.1-next.0",
-    "@backstage/catalog-client": "1.15.1-next.0",
-    "@backstage/catalog-model": "1.8.1-next.0",
-    "@backstage/config": "1.3.8-next.0",
-    "@backstage/errors": "1.3.1-next.0",
-    "@backstage/filter-predicates": "0.1.3-next.0",
-    "@backstage/integration": "2.0.2-next.0",
-    "@backstage/plugin-catalog-common": "1.1.10-next.0",
-    "@backstage/plugin-catalog-node": "2.2.1-next.0",
-    "@backstage/plugin-events-node": "0.4.22-next.0",
-    "@backstage/plugin-permission-common": "0.9.9-next.0",
-    "@backstage/plugin-permission-node": "0.10.13-next.0",
-    "@backstage/types": "1.2.2",
+    "@backstage/backend-openapi-utils": "^0.6.8",
+    "@backstage/backend-plugin-api": "^1.9.0",
+    "@backstage/catalog-client": "^1.15.0",
+    "@backstage/catalog-model": "^1.8.0",
+    "@backstage/config": "^1.3.7",
+    "@backstage/errors": "^1.3.0",
+    "@backstage/filter-predicates": "^0.1.2",
+    "@backstage/integration": "^2.0.1",
+    "@backstage/plugin-catalog-common": "^1.1.9",
+    "@backstage/plugin-catalog-node": "^2.2.0",
+    "@backstage/plugin-events-node": "^0.4.21",
+    "@backstage/plugin-permission-common": "^0.9.8",
+    "@backstage/plugin-permission-node": "^0.10.12",
+    "@backstage/types": "^1.2.2",
     "@opentelemetry/api": "^1.9.0",
     "ajv": "^8.10.0",
     "ajv-errors": "^3.0.0",
@@ -113,18 +113,20 @@
     "zod-validation-error": "^4.0.2"
   },
   "devDependencies": {
-    "@backstage/backend-defaults": "0.17.1-next.0",
-    "@backstage/backend-test-utils": "1.11.3-next.0",
-    "@backstage/cli": "0.36.2-next.0",
-    "@backstage/plugin-catalog-backend-module-logs": "0.1.22-next.0",
-    "@backstage/plugin-scaffolder-common": "2.1.1-next.0",
-    "@backstage/repo-tools": "0.17.2-next.0",
+    "@backstage/backend-defaults": "^0.17.0",
+    "@backstage/backend-test-utils": "^1.11.2",
+    "@backstage/cli": "^0.36.1",
+    "@backstage/plugin-catalog-backend-module-logs": "^0.1.21",
+    "@backstage/plugin-permission-common": "^0.9.8",
+    "@backstage/plugin-scaffolder-common": "^2.1.0",
+    "@backstage/repo-tools": "^0.17.1",
     "@types/core-js": "^2.5.4",
     "@types/express": "^4.17.6",
     "@types/git-url-parse": "^9.0.0",
     "@types/lodash": "^4.14.151",
     "@types/supertest": "^2.0.8",
     "better-sqlite3": "^12.0.0",
+    "luxon": "^3.0.0",
     "msw": "^2.0.0",
     "supertest": "^7.0.0",
     "wait-for-expect": "^4.0.0",