fix(audit-dto): support for invocation id (#1424)

Author: ekremney

src/dto/audit.js

@@ -26,6 +26,7 @@ export const AuditDto = {
    * fullAuditRef: string,
    * isLive: boolean,
    * siteId: string
+   * invocationId: string
    * }} JSON object.
    */
   toJSON: (audit) => ({
@@ -36,6 +37,7 @@ export const AuditDto = {
     isLive: audit.getIsLive(),
     isError: audit.getIsError(),
     siteId: audit.getSiteId(),
+    invocationId: audit.getInvocationId(),
   }),
 
   /**
@@ -48,6 +50,7 @@ export const AuditDto = {
    * fullAuditRef: string,
    * isLive: boolean,
    * siteId: string
+   * invocationId: string
    * }} JSON object.
    */
   toAbbreviatedJSON: (audit) => {
@@ -68,6 +71,7 @@ export const AuditDto = {
       isLive: audit.getIsLive(),
       isError: audit.getIsError(),
       siteId: audit.getSiteId(),
+      invocationId: audit.getInvocationId(),
     };
   },
 };

test/controllers/audits.test.js

@@ -54,6 +54,7 @@ describe('Audits Controller', () => {
       isError: false,
       isLive: true,
       fullAuditRef: 'https://lh-metrics.com/audit/123',
+      invocationId: 'some-invocation-id1',
       auditResult: {
         scores: {
           performance: 0.5,
@@ -70,6 +71,7 @@ describe('Audits Controller', () => {
       isError: false,
       isLive: true,
       fullAuditRef: 'https://lh-metrics.com/audit/234',
+      invocationId: 'some-invocation-id2',
       auditResult: {
         scores: {
           performance: 0.5,
@@ -86,6 +88,7 @@ describe('Audits Controller', () => {
       isError: false,
       isLive: true,
       fullAuditRef: 'https://lh-metrics.com/audit/345',
+      invocationId: 'some-invocation-id3',
       auditResult: {
         scores: {
           'first-contentful-paint': 0.5,

test/controllers/sites.test.js

@@ -178,6 +178,7 @@ describe('Sites Controller', () => {
           getIsError: sandbox.stub().returns(false),
           getIsLive: sandbox.stub().returns(true),
           getSiteId: sandbox.stub().returns(SITE_IDS[0]),
+          getInvocationId: sandbox.stub().returns('some-invocation-id'),
         }),
       },
       KeyEvent: {
@@ -555,6 +556,7 @@ describe('Sites Controller', () => {
       getIsError: () => false,
       getIsLive: () => true,
       getSiteId: () => SITE_IDS[0],
+      getInvocationId: () => 'some-invocation-id',
     };
     sites.forEach((site) => {
       // eslint-disable-next-line no-param-reassign

test/dto/audit.test.js

@@ -48,6 +48,7 @@ describe('Audit DTO', () => {
       getIsLive: () => true,
       getIsError: () => false,
       getSiteId: () => 'site-id',
+      getInvocationId: () => 'some-invocation',
     };
 
     const auditJson = AuditDto.toAbbreviatedJSON(audit);
@@ -60,6 +61,7 @@ describe('Audit DTO', () => {
       isLive: true,
       isError: false,
       siteId: 'site-id',
+      invocationId: 'some-invocation',
     });
   });
 });

test/index.test.js

@@ -48,6 +48,7 @@ describe('Index Tests', () => {
         'best-practices': 0.6,
       },
     }),
+    getInvocationId: () => 'some-invocation',
   };
 
   const scrapeJobConfiguration = {