feat(:sparkles:): add meta information to healthcheck endpoint (#470)

src/services/agent-service.ts

@@ -165,6 +165,12 @@ export class AgentService {
   }
 
   private async handleHealthCheck(_: express.Request, response: express.Response) {
-    return response.json({ success: true })
+    return response.json({
+      success: true,
+      build: {
+        number: this.buildService.buildNumber,
+        url: this.buildService.buildUrl,
+      },
+    })
   }
 }

test/unit/services/agent-service.test.ts

@@ -32,15 +32,32 @@ describe('AgentService', () => {
     it('starts serving dist/public on supplied port', async () => {
       await captureStdOut(() => subject.start(configuration))
 
-      chai.request(`http://localhost:${configuration.agent.port}`)
+      await chai.request(`http://localhost:${configuration.agent.port}`)
         .get('/percy-agent.js')
-        .end((error, response) => {
-          expect(error).to.be.eq(null)
+        .then((response) => {
           expect(response).to.have.status(200)
           expect(response).to.have.header('content-type', /application\/javascript/)
         })
     })
 
+    it('sends meta information with the healthcheck endpoint', async () => {
+      await captureStdOut(() => subject.start(configuration))
+
+      await chai.request(`http://localhost:${configuration.agent.port}`)
+        .get('/percy/healthcheck')
+        .then((response) => {
+          expect(response).to.have.status(200)
+          expect(response).to.be.json
+          expect(response.body).to.deep.equal({
+            success: true,
+            build: {
+              number: 1322,
+              url: 'https://percy.io/test/test/builds/659575',
+            },
+          })
+        })
+    })
+
     it('logs to stdout that it created a build', async () => {
       const stdout = await captureStdOut(() => subject.start(configuration))
       expect(stdout).to.match(/\[percy\] created build #\d+: https:\/\/percy\.io\/test\/test\/builds\/\d+/)
@@ -54,20 +71,16 @@ describe('AgentService', () => {
         await subject.stop()
       })
 
-      chai.request(`http://localhost:${configuration.agent.port}`)
+      await chai.request(`http://localhost:${configuration.agent.port}`)
         .get('/percy-agent.js')
-        .catch(async (error) => {
-          await expect(error).to.have.property('message', `connect ECONNREFUSED 127.0.0.1:${configuration.agent.port}`)
+        .catch((error) => {
+          expect(error).to.have.property('message', `connect ECONNREFUSED 127.0.0.1:${configuration.agent.port}`)
         })
     })
 
     it('logs to stdout that it finalized a build', async () => {
       await captureStdOut(() => subject.start(configuration))
-
-      const stdout = await captureStdOut(async () => {
-        await subject.stop()
-      })
-
+      const stdout = await captureStdOut(() => subject.stop())
       expect(stdout).to.match(/\[percy\] finalized build #\d+: https:\/\/percy\.io\/test\/test\/builds\/\d+/)
     })
   })