Strip ANSI sequences from statuses (#1287)

Author: ehmicky

packages/build/src/core/status.js

@@ -1,5 +1,7 @@
 const { env } = require('process')
 
+const stripAnsi = require('strip-ansi')
+
 const { serializeErrorStatus } = require('../error/parse/serialize_status')
 const { logStatuses } = require('../log/main')
 
@@ -66,8 +68,31 @@ const reportPluginLoadError = async function({ error, api, mode, event, package,
 }
 
 const reportStatuses = async function(statuses, api, mode) {
-  printStatuses(statuses, mode)
-  await sendStatuses(statuses, api, mode)
+  const statusesA = removeStatusesColors(statuses)
+  printStatuses(statusesA, mode)
+  await sendStatuses(statusesA, api, mode)
+}
+
+// Remove colors from statuses
+const removeStatusesColors = function(statuses) {
+  return statuses.map(removeStatusColors)
+}
+
+const removeStatusColors = function(status) {
+  const attributes = COLOR_ATTRIBUTES.map(attribute => removeAttrColor(status, attribute))
+  return Object.assign({}, status, ...attributes)
+}
+
+const COLOR_ATTRIBUTES = ['title', 'summary', 'text']
+
+const removeAttrColor = function(status, attribute) {
+  const value = status[attribute]
+  if (value === undefined) {
+    return {}
+  }
+
+  const valueA = stripAnsi(value)
+  return { [attribute]: valueA }
 }
 
 // When not in production, print statuses to console.

packages/build/tests/plugins/status/fixtures/colors/netlify.toml

@@ -0,0 +1,2 @@
+[[plugins]]
+package = "./plugin.js"

packages/build/tests/plugins/status/fixtures/colors/plugin.js

@@ -0,0 +1,11 @@
+const { red } = require('chalk')
+
+module.exports = {
+  onBuild({
+    utils: {
+      status: { show },
+    },
+  }) {
+    show({ summary: red('summary') })
+  },
+}

packages/build/tests/plugins/status/snapshots/tests.js.md

@@ -1980,6 +1980,74 @@ Generated by [AVA](https://ava.li).
       },
     ]
 
+## utils.status.show() statuses are sent to the API without colors
+
+> Snapshot 1
+
+    `␊
+    ┌─────────────────────────────┐␊
+    │        Netlify Build        │␊
+    └─────────────────────────────┘␊
+    ␊
+    > Version␊
+      @netlify/build 1.0.0␊
+    ␊
+    > Flags␊
+      repositoryRoot: /file/path␊
+    ␊
+    > Current directory␊
+      /file/path␊
+    ␊
+    > Config file␊
+      /file/path␊
+    ␊
+    > Resolved config␊
+      plugins:␊
+        - package: /file/path␊
+    ␊
+    > Context␊
+      production␊
+    ␊
+    > Loading plugins␊
+       - /file/path␊
+    ␊
+    ┌─────────────────────────────────────┐␊
+    │ 1. onBuild command from /file/path │␊
+    └─────────────────────────────────────┘␊
+    ␊
+    ␊
+    (/file/path onBuild completed in 1ms)␊
+    ␊
+    ┌─────────────────────────────┐␊
+    │           Summary           │␊
+    └─────────────────────────────┘␊
+    ␊
+    > Plugin /file/path ran successfully␊
+      summary␊
+    ␊
+    ┌─────────────────────────────┐␊
+    │   Netlify Build Complete    │␊
+    └─────────────────────────────┘␊
+    ␊
+    (Netlify Build completed in 1ms)`
+
+> Snapshot 2
+
+    [
+      {
+        body: {
+          package: './plugin.js',
+          reporting_event: 'onBuild',
+          state: 'success',
+          summary: 'summary',
+          text: undefined,
+          version: '1.0.0',
+        },
+        headers: 'accept accept-encoding authorization connection content-length content-type host user-agent',
+        method: 'POST',
+      },
+    ]
+
 ## utils.status.show() summary should be a string
 
 > Snapshot 1

packages/build/tests/plugins/status/snapshots/tests.js.snap

@@ -66,6 +66,10 @@ test('utils.status.show() statuses are not sent to the API without a DEPLOY_ID',
   await runWithApiMock(t, 'print', { env: { DEPLOY_ID: '' } })
 })
 
+test('utils.status.show() statuses are sent to the API without colors', async t => {
+  await runWithApiMock(t, 'colors')
+})
+
 test('report error statuses from failBuild()', async t => {
   await runWithApiMock(t, 'error_fail_build')
 })