Log returned error responses in Koa template

seek-oss · May 27, 2021 · e4155d9 · e4155d9
1 parent 1742096
commit e4155d9
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 4 deletions.
diff --git a/.changeset/plenty-experts-smash.md b/.changeset/plenty-experts-smash.md
@@ -0,0 +1,5 @@
+---
+'skuba': patch
+---
+
+**template/koa-rest-api:** Log returned error responses
diff --git a/template/koa-rest-api/src/framework/server.test.ts b/template/koa-rest-api/src/framework/server.test.ts
@@ -74,7 +74,11 @@ describe('createApp', () => {
 
     expect(rootLogger.error).not.toBeCalled();
 
-    expect(rootLogger.info).not.toBeCalled();
+    expect(rootLogger.info).nthCalledWith(
+      1,
+      expect.objectContaining({ status: 404 }),
+      'Client error',
+    );
 
     metricsClient.expectTagSubset([
       'http_method:get',
@@ -84,7 +88,37 @@ describe('createApp', () => {
     ]);
   });
 
-  it('handles client error', async () => {
+  it('handles returned client error', async () => {
+    const message = chance.sentence();
+
+    middleware.mockImplementation((ctx) => {
+      ctx.body = message;
+      ctx.status = 400;
+    });
+
+    await agent
+      .get('/')
+      .expect(400, message)
+      .expect('server', /.+/)
+      .expect('x-api-version', /.+/);
+
+    expect(rootLogger.error).not.toBeCalled();
+
+    expect(rootLogger.info).nthCalledWith(
+      1,
+      expect.objectContaining({ status: 400 }),
+      'Client error',
+    );
+
+    metricsClient.expectTagSubset([
+      'http_method:get',
+      'http_status:400',
+      'http_status_family:4xx',
+      'route:/',
+    ]);
+  });
+
+  it('handles client error thrown from context', async () => {
     const message = chance.sentence();
 
     middleware.mockImplementation((ctx) => ctx.throw(400, message));
@@ -111,7 +145,7 @@ describe('createApp', () => {
     ]);
   });
 
-  it('handles server error', async () => {
+  it('handles server error thrown from context', async () => {
     const message = chance.sentence();
 
     middleware.mockImplementation((ctx) => ctx.throw(500, message));

diff --git a/template/koa-rest-api/src/framework/server.ts b/template/koa-rest-api/src/framework/server.ts
@@ -19,7 +19,7 @@ const metrics = MetricsMiddleware.create(
 );
 
 const requestLogging = RequestLogging.createMiddleware((ctx, fields, err) => {
-  if (err === undefined) {
+  if (ctx.status < 400 && err === undefined) {
     // Depend on sidecar logging for happy path requests
     return;
   }