fix(cicd-statistics-module-github): Align authentication with other github frontends

Author: gavinelder

docs/compatibility/new-frontend-system.md

@@ -11,7 +11,8 @@ This is an extension module to the `cicd-statistics` plugin, providing a `CicdSt
 
 ```tsx
 // packages/app/src/apis.ts
-import { githubAuthApiRef } from '@backstage/core-plugin-api';
+import { configApiRef } from '@backstage/core-plugin-api';
+import { scmAuthApiRef } from '@backstage/integration-react';
 
 import { cicdStatisticsApiRef } from '@backstage-community/plugin-cicd-statistics';
 import { CicdStatisticsApiGithub } from '@backstage-community/plugin-cicd-statistics-module-github';
@@ -20,11 +21,11 @@ export const apis: AnyApiFactory[] = [
   createApiFactory({
     api: cicdStatisticsApiRef,
     deps: {
-      githubAuthApi: githubAuthApiRef,
+      scmAuthApi: scmAuthApiRef,
       configApi: configApiRef,
     },
-    factory: ({ githubAuthApi, configApi }) => {
-      return new CicdStatisticsApiGithub(githubAuthApi, configApi);
+    factory: ({ scmAuthApi, configApi }) => {
+      return new CicdStatisticsApiGithub({ scmAuthApi, configApi });
     },
   }),
 ];

workspaces/cicd-statistics/plugins/cicd-statistics-module-github/README.md

@@ -29,7 +29,8 @@ import { catalogApiMock } from '@backstage/plugin-catalog-react/testUtils';
 import { cicdStatisticsApiRef } from '@backstage-community/plugin-cicd-statistics';
 import { catalogApiRef } from '@backstage/plugin-catalog-react';
 import { CicdStatisticsApiGithub } from '../src/api';
-import { configApiRef, githubAuthApiRef } from '@backstage/core-plugin-api';
+import { configApiRef } from '@backstage/core-plugin-api';
+import { scmAuthApiRef } from '@backstage/integration-react';
 
 createDevApp()
   // We need the catalog plugin to get the example entities and make the front entity page functional
@@ -84,26 +85,34 @@ createDevApp()
     }),
   )
   .registerApi({
-    api: githubAuthApiRef,
+    api: scmAuthApiRef,
     deps: {},
     factory: () => {
       return {
-        getAccessToken: async () => {
+        getCredentials: async () => {
           // This nonsense is only here to make been able to locally test this plugin without having to setup a backend app
-          return 'THIS_IS_ONLY_FOR_TESTING_LOCALLY_PLEASE_DO_NOT_NEVER_USE_THIS_IN_PRODUCTION';
+          return {
+            token:
+              'THIS_IS_ONLY_FOR_TESTING_LOCALLY_PLEASE_DO_NOT_NEVER_USE_THIS_IN_PRODUCTION',
+            headers: {},
+          };
         },
-      } as typeof githubAuthApiRef.T;
+      } as typeof scmAuthApiRef.T;
     },
   })
   .registerApi({
     api: cicdStatisticsApiRef,
     deps: {
       catalogApiMock: catalogApiRef,
-      githubAuthApi: githubAuthApiRef,
+      scmAuthApi: scmAuthApiRef,
       configApi: configApiRef,
     },
-    factory: ({ githubAuthApi, configApi }) => {
-      return new CicdStatisticsApiGithub(githubAuthApi, configApi, {});
+    factory: ({ scmAuthApi, configApi }) => {
+      return new CicdStatisticsApiGithub({
+        scmAuthApi,
+        configApi,
+        cicdDefaults: {},
+      });
     },
   })
   .render();

workspaces/cicd-statistics/plugins/cicd-statistics-module-github/dev/index.tsx

@@ -58,6 +58,7 @@
     "@backstage/core-plugin-api": "backstage:^",
     "@backstage/frontend-plugin-api": "backstage:^",
     "@backstage/integration": "backstage:^",
+    "@backstage/integration-react": "backstage:^",
     "@octokit/rest": "^21.1.1",
     "p-limit": "^3.1.0"
   },

workspaces/cicd-statistics/plugins/cicd-statistics-module-github/package.json

@@ -13,39 +13,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { cicdStatisticsApiRef } from '@backstage-community/plugin-cicd-statistics';
-import {
-  ApiBlueprint,
-  configApiRef,
-  createFrontendModule,
-  githubAuthApiRef,
-} from '@backstage/frontend-plugin-api';
-import { CicdStatisticsApiGithub } from './api';
+import { createFrontendModule } from '@backstage/frontend-plugin-api';
+import { cicdStatisticsGithubApi } from './alpha/index';
 
 /**
  * @alpha
  */
