From 04a53de52fdd9424d35bd398904ff21989853153 Mon Sep 17 00:00:00 2001 From: Samira Mokaram Date: Tue, 1 Dec 2020 13:46:46 +0100 Subject: [PATCH] rename type and class, fix test --- plugins/pagerduty/README.md | 2 +- plugins/pagerduty/src/api/client.ts | 6 +++--- plugins/pagerduty/src/api/index.ts | 8 ++------ plugins/pagerduty/src/api/types.ts | 2 +- .../src/components/Incident/Incidents.test.tsx | 18 +++--------------- .../src/components/PagerDutyCard.test.tsx | 2 +- plugins/pagerduty/src/index.ts | 4 ++-- plugins/pagerduty/src/plugin.ts | 4 ++-- 8 files changed, 15 insertions(+), 31 deletions(-) diff --git a/plugins/pagerduty/README.md b/plugins/pagerduty/README.md index 7a886627e3..b925e9d7a7 100644 --- a/plugins/pagerduty/README.md +++ b/plugins/pagerduty/README.md @@ -56,7 +56,7 @@ createApiFactory({ api: pagerDutyApiRef, deps: { discoveryApi: discoveryApiRef }, factory: ({ discoveryApi }) => - new PagerDutyClientApi({ + new PagerDutyClient({ discoveryApi: discoveryApi, eventUrl: "https://events.pagerduty.com/v2" //to override the default value }), diff --git a/plugins/pagerduty/src/api/client.ts b/plugins/pagerduty/src/api/client.ts index ab65514466..214e7d57a7 100644 --- a/plugins/pagerduty/src/api/client.ts +++ b/plugins/pagerduty/src/api/client.ts @@ -17,7 +17,7 @@ import { createApiRef } from '@backstage/core'; import { Service, Incident, OnCall } from '../components/types'; import { - PagerDutyClient, + PagerDutyApi, TriggerAlarmRequest, ServicesResponse, IncidentsResponse, @@ -28,12 +28,12 @@ import { export class UnauthorizedError extends Error {} -export const pagerDutyApiRef = createApiRef({ +export const pagerDutyApiRef = createApiRef({ id: 'plugin.pagerduty.api', description: 'Used to fetch data from PagerDuty API', }); -export class PagerDutyClientApi implements PagerDutyClient { +export class PagerDutyClient implements PagerDutyApi { constructor(private readonly config: ClientApiConfig) {} async getServiceByIntegrationKey(integrationKey: string): Promise { diff --git a/plugins/pagerduty/src/api/index.ts b/plugins/pagerduty/src/api/index.ts index 5ac7470475..90604c4012 100644 --- a/plugins/pagerduty/src/api/index.ts +++ b/plugins/pagerduty/src/api/index.ts @@ -14,9 +14,5 @@ * limitations under the License. */ -export { - PagerDutyClientApi, - pagerDutyApiRef, - UnauthorizedError, -} from './client'; -export type { PagerDutyClient } from './types'; +export { PagerDutyClient, pagerDutyApiRef, UnauthorizedError } from './client'; +export type { PagerDutyApi } from './types'; diff --git a/plugins/pagerduty/src/api/types.ts b/plugins/pagerduty/src/api/types.ts index 2231cc6991..4b3ae74cc1 100644 --- a/plugins/pagerduty/src/api/types.ts +++ b/plugins/pagerduty/src/api/types.ts @@ -24,7 +24,7 @@ export type TriggerAlarmRequest = { userName: string; }; -export interface PagerDutyClient { +export interface PagerDutyApi { /** * Fetches a list of services, filtered by the provided integration key. * diff --git a/plugins/pagerduty/src/components/Incident/Incidents.test.tsx b/plugins/pagerduty/src/components/Incident/Incidents.test.tsx index 3eef24cc6a..3c5e30e0cc 100644 --- a/plugins/pagerduty/src/components/Incident/Incidents.test.tsx +++ b/plugins/pagerduty/src/components/Incident/Incidents.test.tsx @@ -35,11 +35,7 @@ describe('Incidents', () => { const { getByText, queryByTestId } = render( wrapInTestApp( - {}} - /> + , ), ); @@ -99,11 +95,7 @@ describe('Incidents', () => { } = render( wrapInTestApp( - {}} - /> + , ), ); @@ -129,11 +121,7 @@ describe('Incidents', () => { const { getByText, queryByTestId } = render( wrapInTestApp( - {}} - /> + , ), ); diff --git a/plugins/pagerduty/src/components/PagerDutyCard.test.tsx b/plugins/pagerduty/src/components/PagerDutyCard.test.tsx index bca6f9f940..26d67a55e4 100644 --- a/plugins/pagerduty/src/components/PagerDutyCard.test.tsx +++ b/plugins/pagerduty/src/components/PagerDutyCard.test.tsx @@ -15,7 +15,7 @@ */ import React from 'react'; import { render, waitFor, fireEvent } from '@testing-library/react'; -import { PagerDutyCard } from './PagerdutyCard'; +import { PagerDutyCard } from './PagerDutyCard'; import { Entity } from '@backstage/catalog-model'; import { wrapInTestApp } from '@backstage/test-utils'; import { diff --git a/plugins/pagerduty/src/index.ts b/plugins/pagerduty/src/index.ts index 1e8e549ac9..4ecd4edcc6 100644 --- a/plugins/pagerduty/src/index.ts +++ b/plugins/pagerduty/src/index.ts @@ -17,9 +17,9 @@ export { plugin } from './plugin'; export { isPluginApplicableToEntity, PagerDutyCard, -} from './components/PagerdutyCard'; +} from './components/PagerDutyCard'; export { - PagerDutyClientApi, + PagerDutyClient, pagerDutyApiRef, UnauthorizedError, } from './api/client'; diff --git a/plugins/pagerduty/src/plugin.ts b/plugins/pagerduty/src/plugin.ts index 02b11ed773..4e8f429b05 100644 --- a/plugins/pagerduty/src/plugin.ts +++ b/plugins/pagerduty/src/plugin.ts @@ -19,7 +19,7 @@ import { createRouteRef, discoveryApiRef, } from '@backstage/core'; -import { pagerDutyApiRef, PagerDutyClientApi } from './api'; +import { pagerDutyApiRef, PagerDutyClient } from './api'; export const rootRouteRef = createRouteRef({ path: '/pagerduty', @@ -33,7 +33,7 @@ export const plugin = createPlugin({ api: pagerDutyApiRef, deps: { discoveryApi: discoveryApiRef }, factory: ({ discoveryApi }) => - new PagerDutyClientApi({ + new PagerDutyClient({ discoveryApi: discoveryApi, }), }),