Merge pull request #7522 from awanlin/topic/handle-undefined-repobuild-properties

Topic/handle undefined RepoBuild properties

.changeset/plenty-bees-run.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-azure-devops-backend': patch
+---
+
+Updates function for mapping RepoBuilds to handle undefined properties

plugins/azure-devops-backend/api-report.md

@@ -47,7 +47,7 @@ export function createRouter(options: RouterOptions): Promise<express.Router>;
 export type RepoBuild = {
   id?: number;
   title: string;
-  link: string;
+  link?: string;
   status?: BuildStatus;
   result?: BuildResult;
   queueTime?: Date;

plugins/azure-devops-backend/src/api/AzureDevOpsApi.test.ts

@@ -94,4 +94,100 @@ describe('AzureDevOpsApi', () => {
       expect(repoBuildFromBuild(inputBuild)).toEqual(outputRepoBuild);
     });
   });
+
+  describe('repoBuildFromBuild with undefined status', () => {
+    it('should return BuildStatus of None for status', () => {
+      const inputLinks: any = {
+        web: {
+          href: 'https://host.com/myOrg/0bcc0c0d-2d02/_build/results?buildId=1',
+        },
+      };
+
+      const inputBuild: Build = {
+        id: 1,
+        buildNumber: 'Build-1',
+        status: undefined,
+        result: BuildResult.Succeeded,
+        queueTime: new Date('2020-09-12T06:10:23.9325232Z'),
+        sourceBranch: 'refs/heads/develop',
+        sourceVersion: 'f4f78b3100b2923982bdf60c89c57ce6fd2d9a1c',
+        definition: undefined,
+        _links: inputLinks,
+      };
+
+      const outputRepoBuild: RepoBuild = {
+        id: 1,
+        title: 'Build-1',
+        link: 'https://host.com/myOrg/0bcc0c0d-2d02/_build/results?buildId=1',
+        status: BuildStatus.None,
+        result: BuildResult.Succeeded,
+        queueTime: new Date('2020-09-12T06:10:23.9325232Z'),
+        source: 'refs/heads/develop (f4f78b31)',
+      };
+
+      expect(repoBuildFromBuild(inputBuild)).toEqual(outputRepoBuild);
+    });
+  });
+
+  describe('repoBuildFromBuild with undefined result', () => {
+    it('should return BuildResult of None for result', () => {
+      const inputLinks: any = {
+        web: {
+          href: 'https://host.com/myOrg/0bcc0c0d-2d02/_build/results?buildId=1',
+        },
+      };
+
+      const inputBuild: Build = {
+        id: 1,
+        buildNumber: 'Build-1',
+        status: BuildStatus.InProgress,
+        result: undefined,
+        queueTime: new Date('2020-09-12T06:10:23.9325232Z'),
+        sourceBranch: 'refs/heads/develop',
+        sourceVersion: 'f4f78b3100b2923982bdf60c89c57ce6fd2d9a1c',
+        definition: undefined,
+        _links: inputLinks,
+      };
+
+      const outputRepoBuild: RepoBuild = {
+        id: 1,
+        title: 'Build-1',
+        link: 'https://host.com/myOrg/0bcc0c0d-2d02/_build/results?buildId=1',
+        status: BuildStatus.InProgress,
+        result: BuildResult.None,
+        queueTime: new Date('2020-09-12T06:10:23.9325232Z'),
+        source: 'refs/heads/develop (f4f78b31)',
+      };
+
+      expect(repoBuildFromBuild(inputBuild)).toEqual(outputRepoBuild);
+    });
+  });
+
+  describe('repoBuildFromBuild with undefined link', () => {
+    it('should return empty string for link', () => {
+      const inputBuild: Build = {
+        id: 1,
+        buildNumber: 'Build-1',
+        status: BuildStatus.InProgress,
+        result: undefined,
+        queueTime: new Date('2020-09-12T06:10:23.9325232Z'),
+        sourceBranch: 'refs/heads/develop',
+        sourceVersion: 'f4f78b3100b2923982bdf60c89c57ce6fd2d9a1c',
+        definition: undefined,
+        _links: undefined,
+      };
+
+      const outputRepoBuild: RepoBuild = {
+        id: 1,
+        title: 'Build-1',
+        link: '',
+        status: BuildStatus.InProgress,
+        result: BuildResult.None,
+        queueTime: new Date('2020-09-12T06:10:23.9325232Z'),
+        source: 'refs/heads/develop (f4f78b31)',
+      };
+
+      expect(repoBuildFromBuild(inputBuild)).toEqual(outputRepoBuild);
+    });
+  });
 });

plugins/azure-devops-backend/src/api/AzureDevOpsApi.ts

@@ -17,7 +17,11 @@
 import { Logger } from 'winston';
 import { WebApi } from 'azure-devops-node-api';
 import { RepoBuild } from './types';
-import { Build } from 'azure-devops-node-api/interfaces/BuildInterfaces';
+import {
+  Build,
+  BuildResult,
+  BuildStatus,
+} from 'azure-devops-node-api/interfaces/BuildInterfaces';
 
 export class AzureDevOpsApi {
   constructor(
@@ -97,9 +101,9 @@ export function repoBuildFromBuild(build: Build) {
     title: [build.definition?.name, build.buildNumber]
       .filter(Boolean)
       .join(' - '),
-    link: build._links?.web.href,
-    status: build.status,
-    result: build.result,
+    link: build._links?.web.href ? build._links?.web.href : '',
+    status: build.status ? build.status : BuildStatus.None,
+    result: build.result ? build.result : BuildResult.None,
     queueTime: build.queueTime,
     source: `${build.sourceBranch} (${build.sourceVersion?.substr(0, 8)})`,
   };

plugins/azure-devops-backend/src/api/types.ts

@@ -22,7 +22,7 @@ import {
 export type RepoBuild = {
   id?: number;
   title: string;
-  link: string;
+  link?: string;
   status?: BuildStatus;
   result?: BuildResult;
   queueTime?: Date;