-export const cicdStatisticsGithubExtension = ApiBlueprint.make({
-  name: 'cicd-statistics-github-api',
-  params: defineParams =>
-    defineParams({
-      api: cicdStatisticsApiRef,
-      deps: {
-        githubAuthApi: githubAuthApiRef,
-        configApi: configApiRef,
-      },
-      factory: ({ githubAuthApi, configApi }) => {
-        return new CicdStatisticsApiGithub(githubAuthApi, configApi);
-      },
-    }),
-});
-
-/**
- * @alpha
- */
-const cicdStatisticsExtensionOverrides = createFrontendModule({
+export default createFrontendModule({
   pluginId: 'cicd-statistics',
-  extensions: [cicdStatisticsGithubExtension],
+  extensions: [cicdStatisticsGithubApi],
 });
-
-export default cicdStatisticsExtensionOverrides;

workspaces/cicd-statistics/plugins/cicd-statistics-module-github/src/alpha.ts

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { configApiRef, ApiBlueprint } from '@backstage/frontend-plugin-api';
+import { scmAuthApiRef } from '@backstage/integration-react';
+import { cicdStatisticsApiRef } from '@backstage-community/plugin-cicd-statistics';
+import { CicdStatisticsApiGithub } from '../api';
+
+/**
+ * @alpha
+ */
+export const cicdStatisticsGithubApi = ApiBlueprint.make({
+  name: 'cicd-statistics/cicd-statistics-github-api',
+  params: defineParams =>
+    defineParams({
+      api: cicdStatisticsApiRef,
+      deps: { configApi: configApiRef, scmAuthApi: scmAuthApiRef },
+      factory: ({ configApi, scmAuthApi }) =>
+        new CicdStatisticsApiGithub({ configApi, scmAuthApi }),
+    }),
+});

workspaces/cicd-statistics/plugins/cicd-statistics-module-github/src/alpha/apis.ts

@@ -0,0 +1,16 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * from './apis';

workspaces/cicd-statistics/plugins/cicd-statistics-module-github/src/alpha/index.ts

@@ -23,12 +23,13 @@ import {
   FetchBuildsOptions,
   Stage,
 } from '@backstage-community/plugin-cicd-statistics';
-import { ConfigApi, OAuthApi } from '@backstage/core-plugin-api';
+import { ConfigApi } from '@backstage/core-plugin-api';
 import limiterFactory from 'p-limit';
 import { Entity, getEntitySourceLocation } from '@backstage/catalog-model';
 import { jobToStages, workflowToBuild } from './utils';
 
 import { readGithubIntegrationConfigs } from '@backstage/integration';
+import { ScmAuthApi } from '@backstage/integration-react';
 import { Octokit } from '@octokit/rest';
 
 /** @public */
@@ -38,16 +39,16 @@ export const getProjectNameFromEntity = (entity: Entity) =>
   entity?.metadata.annotations?.[GITHUB_ACTIONS_ANNOTATION] ?? '';
 
 /**
- * This type represents a initialized github client with octokit
+ * This type represents an initialized github client with octokit
  *
  * @public
  */
 export type GithubClient = {
-  /* the actual API of octokit */
-  api: InstanceType<typeof Octokit>;
-  /* the owner the repository, retrieved from the entity source location  */
+  /* the octokit instance for making GitHub API calls */
+  octokit: InstanceType<typeof Octokit>;
+  /* the owner of the repository, retrieved from the entity source location */
   owner: string;
-  /* the repository name, retrieved from the entity source location  */
+  /* the repository name, retrieved from the entity source location */
   repo: string;
 };
 
@@ -57,36 +58,46 @@ export type GithubClient = {
  * @public
  */
 export class CicdStatisticsApiGithub implements CicdStatisticsApi {
-  readonly #githubAuthApi: OAuthApi;
-  readonly #cicdDefaults: Partial<CicdDefaults>;
-  readonly configApi: ConfigApi;
-
-  constructor(
-    githubAuthApi: OAuthApi,
-    configApi: ConfigApi,
-    cicdDefaults: Partial<CicdDefaults> = {},
-  ) {
-    this.#githubAuthApi = githubAuthApi;
-    this.#cicdDefaults = cicdDefaults;
-    this.configApi = configApi;
+  private readonly scmAuthApi: ScmAuthApi;
+  private readonly configApi: ConfigApi;
+  private readonly cicdDefaults: Partial<CicdDefaults>;
+
+  constructor(options: {
+    scmAuthApi: ScmAuthApi;
+    configApi: ConfigApi;
+    cicdDefaults?: Partial<CicdDefaults>;
+  }) {
+    this.scmAuthApi = options.scmAuthApi;
+    this.configApi = options.configApi;
+    this.cicdDefaults = options.cicdDefaults ?? {};
   }
 
-  public async createGithubApi(
-    entity: Entity,
-    scopes: string[],
-  ): Promise<GithubClient> {
-    const entityInfo = getEntitySourceLocation(entity);
-    const [owner, repo] = getProjectNameFromEntity(entity).split('/');
-    const url = new URL(entityInfo.target);
-    const oauthToken = await this.#githubAuthApi.getAccessToken(scopes);
-
+  private async getOctokit(hostname: string = 'github.com'): Promise<Octokit> {
+    const { token } = await this.scmAuthApi.getCredentials({
+      url: `https://${hostname}/`,
+      additionalScope: {
+        customScopes: {
+          github: ['repo'],
+        },
+      },
+    });
     const configs = readGithubIntegrationConfigs(
       this.configApi.getOptionalConfigArray('integrations.github') ?? [],
     );
-    const githubIntegrationConfig = configs.find(v => v.host === url.hostname);
+    const githubIntegrationConfig = configs.find(v => v.host === hostname);
     const baseUrl = githubIntegrationConfig?.apiBaseUrl;
+    return new Octokit({ auth: token, baseUrl });
+  }
+
+  public async createGithubClient(entity: Entity): Promise<GithubClient> {
+    const entityInfo = getEntitySourceLocation(entity);
+    const [owner, repo] = getProjectNameFromEntity(entity).split('/');
+    const url = new URL(entityInfo.target);
+    const hostname = url.hostname;
+
+    const octokit = await this.getOctokit(hostname);
     return {
-      api: new Octokit({ auth: oauthToken, baseUrl }),
+      octokit,
       owner,
       repo,
     };
@@ -142,18 +153,16 @@ export class CicdStatisticsApiGithub implements CicdStatisticsApi {
       filterStatus = ['all'],
       filterType = 'all',
     } = options;
-    const { api, owner, repo } = await this.createGithubApi(entity, [
-      'read_api',
-    ]);
+    const { octokit, owner, repo } = await this.createGithubClient(entity);
     updateProgress(0, 0, 0);
 
     const branch =
       filterType === 'master'
-        ? await CicdStatisticsApiGithub.getDefaultBranch(api, owner, repo)
+        ? await CicdStatisticsApiGithub.getDefaultBranch(octokit, owner, repo)
         : undefined;
 
-    const workflowsRuns = await api.paginate(
-      api.actions.listWorkflowRunsForRepo,
+    const workflowsRuns = await octokit.paginate(
+      octokit.actions.listWorkflowRunsForRepo,
       {
         owner,
         repo,
@@ -168,10 +177,15 @@ export class CicdStatisticsApiGithub implements CicdStatisticsApi {
     const builds = workflowsRuns.map(async build => ({
       ...build,
       duration: await limiter(() =>
-        CicdStatisticsApiGithub.getDurationOfBuild(api, owner, repo, build),
+        CicdStatisticsApiGithub.getDurationOfBuild(octokit, owner, repo, build),
       ),
       stages: await limiter(() =>
-        CicdStatisticsApiGithub.updateBuildWithStages(api, owner, repo, build),
+        CicdStatisticsApiGithub.updateBuildWithStages(
+          octokit,
+          owner,
+          repo,
+          build,
+        ),
       ),
     }));
     const promisedBuilds = (await Promise.all(builds)).filter(b =>
@@ -194,7 +208,7 @@ export class CicdStatisticsApiGithub implements CicdStatisticsApi {
         'enqueued',
         'scheduled',
       ] as const,
-      defaults: this.#cicdDefaults,
+      defaults: this.cicdDefaults,
     };
   }
 }

workspaces/cicd-statistics/plugins/cicd-statistics-module-github/src/api/github.ts

@@ -14,5 +14,11 @@
  * limitations under the License.
  */
 
-export { CicdStatisticsApiGithub } from './api';
+/**
+ * A Backstage plugin that provides GitHub CI/CD statistics
+ *
+ * @packageDocumentation
+ */
+
+export { CicdStatisticsApiGithub, GITHUB_ACTIONS_ANNOTATION } from './api';
 export type { GithubClient } from './api';