Merge pull request #18 from Abhay-soni-developer/feature/external-url

url can be passed from app-config.yaml

Author: NishkarshRaj

package.json

@@ -78,5 +78,21 @@
     "backstage",
     "statusneo",
     "github"
-  ]
+  ],
+  "configSchema": {
+    "$schema": "https://backstage.io/schema/config-v1",
+    "title": "@statusneo/backstage-plugin-github",
+    "type": "object",
+    "properties": {
+      "gh-plugin": {
+        "type": "object",
+        "properties": {
+          "url": {
+            "type": "string",
+            "visibility": "frontend"
+          }
+        }
+      }
+    }
+  }
 }

src/api/GithubClient.ts

@@ -1,5 +1,5 @@
 import { GithubApi } from './GithubApi';
-import { OAuthApi, FetchApi } from '@backstage/core-plugin-api';
+import { OAuthApi, FetchApi, ConfigApi } from '@backstage/core-plugin-api';
 import { ResponseError } from '@backstage/errors';
 import {
   SearchApiFetchRequest,
@@ -17,20 +17,30 @@ import {
 export class GithubClient implements GithubApi {
   private readonly authApi: OAuthApi;
   private readonly fetchApi: FetchApi;
+  private readonly configApi: ConfigApi;
 
-  constructor(options: { authApi: OAuthApi; fetchApi: FetchApi }) {
+  constructor(options: {
+    authApi: OAuthApi;
+    fetchApi: FetchApi;
+    configApi: ConfigApi;
+  }) {
     this.authApi = options.authApi;
     this.fetchApi = options.fetchApi;
+    this.configApi = options.configApi;
   }
 
   private async get<T>(
     path: string,
     params: { [key in string]: any } = {},
   ): Promise<T> {
     const query = new URLSearchParams(params);
+
+    const baseUrl: string =
+      this.configApi.get('gh-plugin.url') || 'https://api.github.com/';
+
     const url = new URL(
       `${path}?${query.toString().replaceAll('%2B', '+')}`,
-      'https://api.github.com/',
+      baseUrl,
     );
 
     const token = await this.authApi.getAccessToken();
@@ -82,11 +92,9 @@ export class GithubClient implements GithubApi {
     );
   }
 
-  public getAuthenticatedUserReposByType (params: UserRepositoryApiRequest): Promise<UserRepositoryApiResponse> {
-    return this.get<UserRepositoryApiResponse>(
-      `/user/repos`,
-      params,
-    );
+  public getAuthenticatedUserReposByType(
+    params: UserRepositoryApiRequest,
+  ): Promise<UserRepositoryApiResponse> {
+    return this.get<UserRepositoryApiResponse>(`/user/repos`, params);
   }
-
 }

src/plugin.ts

@@ -4,15 +4,16 @@ import {
   fetchApiRef,
   createApiFactory,
   createComponentExtension,
+  configApiRef
 } from '@backstage/core-plugin-api';
 import { githubApiRef, GithubClient } from './api';
 
 export const backstageGithubPlugin = createPlugin({
-  id: 'backstage-plugin-github',
+  id: 'backstage-statusneo-plugin-github',
   apis: [
     createApiFactory({
       api: githubApiRef,
-      deps: { authApi: githubAuthApiRef, fetchApi: fetchApiRef },
+      deps: { authApi: githubAuthApiRef, fetchApi: fetchApiRef, configApi: configApiRef },
       factory(deps) {
         return new GithubClient(deps);
       },