Improve error handling in publish plugin (#2526)

Author: davidjgoss

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 Please see [CONTRIBUTING.md](./CONTRIBUTING.md) on how to contribute to Cucumber.
 
 ## [Unreleased]
+### Changed
+- Improve error handling in publish plugin ([#2526](https://github.com/cucumber/cucumber-js/pull/2526))
 
 ## [11.2.0] - 2025-01-09
 ### Added

features/publish.feature

@@ -86,14 +86,40 @@ Feature: Publish reports
       """
 
   @spawn
-  Scenario: when results are not published due to an error raised by the server, the banner is displayed
+  Scenario: results are not published due to a client error
     When I run cucumber-js with env `CUCUMBER_PUBLISH_TOKEN=keyboardcat`
     Then it passes
     And the error output contains the text:
       """
       ┌─────────────────────┐
       │ Error invalid token │
       └─────────────────────┘
+      """
 
-      Unexpected http status 401 from GET http://localhost:9987
+  @spawn
+  Scenario: results are not published due to a service error
+    Given report publishing is not working
+    When I run cucumber-js with arguments `--publish` and env ``
+    Then it passes
+    And the error output does not contain the text:
+      """
+      Not a useful error message
+      """
+    And the error output contains the text:
+      """
+      Failed to publish report to http://localhost:9987 with status 500
+      """
+
+  @spawn
+  Scenario: results are not published due to an error on uploading
+    Given report uploads are not working
+    When I run cucumber-js with arguments `--publish` and env ``
+    Then it passes
+    And the error output does not contain the text:
+      """
+      View your Cucumber Report at:
+      """
+    And the error output contains the text:
+      """
+      Failed to upload report to http://localhost:9987 with status 500
       """

features/step_definitions/report_server_steps.ts

@@ -14,6 +14,14 @@ Given(
   }
 )
 
+Given('report publishing is not working', async function (this: World) {
+  this.reportServer.failOnTouch = true
+})
+
+Given('report uploads are not working', async function (this: World) {
+  this.reportServer.failOnUpload = true
+})
+
 Then(
   'the server should receive the following message types:',
   async function (this: World, expectedMessageTypesTable: DataTable) {

package-lock.json

@@ -251,7 +251,6 @@
     "semver": "7.7.1",
     "string-argv": "0.3.1",
     "supports-color": "^8.1.1",
-    "tmp": "0.2.3",
     "type-fest": "^4.8.3",
     "util-arity": "^1.1.0",
     "yaml": "^2.2.2",
@@ -307,6 +306,7 @@
     "sinon": "15.0.1",
     "sinon-chai": "3.7.0",
     "stream-to-string": "1.2.1",
+    "tmp": "0.2.3",
     "ts-node": "10.9.2",
     "tsd": "0.31.2",
     "typedoc": "^0.26.11",

package.json

@@ -1,10 +1,13 @@
 import { Writable } from 'node:stream'
 import { stripVTControlCharacters } from 'node:util'
+import { mkdtemp, stat } from 'node:fs/promises'
+import path from 'node:path'
+import { tmpdir } from 'node:os'
+import { createReadStream, createWriteStream } from 'node:fs'
 import { supportsColor } from 'supports-color'
 import hasAnsi from 'has-ansi'
 import { InternalPlugin } from '../plugin'
 import { IPublishConfig } from './types'
-import HttpStream from './http_stream'
 
 const DEFAULT_CUCUMBER_PUBLISH_URL = 'https://messages.cucumber.io/api/reports'
 
@@ -19,24 +22,62 @@ export const publishPlugin: InternalPlugin<IPublishConfig | false> = {
     if (token !== undefined) {
       headers.Authorization = `Bearer ${token}`
     }
-    const stream = new HttpStream(url, 'GET', headers)
-    const readerStream = new Writable({
-      objectMode: true,
-      write: function (responseBody: string, encoding, writeCallback) {
-        environment.stderr.write(
-          sanitisePublishOutput(responseBody, environment.stderr) + '\n'
-        )
-        writeCallback()
-      },
+    const touchResponse = await fetch(url, { headers })
+    const banner = await touchResponse.text()
+
+    if (!touchResponse.ok) {
+      return () => {
+        if (touchResponse.status < 500) {
+          environment.stderr.write(
+            sanitisePublishOutput(banner, environment.stderr) + '\n'
+          )
+        } else {
+          logger.error(
+            `Failed to publish report to ${new URL(url).origin} with status ${
+              touchResponse.status
+            }`
+          )
+          logger.debug(touchResponse)
+        }
+      }
+    }
+
+    const uploadUrl = touchResponse.headers.get('Location')
+    const tempDir = await mkdtemp(path.join(tmpdir(), `cucumber-js-publish-`))
+    const tempFilePath = path.join(tempDir, 'envelopes.ndjson')
+    const tempFileStream = createWriteStream(tempFilePath, {
+      encoding: 'utf-8',
     })
-    stream.pipe(readerStream)
-    stream.on('error', (error: Error) => logger.error(error.message))
-    on('message', (value) => stream.write(JSON.stringify(value) + '\n'))
-    return () =>
-      new Promise<void>((resolve) => {
-        stream.on('finish', () => resolve())
-        stream.end()
+    on('message', (value) => tempFileStream.write(JSON.stringify(value) + '\n'))
+
+    return () => {
+      return new Promise<void>((resolve) => {
+        tempFileStream.end(async () => {
+          const stats = await stat(tempFilePath)
+          const uploadResponse = await fetch(uploadUrl, {
+            method: 'PUT',
+            headers: {
+              'Content-Length': stats.size.toString(),
+            },
+            body: createReadStream(tempFilePath, { encoding: 'utf-8' }),
+            duplex: 'half',
+          })
+          if (uploadResponse.ok) {
+            environment.stderr.write(
+              sanitisePublishOutput(banner, environment.stderr) + '\n'
+            )
+          } else {
+            logger.error(
+              `Failed to upload report to ${
+                new URL(uploadUrl).origin
+              } with status ${uploadResponse.status}`
+            )
+            logger.debug(uploadResponse)
+          }
+          resolve()
+        })
       })
+    }
   },
 }
 

src/publish/http_stream.ts

@@ -14,11 +14,18 @@ export default class FakeReportServer {
   private readonly server: Server
   public receivedBodies = Buffer.alloc(0)
   public receivedHeaders: http.IncomingHttpHeaders = {}
+  public failOnTouch = false
+  public failOnUpload = false
 
   constructor(private readonly port: number) {
     const app = express()
 
     app.put('/s3', (req, res) => {
+      if (this.failOnUpload) {
+        res.status(500).end()
+        return
+      }
+
       this.receivedHeaders = { ...this.receivedHeaders, ...req.headers }
 
       const captureBodyStream = new Writable({
@@ -39,6 +46,11 @@ export default class FakeReportServer {
     })
 
     app.get('/api/reports', (req, res) => {
+      if (this.failOnTouch) {
+        res.status(500).end('Not a useful error message')
+        return
+      }
+
       this.receivedHeaders = { ...this.receivedHeaders, ...req.headers }
       const token = extractAuthorizationToken(req.headers.authorization)
       if (token && !isValidUUID(token)) {