Verify gzipped content functions correctly

Author: davidjgoss

features/actions/composeGzipped.mts

@@ -0,0 +1,13 @@
+import { gzipSync } from 'node:zlib'
+import type { RequestComposer } from './types.ts'
+
+export const composeGzipped: RequestComposer = (content) => {
+  return {
+    method: 'PUT',
+    headers: {
+      'Content-Type': 'application/jsonl',
+      'Content-Encoding': 'gzip',
+    },
+    body: gzipSync(content),
+  }
+}

features/actions/composeUncompressed.mts

@@ -0,0 +1,8 @@
+import type { RequestComposer } from './types.ts'
+
+export const composeUncompressed: RequestComposer = (content) => {
+  return {
+    method: 'PUT',
+    body: content,
+  }
+}

features/actions/publishReport.mts

@@ -3,12 +3,13 @@ import { stripVTControlCharacters } from 'node:util'
 import { readFileSync } from 'node:fs'
 import path from 'node:path'
 import { type Action } from '../support/Actor.mjs'
-import { type PublishResult } from './types'
+import { type RequestComposer, type PublishResult } from './types'
 
-export const publishReport: (fixture: string, privateToken?: string) => Action<PublishResult> = (
-  fixture,
-  privateToken
-) => {
+export const publishReport: (
+  fixture: string,
+  requestComposer: RequestComposer,
+  privateToken?: string
+) => Action<PublishResult> = (fixture, requestComposer, privateToken) => {
   return async () => {
     const headers = new Headers()
     if (privateToken) {
@@ -23,14 +24,11 @@ export const publishReport: (fixture: string, privateToken?: string) => Action<P
     const url = banner.split(' ').find((part) => part.startsWith('http'))
 
     if (getResponse.ok && url) {
-      const putUrl = getResponse.headers.get('Location') as string
+      const uploadUrl = getResponse.headers.get('Location') as string
       const envelopes = readFileSync(path.join(import.meta.dirname, '..', 'fixtures', fixture), {
         encoding: 'utf-8',
       })
-      const putResponse = await fetch(putUrl, {
-        method: 'PUT',
-        body: envelopes,
-      })
+      const putResponse = await fetch(uploadUrl, requestComposer(envelopes))
       assert.ok(putResponse.ok)
     }
 

features/actions/types.ts

@@ -1,3 +1,5 @@
+export type RequestComposer = (content: string) => RequestInit
+
 export interface PublishResult {
   success: boolean
   banner: string

features/publishing.feature

@@ -15,4 +15,10 @@ Feature: Publishing
     Given a Cucumber implementation that omits some fields
     When Ira publishes a report
     And Ira views the report they just published
-    Then Ira should see their test results
+    Then Ira should see their test results
+
+  Scenario: Report content can be compressed
+    Given a Cucumber implementation that compresses content
+    When Jaqueline publishes a report
+    And Jaqueline views the report they just published
+    Then Jaqueline should see their test results

features/steps/steps.mts

@@ -12,11 +12,16 @@ import { wasDeleted } from '../actions/wasDeleted.mjs'
 import { wasNotFound } from '../actions/wasNotFound.mjs'
 import { navigateToSite } from '../actions/navigateToSite.mjs'
 import { canSeeSample } from '../actions/canSeeSample.mjs'
+import { composeGzipped } from '../actions/composeGzipped.mts'
 
 Given('a Cucumber implementation that omits some fields', async (t) => {
   t.world.messagesFixture = 'messages-omissions.ndjson'
 })
 
+Given('a Cucumber implementation that compresses content', async (t) => {
+  t.world.requestComposer = composeGzipped
+})
+
 Given('{actor} has a private token', async (t, actor: Actor) => {
   actor.remember('privateToken', crypto.randomBytes(16).toString('hex'))
 })
@@ -31,7 +36,7 @@ Given('a report previously published by {actor} has been deleted', async (t, act
 
 When('{actor} publishes a report', async (t, actor: Actor) => {
   const publishResult = await actor.attemptsTo(
-    publishReport(t.world.messagesFixture, actor.recall('privateToken'))
+    publishReport(t.world.messagesFixture, t.world.requestComposer, actor.recall('privateToken'))
   )
   actor.remember('publishResult', publishResult)
   t.world.publishResults.push(publishResult)

features/support/CustomWorld.mts

@@ -1,12 +1,14 @@
 import { Browser, launch } from 'puppeteer'
 import { ActorLookup } from './ActorLookup.mjs'
 import { Actor } from './Actor.mjs'
-import { type PublishResult } from '../actions/types'
+import { type RequestComposer, type PublishResult } from '../actions/types'
+import { composeUncompressed } from '../actions/composeUncompressed.mjs'
 
 export class CustomWorld {
   private readonly actorLookup = new ActorLookup()
   private browser: Browser | undefined
   public messagesFixture = 'messages-valid.ndjson'
+  public requestComposer: RequestComposer = composeUncompressed
   public publishResults: Array<PublishResult> = []
 
   public findOrCreateActor(actorName: string): Actor {