@backstage/plugin-catalog-react 0.6.11 → 0.6.13-next.1

package/CHANGELOG.md

@@ -1,5 +1,65 @@
 # @backstage/plugin-catalog-react
 
+## 0.6.13-next.1
+
+### Patch Changes
+
+- f7257dff6f: The `<Link />` component now accepts a `noTrack` prop, which prevents the `click` event from being captured by the Analytics API. This can be used if tracking is explicitly not warranted, or in order to use custom link tracking in specific situations.
+- 300f8cdaee: Fix bug: previously the filter would be set to "all" on page load, even if the
+  `initiallySelectedFilter` on the `DefaultCatalogPage` was set to something else,
+  or a different query parameter was supplied. Now, the prop and query parameters
+  control the filter as expected. Additionally, after this change any filters
+  which match 0 items will be disabled, and the filter will be reverted to 'all'
+  if they're set on page load.
+- 6acc8f7db7: Add caching to the useEntityPermission hook
+
+  The hook now caches the authorization decision based on the permission + the entity, and returns the cache match value as the default `allowed` value while loading. This helps avoid flicker in UI elements that would be conditionally rendered based on the `allowed` result of this hook.
+
+- Updated dependencies
+  - @backstage/core-components@0.8.7-next.1
+
+## 0.6.13-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/core-components@0.8.7-next.0
+
+## 0.6.12
+
+### Patch Changes
+
+- 3d87019269: The `entityRouteRef` is now a well-known route that should be imported directly from `@backstage/plugin-catalog-react`. It is guaranteed to be globally unique across duplicate installations of the `@backstage/plugin-catalog-react`, starting at this version.
+
+  Deprecated `entityRoute` in favor of `entityRouteRef`.
+
+  Deprecated `rootRoute` and `catalogRouteRef`. If you want to refer to the catalog index page from a public plugin you now need to use an `ExternalRouteRef` instead. For private plugins it is possible to take the shortcut of referring directly to `catalogPlugin.routes.indexPage` instead.
+
+- 2916a83b9c: Deprecated `loadIdentityOwnerRefs`, since they can now be retrieved as `ownershipEntityRefs` from `identityApi.getBackstageIdentity()` instead.
+- 51fbedc445: Migrated usage of deprecated `IdentityApi` methods.
+- c54c0d9d10: Add useEntityPermission hook
+- Updated dependencies
+  - @backstage/plugin-permission-react@0.3.0
+  - @backstage/core-components@0.8.5
+  - @backstage/integration@0.7.2
+  - @backstage/plugin-permission-common@0.4.0
+  - @backstage/core-plugin-api@0.6.0
+  - @backstage/catalog-model@0.9.10
+  - @backstage/catalog-client@0.5.5
+
+## 0.6.12-next.0
+
+### Patch Changes
+
+- 2916a83b9c: Deprecated `loadIdentityOwnerRefs`, since they can now be retrieved as `ownershipEntityRefs` from `identityApi.getBackstageIdentity()` instead.
+- 51fbedc445: Migrated usage of deprecated `IdentityApi` methods.
+- Updated dependencies
+  - @backstage/core-components@0.8.5-next.0
+  - @backstage/core-plugin-api@0.6.0-next.0
+  - @backstage/catalog-model@0.9.10-next.0
+  - @backstage/catalog-client@0.5.5-next.0
+  - @backstage/integration@0.7.2-next.0
+
 ## 0.6.11
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -21,7 +21,7 @@ var isEqual = require('lodash/isEqual');
 var coreComponents = require('@backstage/core-components');
 var core = require('@material-ui/core');
 var useObservable = require('react-use/lib/useObservable');
-var jwtDecoder = require('jwt-decode');
+var pluginPermissionReact = require('@backstage/plugin-permission-react');
 var CheckBoxIcon = require('@material-ui/icons/CheckBox');
 var CheckBoxOutlineBlankIcon = require('@material-ui/icons/CheckBoxOutlineBlank');
 var ExpandMoreIcon = require('@material-ui/icons/ExpandMore');
