Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add batch denylist check #166

Merged
merged 3 commits into from
Jun 27, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions packages/denylist/src/denylist.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,40 @@ export const denylistGet = async function (request, env) {
})
return response
}

/**
* Batch denylist check. POST an Array of cid strings.
* Returns the subset of the Array that are on the deny list.
* @param {import('itty-router').Request} request
* @param {import('./env').Env} env
*/
export async function denylistPost (request, env) {
if (!request.json) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIK this is not undefined if content-type is not json...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah yes, right, i was following the itty-route request type which defines .json as optional, but isn't want i want to test for here. Fixing!

return new Response('Unsupported Media Type', { status: 415 })
}

let checklist
try {
checklist = await request.json()
} catch (err) {
return new Response('Invalid JSON', { status: 400, statusText: 'Bad Request' })
}

if (!Array.isArray(checklist)) {
return new Response('Expected an array', { status: 400, statusText: 'Bad Request' })
}

if (checklist.length > 1000) {
return new Response('Too many items. Max 1000', { status: 400, statusText: 'Bad Request' })
}

const body = []
for (const item of checklist) {
const res = await getFromDenyList(item, env)
if (res) {
body.push(item)
}
}

return new JSONResponse(body)
}
3 changes: 2 additions & 1 deletion packages/denylist/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import { Router } from 'itty-router'

import { denylistGet } from './denylist.js'
import { denylistGet, denylistPost } from './denylist.js'
import { versionGet } from './version.js'

import { addCorsHeaders, withCorsHeaders } from './cors.js'
Expand All @@ -19,6 +19,7 @@ router
.all('*', envAll)
.get('/version', withCorsHeaders(versionGet))
.get('/:cid', withCdnCache(withCorsHeaders(denylistGet)))
.post('/', withCorsHeaders(denylistPost))

/**
* @param {Error} error
Expand Down
40 changes: 40 additions & 0 deletions packages/denylist/test/denylist.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -73,3 +73,43 @@ test('GET / caches response', async (t) => {
})
t.is(res2.status, 200)
})

test('POST / batch', async t => {
const { mf } = t.context
const cid = await createTestCid('CID CACHE TEST')
const denylistKv = await mf.getKVNamespace('DENYLIST')
await denylistKv.put(await toDenyListAnchor(cid), JSON.stringify({ status: 410, reason: 'blocked for testing the cache' }))

const checklist = ['QmSDeYAe9mga6NdTozAZuyGL3Q1XjsLtvX28XFxJH8oPjq', cid]
let res = await mf.dispatchFetch('http://localhost:8787/', {
method: 'POST',
headers: {
'content-type': 'application/json'
},
body: JSON.stringify(checklist)
})
t.is(res.status, 200)
const denylist = await res.json()
t.is(denylist.length, 1)
t.is(denylist[0], cid)

// not really cids, but we're checking that a max length limit is applied here
const tooLong = [...Array(1001).keys()]
res = await mf.dispatchFetch('http://localhost:8787/', {
method: 'POST',
headers: {
'content-type': 'application/json'
},
body: JSON.stringify(tooLong)
})
t.is(res.status, 400)

res = await mf.dispatchFetch('http://localhost:8787/', {
method: 'POST',
headers: {
'content-type': 'application/json'
},
body: JSON.stringify(checklist).slice(0, -1)
})
t.is(res.status, 400)
})