Updated to use fetchApi as per ADR013

Signed-off-by: Andre Wanlin <awanlin@spotify.com>
This commit is contained in:
Andre Wanlin
2024-02-18 08:56:32 -06:00
parent 25adbdde2d
commit a0e33935a9
11 changed files with 84 additions and 24 deletions
+7
View File
@@ -0,0 +1,7 @@
---
'@backstage/plugin-azure-devops': patch
'@backstage/plugin-devtools': patch
'@backstage/plugin-linguist': patch
---
Updated to use `fetchApi` as per [ADR013](https://backstage.io/docs/architecture-decisions/adrs-adr013)
+2
View File
@@ -12,6 +12,7 @@ import { BuildRunOptions } from '@backstage/plugin-azure-devops-common';
import { DashboardPullRequest } from '@backstage/plugin-azure-devops-common';
import { DiscoveryApi } from '@backstage/core-plugin-api';
import { Entity } from '@backstage/catalog-model';
import { FetchApi } from '@backstage/core-plugin-api';
import { GitTag } from '@backstage/plugin-azure-devops-common';
import { IdentityApi } from '@backstage/core-plugin-api';
import { JSX as JSX_2 } from 'react';
@@ -124,6 +125,7 @@ export class AzureDevOpsClient implements AzureDevOpsApi {
constructor(options: {
discoveryApi: DiscoveryApi;
identityApi: IdentityApi;
fetchApi: FetchApi;
});
// (undocumented)
getAllTeams(): Promise<Team[]>;
+8 -3
View File
@@ -21,6 +21,7 @@ import {
createPageExtension,
createPlugin,
discoveryApiRef,
fetchApiRef,
identityApiRef,
} from '@backstage/frontend-plugin-api';
import { azureDevOpsApiRef, AzureDevOpsClient } from '../api';
@@ -38,9 +39,13 @@ import { azurePullRequestDashboardRouteRef } from '../routes';
export const azureDevOpsApi = createApiExtension({
factory: createApiFactory({
api: azureDevOpsApiRef,
deps: { discoveryApi: discoveryApiRef, identityApi: identityApiRef },
factory: ({ discoveryApi, identityApi }) =>
new AzureDevOpsClient({ discoveryApi, identityApi }),
deps: {
discoveryApi: discoveryApiRef,
identityApi: identityApiRef,
fetchApi: fetchApiRef,
},
factory: ({ discoveryApi, identityApi, fetchApi }) =>
new AzureDevOpsClient({ discoveryApi, identityApi, fetchApi }),
}),
});
@@ -27,7 +27,11 @@ import {
RepoBuildOptions,
Team,
} from '@backstage/plugin-azure-devops-common';
import { DiscoveryApi, IdentityApi } from '@backstage/core-plugin-api';
import {
DiscoveryApi,
FetchApi,
IdentityApi,
} from '@backstage/core-plugin-api';
import { ResponseError } from '@backstage/errors';
import { AzureDevOpsApi } from './AzureDevOpsApi';
@@ -35,13 +39,16 @@ import { AzureDevOpsApi } from './AzureDevOpsApi';
export class AzureDevOpsClient implements AzureDevOpsApi {
private readonly discoveryApi: DiscoveryApi;
private readonly identityApi: IdentityApi;
private readonly fetchApi: FetchApi;
public constructor(options: {
discoveryApi: DiscoveryApi;
identityApi: IdentityApi;
fetchApi: FetchApi;
}) {
this.discoveryApi = options.discoveryApi;
this.identityApi = options.identityApi;
this.fetchApi = options.fetchApi;
}
public async getRepoBuilds(
@@ -201,7 +208,7 @@ export class AzureDevOpsClient implements AzureDevOpsApi {
const url = new URL(path, baseUrl);
const { token: idToken } = await this.identityApi.getCredentials();
const response = await fetch(url.toString(), {
const response = await this.fetchApi.fetch(url.toString(), {
headers: idToken ? { Authorization: `Bearer ${idToken}` } : {},
});
+8 -3
View File
@@ -27,6 +27,7 @@ import {
createComponentExtension,
discoveryApiRef,
identityApiRef,
fetchApiRef,
} from '@backstage/core-plugin-api';
import { AzureDevOpsClient } from './api/AzureDevOpsClient';
@@ -56,9 +57,13 @@ export const azureDevOpsPlugin = createPlugin({
apis: [
createApiFactory({
api: azureDevOpsApiRef,
deps: { discoveryApi: discoveryApiRef, identityApi: identityApiRef },
factory: ({ discoveryApi, identityApi }) =>
new AzureDevOpsClient({ discoveryApi, identityApi }),
deps: {
discoveryApi: discoveryApiRef,
identityApi: identityApiRef,
fetchApi: fetchApiRef,
},
factory: ({ discoveryApi, identityApi, fetchApi }) =>
new AzureDevOpsClient({ discoveryApi, identityApi, fetchApi }),
}),
],
});
+8 -3
View File
@@ -22,6 +22,7 @@ import {
createPageExtension,
createPlugin,
discoveryApiRef,
fetchApiRef,
identityApiRef,
} from '@backstage/frontend-plugin-api';
@@ -37,9 +38,13 @@ import { rootRouteRef } from '../routes';
export const devToolsApi = createApiExtension({
factory: createApiFactory({
api: devToolsApiRef,
deps: { discoveryApi: discoveryApiRef, identityApi: identityApiRef },
factory: ({ discoveryApi, identityApi }) =>
new DevToolsClient({ discoveryApi, identityApi }),
deps: {
discoveryApi: discoveryApiRef,
identityApi: identityApiRef,
fetchApi: fetchApiRef,
},
factory: ({ discoveryApi, identityApi, fetchApi }) =>
new DevToolsClient({ discoveryApi, identityApi, fetchApi }),
}),
});
+9 -2
View File
@@ -14,7 +14,11 @@
* limitations under the License.
*/
import { DiscoveryApi, IdentityApi } from '@backstage/core-plugin-api';
import {
DiscoveryApi,
FetchApi,
IdentityApi,
} from '@backstage/core-plugin-api';
import {
ConfigInfo,
DevToolsInfo,
@@ -26,13 +30,16 @@ import { DevToolsApi } from './DevToolsApi';
export class DevToolsClient implements DevToolsApi {
private readonly discoveryApi: DiscoveryApi;
private readonly identityApi: IdentityApi;
private readonly fetchApi: FetchApi;
public constructor(options: {
discoveryApi: DiscoveryApi;
identityApi: IdentityApi;
fetchApi: FetchApi;
}) {
this.discoveryApi = options.discoveryApi;
this.identityApi = options.identityApi;
this.fetchApi = options.fetchApi;
}
public async getConfig(): Promise<ConfigInfo | undefined> {
@@ -65,7 +72,7 @@ export class DevToolsClient implements DevToolsApi {
const url = new URL(path, baseUrl);
const { token } = await this.identityApi.getCredentials();
const response = await fetch(url.toString(), {
const response = await this.fetchApi.fetch(url.toString(), {
headers: token ? { Authorization: `Bearer ${token}` } : {},
});
+8 -3
View File
@@ -19,6 +19,7 @@ import {
createPlugin,
createRoutableExtension,
discoveryApiRef,
fetchApiRef,
identityApiRef,
} from '@backstage/core-plugin-api';
import { devToolsApiRef, DevToolsClient } from './api';
@@ -31,9 +32,13 @@ export const devToolsPlugin = createPlugin({
apis: [
createApiFactory({
api: devToolsApiRef,
deps: { discoveryApi: discoveryApiRef, identityApi: identityApiRef },
factory: ({ discoveryApi, identityApi }) =>
new DevToolsClient({ discoveryApi, identityApi }),
deps: {
discoveryApi: discoveryApiRef,
identityApi: identityApiRef,
fetchApi: fetchApiRef,
},
factory: ({ discoveryApi, identityApi, fetchApi }) =>
new DevToolsClient({ discoveryApi, identityApi, fetchApi }),
}),
],
routes: {
+8 -3
View File
@@ -20,6 +20,7 @@ import {
createApiFactory,
createPlugin,
discoveryApiRef,
fetchApiRef,
identityApiRef,
} from '@backstage/frontend-plugin-api';
@@ -40,9 +41,13 @@ export const entityLinguistCard = createEntityCardExtension({
export const linguistApi = createApiExtension({
factory: createApiFactory({
api: linguistApiRef,
deps: { discoveryApi: discoveryApiRef, identityApi: identityApiRef },
factory: ({ discoveryApi, identityApi }) =>
new LinguistClient({ discoveryApi, identityApi }),
deps: {
discoveryApi: discoveryApiRef,
identityApi: identityApiRef,
fetchApi: fetchApiRef,
},
factory: ({ discoveryApi, identityApi, fetchApi }) =>
new LinguistClient({ discoveryApi, identityApi, fetchApi }),
}),
});
+9 -2
View File
@@ -14,7 +14,11 @@
* limitations under the License.
*/
import { DiscoveryApi, IdentityApi } from '@backstage/core-plugin-api';
import {
DiscoveryApi,
FetchApi,
IdentityApi,
} from '@backstage/core-plugin-api';
import { ResponseError } from '@backstage/errors';
import { Languages } from '@backstage/plugin-linguist-common';
import { LinguistApi } from './LinguistApi';
@@ -22,13 +26,16 @@ import { LinguistApi } from './LinguistApi';
export class LinguistClient implements LinguistApi {
private readonly discoveryApi: DiscoveryApi;
private readonly identityApi: IdentityApi;
private readonly fetchApi: FetchApi;
public constructor(options: {
discoveryApi: DiscoveryApi;
identityApi: IdentityApi;
fetchApi: FetchApi;
}) {
this.discoveryApi = options.discoveryApi;
this.identityApi = options.identityApi;
this.fetchApi = options.fetchApi;
}
public async getLanguages(entityRef: string): Promise<Languages> {
@@ -46,7 +53,7 @@ export class LinguistClient implements LinguistApi {
const url = new URL(path, baseUrl);
const { token } = await this.identityApi.getCredentials();
const response = await fetch(url.toString(), {
const response = await this.fetchApi.fetch(url.toString(), {
headers: token ? { Authorization: `Bearer ${token}` } : {},
});
+8 -3
View File
@@ -19,6 +19,7 @@ import {
createComponentExtension,
createPlugin,
discoveryApiRef,
fetchApiRef,
identityApiRef,
} from '@backstage/core-plugin-api';
import { linguistApiRef, LinguistClient } from './api';
@@ -35,9 +36,13 @@ export const linguistPlugin = createPlugin({
apis: [
createApiFactory({
api: linguistApiRef,
deps: { discoveryApi: discoveryApiRef, identityApi: identityApiRef },
factory: ({ discoveryApi, identityApi }) =>
new LinguistClient({ discoveryApi, identityApi }),
deps: {
discoveryApi: discoveryApiRef,
identityApi: identityApiRef,
fetchApi: fetchApiRef,
},
factory: ({ discoveryApi, identityApi, fetchApi }) =>
new LinguistClient({ discoveryApi, identityApi, fetchApi }),
}),
],
});