Skip to content

Commit

Permalink
fix: gateway conformance tests (#81)
Browse files Browse the repository at this point in the history 
* fix: fixture loading

* fix: bug with parsing certain content

* chore: apply review suggestions

* chore: re-enable 'default' tests but skip ininite looping ones

* fix: default test failure expectation

* chore: expected successes for default tests
  • Loading branch information
@SgtPooki
SgtPooki authored May 16, 2024
1 parent ef5b6a5 commit d0a3b6b
Show file tree
Hide file tree
Showing 9 changed files with 156 additions and 130 deletions.
16 changes: 6 additions & 10 deletions packages/gateway-conformance/.aegir.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,13 @@ export default {
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))
const KUBO_PORT = await getPort(3440)
const { node: controller, gatewayUrl, repoPath } = await createKuboNode(KUBO_PORT)
await controller.start()
const kuboGateway = `http://${controller.api.gatewayHost}:${controller.api.gatewayPort}`
const { loadKuboFixtures } = await import('./dist/src/fixtures/kubo-mgmt.js')
const IPFS_NS_MAP = await loadKuboFixtures(repoPath)
const kuboGateway = gatewayUrl

const { startBasicServer } = await import('./dist/src/fixtures/basic-server.js')
const SERVER_PORT = await getPort(3441)
Expand All @@ -28,7 +27,6 @@ export default {

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',
Expand All @@ -43,13 +41,11 @@ export default {
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
KUBO_GATEWAY: kuboGateway
}
}
},
Expand Down
7 changes: 4 additions & 3 deletions packages/gateway-conformance/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,16 @@
"test": "aegir test -t node"
},
"dependencies": {
"@helia/interface": "^4.3.0",
"@helia/verified-fetch": "1.4.1",
"@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",
"fast-glob": "^3.3.2",
"ipfsd-ctl": "^14.1.0",
"kubo": "^0.27.0",
"kubo-rpc-client": "^3.0.4",
"kubo-rpc-client": "^4.1.1",
"undici": "^6.15.0"
},
"browser": {
Expand Down
93 changes: 57 additions & 36 deletions packages/gateway-conformance/src/conformance.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ interface TestConfig {
}

function getGatewayConformanceBinaryPath (): string {
if (process.env.GATEWAY_CONFORMANCE_BINARY != null) {
return process.env.GATEWAY_CONFORMANCE_BINARY
}
const goPath = process.env.GOPATH ?? join(homedir(), 'go', 'bin')
return join(goPath, 'gateway-conformance')
}
Expand Down Expand Up @@ -56,13 +59,13 @@ const tests: TestConfig[] = [
{
name: 'TestPlainCodec',
run: ['TestPlainCodec'],
maxFailures: 44,
maxFailures: 83,
minimumSuccesses: 15
},
{
name: 'TestPathing',
run: ['TestPathing'],
maxFailures: 5,
maxFailures: 13,
minimumSuccesses: 0
},
{
Expand All @@ -83,12 +86,13 @@ const tests: TestConfig[] = [
maxFailures: 9,
minimumSuccesses: 0
},
{
name: 'TestNativeDag',
run: ['TestNativeDag'],
maxFailures: 2,
minimumSuccesses: 0
},
// currently results in an infinite loop without verified-fetch stopping the request whether sessions are enabled or not.
// {
// name: 'TestNativeDag',
// run: ['TestNativeDag'],
// maxFailures: 2,
// minimumSuccesses: 0
// },
{
name: 'TestGatewayJSONCborAndIPNS',
run: ['TestGatewayJSONCborAndIPNS'],
Expand Down Expand Up @@ -137,12 +141,13 @@ const tests: TestConfig[] = [
maxFailures: 26,
minimumSuccesses: 3
},
{
name: 'TestTrustlessCarEntityBytes',
run: ['TestTrustlessCarEntityBytes'],
maxFailures: 122,
minimumSuccesses: 55
},
// times out
// {
// name: 'TestTrustlessCarEntityBytes',
// run: ['TestTrustlessCarEntityBytes'],
// maxFailures: 122,
// minimumSuccesses: 55
// },
{
name: 'TestTrustlessCarDagScopeAll',
run: ['TestTrustlessCarDagScopeAll'],
Expand Down Expand Up @@ -185,12 +190,13 @@ const tests: TestConfig[] = [
maxFailures: 279,
minimumSuccesses: 0
},
{
name: 'TestUnixFSDirectoryListingOnSubdomainGateway',
run: ['TestUnixFSDirectoryListingOnSubdomainGateway'],
maxFailures: 39,
minimumSuccesses: 0
},
// times out
// {
// name: 'TestUnixFSDirectoryListingOnSubdomainGateway',
// run: ['TestUnixFSDirectoryListingOnSubdomainGateway'],
// maxFailures: 39,
// minimumSuccesses: 0
// },
{
name: 'TestRedirectsFileWithIfNoneMatchHeader',
run: ['TestRedirectsFileWithIfNoneMatchHeader'],
Expand Down Expand Up @@ -233,18 +239,20 @@ const tests: TestConfig[] = [
maxFailures: 27,
minimumSuccesses: 15
},
{
name: 'TestGatewayCache',
run: ['TestGatewayCache'],
maxFailures: 71,
minimumSuccesses: 23
},
{
name: 'TestUnixFSDirectoryListing',
run: ['TestUnixFSDirectoryListing'],
maxFailures: 50,
minimumSuccesses: 0
},
// times out
// {
// name: 'TestGatewayCache',
// run: ['TestGatewayCache'],
// maxFailures: 71,
// minimumSuccesses: 23
// },
// times out
// {
// name: 'TestUnixFSDirectoryListing',
// run: ['TestUnixFSDirectoryListing'],
// maxFailures: 50,
// minimumSuccesses: 0
// },
{
name: 'TestTar',
run: ['TestTar'],
Expand Down Expand Up @@ -298,6 +306,10 @@ describe('@helia/verified-fetch - gateway conformance', function () {
const binaryPath = getGatewayConformanceBinaryPath()
before(async () => {
const log = logger.forComponent('before')
if (process.env.GATEWAY_CONFORMANCE_BINARY != null) {
log('Using custom gateway-conformance binary at %s', binaryPath)
return
}
const { stdout, stderr } = await execa('go', ['install', 'github.com/ipfs/gateway-conformance/cmd/gateway-conformance@latest'], { reject: true })
log(stdout)
log.error(stderr)
Expand Down Expand Up @@ -357,7 +369,16 @@ describe('@helia/verified-fetch - gateway conformance', function () {
it('has expected total failures and successes', async function () {
const log = logger.forComponent('all')

const { stderr, stdout } = await execa(binaryPath, getConformanceTestArgs('all'), { reject: false })
// TODO: unskip when verified-fetch is no longer infinitely looping on requests.
const toSkip = [
'TestNativeDag',
'TestTrustlessCarEntityBytes',
'TestUnixFSDirectoryListingOnSubdomainGateway',
'TestGatewayCache',
'TestUnixFSDirectoryListing'
]

const { stderr, stdout } = await execa(binaryPath, getConformanceTestArgs('all', [], ['-skip', toSkip.join('|')]), { reject: false })

log(stdout)
log.error(stderr)
Expand All @@ -374,9 +395,9 @@ describe('@helia/verified-fetch - gateway conformance', function () {
successCount++
}
}

expect(failureCount).to.be.lessThanOrEqual(135)
expect(successCount).to.be.greaterThanOrEqual(30)
// CI has 1134 failures, but I get 1129 locally.
expect(failureCount).to.be.lessThanOrEqual(1134)
expect(successCount).to.be.greaterThanOrEqual(262)
})
})
})
24 changes: 17 additions & 7 deletions packages/gateway-conformance/src/demo-server.ts
View file
Original file line number Diff line number Diff line change
@@ -1,29 +1,39 @@
/**
* 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 { logger } from '@libp2p/logger'
import getPort from 'aegir/get-port'
import { startBasicServer } from './fixtures/basic-server.js'
import { createKuboNode } from './fixtures/create-kubo.js'
import { loadKuboFixtures } from './fixtures/kubo-mgmt.js'
import { startReverseProxy } from './fixtures/reverse-proxy.js'

const { loadKuboFixtures } = await import('./fixtures/kubo-mgmt.js')
await loadKuboFixtures()
const log = logger('demo-server')

const { createKuboNode } = await import('./fixtures/create-kubo.js')
const controller = await createKuboNode(await getPort(3440))
const { node: controller, gatewayUrl, repoPath } = await createKuboNode(await getPort(3440))

const kuboGateway = gatewayUrl
await controller.start()
const kuboGateway = `http://${controller.api.gatewayHost}:${controller.api.gatewayPort}`
await loadKuboFixtures(repoPath)

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
})

process.on('exit', () => {
controller.stop().catch((err) => {
log.error('Failed to stop controller', err)
process.exit(1)
})
})

export {}
20 changes: 14 additions & 6 deletions packages/gateway-conformance/src/fixtures/basic-server.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,18 @@ export interface BasicServerOptions {

export async function startBasicServer ({ kuboGateway, serverPort }: BasicServerOptions): Promise<() => Promise<void>> {
kuboGateway = kuboGateway ?? process.env.KUBO_GATEWAY
const useSessions = process.env.USE_SESSIONS !== 'false'

log('Starting basic server wrapper for verified-fetch %s', useSessions ? 'with sessions' : 'without sessions')

if (kuboGateway == null) {
throw new Error('options.kuboGateway or KUBO_GATEWAY env var is required')
}

const verifiedFetch = await createVerifiedFetch({
gateways: [kuboGateway],
routers: [kuboGateway]
routers: [],
allowInsecure: true,
allowLocal: true
}, {
contentTypeParser
})
Expand All @@ -42,7 +47,7 @@ export async function startBasicServer ({ kuboGateway, serverPort }: BasicServer
return
}

log('req.headers: %O', req.headers)
log.trace('req.headers: %O', req.headers)
const hostname = req.headers.host?.split(':')[0]
const host = req.headers['x-forwarded-for'] ?? `${hostname}:${serverPort}`

Expand All @@ -56,7 +61,7 @@ export async function startBasicServer ({ kuboGateway, serverPort }: BasicServer
requestController.abort()
})

void verifiedFetch(fullUrlHref, { redirect: 'manual', signal: requestController.signal }).then(async (resp) => {
void verifiedFetch(fullUrlHref, { redirect: 'manual', signal: requestController.signal, session: useSessions, allowInsecure: true, allowLocal: true }).then(async (resp) => {
// loop over headers and set them on the response
const headers: Record<string, string> = {}
for (const [key, value] of resp.headers.entries()) {
Expand All @@ -65,7 +70,8 @@ export async function startBasicServer ({ kuboGateway, serverPort }: BasicServer

res.writeHead(resp.status, headers)
if (resp.body == null) {
res.write(await resp.arrayBuffer())
// need to convert ArrayBuffer to Buffer or Uint8Array
res.write(Buffer.from(await resp.arrayBuffer()))
} else {
// read the body of the response and write it to the response from the server
const reader = resp.body.getReader()
Expand All @@ -74,12 +80,14 @@ export async function startBasicServer ({ kuboGateway, serverPort }: BasicServer
if (done) {
break
}
log('typeof value: %s', typeof value)

res.write(Buffer.from(value))
}
}
res.end()
}).catch((e) => {
log.error('Problem with request: %s', e.message)
log.error('Problem with request: %s', e.message, e)
if (!res.headersSent) {
res.writeHead(500)
}
Expand Down
7 changes: 7 additions & 0 deletions packages/gateway-conformance/src/fixtures/content-type-parser.ts
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,26 @@
import { logger } from '@libp2p/logger'
import { fileTypeFromBuffer } from '@sgtpooki/file-type'

const log = logger('content-type-parser')

// 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 {
log('checking for svg')
return /^(<\?xml[^>]+>)?[^<^\w]+<svg/ig.test(
new TextDecoder().decode(bytes.slice(0, 64)))
? 'image/svg+xml'
: defaultMimeType
}

export async function contentTypeParser (bytes: Uint8Array, fileName?: string): Promise<string> {
log('contentTypeParser called for fileName: %s', fileName)
const detectedType = (await fileTypeFromBuffer(bytes))?.mime
if (detectedType != null) {
log('detectedType: %s', detectedType)
return detectedType
}
log('no detectedType')

if (fileName == null) {
// no other way to determine file-type.
Expand Down
Loading

0 comments on commit d0a3b6b

Please sign in to comment.