paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 28 Packages Projects Releases Wiki Activity

Merge pull request #9560 from backstage/freben/location-by-ref

Browse Source 
Removed `CatalogApi.geLocationByEntity` and `CatalogApi.getOriginLocationByEntity`, and replaced them with `CatalogApi.getLocationByRef`.
This commit is contained in:
Fredrik Adelöw
2022-02-16 18:58:14 +01:00
committed by GitHub
parent d99c3c2177 a31cdf9c85
commit 69ad9e1e7b
30 changed files with 86 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/mean-cups-invite.md
+15
View File
@@ -0,0 +1,15 @@
---
'@backstage/plugin-api-docs': patch
'@backstage/plugin-auth-backend': patch
'@backstage/plugin-badges-backend': patch
'@backstage/plugin-catalog': patch
'@backstage/plugin-catalog-graph': patch
'@backstage/plugin-catalog-import': patch
'@backstage/plugin-catalog-react': patch
'@backstage/plugin-explore': patch
'@backstage/plugin-fossa': patch
'@backstage/plugin-scaffolder': patch
'@backstage/plugin-todo-backend': patch
---
Adapt to the new `CatalogApi.getLocationByRef`
.changeset/unlucky-dodos-scream.md
+14
View File
@@ -0,0 +1,14 @@
---
'@backstage/catalog-client': minor
---
Removed `CatalogApi.geLocationByEntity` and `CatalogApi.getOriginLocationByEntity`, and replaced them with `CatalogApi.getLocationByRef`.
If you were using one of the two old methods, you can update your code as follows:
```diff
-const originLocation = catalogApi.getOriginLocationByEntity(entity);
+const originLocation = catalogApi.getLocationByRef(entity.metadata.annotations[ANNOTATION_ORIGIN_LOCATION]!);
-const location = catalogApi.getLocationByEntity(entity);
+const location = catalogApi.getLocationByRef(entity.metadata.annotations[ANNOTATION_LOCATION]!);
```
packages/catalog-client/api-report.md
+8 -6
View File
@@ -43,16 +43,12 @@ export interface CatalogApi {
name: EntityName,
options?: CatalogRequestOptions,
): Promise<Entity | undefined>;
getLocationByEntity(
entity: Entity,
options?: CatalogRequestOptions,
): Promise<Location_2 | undefined>;
getLocationById(
id: string,
options?: CatalogRequestOptions,
): Promise<Location_2 | undefined>;
getOriginLocationByEntity(
entity: Entity,
getLocationByRef(
locationRef: string,
options?: CatalogRequestOptions,
): Promise<Location_2 | undefined>;
refreshEntity(
@@ -95,6 +91,7 @@ export class CatalogClient implements CatalogApi {
compoundName: EntityName,
options?: CatalogRequestOptions,
): Promise<Entity | undefined>;
// @deprecated (undocumented)
getLocationByEntity(
entity: Entity,
options?: CatalogRequestOptions,
@@ -103,6 +100,11 @@ export class CatalogClient implements CatalogApi {
id: string,
options?: CatalogRequestOptions,
): Promise<Location_2 | undefined>;
getLocationByRef(
locationRef: string,
options?: CatalogRequestOptions,
): Promise<Location_2 | undefined>;
// @deprecated (undocumented)
getOriginLocationByEntity(
entity: Entity,
options?: CatalogRequestOptions,
packages/catalog-client/src/CatalogClient.ts
+19 -2
View File
@@ -246,7 +246,7 @@ export class CatalogClient implements CatalogApi {
}
/**
* {@inheritdoc CatalogApi.getOriginLocationByEntity}
* @deprecated please use getLocationByRef instead
*/
async getOriginLocationByEntity(
entity: Entity,
@@ -268,7 +268,7 @@ export class CatalogClient implements CatalogApi {
}
/**
* {@inheritdoc CatalogApi.getLocationByEntity}
* @deprecated please use getLocationByRef instead
*/
async getLocationByEntity(
entity: Entity,
@@ -288,6 +288,23 @@ export class CatalogClient implements CatalogApi {
.find(l => locationCompound === stringifyLocationRef(l));
}
/**
* {@inheritdoc CatalogApi.getLocationByRef}
*/
async getLocationByRef(
locationRef: string,
options?: CatalogRequestOptions,
): Promise<Location | undefined> {
const all: { data: Location }[] = await this.requestRequired(
'GET',
'/locations',
options,
);
return all
.map(r => r.data)
.find(l => locationRef === stringifyLocationRef(l));
}
/**
* {@inheritdoc CatalogApi.removeLocationById}
*/
packages/catalog-client/src/types/api.ts
+4 -15
View File
@@ -262,24 +262,13 @@ export interface CatalogApi {
): Promise<Location | undefined>;
/**
* Gets origin location by Entity.
* Gets a registered location by its ref.
*
* @param entity - An {@link catalog-model#Entity}.
* @param locationRef - A location ref, e.g. "url:https://github.com/..."
* @param options - Additional options
*/
getOriginLocationByEntity(
entity: Entity,
options?: CatalogRequestOptions,
): Promise<Location | undefined>;
/**
* Gets Location by Entity.
*
* @param entity - An {@link catalog-model#Entity}.
* @param options - Additional options
*/
getLocationByEntity(
entity: Entity,
getLocationByRef(
locationRef: string,
options?: CatalogRequestOptions,
): Promise<Location | undefined>;
plugins/api-docs/src/components/ApiExplorerPage/DefaultApiExplorerPage.test.tsx
+1 -1
View File
@@ -56,7 +56,7 @@ describe('DefaultApiExplorerPage', () => {
},
] as Entity[],
}),
getLocationByEntity: () =>
getLocationByRef: () =>
Promise.resolve({ id: 'id', type: 'github', target: 'url' }),
getEntityByName: async entityName => {
return {
plugins/api-docs/src/components/ApisCards/ConsumedApisCard.test.tsx
+1 -1
View File
@@ -36,7 +36,7 @@ describe('<ConsumedApisCard />', () => {
getEntityByName: jest.fn(),
getEntities: jest.fn(),
addLocation: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
removeEntityByUid: jest.fn(),
} as any;
let Wrapper: React.ComponentType;
plugins/api-docs/src/components/ApisCards/HasApisCard.test.tsx
+1 -1
View File
@@ -36,7 +36,7 @@ describe('<HasApisCard />', () => {
getEntityByName: jest.fn(),
getEntities: jest.fn(),
addLocation: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
removeEntityByUid: jest.fn(),
} as any;
let Wrapper: React.ComponentType;
plugins/api-docs/src/components/ApisCards/ProvidedApisCard.test.tsx
+1 -1
View File
@@ -36,7 +36,7 @@ describe('<ProvidedApisCard />', () => {
getEntityByName: jest.fn(),
getEntities: jest.fn(),
addLocation: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
removeEntityByUid: jest.fn(),
} as any;
let Wrapper: React.ComponentType;
plugins/api-docs/src/components/ComponentsCards/ConsumingComponentsCard.test.tsx
+1 -1
View File
@@ -32,7 +32,7 @@ describe('<ConsumingComponentsCard />', () => {
getEntityByName: jest.fn(),
getEntities: jest.fn(),
addLocation: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
removeEntityByUid: jest.fn(),
} as any;
let Wrapper: React.ComponentType;
plugins/api-docs/src/components/ComponentsCards/ProvidingComponentsCard.test.tsx
+1 -1
View File
@@ -32,7 +32,7 @@ describe('<ProvidingComponentsCard />', () => {
getEntityByName: jest.fn(),
getEntities: jest.fn(),
addLocation: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
removeEntityByUid: jest.fn(),
} as any;
let Wrapper: React.ComponentType;
plugins/auth-backend/src/lib/catalog/CatalogIdentityClient.test.ts
+1 -2
View File
@@ -30,8 +30,7 @@ describe('CatalogIdentityClient', () => {
getEntities: jest.fn(),
addLocation: jest.fn(),
removeLocationById: jest.fn(),
getOriginLocationByEntity: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
removeEntityByUid: jest.fn(),
refreshEntity: jest.fn(),
getEntityAncestors: jest.fn(),
plugins/badges-backend/src/service/router.test.ts
+1 -2
View File
@@ -61,8 +61,7 @@ describe('createRouter', () => {
addLocation: jest.fn(),
getEntities: jest.fn(),
getEntityByName: jest.fn(),
getOriginLocationByEntity: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
getLocationById: jest.fn(),
removeLocationById: jest.fn(),
removeEntityByUid: jest.fn(),
plugins/catalog-graph/src/components/CatalogGraphCard/CatalogGraphCard.test.tsx
+1 -2
View File
@@ -60,8 +60,7 @@ describe('<CatalogGraphCard/>', () => {
getEntityByName: jest.fn(async _ => ({ ...entity, relations: [] })),
removeEntityByUid: jest.fn(),
getLocationById: jest.fn(),
getOriginLocationByEntity: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
addLocation: jest.fn(),
removeLocationById: jest.fn(),
refreshEntity: jest.fn(),
plugins/catalog-graph/src/components/CatalogGraphPage/CatalogGraphPage.test.tsx
+1 -2
View File
@@ -89,8 +89,7 @@ describe('<CatalogGraphPage/>', () => {
getEntityByName: jest.fn(async n => (n.name === 'e' ? entityE : entityC)),
removeEntityByUid: jest.fn(),
getLocationById: jest.fn(),
getOriginLocationByEntity: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
addLocation: jest.fn(),
removeLocationById: jest.fn(),
refreshEntity: jest.fn(),
plugins/catalog-graph/src/components/EntityRelationsGraph/EntityRelationsGraph.test.tsx
+1 -2
View File
@@ -150,8 +150,7 @@ describe('<EntityRelationsGraph/>', () => {
getEntityByName: jest.fn(async n => entities[stringifyEntityRef(n)]),
removeEntityByUid: jest.fn(),
getLocationById: jest.fn(),
getOriginLocationByEntity: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
addLocation: jest.fn(),
removeLocationById: jest.fn(),
refreshEntity: jest.fn(),
plugins/catalog-graph/src/components/EntityRelationsGraph/useEntityStore.test.ts
+1 -2
View File
@@ -32,8 +32,7 @@ describe('useEntityStore', () => {
getEntityByName: jest.fn(),
removeEntityByUid: jest.fn(),
getLocationById: jest.fn(),
getOriginLocationByEntity: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
addLocation: jest.fn(),
removeLocationById: jest.fn(),
refreshEntity: jest.fn(),
plugins/catalog-import/src/api/CatalogImportClient.test.ts
+1 -2
View File
@@ -94,8 +94,7 @@ describe('CatalogImportClient', () => {
addLocation: jest.fn(),
removeLocationById: jest.fn(),
getEntityByName: jest.fn(),
getOriginLocationByEntity: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
getLocationById: jest.fn(),
removeEntityByUid: jest.fn(),
refreshEntity: jest.fn(),
plugins/catalog-import/src/components/StepPrepareCreatePullRequest/StepPrepareCreatePullRequest.test.tsx
+1 -2
View File
@@ -39,8 +39,7 @@ describe('<StepPrepareCreatePullRequest />', () => {
getEntities: jest.fn(),
addLocation: jest.fn(),
getEntityByName: jest.fn(),
getOriginLocationByEntity: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
getLocationById: jest.fn(),
removeLocationById: jest.fn(),
removeEntityByUid: jest.fn(),
plugins/catalog-react/src/components/UnregisterEntityDialog/useUnregisterEntityDialogState.test.tsx
+2 -4
View File
@@ -39,7 +39,7 @@ function defer<T>(): { promise: Promise<T>; resolve: (value: T) => void } {
describe('useUnregisterEntityDialogState', () => {
const catalogApiMock = {
getOriginLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
getEntities: jest.fn(),
removeLocationById: jest.fn(),
removeEntityByUid: jest.fn(),
@@ -65,9 +65,7 @@ describe('useUnregisterEntityDialogState', () => {
resolveLocation = deferredLocation.resolve;
resolveColocatedEntities = deferredColocatedEntities.resolve;
catalogApiMock.getOriginLocationByEntity.mockReturnValue(
deferredLocation.promise,
);
catalogApiMock.getLocationByRef.mockReturnValue(deferredLocation.promise);
catalogApiMock.getEntities.mockReturnValue(
deferredColocatedEntities.promise.then(items => ({ items })),
);
plugins/catalog-react/src/components/UnregisterEntityDialog/useUnregisterEntityDialogState.ts
+1 -1
View File
@@ -67,7 +67,7 @@ export function useUnregisterEntityDialogState(
// Load the prerequisite data: what entities that are colocated with us, and
// what location that spawned us
const prerequisites = useAsync(async () => {
const locationPromise = catalogApi.getOriginLocationByEntity(entity);
const locationPromise = catalogApi.getLocationByRef(locationRef!);
let colocatedEntitiesPromise: Promise<Entity[]>;
if (!locationRef) {
plugins/catalog/src/components/AboutCard/AboutCard.test.tsx
+1 -1
View File
@@ -38,7 +38,7 @@ describe('<AboutCard />', () => {
getEntityByName: jest.fn(),
getEntities: jest.fn(),
addLocation: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
removeEntityByUid: jest.fn(),
refreshEntity: jest.fn(),
} as any;
plugins/catalog/src/components/CatalogPage/DefaultCatalogPage.test.tsx
+1 -1
View File
@@ -100,7 +100,7 @@ describe('DefaultCatalogPage', () => {
},
] as Entity[],
}),
getLocationByEntity: () =>
getLocationByRef: () =>
Promise.resolve({ id: 'id', type: 'github', target: 'url' }),
getEntityByName: async entityName => {
return {
plugins/explore/src/components/DefaultExplorePage/DefaultExplorePage.test.tsx
+1 -2
View File
@@ -24,8 +24,7 @@ describe('<DefaultExplorePage />', () => {
const catalogApi: jest.Mocked<typeof catalogApiRef.T> = {
addLocation: jest.fn(_a => new Promise(() => {})),
getEntities: jest.fn(),
getOriginLocationByEntity: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
getLocationById: jest.fn(),
removeLocationById: jest.fn(),
removeEntityByUid: jest.fn(),
plugins/explore/src/components/DomainExplorerContent/DomainExplorerContent.test.tsx
+1 -2
View File
@@ -25,8 +25,7 @@ describe('<DomainExplorerContent />', () => {
const catalogApi: jest.Mocked<typeof catalogApiRef.T> = {
addLocation: jest.fn(_a => new Promise(() => {})),
getEntities: jest.fn(),
getOriginLocationByEntity: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
getLocationById: jest.fn(),
removeLocationById: jest.fn(),
removeEntityByUid: jest.fn(),
plugins/explore/src/components/GroupsExplorerContent/GroupsExplorerContent.test.tsx
+1 -2
View File
@@ -25,8 +25,7 @@ describe('<GroupsExplorerContent />', () => {
const catalogApi: jest.Mocked<typeof catalogApiRef.T> = {
addLocation: jest.fn(_a => new Promise(() => {})),
getEntities: jest.fn(),
getOriginLocationByEntity: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
getLocationById: jest.fn(),
removeLocationById: jest.fn(),
removeEntityByUid: jest.fn(),
plugins/fossa/src/components/FossaPage/FossaPage.test.tsx
+1 -2
View File
@@ -30,9 +30,8 @@ describe('<FossaPage />', () => {
addLocation: jest.fn(),
getEntities: jest.fn(),
getEntityByName: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
getLocationById: jest.fn(),
getOriginLocationByEntity: jest.fn(),
removeEntityByUid: jest.fn(),
removeLocationById: jest.fn(),
refreshEntity: jest.fn(),
plugins/scaffolder/src/components/fields/EntityPicker/EntityPicker.test.tsx
+1 -1
View File
@@ -46,7 +46,7 @@ describe('<EntityPicker />', () => {
getEntityByName: jest.fn(),
getEntities: jest.fn(async () => ({ items: entities })),
addLocation: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
removeEntityByUid: jest.fn(),
} as any;
let Wrapper: React.ComponentType;
plugins/scaffolder/src/components/fields/OwnerPicker/OwnerPicker.test.tsx
+1 -1
View File
@@ -43,7 +43,7 @@ describe('<OwnerPicker />', () => {
getEntityByName: jest.fn(),
getEntities: jest.fn(async () => ({ items: entities })),
addLocation: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
removeEntityByUid: jest.fn(),
} as any;
let Wrapper: React.ComponentType;
plugins/todo-backend/src/service/TodoReaderService.test.ts
+1 -2
View File
@@ -45,8 +45,7 @@ function mockCatalogClient(entity?: Entity): jest.Mocked<CatalogApi> {
addLocation: jest.fn(),
getEntities: jest.fn(),
getEntityByName: jest.fn(),
getOriginLocationByEntity: jest.fn(),
getLocationByEntity: jest.fn(),
getLocationByRef: jest.fn(),
getLocationById: jest.fn(),
removeLocationById: jest.fn(),
removeEntityByUid: jest.fn(),