@@ -46,7 +46,6 @@ var useMountedState__default = /*#__PURE__*/_interopDefaultLegacy(useMountedStat
 var useAsync__default = /*#__PURE__*/_interopDefaultLegacy(useAsync);
 var isEqual__default = /*#__PURE__*/_interopDefaultLegacy(isEqual);
 var useObservable__default = /*#__PURE__*/_interopDefaultLegacy(useObservable);
-var jwtDecoder__default = /*#__PURE__*/_interopDefaultLegacy(jwtDecoder);
 var CheckBoxIcon__default = /*#__PURE__*/_interopDefaultLegacy(CheckBoxIcon);
 var CheckBoxOutlineBlankIcon__default = /*#__PURE__*/_interopDefaultLegacy(CheckBoxOutlineBlankIcon);
 var ExpandMoreIcon__default = /*#__PURE__*/_interopDefaultLegacy(ExpandMoreIcon);
@@ -129,11 +128,11 @@ const rootRoute = corePluginApi.createRouteRef({
   id: "catalog"
 });
 const catalogRouteRef = rootRoute;
-const entityRoute = corePluginApi.createRouteRef({
+const entityRouteRef = versionBridge.getOrCreateGlobalSingleton("catalog:entity-route-ref", () => corePluginApi.createRouteRef({
   id: "catalog:entity",
   params: ["namespace", "kind", "name"]
-});
-const entityRouteRef = entityRoute;
+}));
+const entityRoute = entityRouteRef;
 function entityRouteParams(entity) {
   var _a, _b;
   return {
@@ -624,11 +623,13 @@ function useEntityKinds() {
 function useOwnUser() {
   const catalogApi = corePluginApi.useApi(catalogApiRef);
   const identityApi = corePluginApi.useApi(corePluginApi.identityApiRef);
-  return useAsync__default["default"](() => catalogApi.getEntityByName({
-    kind: "User",
-    namespace: "default",
-    name: identityApi.getUserId()
-  }), [catalogApi, identityApi]);
+  return useAsync__default["default"](async () => {
+    const identity = await identityApi.getBackstageIdentity();
+    return catalogApi.getEntityByName(catalogModel.parseEntityRef(identity.userEntityRef, {
+      defaultKind: "User",
+      defaultNamespace: catalogModel.ENTITY_DEFAULT_NAMESPACE
+    }));
+  }, [catalogApi, identityApi]);
 }
 
 const BATCH_SIZE = 20;
@@ -712,34 +713,9 @@ function useStarredEntity(entityOrRef) {
   };
 }
 
-function extendUserId(id) {
-  try {
-    const ref = catalogModel.parseEntityRef(id, {
-      defaultKind: "User",
-      defaultNamespace: "default"
-    });
-    return catalogModel.stringifyEntityRef(ref);
-  } catch {
-    return id;
-  }
-}
 async function loadIdentityOwnerRefs(identityApi) {
-  const id = identityApi.getUserId();
-  const token = await identityApi.getIdToken();
-  const result = [];
-  if (id) {
-    result.push(extendUserId(id));
-  }
-  if (token) {
-    try {
-      const decoded = jwtDecoder__default["default"](token);
-      if (decoded == null ? void 0 : decoded.ent) {
-        [decoded.ent].flat().filter((x) => typeof x === "string").map((x) => x.toLocaleLowerCase("en-US")).forEach((x) => result.push(x));
-      }
-    } catch {
-    }
-  }
-  return result;
+  const identity = await identityApi.getBackstageIdentity();
+  return identity.ownershipEntityRefs;
 }
 async function loadCatalogOwnerRefs(catalogApi, identityOwnerRefs) {
   const result = new Array();
@@ -761,9 +737,9 @@ function useEntityOwnership() {
   const identityApi = corePluginApi.useApi(corePluginApi.identityApiRef);
   const catalogApi = corePluginApi.useApi(catalogApiRef);
   const { loading, value: refs } = useAsync__default["default"](async () => {
-    const identityRefs = await loadIdentityOwnerRefs(identityApi);
-    const catalogRefs = await loadCatalogOwnerRefs(catalogApi, identityRefs);
-    return /* @__PURE__ */ new Set([...identityRefs, ...catalogRefs]);
+    const { ownershipEntityRefs } = await identityApi.getBackstageIdentity();
+    const catalogRefs = await loadCatalogOwnerRefs(catalogApi, ownershipEntityRefs);
+    return /* @__PURE__ */ new Set([...ownershipEntityRefs, ...catalogRefs]);
   }, []);
   const isOwnedEntity = React.useMemo(() => {
     const myOwnerRefs = new Set(refs != null ? refs : []);
@@ -804,6 +780,22 @@ function useOwnedEntities(allowedKinds) {
   return React.useMemo(() => ({ loading, ownedEntities }), [loading, ownedEntities]);
 }
 
+function useEntityPermission(permission) {
+  const { entity, loading: loadingEntity, error: entityError } = useEntity();
+  const {
+    allowed,
+    loading: loadingPermission,
+    error: permissionError
+  } = pluginPermissionReact.usePermission(permission, entity ? catalogModel.stringifyEntityRef(entity) : void 0);
+  if (loadingEntity || loadingPermission) {
+    return { loading: true, allowed: false };
+  }
+  if (entityError) {
+    return { loading: false, allowed: false, error: entityError };
+  }
+  return { loading: false, allowed, error: permissionError };
+}
+
 const EntityKindPicker = ({
   initialFilter,
   hidden
@@ -1528,7 +1520,7 @@ const UserListPicker = ({
   const classes = useStyles();
   const configApi = corePluginApi.useApi(corePluginApi.configApiRef);
   const orgName = (_a = configApi.getOptionalString("organization.name")) != null ? _a : "Company";
-  const { filters, updateFilters, backendEntities, queryParameters } = useEntityListProvider();
+  const { filters, updateFilters, backendEntities, queryParameters, loading } = useEntityListProvider();
   const userAndGroupFilterIds = ["starred", "all"];
   const filterGroups = getFilterGroups(orgName).map((filterGroup) => ({
     ...filterGroup,
@@ -1538,28 +1530,23 @@ const UserListPicker = ({
   const { isOwnedEntity } = useEntityOwnership();
   const ownedFilter = React.useMemo(() => new UserListFilter("owned", isOwnedEntity, isStarredEntity), [isOwnedEntity, isStarredEntity]);
   const starredFilter = React.useMemo(() => new UserListFilter("starred", isOwnedEntity, isStarredEntity), [isOwnedEntity, isStarredEntity]);
-  const [entitiesWithoutUserFilter, setEntitiesWithoutUserFilter] = React.useState(backendEntities);
-  const totalOwnedUserEntities = entitiesWithoutUserFilter.filter((entity) => ownedFilter.filterEntity(entity)).length;
-  const [selectedUserFilter, setSelectedUserFilter] = React.useState(totalOwnedUserEntities > 0 ? (_b = [queryParameters.user].flat()[0]) != null ? _b : initialFilter : "all");
+  const [selectedUserFilter, setSelectedUserFilter] = React.useState((_b = [queryParameters.user].flat()[0]) != null ? _b : initialFilter);
+  const entitiesWithoutUserFilter = React.useMemo(() => backendEntities.filter(reduceEntityFilters(lodash.compact(Object.values({ ...filters, user: void 0 })))), [filters, backendEntities]);
+  const filterCounts = React.useMemo(() => ({
+    all: entitiesWithoutUserFilter.length,
+    starred: entitiesWithoutUserFilter.filter((entity) => starredFilter.filterEntity(entity)).length,
+    owned: entitiesWithoutUserFilter.filter((entity) => ownedFilter.filterEntity(entity)).length
+  }), [entitiesWithoutUserFilter, starredFilter, ownedFilter]);
+  React.useEffect(() => {
+    if (!loading && !!selectedUserFilter && selectedUserFilter !== "all" && filterCounts[selectedUserFilter] === 0) {
+      setSelectedUserFilter("all");
+    }
+  }, [loading, filterCounts, selectedUserFilter, setSelectedUserFilter]);
   React.useEffect(() => {
     updateFilters({
       user: selectedUserFilter ? new UserListFilter(selectedUserFilter, isOwnedEntity, isStarredEntity) : void 0
     });
   }, [selectedUserFilter, isOwnedEntity, isStarredEntity, updateFilters]);
-  React.useEffect(() => {
-    const filterFn = reduceEntityFilters(lodash.compact(Object.values({ ...filters, user: void 0 })));
-    setEntitiesWithoutUserFilter(backendEntities.filter(filterFn));
-  }, [filters, backendEntities]);
-  function getFilterCount(id) {
-    switch (id) {
-      case "owned":
-        return totalOwnedUserEntities;
-      case "starred":
-        return entitiesWithoutUserFilter.filter((entity) => starredFilter.filterEntity(entity)).length;
-      default:
-        return entitiesWithoutUserFilter.length;
-    }
-  }
   return /* @__PURE__ */ React__default["default"].createElement(core.Card, {
     className: classes.root
   }, filterGroups.map((group) => /* @__PURE__ */ React__default["default"].createElement(React.Fragment, {
@@ -1580,15 +1567,16 @@ const UserListPicker = ({
       divider: true,
       onClick: () => setSelectedUserFilter(item.id),
       selected: item.id === ((_a2 = filters.user) == null ? void 0 : _a2.value),
-      className: classes.menuItem
+      className: classes.menuItem,
+      disabled: filterCounts[item.id] === 0,
+      "data-testid": `user-picker-${item.id}`
     }, item.icon && /* @__PURE__ */ React__default["default"].createElement(core.ListItemIcon, {
       className: classes.listIcon
     }, /* @__PURE__ */ React__default["default"].createElement(item.icon, {
       fontSize: "small"
     })), /* @__PURE__ */ React__default["default"].createElement(core.ListItemText, null, /* @__PURE__ */ React__default["default"].createElement(core.Typography, {
-      variant: "body1",
-      "data-testid": `user-picker-${item.id}`
-    }, item.label)), /* @__PURE__ */ React__default["default"].createElement(core.ListItemSecondaryAction, null, (_b2 = getFilterCount(item.id)) != null ? _b2 : "-"));
+      variant: "body1"
+    }, item.label)), /* @__PURE__ */ React__default["default"].createElement(core.ListItemSecondaryAction, null, (_b2 = filterCounts[item.id]) != null ? _b2 : "-"));
   }))))));
 };
 
@@ -1673,6 +1661,7 @@ exports.useEntityFromUrl = useEntityFromUrl;
 exports.useEntityKinds = useEntityKinds;
 exports.useEntityListProvider = useEntityListProvider;
 exports.useEntityOwnership = useEntityOwnership;
+exports.useEntityPermission = useEntityPermission;
 exports.useEntityTypeFilter = useEntityTypeFilter;
 exports.useOwnUser = useOwnUser;
 exports.useOwnedEntities = useOwnedEntities;