@backstage/plugin-catalog-backend 1.16.2 → 1.17.0-next.1

package/CHANGELOG.md

@@ -1,10 +1,61 @@
 # @backstage/plugin-catalog-backend
 
-## 1.16.2
+## 1.17.0-next.1
+
+### Minor Changes
+
+- 43dad25: Add API to get location by entity
 
 ### Patch Changes
 
-- 4a3a427: Rollback the change for wildcard discovery, this fixes a bug with the `AzureUrlReader` not working with wildcard paths
+- 89b674c: Minor performance improvement for `queryEntities` when the limit is 0.
+- efa8160: Rollback the change for wildcard discovery, this fixes a bug with the `AzureUrlReader` not working with wildcard paths
+- Updated dependencies
+  - @backstage/catalog-model@1.4.4-next.0
+  - @backstage/catalog-client@1.6.0-next.1
+  - @backstage/backend-plugin-api@0.6.10-next.1
+  - @backstage/backend-common@0.21.0-next.1
+  - @backstage/integration@1.9.0-next.0
+  - @backstage/backend-openapi-utils@0.1.3-next.1
+  - @backstage/backend-tasks@0.5.15-next.1
+  - @backstage/config@1.1.1
+  - @backstage/errors@1.2.3
+  - @backstage/types@1.1.1
+  - @backstage/plugin-auth-node@0.4.4-next.1
+  - @backstage/plugin-catalog-common@1.0.21-next.0
+  - @backstage/plugin-catalog-node@1.6.2-next.1
+  - @backstage/plugin-events-node@0.2.19-next.1
+  - @backstage/plugin-permission-common@0.7.12
+  - @backstage/plugin-permission-node@0.7.21-next.1
+  - @backstage/plugin-search-backend-module-catalog@0.1.14-next.1
+
+## 1.17.0-next.0
+
+### Minor Changes
+
+- 126c2f9: Updates the OpenAPI spec to use plugin as `info.title` instead of package name.
+- 04907c3: Updates the OpenAPI specification title to plugin ID instead of package name.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.21.0-next.0
+  - @backstage/backend-openapi-utils@0.1.3-next.0
+  - @backstage/catalog-client@1.6.0-next.0
+  - @backstage/backend-tasks@0.5.15-next.0
+  - @backstage/plugin-auth-node@0.4.4-next.0
+  - @backstage/plugin-catalog-node@1.6.2-next.0
+  - @backstage/plugin-permission-node@0.7.21-next.0
+  - @backstage/plugin-search-backend-module-catalog@0.1.14-next.0
+  - @backstage/backend-plugin-api@0.6.10-next.0
+  - @backstage/catalog-model@1.4.3
+  - @backstage/config@1.1.1
+  - @backstage/errors@1.2.3
+  - @backstage/integration@1.8.0
+  - @backstage/types@1.1.1
+  - @backstage/plugin-catalog-common@1.0.20
+  - @backstage/plugin-events-node@0.2.19-next.0
+  - @backstage/plugin-permission-common@0.7.12
 
 ## 1.16.1
 

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend",
-  "version": "1.16.2",
+  "version": "1.17.0-next.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-59dba5ef.cjs.js');
+var CatalogBuilder = require('./cjs/CatalogBuilder-2dd9e66c.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/cjs/{CatalogBuilder-59dba5ef.cjs.js → CatalogBuilder-2dd9e66c.cjs.js}

@@ -947,6 +947,30 @@ class DefaultLocationStore {
       removed: [{ entity, locationKey: getEntityLocationRef(entity) }]
     });
   }
