Use the options object pattern for frontend API

Signed-off-by: Andrew Shirley <andrew.shirley@sainsburys.co.uk> Signed-off-by: blam <ben@blam.sh>
jeremyguarini · Jul 14, 2021 · 91cc491 · 91cc491
1 parent 37d0143
commit 91cc491
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 40 deletions.
diff --git a/plugins/jenkins-backend/api-report.md b/plugins/jenkins-backend/api-report.md
@@ -8,7 +8,7 @@ import { CatalogClient } from '@backstage/catalog-client';
 import { Config } from '@backstage/config';
 import { EntityName } from '@backstage/catalog-model';
 import express from 'express';
-import { Logger } from 'winston';
+import { Logger as Logger_2 } from 'winston';
 
 // @public (undocumented)
 export function createRouter(options: RouterOptions): Promise<express.Router>;
@@ -55,7 +55,7 @@ export interface RouterOptions {
     // (undocumented)
     jenkinsInfoProvider: JenkinsInfoProvider;
     // (undocumented)
-    logger: Logger;
+    logger: Logger_2;
 }
 
 

diff --git a/plugins/jenkins/src/api/JenkinsApi.ts b/plugins/jenkins/src/api/JenkinsApi.ts
@@ -78,35 +78,35 @@ export interface JenkinsApi {
    *
    * Typically, a folder job will be identified and the backend plugin will recursively look for projects (jobs with builds) within that folder.
    *
-   * @param entity the entity whose jobs should be retrieved.
-   * @param filter a filter on jobs. Currently this just takes a branch (and assumes certain structures in jenkins)
+   * @param options.entity the entity whose jobs should be retrieved.
+   * @param options.filter a filter on jobs. Currently this just takes a branch (and assumes certain structures in jenkins)
    */
-  getProjects(
-    entity: EntityRef,
-    filter: { branch?: string },
-  ): Promise<Project[]>;
+  getProjects(options: {
+    entity: EntityRef;
+    filter: { branch?: string };
+  }): Promise<Project[]>;
 
   /**
    * Get a single build.
    *
    * This takes an entity to support selecting between multiple jenkins instances.
    *
    * TODO: abstract jobName (so we could support differentiating between the same named job on multiple instances).
-   * @param entity
-   * @param jobName
-   * @param buildNumber
+   * @param options.entity
+   * @param options.jobName
+   * @param options.buildNumber
    */
-  getBuild(
-    entity: EntityName,
-    jobName: string,
-    buildNumber: string,
-  ): Promise<Build>;
-
-  retry(
-    entity: EntityName,
-    jobName: string,
-    buildNumber: string,
-  ): Promise<void>;
+  getBuild(options: {
+    entity: EntityName;
+    jobName: string;
+    buildNumber: string;
+  }): Promise<Build>;
+
+  retry(options: {
+    entity: EntityName;
+    jobName: string;
+    buildNumber: string;
+  }): Promise<void>;
 }
 
 export class JenkinsClient implements JenkinsApi {
@@ -121,10 +121,13 @@ export class JenkinsClient implements JenkinsApi {
     this.identityApi = options.identityApi;
   }
 
-  async getProjects(
-    entity: EntityName,
-    filter: { branch?: string },
-  ): Promise<Project[]> {
+  async getProjects({
+    entity,
+    filter,
+  }: {
+    entity: EntityName;
+    filter: { branch?: string };
+  }): Promise<Project[]> {
     const url = new URL(
       `${await this.discoveryApi.getBaseUrl(
         'jenkins',
@@ -149,17 +152,25 @@ export class JenkinsClient implements JenkinsApi {
       (await response.json()).projects?.map((p: Project) => ({
         ...p,
         onRestartClick: async () => {
-          await this.retry(entity, p.fullName, String(p.lastBuild.number));
+          await this.retry({
+            entity,
+            jobName: p.fullName,
+            buildNumber: String(p.lastBuild.number),
+          });
         },
       })) || []
     );
   }
 
-  async getBuild(
-    entity: EntityName,
-    jobName: string,
-    buildNumber: string,
-  ): Promise<Build> {
+  async getBuild({
+    entity,
+    jobName,
+    buildNumber,
+  }: {
+    entity: EntityName;
+    jobName: string;
+    buildNumber: string;
+  }): Promise<Build> {
     const url = `${await this.discoveryApi.getBaseUrl(
       'jenkins',
     )}/v1/entity/${encodeURIComponent(entity.namespace)}/${encodeURIComponent(
@@ -179,11 +190,15 @@ export class JenkinsClient implements JenkinsApi {
     return (await response.json()).build;
   }
 
-  async retry(
-    entity: EntityName,
-    jobName: string,
-    buildNumber: string,
-  ): Promise<void> {
+  async retry({
+    entity,
+    jobName,
+    buildNumber,
+  }: {
+    entity: EntityName;
+    jobName: string;
+    buildNumber: string;
+  }): Promise<void> {
     const url = `${await this.discoveryApi.getBaseUrl(
       'jenkins',
     )}/v1/entity/${encodeURIComponent(entity.namespace)}/${encodeURIComponent(

diff --git a/plugins/jenkins/src/components/useBuildWithSteps.ts b/plugins/jenkins/src/components/useBuildWithSteps.ts
@@ -42,7 +42,7 @@ export function useBuildWithSteps({
   const getBuildWithSteps = useCallback(async () => {
     try {
       const entityName = await getEntityName(entity);
-      return api.getBuild(entityName, jobName, buildNumber);
+      return api.getBuild({ entity: entityName, jobName, buildNumber });
     } catch (e) {
       errorApi.post(e);
       return Promise.reject(e);

diff --git a/plugins/jenkins/src/components/useBuilds.ts b/plugins/jenkins/src/components/useBuilds.ts
@@ -47,15 +47,18 @@ export function useBuilds({ branch }: { branch?: string } = {}) {
 
   const restartBuild = async (jobName: string, buildNumber: string) => {
     try {
-      await api.retry(entityName, jobName, buildNumber);
+      await api.retry({ entity: entityName, jobName, buildNumber });
     } catch (e) {
       errorApi.post(e);
     }
   };
 
   const { loading, value: projects, retry } = useAsyncRetry(async () => {
     try {
-      const build = await api.getProjects(getEntityName(entity), { branch });
+      const build = await api.getProjects({
+        entity: getEntityName(entity),
+        filter: { branch },
+      });
 
       setTotal(build.length);