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

feat(plugins/pagerduty): refactor PagerDutyClient.getServiceByEntity

Browse Source 
* provide raw backstage entity

Signed-off-by: Alec Jacobs <cajacobs5401@gmail.com>
This commit is contained in:
Alec Jacobs
2022-06-17 14:39:46 -07:00
parent fb9b81780a
commit a9b6b729c4
4 changed files with 82 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/pagerduty/src/api/client.test.ts
+70 -53
View File
@@ -16,9 +16,9 @@
import { MockFetchApi } from '@backstage/test-utils';
import { DiscoveryApi } from '@backstage/core-plugin-api';
import { PagerDutyClient, UnauthorizedError } from './client';
import { PagerDutyEntity } from '../types';
import { PagerDutyService, PagerDutyUser } from '../components/types';
import { NotFoundError } from '@backstage/errors';
import { Entity } from '@backstage/catalog-model';
const mockFetch = jest.fn().mockName('fetch');
const mockDiscoveryApi: jest.Mocked<DiscoveryApi> = {
@@ -32,7 +32,7 @@ const mockFetchApi: MockFetchApi = new MockFetchApi({
});
let client: PagerDutyClient;
let pagerDutyEntity: PagerDutyEntity;
let entity: Entity;
const user: PagerDutyUser = {
name: 'person1',
@@ -76,9 +76,15 @@ describe('PagerDutyClient', () => {
describe('getServiceByEntity', () => {
describe('when provided entity has an integrationKey value', () => {
beforeEach(() => {
pagerDutyEntity = {
name: 'pagerduty-test',
integrationKey: 'abc123',
entity = {
apiVersion: 'backstage.io/v1alpha1',
kind: 'Component',
metadata: {
name: 'pagerduty-test',
annotations: {
'pagerduty.com/integration-key': 'abc123',
},
},
};
});
@@ -89,7 +95,7 @@ describe('PagerDutyClient', () => {
json: () => Promise.resolve({ services: [service] }),
});
expect(await client.getServiceByEntity(pagerDutyEntity)).toEqual({
expect(await client.getServiceByEntity(entity)).toEqual({
service,
});
expect(mockFetch).toHaveBeenCalledWith(
@@ -108,9 +114,9 @@ describe('PagerDutyClient', () => {
});
it('throws UnauthorizedError', async () => {
await expect(
client.getServiceByEntity(pagerDutyEntity),
).rejects.toThrowError(UnauthorizedError);
await expect(client.getServiceByEntity(entity)).rejects.toThrowError(
UnauthorizedError,
);
});
});
@@ -124,9 +130,9 @@ describe('PagerDutyClient', () => {
});
it('throws NotFoundError', async () => {
await expect(
client.getServiceByEntity(pagerDutyEntity),
).rejects.toThrowError(NotFoundError);
await expect(client.getServiceByEntity(entity)).rejects.toThrowError(
NotFoundError,
);
});
});
@@ -143,9 +149,7 @@ describe('PagerDutyClient', () => {
});
it('throws NotFoundError', async () => {
await expect(
client.getServiceByEntity(pagerDutyEntity),
).rejects.toThrowError(
await expect(client.getServiceByEntity(entity)).rejects.toThrowError(
'Request failed with 500, Not valid request internal error occurred',
);
});
@@ -161,18 +165,24 @@ describe('PagerDutyClient', () => {
});
it('throws NotFoundError', async () => {
await expect(
client.getServiceByEntity(pagerDutyEntity),
).rejects.toThrowError(NotFoundError);
await expect(client.getServiceByEntity(entity)).rejects.toThrowError(
NotFoundError,
);
});
});
});
describe('when provided entity has a serviceId value', () => {
beforeEach(() => {
pagerDutyEntity = {
name: 'pagerduty-test',
serviceId: 'def456',
entity = {
apiVersion: 'backstage.io/v1alpha1',
kind: 'Component',
metadata: {
name: 'pagerduty-test',
annotations: {
'pagerduty.com/service-id': 'def456',
},
},
};
});
@@ -183,7 +193,7 @@ describe('PagerDutyClient', () => {
json: () => Promise.resolve({ service }),
});
expect(await client.getServiceByEntity(pagerDutyEntity)).toEqual({
expect(await client.getServiceByEntity(entity)).toEqual({
service,
});
expect(mockFetch).toHaveBeenCalledWith(
@@ -202,9 +212,9 @@ describe('PagerDutyClient', () => {
});
it('throws UnauthorizedError', async () => {
await expect(
client.getServiceByEntity(pagerDutyEntity),
).rejects.toThrowError(UnauthorizedError);
await expect(client.getServiceByEntity(entity)).rejects.toThrowError(
UnauthorizedError,
);
});
});
@@ -218,9 +228,9 @@ describe('PagerDutyClient', () => {
});
it('throws NotFoundError', async () => {
await expect(
client.getServiceByEntity(pagerDutyEntity),
).rejects.toThrowError(NotFoundError);
await expect(client.getServiceByEntity(entity)).rejects.toThrowError(
NotFoundError,
);
});
});
@@ -237,9 +247,7 @@ describe('PagerDutyClient', () => {
});
it('throws NotFoundError', async () => {
await expect(
client.getServiceByEntity(pagerDutyEntity),
).rejects.toThrowError(
await expect(client.getServiceByEntity(entity)).rejects.toThrowError(
'Request failed with 500, Not valid request internal error occurred',
);
});
@@ -248,10 +256,16 @@ describe('PagerDutyClient', () => {
describe('when provided entity has both integrationKey and serviceId', () => {
beforeEach(() => {
pagerDutyEntity = {
name: 'pagerduty-test',
integrationKey: 'abc123',
serviceId: 'def456',
entity = {
apiVersion: 'backstage.io/v1alpha1',
kind: 'Component',
metadata: {
name: 'pagerduty-test',
annotations: {
'pagerduty.com/integration-key': 'abc123',
'pagerduty.com/service-id': 'def456',
},
},
};
});
@@ -262,7 +276,7 @@ describe('PagerDutyClient', () => {
json: () => Promise.resolve({ services: [service] }),
});
expect(await client.getServiceByEntity(pagerDutyEntity)).toEqual({
expect(await client.getServiceByEntity(entity)).toEqual({
service,
});
expect(mockFetch).toHaveBeenCalledWith(
@@ -281,9 +295,9 @@ describe('PagerDutyClient', () => {
});
it('throws UnauthorizedError', async () => {
await expect(
client.getServiceByEntity(pagerDutyEntity),
).rejects.toThrowError(UnauthorizedError);
await expect(client.getServiceByEntity(entity)).rejects.toThrowError(
UnauthorizedError,
);
});
});
@@ -297,9 +311,9 @@ describe('PagerDutyClient', () => {
});
it('throws NotFoundError', async () => {
await expect(
client.getServiceByEntity(pagerDutyEntity),
).rejects.toThrowError(NotFoundError);
await expect(client.getServiceByEntity(entity)).rejects.toThrowError(
NotFoundError,
);
});
});
@@ -316,9 +330,7 @@ describe('PagerDutyClient', () => {
});
it('throws NotFoundError', async () => {
await expect(
client.getServiceByEntity(pagerDutyEntity),
).rejects.toThrowError(
await expect(client.getServiceByEntity(entity)).rejects.toThrowError(
'Request failed with 500, Not valid request internal error occurred',
);
});
@@ -334,24 +346,29 @@ describe('PagerDutyClient', () => {
});
it('throws NotFoundError', async () => {
await expect(
client.getServiceByEntity(pagerDutyEntity),
).rejects.toThrowError(NotFoundError);
await expect(client.getServiceByEntity(entity)).rejects.toThrowError(
NotFoundError,
);
});
});
});
describe('when provided entity has no integrationKey or serviceId values', () => {
beforeEach(() => {
pagerDutyEntity = {
name: 'pagerduty-test',
entity = {
apiVersion: 'backstage.io/v1alpha1',
kind: 'Component',
metadata: {
name: 'pagerduty-test',
annotations: {},
},
};
});
it('throws NotFoundError', async () => {
await expect(
client.getServiceByEntity(pagerDutyEntity),
).rejects.toThrowError(NotFoundError);
await expect(client.getServiceByEntity(entity)).rejects.toThrowError(
NotFoundError,
);
expect(mockFetch).not.toHaveBeenCalled();
});
});
plugins/pagerduty/src/api/client.ts
+4 -5
View File
@@ -28,7 +28,8 @@ import {
} from './types';
import { createApiRef, ConfigApi } from '@backstage/core-plugin-api';
import { NotFoundError } from '@backstage/errors';
import { PagerDutyEntity } from '../types';
import { Entity } from '@backstage/catalog-model';
import { getPagerDutyEntity } from '../components/pagerDutyEntity';
export class UnauthorizedError extends Error {}
@@ -56,10 +57,8 @@ export class PagerDutyClient implements PagerDutyApi {
}
constructor(private readonly config: PagerDutyClientApiConfig) {}
async getServiceByEntity(
pagerDutyEntity: PagerDutyEntity,
): Promise<PagerDutyServiceResponse> {
const { integrationKey, serviceId } = pagerDutyEntity;
async getServiceByEntity(entity: Entity): Promise<PagerDutyServiceResponse> {
const { integrationKey, serviceId } = getPagerDutyEntity(entity);
let response: PagerDutyServiceResponse;
let url: string;
plugins/pagerduty/src/api/types.ts
+3 -5
View File
@@ -21,7 +21,7 @@ import {
PagerDutyService,
} from '../components/types';
import { DiscoveryApi, FetchApi } from '@backstage/core-plugin-api';
import { PagerDutyEntity } from '../types';
import { Entity } from '@backstage/catalog-model';
export type PagerDutyServicesResponse = {
services: PagerDutyService[];
@@ -52,12 +52,10 @@ export type PagerDutyTriggerAlarmRequest = {
export interface PagerDutyApi {
/**
* Fetches the service for the provided PagerDutyEntity.
* Fetches the service for the provided Entity.
*
*/
getServiceByEntity(
pagerDutyEntity: PagerDutyEntity,
): Promise<PagerDutyServiceResponse>;
getServiceByEntity(entity: Entity): Promise<PagerDutyServiceResponse>;
/**
* Fetches a list of incidents a provided service has.
plugins/pagerduty/src/components/PagerDutyCard/index.tsx
+5 -5
View File
@@ -25,7 +25,6 @@ import AlarmAddIcon from '@material-ui/icons/AlarmAdd';
import { MissingTokenError, ServiceNotFoundError } from '../Errors';
import WebIcon from '@material-ui/icons/Web';
import DateRangeIcon from '@material-ui/icons/DateRange';
import { usePagerdutyEntity } from '../../hooks';
import { PAGERDUTY_INTEGRATION_KEY, PAGERDUTY_SERVICE_ID } from '../constants';
import { TriggerDialog } from '../TriggerDialog';
import { ChangeEvents } from '../ChangeEvents';
@@ -40,6 +39,8 @@ import {
CardTab,
InfoCard,
} from '@backstage/core-components';
import { useEntity } from '@backstage/plugin-catalog-react';
import { getPagerDutyEntity } from '../pagerDutyEntity';
const BasicCard = ({ children }: { children: ReactNode }) => (
<InfoCard title="PagerDuty">{children}</InfoCard>
@@ -52,7 +53,8 @@ export const isPluginApplicableToEntity = (entity: Entity) =>
);
export const PagerDutyCard = () => {
const pagerDutyEntity = usePagerdutyEntity();
const { entity } = useEntity();
const pagerDutyEntity = getPagerDutyEntity(entity);
const api = useApi(pagerDutyApiRef);
const [refreshIncidents, setRefreshIncidents] = useState<boolean>(false);
const [refreshChangeEvents, setRefreshChangeEvents] =
@@ -76,9 +78,7 @@ export const PagerDutyCard = () => {
loading,
error,
} = useAsync(async () => {
const { service: foundService } = await api.getServiceByEntity(
pagerDutyEntity,
);
const { service: foundService } = await api.getServiceByEntity(entity);
return {
id: foundService.id,