update the catalog client to add getEntityFacets

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2022-02-13 19:58:15 +01:00
parent 01e124ea60
commit 6e1cbc12a6
21 changed files with 216 additions and 57 deletions
@@ -34,6 +34,7 @@ describe('CatalogIdentityClient', () => {
removeEntityByUid: jest.fn(),
refreshEntity: jest.fn(),
getEntityAncestors: jest.fn(),
getEntityFacets: jest.fn(),
};
const tokenManager: jest.Mocked<TokenManager> = {
getToken: jest.fn(),
@@ -67,6 +67,7 @@ describe('createRouter', () => {
removeEntityByUid: jest.fn(),
refreshEntity: jest.fn(),
getEntityAncestors: jest.fn(),
getEntityFacets: jest.fn(),
};
config = new ConfigReader({
@@ -65,6 +65,7 @@ describe('<CatalogGraphCard/>', () => {
removeLocationById: jest.fn(),
refreshEntity: jest.fn(),
getEntityAncestors: jest.fn(),
getEntityFacets: jest.fn(),
};
apis = TestApiRegistry.from([catalogApiRef, catalog]);
@@ -94,6 +94,7 @@ describe('<CatalogGraphPage/>', () => {
removeLocationById: jest.fn(),
refreshEntity: jest.fn(),
getEntityAncestors: jest.fn(),
getEntityFacets: jest.fn(),
};
wrapper = (
@@ -155,6 +155,7 @@ describe('<EntityRelationsGraph/>', () => {
removeLocationById: jest.fn(),
refreshEntity: jest.fn(),
getEntityAncestors: jest.fn(),
getEntityFacets: jest.fn(),
};
Wrapper = ({ children }) => (
@@ -37,6 +37,7 @@ describe('useEntityStore', () => {
removeLocationById: jest.fn(),
refreshEntity: jest.fn(),
getEntityAncestors: jest.fn(),
getEntityFacets: jest.fn(),
};
useApi.mockReturnValue(catalogApi);
@@ -99,6 +99,7 @@ describe('CatalogImportClient', () => {
removeEntityByUid: jest.fn(),
refreshEntity: jest.fn(),
getEntityAncestors: jest.fn(),
getEntityFacets: jest.fn(),
};
let catalogImportClient: CatalogImportClient;
@@ -45,6 +45,7 @@ describe('<StepPrepareCreatePullRequest />', () => {
removeEntityByUid: jest.fn(),
refreshEntity: jest.fn(),
getEntityAncestors: jest.fn(),
getEntityFacets: jest.fn(),
};
const errorApi: jest.Mocked<typeof errorApiRef.T> = {
@@ -16,45 +16,21 @@
import React, { PropsWithChildren } from 'react';
import { CatalogApi } from '@backstage/catalog-client';
import { Entity } from '@backstage/catalog-model';
import { catalogApiRef } from '../api';
import { renderHook } from '@testing-library/react-hooks';
import { useEntityKinds } from './useEntityKinds';
import { TestApiProvider } from '@backstage/test-utils';
const entities: Entity[] = [
{
apiVersion: '1',
kind: 'Component',
metadata: {
name: 'component-1',
},
},
{
apiVersion: '1',
kind: 'Component',
metadata: {
name: 'component-2',
},
},
{
apiVersion: '1',
kind: 'Template',
metadata: {
name: 'template',
},
},
{
apiVersion: '1',
kind: 'System',
metadata: {
name: 'system',
},
},
];
const mockCatalogApi: Partial<CatalogApi> = {
getEntities: jest.fn().mockResolvedValue({ items: entities }),
getEntityFacets: jest.fn().mockResolvedValue({
facets: {
kind: [
{ value: 'Template', count: 2 },
{ value: 'System', count: 1 },
{ value: 'Component', count: 3 },
],
},
}),
};
const wrapper = ({ children }: PropsWithChildren<{}>) => {
@@ -66,24 +42,10 @@ const wrapper = ({ children }: PropsWithChildren<{}>) => {
};
describe('useEntityKinds', () => {
it('does not return duplicate kinds', async () => {
it('gets entity kinds', async () => {
const { result, waitForValueToChange } = renderHook(
() => useEntityKinds(),
{
wrapper,
},
);
await waitForValueToChange(() => result.current);
expect(result.current.kinds).toBeDefined();
expect(result.current.kinds!.length).toBe(3);
});
it('sorts entity kinds', async () => {
const { result, waitForValueToChange } = renderHook(
() => useEntityKinds(),
{
wrapper,
},
{ wrapper },
);
await waitForValueToChange(() => result.current);
expect(result.current.kinds).toEqual(['Component', 'System', 'Template']);
@@ -27,11 +27,9 @@ export function useEntityKinds() {
loading,
value: kinds,
} = useAsync(async () => {
const entities = await catalogApi
.getEntities({ fields: ['kind'] })
.then(response => response.items);
return [...new Set(entities.map(e => e.kind))].sort();
return await catalogApi
.getEntityFacets({ facets: ['kind'] })
.then(response => response.facets.kind?.map(f => f.value).sort() || []);
});
return { error, loading, kinds };
}
@@ -31,6 +31,7 @@ describe('<DefaultExplorePage />', () => {
getEntityByName: jest.fn(),
refreshEntity: jest.fn(),
getEntityAncestors: jest.fn(),
getEntityFacets: jest.fn(),
};
const Wrapper = ({ children }: { children?: React.ReactNode }) => (
@@ -32,6 +32,7 @@ describe('<DomainExplorerContent />', () => {
getEntityByName: jest.fn(),
refreshEntity: jest.fn(),
getEntityAncestors: jest.fn(),
getEntityFacets: jest.fn(),
};
const Wrapper = ({ children }: { children?: React.ReactNode }) => (
@@ -32,6 +32,7 @@ describe('<GroupsExplorerContent />', () => {
getEntityByName: jest.fn(),
refreshEntity: jest.fn(),
getEntityAncestors: jest.fn(),
getEntityFacets: jest.fn(),
};
const Wrapper = ({ children }: { children?: React.ReactNode }) => (
@@ -36,6 +36,7 @@ describe('<FossaPage />', () => {
removeLocationById: jest.fn(),
refreshEntity: jest.fn(),
getEntityAncestors: jest.fn(),
getEntityFacets: jest.fn(),
};
const fossaApi: jest.Mocked<FossaApi> = {
getFindingSummary: jest.fn(),
@@ -51,6 +51,7 @@ function mockCatalogClient(entity?: Entity): jest.Mocked<CatalogApi> {
removeEntityByUid: jest.fn(),
refreshEntity: jest.fn(),
getEntityAncestors: jest.fn(),
getEntityFacets: jest.fn(),
};
if (entity) {
mock.getEntityByName.mockReturnValue(entity);