@backstage/plugin-catalog-react 1.7.0-next.1 → 1.7.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @backstage/plugin-catalog-react
 
+## 1.7.0-next.2
+
+### Patch Changes
+
+- d68692aee97e: Make `useRelatedEntities` use `getEntitiesByRefs` under the hood
+- Updated dependencies
+  - @backstage/theme@0.4.0-next.1
+  - @backstage/core-components@0.13.2-next.2
+  - @backstage/core-plugin-api@1.5.2-next.0
+  - @backstage/plugin-permission-react@0.4.13-next.0
+
 ## 1.7.0-next.1
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-react",
-  "version": "1.7.0-next.1",
+  "version": "1.7.0-next.2",
   "main": "../dist/alpha.esm.js",
   "module": "../dist/alpha.esm.js",
   "types": "../dist/alpha.d.ts"

package/dist/index.d.ts

@@ -569,7 +569,12 @@ declare function useEntityTypeFilter(): {
     setSelectedTypes: (types: string[]) => void;
 };
 
-/** @public */
+/**
+ * Fetches all entities that appear in the entity's relations, optionally
+ * filtered by relation type and kind.
+ *
+ * @public
+ */
 declare function useRelatedEntities(entity: Entity, relationFilter: {
     type?: string;
     kind?: string;

package/dist/index.esm.js

@@ -8,7 +8,7 @@ import { Select, Link, Progress, ErrorPanel, ResponseErrorPanel, OverflowTooltip
 import { ANNOTATION_SOURCE_LOCATION, parseLocationRef, stringifyEntityRef, parseEntityRef, RELATION_OWNED_BY, DEFAULT_NAMESPACE, getCompoundEntityRef, isUserEntity, isGroupEntity, RELATION_PART_OF, ANNOTATION_LOCATION, ANNOTATION_ORIGIN_LOCATION } from '@backstage/catalog-model';
 import { g as getEntityRelations } from './esm/useEntity-de64059a.esm.js';
 export { A as AsyncEntityProvider, E as EntityProvider, g as getEntityRelations, a as useAsyncEntity, u as useEntity } from './esm/useEntity-de64059a.esm.js';
-import { compact, isEqual, groupBy, chunk, debounce } from 'lodash';
+import { compact, isEqual, debounce } from 'lodash';
 import qs from 'qs';
 import { useLocation, useNavigate } from 'react-router-dom';
 import useAsyncFn from 'react-use/lib/useAsyncFn';
@@ -38,7 +38,7 @@ import Star from '@material-ui/icons/Star';
 import StarBorder from '@material-ui/icons/StarBorder';
 import WorkIcon from '@material-ui/icons/Work';
 import HelpOutlineIcon from '@material-ui/icons/HelpOutline';
-import groupBy$1 from 'lodash/groupBy';
+import groupBy from 'lodash/groupBy';
 import DialogContentText$1 from '@material-ui/core/DialogContentText';
 import YAML from 'yaml';
 import Alert$1 from '@material-ui/lab/Alert';
@@ -489,7 +489,6 @@ function useEntityTypeFilter() {
   };
 }
 
-const BATCH_SIZE = 20;
 function useRelatedEntities(entity, relationFilter) {
   var _a, _b;
   const filterByTypeLower = (_a = relationFilter == null ? void 0 : relationFilter.type) == null ? void 0 : _a.toLocaleLowerCase("en-US");
@@ -501,43 +500,16 @@ function useRelatedEntities(entity, relationFilter) {
     error
   } = useAsync(async () => {
     var _a2;
-    const relations = (_a2 = entity.relations) == null ? void 0 : _a2.map((r) => ({ type: r.type, target: parseEntityRef(r.targetRef) })).filter(
-      (r) => (!filterByTypeLower || r.type.toLocaleLowerCase("en-US") === filterByTypeLower) && (!filterByKindLower || r.target.kind === filterByKindLower)
+    const relations = (_a2 = entity.relations) == null ? void 0 : _a2.filter(
+      (r) => (!filterByTypeLower || r.type.toLocaleLowerCase("en-US") === filterByTypeLower) && (!filterByKindLower || parseEntityRef(r.targetRef).kind === filterByKindLower)
     );
-    if (!relations) {
+    if (!(relations == null ? void 0 : relations.length)) {
       return [];
     }
-    const relationsByKindAndNamespace = Object.values(
-      groupBy(relations, ({ target }) => {
-        return `${target.kind}:${target.namespace}`.toLocaleLowerCase("en-US");
-      })
-    );
-    const batchedRelationsByKindAndNamespace = [];
-    for (const rs of relationsByKindAndNamespace) {
-      batchedRelationsByKindAndNamespace.push({
-        // All relations in a group have the same kind and namespace, so its arbitrary which we pick
-        kind: rs[0].target.kind,
-        namespace: rs[0].target.namespace,
-        nameBatches: chunk(
-          rs.map((r) => r.target.name),
-          BATCH_SIZE
-        )
-      });
-    }
-    const results = await Promise.all(
-      batchedRelationsByKindAndNamespace.flatMap((rs) => {
-        return rs.nameBatches.map((names) => {
-          return catalogApi.getEntities({
-            filter: {
-              kind: rs.kind,
-              "metadata.namespace": rs.namespace,
-              "metadata.name": names
-            }
-          });
-        });
-      })
-    );
-    return results.flatMap((r) => r.items);
+    const { items } = await catalogApi.getEntitiesByRefs({
+      entityRefs: relations.map((r) => r.targetRef)
+    });
+    return items.filter((x) => Boolean(x));
   }, [entity, filterByTypeLower, filterByKindLower]);
   return {
     entities,
@@ -1996,7 +1968,7 @@ function OverviewPage(props) {
     relations = [],
     status = {}
   } = props.entity;
-  const groupedRelations = groupBy$1(
+  const groupedRelations = groupBy(
     sortBy(relations, (r) => r.targetRef),
     "type"
   );