diff --git a/.changeset/wicked-ladybugs-argue.md b/.changeset/wicked-ladybugs-argue.md index d75f250689..9a36cf17cb 100644 --- a/.changeset/wicked-ladybugs-argue.md +++ b/.changeset/wicked-ladybugs-argue.md @@ -3,7 +3,7 @@ '@backstage/plugin-catalog-react': patch --- -Added new `EntityAdvancedPicker` that will filter for entities with orphans and/or errors. +Added new `EntityProcessingStatusPicker` that will filter for entities with orphans and/or errors. If you are using the default Catalog page this picker will be added automatically. For those who have customized their Catalog page you'll need to add this manually by doing something like this: @@ -14,7 +14,7 @@ import { EntityTypePicker, UserListPicker, EntityTagPicker -+ EntityAdvancedPicker, ++ EntityProcessingStatusPicker, } from '@backstage/plugin-catalog-react'; ... export const CustomCatalogPage = ({ @@ -31,7 +31,7 @@ export const CustomCatalogPage = ({ -+ ++ diff --git a/plugins/catalog-react/api-report.md b/plugins/catalog-react/api-report.md index 61c1eb4592..5232c49150 100644 --- a/plugins/catalog-react/api-report.md +++ b/plugins/catalog-react/api-report.md @@ -78,18 +78,18 @@ export type CatalogReactComponentsNameToClassKey = { CatalogReactEntitySearchBar: CatalogReactEntitySearchBarClassKey; CatalogReactEntityTagPicker: CatalogReactEntityTagPickerClassKey; CatalogReactEntityOwnerPicker: CatalogReactEntityOwnerPickerClassKey; - CatalogReactEntityAdvancedPicker: CatalogReactEntityAdvancedPickerClassKey; + CatalogReactEntityProcessingStatusPicker: CatalogReactEntityProcessingStatusPickerClassKey; }; -// @public (undocumented) -export type CatalogReactEntityAdvancedPickerClassKey = 'input'; - // @public (undocumented) export type CatalogReactEntityLifecyclePickerClassKey = 'input'; // @public (undocumented) export type CatalogReactEntityOwnerPickerClassKey = 'input'; +// @public (undocumented) +export type CatalogReactEntityProcessingStatusPickerClassKey = 'input'; + // @public (undocumented) export type CatalogReactEntitySearchBarClassKey = 'searchToolbar' | 'input'; @@ -145,9 +145,6 @@ export type DefaultEntityFilters = { error?: EntityErrorFilter; }; -// @public (undocumented) -export const EntityAdvancedPicker: () => JSX.Element; - // @public export class EntityErrorFilter implements EntityFilter { constructor(value: boolean); @@ -263,6 +260,9 @@ export class EntityOwnerFilter implements EntityFilter { // @public (undocumented) export const EntityOwnerPicker: () => JSX.Element | null; +// @public (undocumented) +export const EntityProcessingStatusPicker: () => JSX.Element; + // @public export const EntityProvider: (props: EntityProviderProps) => JSX.Element; diff --git a/plugins/catalog-react/src/components/EntityAdvancedPicker/EntityAdvancedPicker.test.tsx b/plugins/catalog-react/src/components/EntityProcessingStatusPicker/EntityProcessingStatusPicker.test.tsx similarity index 81% rename from plugins/catalog-react/src/components/EntityAdvancedPicker/EntityAdvancedPicker.test.tsx rename to plugins/catalog-react/src/components/EntityProcessingStatusPicker/EntityProcessingStatusPicker.test.tsx index c139c66505..8e90e04148 100644 --- a/plugins/catalog-react/src/components/EntityAdvancedPicker/EntityAdvancedPicker.test.tsx +++ b/plugins/catalog-react/src/components/EntityProcessingStatusPicker/EntityProcessingStatusPicker.test.tsx @@ -19,7 +19,7 @@ import { fireEvent, render } from '@testing-library/react'; import React from 'react'; import { EntityErrorFilter, EntityOrphanFilter } from '../../filters'; import { MockEntityListContextProvider } from '../../testUtils/providers'; -import { EntityAdvancedPicker } from './EntityAdvancedPicker'; +import { EntityProcessingStatusPicker } from './EntityProcessingStatusPicker'; const orphanAnnotation: Record = {}; orphanAnnotation['backstage.io/orphan'] = 'true'; @@ -50,18 +50,18 @@ const sampleEntities: Entity[] = [ }, ]; -describe('', () => { - it('renders all advanced options', () => { +describe('', () => { + it('renders all processing status options', () => { const rendered = render( - + , ); - expect(rendered.getByText('Advanced')).toBeInTheDocument(); + expect(rendered.getByText('Processing Status')).toBeInTheDocument(); - fireEvent.click(rendered.getByTestId('advanced-picker-expand')); + fireEvent.click(rendered.getByTestId('processing-status-picker-expand')); expect(rendered.getByText('Is Orphan')).toBeInTheDocument(); expect(rendered.getByText('Has Error')).toBeInTheDocument(); }); @@ -76,11 +76,11 @@ describe('', () => { updateFilters, }} > - + , ); - fireEvent.click(rendered.getByTestId('advanced-picker-expand')); + fireEvent.click(rendered.getByTestId('processing-status-picker-expand')); fireEvent.click(rendered.getByText('Is Orphan')); expect(updateFilters).toHaveBeenCalledWith({ orphan: new EntityOrphanFilter(true), @@ -97,11 +97,11 @@ describe('', () => { updateFilters, }} > - + , ); - fireEvent.click(rendered.getByTestId('advanced-picker-expand')); + fireEvent.click(rendered.getByTestId('processing-status-picker-expand')); fireEvent.click(rendered.getByText('Has Error')); expect(updateFilters).toHaveBeenCalledWith({ error: new EntityErrorFilter(true), @@ -118,11 +118,11 @@ describe('', () => { updateFilters, }} > - + , ); - fireEvent.click(rendered.getByTestId('advanced-picker-expand')); + fireEvent.click(rendered.getByTestId('processing-status-picker-expand')); fireEvent.click(rendered.getByText('Is Orphan')); expect(updateFilters).toHaveBeenCalledWith({ orphan: undefined, @@ -139,11 +139,11 @@ describe('', () => { updateFilters, }} > - + , ); - fireEvent.click(rendered.getByTestId('advanced-picker-expand')); + fireEvent.click(rendered.getByTestId('processing-status-picker-expand')); fireEvent.click(rendered.getByText('Has Error')); expect(updateFilters).toHaveBeenCalledWith({ error: undefined, diff --git a/plugins/catalog-react/src/components/EntityAdvancedPicker/EntityAdvancedPicker.tsx b/plugins/catalog-react/src/components/EntityProcessingStatusPicker/EntityProcessingStatusPicker.tsx similarity index 89% rename from plugins/catalog-react/src/components/EntityAdvancedPicker/EntityAdvancedPicker.tsx rename to plugins/catalog-react/src/components/EntityProcessingStatusPicker/EntityProcessingStatusPicker.tsx index e3be9be3c5..3fe3b60e25 100644 --- a/plugins/catalog-react/src/components/EntityAdvancedPicker/EntityAdvancedPicker.tsx +++ b/plugins/catalog-react/src/components/EntityProcessingStatusPicker/EntityProcessingStatusPicker.tsx @@ -31,14 +31,14 @@ import { useEntityList } from '../../hooks'; import { Autocomplete } from '@material-ui/lab'; /** @public */ -export type CatalogReactEntityAdvancedPickerClassKey = 'input'; +export type CatalogReactEntityProcessingStatusPickerClassKey = 'input'; const useStyles = makeStyles( { input: {}, }, { - name: 'CatalogReactEntityAdvancedPicker', + name: 'CatalogReactEntityProcessingStatusPickerPicker', }, ); @@ -46,7 +46,7 @@ const icon = ; const checkedIcon = ; /** @public */ -export const EntityAdvancedPicker = () => { +export const EntityProcessingStatusPicker = () => { const classes = useStyles(); const { updateFilters } = useEntityList(); @@ -71,7 +71,7 @@ export const EntityAdvancedPicker = () => { return ( - Advanced + Processing Status { /> )} size="small" - popupIcon={} + popupIcon={ + + } renderInput={params => ( - +