diff --git a/.github/workflows/gateway-conformance.yml b/.github/workflows/gateway-conformance.yml
new file mode 100644
index 0000000..8d2f9fe
--- /dev/null
+++ b/.github/workflows/gateway-conformance.yml
@@ -0,0 +1,82 @@
+name: Gateway Conformance
+
+on:
+ push:
+ branches:
+ - main
+ pull_request:
+ workflow_dispatch:
+
+jobs:
+ gateway-conformance:
+ runs-on: ubuntu-latest
+ steps:
+ # 1, Setup Node, install npm dependencies, and build all packages/*
+ # see https://github.com/ipdxco/unified-github-workflows/blob/3a1a7870ce5967163d8f5c8210b8ad50b2e659aa/.github/workflows/js-test-and-release.yml#L28-L34
+ - uses: actions/checkout@v4
+ - uses: actions/setup-node@v4
+ with:
+ node-version: lts/*
+ - uses: ipfs/aegir/actions/cache-node-modules@master
+
+ # 2. Set up 'go' so we can install the gateway-conformance binary
+ - name: Setup Go
+ uses: actions/setup-go@v4
+ with:
+ go-version: 1.21.x
+
+ # 3. Download the gateway-conformance fixtures using ipfs/gateway-conformance action
+ # This will prevent us from needing to install `docker` on the github runner
+ - name: Download gateway-conformance fixtures
+ uses: ipfs/gateway-conformance/.github/actions/extract-fixtures@v0.5.1
+ # working-directory: ./packages/gateway-conformance
+ with:
+ output: ./packages/gateway-conformance/dist/src/fixtures/data/gateway-conformance-fixtures
+
+
+ # 4. Run the tests
+ - name: Run gateway-conformance tests
+ run: |
+ npm run test
+ working-directory: ./packages/gateway-conformance
+
+ # 5. Convert json output to reports similar to how it's done at https://github.com/ipfs/gateway-conformance/blob/main/.github/actions/test/action.yml
+ # the 'gwc-report-all.json' file is created by the 'has expected total failures and successes' test
+ # TODO: remove this when we're passing enough tests to use the 'ipfs/gateway-conformance/.github/actions/test' action
+ - name: Create the XML
+ if: failure() || success()
+ uses: pl-strflt/gotest-json-to-junit-xml@v1
+ with:
+ input: ./packages/gateway-conformance/gwc-report-all.json
+ output: ./packages/gateway-conformance/gwc-report-all.xml
+ - name: Create the HTML
+ if: failure() || success()
+ uses: pl-strflt/junit-xml-to-html@v1
+ with:
+ mode: no-frames
+ input: ./packages/gateway-conformance/gwc-report-all.xml
+ output: ./packages/gateway-conformance/gwc-report-all.html
+ - name: Create the Markdown
+ if: failure() || success()
+ uses: pl-strflt/junit-xml-to-html@v1
+ with:
+ mode: summary
+ input: ./packages/gateway-conformance/gwc-report-all.xml
+ output: ./packages/gateway-conformance/gwc-report-all.md
+
+ # 6. Upload the reports
+ - name: Upload MD summary
+ if: failure() || success()
+ run: cat ./packages/gateway-conformance/gwc-report-all.md >> $GITHUB_STEP_SUMMARY
+ - name: Upload HTML report
+ if: failure() || success()
+ uses: actions/upload-artifact@v4
+ with:
+ name: gateway-conformance.html
+ path: ./packages/gateway-conformance/gwc-report-all.html
+ - name: Upload JSON report
+ if: failure() || success()
+ uses: actions/upload-artifact@v4
+ with:
+ name: gateway-conformance.json
+ path: ./packages/gateway-conformance/gwc-report-all.json
diff --git a/packages/gateway-conformance/.aegir.js b/packages/gateway-conformance/.aegir.js
new file mode 100644
index 0000000..db26866
--- /dev/null
+++ b/packages/gateway-conformance/.aegir.js
@@ -0,0 +1,65 @@
+// @ts-check
+import getPort from 'aegir/get-port'
+
+/** @type {import('aegir').PartialOptions} */
+export default {
+ test: {
+ files: ['./dist/src/*.spec.js'],
+ before: async (options) => {
+ if (options.runner !== 'node') {
+ throw new Error('Only node runner is supported')
+ }
+
+ const { GWC_IMAGE } = await import('./dist/src/constants.js')
+ const { loadKuboFixtures, kuboRepoDir } = await import('./dist/src/fixtures/kubo-mgmt.js')
+ const IPFS_NS_MAP = await loadKuboFixtures()
+
+ const { createKuboNode } = await import('./dist/src/fixtures/create-kubo.js')
+ const controller = await createKuboNode(await getPort(3440))
+ await controller.start()
+ const kuboGateway = `http://${controller.api.gatewayHost}:${controller.api.gatewayPort}`
+
+ const { startBasicServer } = await import('./dist/src/fixtures/basic-server.js')
+ const SERVER_PORT = await getPort(3441)
+ const stopBasicServer = await startBasicServer({
+ serverPort: SERVER_PORT,
+ kuboGateway
+ })
+
+ const { startReverseProxy } = await import('./dist/src/fixtures/reverse-proxy.js')
+ const PROXY_PORT = await getPort(3442)
+ const KUBO_PORT = controller.api.gatewayPort
+ const stopReverseProxy = await startReverseProxy({
+ backendPort: SERVER_PORT,
+ targetHost: 'localhost',
+ proxyPort: PROXY_PORT
+ })
+
+ const CONFORMANCE_HOST = 'localhost'
+
+ return {
+ controller,
+ stopReverseProxy,
+ stopBasicServer,
+ env: {
+ IPFS_NS_MAP,
+ GWC_IMAGE,
+ CONFORMANCE_HOST,
+ KUBO_PORT: `${KUBO_PORT}`,
+ PROXY_PORT: `${PROXY_PORT}`,
+ SERVER_PORT: `${SERVER_PORT}`,
+ KUBO_GATEWAY: kuboGateway,
+ KUBO_REPO: process.env.KUBO_REPO || kuboRepoDir
+ }
+ }
+ },
+ after: async (options, beforeResult) => {
+ // @ts-expect-error - broken aegir types
+ await beforeResult.stopReverseProxy()
+ // @ts-expect-error - broken aegir types
+ await beforeResult.stopBasicServer()
+ // @ts-expect-error - broken aegir types
+ await beforeResult.controller.stop()
+ }
+ }
+}
diff --git a/packages/gateway-conformance/.gitignore b/packages/gateway-conformance/.gitignore
new file mode 100644
index 0000000..b730535
--- /dev/null
+++ b/packages/gateway-conformance/.gitignore
@@ -0,0 +1 @@
+gwc-report*.json
diff --git a/packages/gateway-conformance/CHANGELOG.md b/packages/gateway-conformance/CHANGELOG.md
new file mode 100644
index 0000000..e69de29
diff --git a/packages/gateway-conformance/LICENSE b/packages/gateway-conformance/LICENSE
new file mode 100644
index 0000000..20ce483
--- /dev/null
+++ b/packages/gateway-conformance/LICENSE
@@ -0,0 +1,4 @@
+This project is dual licensed under MIT and Apache-2.0.
+
+MIT: https://www.opensource.org/licenses/mit
+Apache-2.0: https://www.apache.org/licenses/license-2.0
diff --git a/packages/gateway-conformance/LICENSE-APACHE b/packages/gateway-conformance/LICENSE-APACHE
new file mode 100644
index 0000000..14478a3
--- /dev/null
+++ b/packages/gateway-conformance/LICENSE-APACHE
@@ -0,0 +1,5 @@
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
diff --git a/packages/gateway-conformance/LICENSE-MIT b/packages/gateway-conformance/LICENSE-MIT
new file mode 100644
index 0000000..72dc60d
--- /dev/null
+++ b/packages/gateway-conformance/LICENSE-MIT
@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/packages/gateway-conformance/README.md b/packages/gateway-conformance/README.md
new file mode 100644
index 0000000..8829da5
--- /dev/null
+++ b/packages/gateway-conformance/README.md
@@ -0,0 +1,58 @@
+
+
+ 
+
+
+
+# @helia/verified-fetch-gateway-conformance
+
+[](https://ipfs.tech)
+[](https://discuss.ipfs.tech)
+[](https://codecov.io/gh/ipfs/helia-verified-fetch)
+[](https://github.com/ipfs/helia-verified-fetch/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
+
+> [Gateway Conformance](https://github.com/ipfs/gateway-conformance) tests for @helia/verified-fetch
+
+# About
+
+Runs Gateway Conformance tests against @helia/verified-fetch using Kubo as a backing trustless-gateway.
+
+## Example - Testing a new Kubo release
+
+```console
+$ npm i @helia/verified-fetch-gateway-conformance
+$ KUBO_BINARY=/path/to/kubo verified-fetch-gateway-conformance
+```
+
+# Install
+
+```console
+$ npm i @helia/verified-fetch-gateway-conformance
+```
+
+## Browser `
+```
+
+# License
+
+Licensed under either of
+
+- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )
+- MIT ([LICENSE-MIT](LICENSE-MIT) / )
+
+# Contribute
+
+Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia-verified-fetch/issues).
+
+Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
+
+Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
+
+[](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
diff --git a/packages/gateway-conformance/package.json b/packages/gateway-conformance/package.json
new file mode 100644
index 0000000..a0f9b28
--- /dev/null
+++ b/packages/gateway-conformance/package.json
@@ -0,0 +1,70 @@
+{
+ "name": "@helia/verified-fetch-gateway-conformance",
+ "version": "1.20.0",
+ "description": "Gateway conformance tests for @helia/verified-fetch",
+ "license": "Apache-2.0 OR MIT",
+ "homepage": "https://github.com/ipfs/helia-verified-fetch/tree/main/packages/gateway-conformance#readme",
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/ipfs/helia-verified-fetch.git"
+ },
+ "bugs": {
+ "url": "https://github.com/ipfs/helia-verified-fetch/issues"
+ },
+ "publishConfig": {
+ "access": "public",
+ "provenance": true
+ },
+ "keywords": [
+ "IPFS"
+ ],
+ "bin": {
+ "demo-server": "./dist/src/demo-server.js",
+ "verified-fetch-gateway-conformance": "./dist/src/bin.js"
+ },
+ "type": "module",
+ "types": "./dist/src/index.d.ts",
+ "files": [
+ "src",
+ "dist",
+ "!dist/test",
+ "!**/*.tsbuildinfo"
+ ],
+ "exports": {
+ ".": {
+ "types": "./dist/src/index.d.ts",
+ "import": "./dist/src/index.js"
+ }
+ },
+ "eslintConfig": {
+ "extends": "ipfs",
+ "parserOptions": {
+ "project": true,
+ "sourceType": "module"
+ }
+ },
+ "scripts": {
+ "clean": "aegir clean dist gwc-report-*.json",
+ "lint": "aegir lint",
+ "dep-check": "aegir dep-check",
+ "doc-check": "aegir doc-check",
+ "build": "aegir build",
+ "test": "aegir test -t node"
+ },
+ "dependencies": {
+ "@helia/verified-fetch": "1.3.13",
+ "@libp2p/logger": "^4.0.11",
+ "@sgtpooki/file-type": "^1.0.1",
+ "aegir": "^42.2.5",
+ "execa": "^8.0.1",
+ "glob": "^10.3.12",
+ "ipfsd-ctl": "^13.0.0",
+ "kubo": "^0.27.0",
+ "kubo-rpc-client": "^3.0.4",
+ "undici": "^6.15.0"
+ },
+ "browser": {
+ "./dist/src/fixtures/create-kubo.js": "./dist/src/fixtures/create-kubo.browser.js",
+ "kubo": false
+ }
+}
diff --git a/packages/gateway-conformance/src/bin.ts b/packages/gateway-conformance/src/bin.ts
new file mode 100644
index 0000000..d43e878
--- /dev/null
+++ b/packages/gateway-conformance/src/bin.ts
@@ -0,0 +1,25 @@
+#! /usr/bin/env node
+/* eslint-disable no-console */
+
+import { spawn } from 'node:child_process'
+import { dirname, resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+// aegir should be run from `node_modules/@helia/verified-fetch-gateway-conformance`
+const cwd = resolve(dirname(fileURLToPath(import.meta.url)), '../../')
+
+const test = spawn('npx', ['aegir', 'test'], {
+ cwd
+})
+
+test.stdout.on('data', (data) => {
+ process.stdout.write(data)
+})
+
+test.stderr.on('data', (data) => {
+ process.stderr.write(data)
+})
+
+test.on('close', (code) => {
+ process.exit(code ?? 0)
+})
diff --git a/packages/gateway-conformance/src/conformance.spec.ts b/packages/gateway-conformance/src/conformance.spec.ts
new file mode 100644
index 0000000..9e8d4d1
--- /dev/null
+++ b/packages/gateway-conformance/src/conformance.spec.ts
@@ -0,0 +1,382 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-env mocha */
+import { readFile } from 'node:fs/promises'
+import { homedir } from 'node:os'
+import { join } from 'node:path'
+import { prefixLogger } from '@libp2p/logger'
+import { expect } from 'aegir/chai'
+import { execa } from 'execa'
+import { Agent, setGlobalDispatcher } from 'undici'
+
+const logger = prefixLogger('conformance-tests')
+
+interface TestConfig {
+ name: string
+ spec?: string
+ skip?: string[]
+ run?: string[]
+ maxFailures: number
+ minimumSuccesses?: number
+}
+
+function getGatewayConformanceBinaryPath (): string {
+ const goPath = process.env.GOPATH ?? join(homedir(), 'go', 'bin')
+ return join(goPath, 'gateway-conformance')
+}
+
+function getConformanceTestArgs (name: string, gwcArgs: string[] = [], goTestArgs: string[] = []): string[] {
+ return [
+ 'test',
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ `--gateway-url=http://${process.env.CONFORMANCE_HOST!}:${process.env.PROXY_PORT!}`,
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ `--subdomain-url=http://${process.env.CONFORMANCE_HOST!}:${process.env.PROXY_PORT!}`,
+ '--verbose',
+ '--json', `gwc-report-${name}.json`,
+ ...gwcArgs,
+ '--',
+ '-timeout', '5m',
+ ...goTestArgs
+ ]
+}
+
+const tests: TestConfig[] = [
+ {
+ name: 'TestMetadata',
+ run: ['TestMetadata'],
+ maxFailures: 0,
+ minimumSuccesses: 1
+ },
+ {
+ name: 'TestDagPbConversion',
+ run: ['TestDagPbConversion'],
+ maxFailures: 51,
+ minimumSuccesses: 14
+ },
+ {
+ name: 'TestPlainCodec',
+ run: ['TestPlainCodec'],
+ maxFailures: 44,
+ minimumSuccesses: 15
+ },
+ {
+ name: 'TestPathing',
+ run: ['TestPathing'],
+ maxFailures: 5,
+ minimumSuccesses: 0
+ },
+ {
+ name: 'TestDNSLinkGatewayUnixFSDirectoryListing',
+ run: ['TestDNSLinkGatewayUnixFSDirectoryListing'],
+ maxFailures: 20,
+ minimumSuccesses: 0
+ },
+ {
+ name: 'TestCors',
+ run: ['TestCors'],
+ maxFailures: 11,
+ minimumSuccesses: 0
+ },
+ {
+ name: 'TestGatewayJsonCbor',
+ run: ['TestGatewayJsonCbor'],
+ maxFailures: 9,
+ minimumSuccesses: 0
+ },
+ {
+ name: 'TestNativeDag',
+ run: ['TestNativeDag'],
+ maxFailures: 2,
+ minimumSuccesses: 0
+ },
+ {
+ name: 'TestGatewayJSONCborAndIPNS',
+ run: ['TestGatewayJSONCborAndIPNS'],
+ maxFailures: 25,
+ minimumSuccesses: 8
+ },
+ {
+ name: 'TestGatewayIPNSPath',
+ run: ['TestGatewayIPNSPath'],
+ maxFailures: 8,
+ minimumSuccesses: 3
+ },
+ {
+ name: 'TestRedirectCanonicalIPNS',
+ run: ['TestRedirectCanonicalIPNS'],
+ maxFailures: 7,
+ minimumSuccesses: 0
+ },
+ {
+ name: 'TestGatewayBlock',
+ run: ['TestGatewayBlock'],
+ maxFailures: 25,
+ minimumSuccesses: 4
+ },
+ {
+ name: 'TestTrustlessRawRanges',
+ run: ['TestTrustlessRawRanges'],
+ maxFailures: 5,
+ minimumSuccesses: 7
+ },
+ {
+ name: 'TestTrustlessRaw',
+ run: ['TestTrustlessRaw'],
+ maxFailures: 29,
+ minimumSuccesses: 7
+ },
+ {
+ name: 'TestGatewayIPNSRecord',
+ run: ['TestGatewayIPNSRecord'],
+ maxFailures: 23,
+ minimumSuccesses: 0
+ },
+ {
+ name: 'TestTrustlessCarOrderAndDuplicates',
+ run: ['TestTrustlessCarOrderAndDuplicates'],
+ maxFailures: 26,
+ minimumSuccesses: 3
+ },
+ {
+ name: 'TestTrustlessCarEntityBytes',
+ run: ['TestTrustlessCarEntityBytes'],
+ maxFailures: 122,
+ minimumSuccesses: 55
+ },
+ {
+ name: 'TestTrustlessCarDagScopeAll',
+ run: ['TestTrustlessCarDagScopeAll'],
+ maxFailures: 23,
+ minimumSuccesses: 10
+ },
+ {
+ name: 'TestTrustlessCarDagScopeEntity',
+ run: ['TestTrustlessCarDagScopeEntity'],
+ maxFailures: 56,
+ minimumSuccesses: 25
+ },
+ {
+ name: 'TestTrustlessCarDagScopeBlock',
+ run: ['TestTrustlessCarDagScopeBlock'],
+ maxFailures: 34,
+ minimumSuccesses: 15
+ },
+ {
+ name: 'TestTrustlessCarPathing',
+ run: ['TestTrustlessCarPathing'],
+ maxFailures: 45,
+ minimumSuccesses: 20
+ },
+ {
+ name: 'TestSubdomainGatewayDNSLinkInlining',
+ run: ['TestSubdomainGatewayDNSLinkInlining'],
+ maxFailures: 41,
+ minimumSuccesses: 0
+ },
+ {
+ name: 'TestGatewaySubdomainAndIPNS',
+ run: ['TestGatewaySubdomainAndIPNS'],
+ maxFailures: 95,
+ minimumSuccesses: 0
+ },
+ {
+ name: 'TestGatewaySubdomains',
+ run: ['TestGatewaySubdomains'],
+ maxFailures: 279,
+ minimumSuccesses: 0
+ },
+ {
+ name: 'TestUnixFSDirectoryListingOnSubdomainGateway',
+ run: ['TestUnixFSDirectoryListingOnSubdomainGateway'],
+ maxFailures: 39,
+ minimumSuccesses: 0
+ },
+ {
+ name: 'TestRedirectsFileWithIfNoneMatchHeader',
+ run: ['TestRedirectsFileWithIfNoneMatchHeader'],
+ maxFailures: 15,
+ minimumSuccesses: 0
+ },
+ {
+ name: 'TestRedirectsFileSupportWithDNSLink',
+ run: ['TestRedirectsFileSupportWithDNSLink'],
+ maxFailures: 17,
+ minimumSuccesses: 6
+ },
+ {
+ name: 'TestRedirectsFileSupport',
+ run: ['TestRedirectsFileSupport'],
+ maxFailures: 252,
+ minimumSuccesses: 6
+ },
+ {
+ name: 'TestPathGatewayMiscellaneous',
+ run: ['TestPathGatewayMiscellaneous'],
+ maxFailures: 3,
+ minimumSuccesses: 0
+ },
+ {
+ name: 'TestGatewayUnixFSFileRanges',
+ run: ['TestGatewayUnixFSFileRanges'],
+ maxFailures: 10,
+ minimumSuccesses: 5
+ },
+ {
+ name: 'TestGatewaySymlink',
+ run: ['TestGatewaySymlink'],
+ maxFailures: 9,
+ minimumSuccesses: 0
+ },
+ {
+ name: 'TestGatewayCacheWithIPNS',
+ run: ['TestGatewayCacheWithIPNS'],
+ maxFailures: 27,
+ minimumSuccesses: 15
+ },
+ {
+ name: 'TestGatewayCache',
+ run: ['TestGatewayCache'],
+ maxFailures: 71,
+ minimumSuccesses: 23
+ },
+ {
+ name: 'TestUnixFSDirectoryListing',
+ run: ['TestUnixFSDirectoryListing'],
+ maxFailures: 50,
+ minimumSuccesses: 0
+ },
+ {
+ name: 'TestTar',
+ run: ['TestTar'],
+ maxFailures: 16,
+ minimumSuccesses: 8
+ }
+]
+
+describe('@helia/verified-fetch - gateway conformance', function () {
+ before(async () => {
+ if (process.env.KUBO_GATEWAY == null) {
+ throw new Error('KUBO_GATEWAY env var is required')
+ }
+ if (process.env.PROXY_PORT == null) {
+ throw new Error('PROXY_PORT env var is required')
+ }
+ if (process.env.SERVER_PORT == null) {
+ throw new Error('SERVER_PORT env var is required')
+ }
+ if (process.env.CONFORMANCE_HOST == null) {
+ throw new Error('CONFORMANCE_HOST env var is required')
+ }
+ // see https://stackoverflow.com/questions/71074255/use-custom-dns-resolver-for-any-request-in-nodejs
+ // EVERY undici/fetch request host resolves to local IP. Node.js does not resolve reverse-proxy requests properly
+ const staticDnsAgent = new Agent({
+ connect: {
+ lookup: (_hostname, _options, callback) => { callback(null, [{ address: '0.0.0.0', family: 4 }]) }
+ }
+ })
+ setGlobalDispatcher(staticDnsAgent)
+ })
+
+ describe('smokeTests', () => {
+ [
+ ['basic server path request works', `http://localhost:${process.env.SERVER_PORT}/ipfs/bafkqabtimvwgy3yk`],
+ ['proxy server path request works', `http://localhost:${process.env.PROXY_PORT}/ipfs/bafkqabtimvwgy3yk`],
+ ['basic server subdomain request works', `http://bafkqabtimvwgy3yk.ipfs.localhost:${process.env.SERVER_PORT}`],
+ ['proxy server subdomain request works', `http://bafkqabtimvwgy3yk.ipfs.localhost:${process.env.PROXY_PORT}`]
+ ].forEach(([name, url]) => {
+ it(name, async () => {
+ const resp = await fetch(url)
+ expect(resp).to.be.ok()
+ expect(resp.status).to.equal(200)
+ const text = await resp.text()
+ expect(text.trim()).to.equal('hello')
+ })
+ })
+ })
+
+ describe('conformance testing', () => {
+ const binaryPath = getGatewayConformanceBinaryPath()
+ before(async () => {
+ const log = logger.forComponent('before')
+ const { stdout, stderr } = await execa('go', ['install', 'github.com/ipfs/gateway-conformance/cmd/gateway-conformance@latest'], { reject: true })
+ log(stdout)
+ log.error(stderr)
+ })
+
+ after(async () => {
+ const log = logger.forComponent('after')
+ try {
+ await execa('rm', [binaryPath])
+ log('gateway-conformance binary successfully uninstalled.')
+ } catch (error) {
+ log.error(`Error removing "${binaryPath}"`, error)
+ }
+ })
+
+ tests.forEach(({ name, spec, skip, run, maxFailures, minimumSuccesses }) => {
+ const log = logger.forComponent(name)
+
+ it(`has no more than ${maxFailures} failing tests for ${name}`, async function () {
+ const { stderr, stdout } = await execa(binaryPath, getConformanceTestArgs(name,
+ [
+ ...(spec != null ? ['--specs', spec] : [])
+ ],
+ [
+ ...((skip != null) ? ['-skip', `${skip.join('|')}`] : []),
+ ...((run != null) ? ['-run', `${run.join('|')}`] : [])
+ ]
+ ), { reject: false })
+
+ log(stdout)
+ log.error(stderr)
+
+ let failureCount = 0
+ let successCount = 0
+
+ // parse the newline delimited JSON report at gwc-report-${name}.json and count the number of "PASS:" and "FAIL:" lines
+ const report = await readFile(`gwc-report-${name}.json`, 'utf8')
+ const lines = report.split('\n')
+ for (const line of lines) {
+ if (line.includes('--- FAIL:')) {
+ failureCount++
+ } else if (line.includes('--- PASS:')) {
+ successCount++
+ }
+ }
+
+ expect(failureCount).to.be.lessThanOrEqual(maxFailures)
+ expect(successCount).to.be.greaterThanOrEqual(minimumSuccesses ?? 0)
+ })
+ })
+
+ /**
+ * This test ensures new or existing gateway-conformance tests that fail are caught and addressed appropriately.
+ * Eventually, we will not need the `tests.forEach` tests and can just run all the recommended tests directly,
+ * as this test does.
+ */
+ it('has expected total failures and successes', async function () {
+ const log = logger.forComponent('all')
+
+ const { stderr, stdout } = await execa(binaryPath, getConformanceTestArgs('all'), { reject: false })
+
+ log(stdout)
+ log.error(stderr)
+ let failureCount = 0
+ let successCount = 0
+
+ // parse the newline delimited JSON report at gwc-report-${name}.json and count the number of "PASS:" and "FAIL:" lines
+ const report = await readFile('gwc-report-all.json', 'utf8')
+ const lines = report.split('\n')
+ for (const line of lines) {
+ if (line.includes('--- FAIL:')) {
+ failureCount++
+ } else if (line.includes('--- PASS:')) {
+ successCount++
+ }
+ }
+
+ expect(failureCount).to.be.lessThanOrEqual(135)
+ expect(successCount).to.be.greaterThanOrEqual(30)
+ })
+ })
+})
diff --git a/packages/gateway-conformance/src/constants.ts b/packages/gateway-conformance/src/constants.ts
new file mode 100644
index 0000000..2ebdd15
--- /dev/null
+++ b/packages/gateway-conformance/src/constants.ts
@@ -0,0 +1 @@
+export const GWC_IMAGE = process.env.GWC_IMAGE ?? 'ghcr.io/ipfs/gateway-conformance:v0.5.1'
diff --git a/packages/gateway-conformance/src/demo-server.ts b/packages/gateway-conformance/src/demo-server.ts
new file mode 100644
index 0000000..db78191
--- /dev/null
+++ b/packages/gateway-conformance/src/demo-server.ts
@@ -0,0 +1,29 @@
+/**
+ * Basically copies what .aegir.js does, but without all the env vars and setup.. just so you can run `node src/demo-server.ts` and test queries manually.
+ */
+import getPort from 'aegir/get-port'
+
+const { loadKuboFixtures } = await import('./fixtures/kubo-mgmt.js')
+await loadKuboFixtures()
+
+const { createKuboNode } = await import('./fixtures/create-kubo.js')
+const controller = await createKuboNode(await getPort(3440))
+await controller.start()
+const kuboGateway = `http://${controller.api.gatewayHost}:${controller.api.gatewayPort}`
+
+const { startBasicServer } = await import('./fixtures/basic-server.js')
+const SERVER_PORT = await getPort(3441)
+await startBasicServer({
+ serverPort: SERVER_PORT,
+ kuboGateway
+})
+
+const { startReverseProxy } = await import('./fixtures/reverse-proxy.js')
+const PROXY_PORT = await getPort(3442)
+await startReverseProxy({
+ backendPort: SERVER_PORT,
+ targetHost: 'localhost',
+ proxyPort: PROXY_PORT
+})
+
+export {}
diff --git a/packages/gateway-conformance/src/fixtures/basic-server.ts b/packages/gateway-conformance/src/fixtures/basic-server.ts
new file mode 100644
index 0000000..210597a
--- /dev/null
+++ b/packages/gateway-conformance/src/fixtures/basic-server.ts
@@ -0,0 +1,107 @@
+import { createServer } from 'node:http'
+import { logger } from '@libp2p/logger'
+import { contentTypeParser } from './content-type-parser.js'
+import { createVerifiedFetch } from './create-verified-fetch.js'
+
+const log = logger('basic-server')
+/**
+ * Create a basic server with native Node.js HTTP server that simply calls verifiedFetch and returns the response.
+ *
+ * This server needs to be wrapped by reverse-proxy to work for the gateway conformance tests.
+ */
+
+export interface BasicServerOptions {
+ kuboGateway?: string
+ serverPort: number
+}
+
+export async function startBasicServer ({ kuboGateway, serverPort }: BasicServerOptions): Promise<() => Promise> {
+ kuboGateway = kuboGateway ?? process.env.KUBO_GATEWAY
+ if (kuboGateway == null) {
+ throw new Error('options.kuboGateway or KUBO_GATEWAY env var is required')
+ }
+
+ const verifiedFetch = await createVerifiedFetch({
+ gateways: [kuboGateway],
+ routers: [kuboGateway]
+ }, {
+ contentTypeParser
+ })
+
+ const server = createServer((req, res) => {
+ if (req.method === 'OPTIONS') {
+ res.writeHead(200)
+ res.end()
+ return
+ }
+
+ if (req.url == null) {
+ // this should never happen
+ res.writeHead(400)
+ res.end('Bad Request')
+ return
+ }
+
+ log('req.headers: %O', req.headers)
+ const hostname = req.headers.host?.split(':')[0]
+ const host = req.headers['x-forwarded-for'] ?? `${hostname}:${serverPort}`
+
+ const fullUrlHref = req.headers.referer ?? `http://${host}${req.url}`
+ log('fetching %s', fullUrlHref)
+
+ const requestController = new AbortController()
+ // we need to abort the request if the client disconnects
+ req.on('close', () => {
+ log('client disconnected, aborting request')
+ requestController.abort()
+ })
+
+ void verifiedFetch(fullUrlHref, { redirect: 'manual', signal: requestController.signal }).then(async (resp) => {
+ // loop over headers and set them on the response
+ const headers: Record = {}
+ for (const [key, value] of resp.headers.entries()) {
+ headers[key] = value
+ }
+
+ res.writeHead(resp.status, headers)
+ if (resp.body == null) {
+ res.write(await resp.arrayBuffer())
+ } else {
+ // read the body of the response and write it to the response from the server
+ const reader = resp.body.getReader()
+ while (true) {
+ const { done, value } = await reader.read()
+ if (done) {
+ break
+ }
+ res.write(Buffer.from(value))
+ }
+ }
+ res.end()
+ }).catch((e) => {
+ log.error('Problem with request: %s', e.message)
+ if (!res.headersSent) {
+ res.writeHead(500)
+ }
+ res.end(`Internal Server Error: ${e.message}`)
+ }).finally(() => {
+ requestController.abort()
+ })
+ })
+
+ server.listen(serverPort, () => {
+ log(`Basic server listening on port ${serverPort}`)
+ })
+
+ return async () => {
+ await new Promise((resolve, reject) => {
+ server.close((err: any) => {
+ if (err != null) {
+ reject(err)
+ } else {
+ resolve()
+ }
+ })
+ })
+ }
+}
diff --git a/packages/gateway-conformance/src/fixtures/content-type-parser.ts b/packages/gateway-conformance/src/fixtures/content-type-parser.ts
new file mode 100644
index 0000000..76f2247
--- /dev/null
+++ b/packages/gateway-conformance/src/fixtures/content-type-parser.ts
@@ -0,0 +1,53 @@
+import { fileTypeFromBuffer } from '@sgtpooki/file-type'
+
+// default from verified-fetch is application/octect-stream, which forces a download. This is not what we want for MANY file types.
+const defaultMimeType = 'text/html; charset=utf-8'
+function checkForSvg (bytes: Uint8Array): string {
+ return /^(<\?xml[^>]+>)?[^<^\w]+