fix: verified-fetch supports HEAD requests (#222)

* test: remove HEAD handling in gwc server

* fix: verified-fetch handles HEAD requests

* fix: set correct contentType for dag-json

* fix: set correct content-length for dag-json

* test: ensure we can skip and run specific tests

* test: update test expectations

NOTE: a lot of removed successful tests, but they are passing when explicitly ran (except the multi-range ones)

* test: dag-json content-type

Author: SgtPooki

.gitignore

@@ -7,3 +7,4 @@ node_modules
 package-lock.json
 yarn.lock
 .vscode
+removed-passing-tests.json

packages/gateway-conformance/src/conformance.spec.ts

@@ -10,6 +10,9 @@ import { GWC_IMAGE } from './constants.js'
 import expectedFailingTests from './expected-failing-tests.json' with { type: 'json' }
 import expectedPassingTests from './expected-passing-tests.json' with { type: 'json' }
 import { getReportDetails } from './get-report-details.js'
+import { getTestsToRun } from './get-tests-to-run.js'
+import { getTestsToSkip } from './get-tests-to-skip.js'
+
 const logger = prefixLogger('gateway-conformance')
 
 function getGatewayConformanceBinaryPath (): string {
@@ -114,7 +117,15 @@ describe('@helia/verified-fetch - gateway conformance', function () {
       const log = logger.forComponent('output:all')
 
       before(async function () {
-        const { stderr, stdout } = await execa(binaryPath, getConformanceTestArgs('all', [], []), { reject: false, cancelSignal: AbortSignal.timeout(200000) })
+        const testsToSkip: string[] = getTestsToSkip()
+        const testsToRun: string[] = getTestsToRun()
+        const cancelSignal = AbortSignal.timeout(200000)
+        const { stderr, stdout } = await execa(binaryPath, getConformanceTestArgs('all', [], [
+          ...(testsToRun.length > 0 ? ['-run', `${testsToRun.join('|')}`] : []),
+          ...(testsToSkip.length > 0 ? ['-skip', `${testsToSkip.join('|')}`] : [])
+        ]), { reject: false, cancelSignal })
+
+        expect(cancelSignal.aborted).to.be.false()
 
         log(stdout)
         log.error(stderr)
@@ -143,7 +154,7 @@ describe('@helia/verified-fetch - gateway conformance', function () {
         })
       }
 
-      const knownSuccessRate = 46.01
+      const knownSuccessRate = 44.14
       it(`has expected success rate of ${knownSuccessRate}%`, () => {
         // check latest success rate with `SUCCESS_RATE=100 npm run test -- -g 'total'`
         const expectedSuccessRate = process.env.SUCCESS_RATE != null ? Number.parseFloat(process.env.SUCCESS_RATE) : knownSuccessRate

packages/gateway-conformance/src/expected-failing-tests.json

@@ -77,11 +77,6 @@ interface CallVerifiedFetchOptions {
 
 async function callVerifiedFetch (req: IncomingMessage, res: Response, { serverPort, useSessions, verifiedFetch }: CallVerifiedFetchOptions): Promise<void> {
   const log = logger('basic-server:request')
-  if (req.method === 'HEAD') {
-    res.writeHead(200)
-    res.end()
-    return
-  }
 
   if (req.url == null) {
     // this should never happen

packages/gateway-conformance/src/expected-passing-tests.json

@@ -0,0 +1,31 @@
+import { getWontFixTests } from './get-wontfix-tests.js'
+
+/**
+ *
+ * You can see output for specific tests with something like
+ *
+ * @example
+ *
+ * ```
+ * DEBUG="gateway-conformance*,gateway-conformance*:trace" RUN_TESTS='TestNativeDag/HEAD_plain_JSON_codec_with_no_explicit_format_returns_HTTP_200.*' npm run test
+ * ```
+ *
+ * If you run `npm run update` and see that some passing tests are removed, you should probably verify that those tests
+ * pass. You can chose to not update `expected-failing-tests.json` and `expected-passing-tests.json` and then choose to
+ * save the removed passing tests to a file to ensure that they do still pass with a command like:
+ *
+ * @example
+ * ```
+ * DEBUG="gateway-conformance*,gateway-conformance*:trace" RUN_TESTS="$(jq -r '.[]' removed-passing-tests.json | paste -sd ',' -)" npm run test
+ * ```
+ */
+export function getTestsToRun (): string[] {
+  const envTestsToRun = process.env.RUN_TESTS != null ? process.env.RUN_TESTS.split(',') : []
+  // by default, we filter out tests that we know we are not going to fix...
+  // set FORCE_RUN=true to run all tests you set in RUN_TESTS (even if they are in the wontfix list)
+  const shouldFilterOutWontFixTests = process.env.FORCE_RUN == null
+  const wontFixTests = getWontFixTests()
+  // TODO: tests to run can be gotest based regex, we need to be smarter about filtering.
+  const testsToRun = shouldFilterOutWontFixTests ? envTestsToRun.filter((test) => !wontFixTests.includes(test)) : envTestsToRun
+  return testsToRun
+}

packages/gateway-conformance/src/fixtures/basic-server.ts

@@ -0,0 +1,17 @@
+import { getWontFixTests } from './get-wontfix-tests.js'
+
+/**
+ *
+ * you can skip certain tests by setting SKIP_TESTS to a comma-separated list of test names
+ *
+ * @example
+ *
+ * ```
+ * SKIP_TESTS='TestNativeDag/HEAD_plain_JSON_codec_with_no_explicit_format_returns_HTTP_200.*' npm run test
+ * ```
+ */
+export function getTestsToSkip (): string[] {
+  const envTestsToSkip = process.env.SKIP_TESTS != null ? process.env.SKIP_TESTS.split(',') : []
+  const testsToSkip = [...getWontFixTests(), ...envTestsToSkip]
+  return testsToSkip
+}

packages/gateway-conformance/src/get-tests-to-run.ts

@@ -0,0 +1,7 @@
+export function getWontFixTests (): string[] {
+  return [
+    // these tests are dependent upon supporting multi-range requests: https://github.com/ipfs/helia-verified-fetch/pull/207
+    'TestNativeDag/Convert_application%2Fvnd.ipld.dag-cbor_to_application%2Fvnd.ipld.dag-json_with_range_request_includes_correct_bytes_-_multi_range/Check_1',
+    'TestNativeDag/Convert_application%2Fvnd.ipld.dag-cbor_to_application%2Fvnd.ipld.dag-json_with_range_request_includes_correct_bytes_-_multi_range'
+  ]
+}

packages/gateway-conformance/src/get-tests-to-skip.ts

@@ -77,6 +77,16 @@ if (failingTestAdditions.length > 0 || passingTestAdditions.length > 0) {
 
   if (!answer) {
     console.log('Aborting.')
+
+    if (passingTestRemovals.length > 0) {
+      // to help with debugging, we can save the removed passing tests to a file to ensure that they do still pass with a command like:
+      // DEBUG="gateway-conformance*,gateway-conformance*:trace" RUN_TESTS="$(jq -r '.[]' removed-passing-tests.json | paste -sd ',' -)" npm run test
+      const shouldSaveRemovedPassingTests = await confirm('Should we save the removed passing tests to removed-passing-tests.json file?')
+      if (shouldSaveRemovedPassingTests) {
+        await writeFile('removed-passing-tests.json', JSON.stringify(passingTestRemovals, null, 2) + '\n')
+      }
+    }
+
     process.exit(0)
   }
   await writeFile(expectedPassingTestsPath, JSON.stringify(passingTests, null, 2) + '\n')

packages/gateway-conformance/src/get-wontfix-tests.ts

@@ -53,10 +53,25 @@ export class JsonPlugin extends BasePlugin {
       body = block
     }
 
+    let contentType: string
+    if (accept == null) {
+      if (ipldDagJson.code === cid.code) {
+        contentType = 'application/vnd.ipld.dag-json'
+      } else {
+        contentType = 'application/json'
+      }
+    } else {
+      contentType = accept.split(';')[0]
+    }
+
     context.byteRangeContext.setBody(body)
 
     const response = okRangeResponse(resource, context.byteRangeContext.getBody(), { byteRangeContext: context.byteRangeContext, log: this.log })
-    response.headers.set('content-type', accept ?? 'application/json')
+    this.log.trace('setting content-type to %s', contentType)
+    response.headers.set('content-type', contentType)
+    if (!context.byteRangeContext.isValidRangeRequest) {
+      response.headers.set('content-length', body.length.toString())
+    }
     return response
   }
 }