+  async getLocationByEntity(entityRef) {
+    const entityRefString = catalogModel.stringifyEntityRef(entityRef);
+    const [entity] = await this.db("refresh_state").where({ entity_ref: entityRefString }).select("entity_id").limit(1);
+    if (!entity) {
+      throw new errors.NotFoundError(`found no entity for ref ${entityRefString}`);
+    }
+    const [locationKeyValue] = await this.db("search").where({
+      entity_id: entity.entity_id,
+      key: `metadata.annotations.${catalogModel.ANNOTATION_ORIGIN_LOCATION}`
+    }).select("value").limit(1);
+    if (!locationKeyValue) {
+      throw new errors.NotFoundError(
+        `found no origin annotation for ref ${entityRefString}`
+      );
+    }
+    const { type, target } = catalogModel.parseLocationRef(entityRefString);
+    const [location] = await this.db("locations").where({ type, target }).select().limit(1);
+    if (!location) {
+      throw new errors.NotFoundError(
+        `Found no location with type ${type} and target ${target}`
+      );
+    }
+    return location;
+  }
   get connection() {
     if (!this._connection) {
       throw new Error("location store is not initialized");
@@ -2133,6 +2157,9 @@ class DefaultLocationService {
   deleteLocation(id) {
     return this.store.deleteLocation(id);
   }
+  getLocationByEntity(entityRef) {
+    return this.store.getLocationByEntity(catalogModel.parseEntityRef(entityRef));
+  }
   async processEntities(unprocessedEntities) {
     const entities = [];
     while (unprocessedEntities.length) {
@@ -2559,7 +2586,7 @@ class DefaultEntitiesCatalog {
     ]).limit(isFetchingBackwards ? limit : limit + 1);
     countQuery.count("search.entity_id", { as: "count" });
     const [rows, [{ count }]] = await Promise.all([
-      dbQuery,
+      limit > 0 ? dbQuery : [],
       // for performance reasons we invoke the countQuery
       // only on the first request.
       // The result is then embedded into the cursor
@@ -3914,7 +3941,7 @@ function parseEntityOrderParams(params) {
 const spec = {
   openapi: "3.0.3",
   info: {
-    title: "@backstage/plugin-catalog-backend",
+    title: "catalog",
     version: "1",
     description: "The Backstage backend plugin that provides the Backstage catalog",
     license: {
@@ -3926,9 +3953,6 @@ const spec = {
   servers: [
     {
       url: "/"
-    },
-    {
-      url: "catalog"
     }
   ],
   components: {
@@ -5274,6 +5298,62 @@ const spec = {
         ]
       }
     },
+    "/locations/by-entity/{kind}/{namespace}/{name}": {
+      get: {
+        operationId: "getLocationByEntity",
+        description: "Get a location for entity.",
+        responses: {
+          "200": {
+            description: "Ok",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/Location"
+                }
+              }
+            }
+          },
+          default: {
+            $ref: "#/components/responses/ErrorResponse"
+          }
+        },
+        security: [
+          {},
+          {
+            JWT: []
+          }
+        ],
+        parameters: [
+          {
+            in: "path",
+            name: "kind",
+            required: true,
+            allowReserved: true,
+            schema: {
+              type: "string"
+            }
+          },
+          {
+            in: "path",
+            name: "namespace",
+            required: true,
+            allowReserved: true,
+            schema: {
+              type: "string"
+            }
+          },
+          {
+            in: "path",
+            name: "name",
+            required: true,
+            allowReserved: true,
+            schema: {
+              type: "string"
+            }
+          }
+        ]
+      }
+    },
     "/analyze-location": {
       post: {
         operationId: "AnalyzeLocation",
@@ -5601,6 +5681,17 @@ async function createRouter(options) {
         )
       });
       res.status(204).end();
+    }).get("/locations/by-entity/:kind/:namespace/:name", async (req, res) => {
+      const { kind, namespace, name } = req.params;
+      const output = await locationService.getLocationByEntity(
+        { kind, namespace, name },
+        {
+          authorizationToken: pluginAuthNode.getBearerTokenFromAuthorizationHeader(
+            req.header("authorization")
+          )
+        }
+      );
+      res.status(200).json(output);
     });
   }
   if (locationAnalyzer) {
@@ -6322,6 +6413,16 @@ class AuthorizedLocationService {
     }
     return this.locationService.deleteLocation(id);
   }
+  async getLocationByEntity(entityRef, options) {
+    const authorizationResponse = (await this.permissionApi.authorize(
+      [{ permission: alpha.catalogLocationReadPermission }],
+      { token: options == null ? void 0 : options.authorizationToken }
+    ))[0];
+    if (authorizationResponse.result === pluginPermissionCommon.AuthorizeResult.DENY) {
+      throw new errors.NotFoundError();
+    }
+    return this.locationService.getLocationByEntity(entityRef);
+  }
 }
 
 async function deleteWithEagerPruningOfChildren(options) {
@@ -7256,4 +7357,4 @@ exports.createCatalogPermissionRule = createCatalogPermissionRule;
 exports.createRandomProcessingInterval = createRandomProcessingInterval;
 exports.parseEntityYaml = parseEntityYaml;
 exports.permissionRules = permissionRules;
-//# sourceMappingURL=CatalogBuilder-59dba5ef.cjs.js.map
+//# sourceMappingURL=CatalogBuilder-2dd9e66c.cjs.js.map