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.

Sign up for GitHub

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

Making Full Node Handle batch RPC Requests #46

Merged
merged 4 commits into from
Mar 20, 2020
Merged

Making Full Node Handle batch RPC Requests #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
837b39a
handling batch rpc requests
willmeister Mar 19, 2020
4d58c8a
test updates
willmeister Mar 19, 2020
50b1051
Merge branch 'master' into YAS-246/BatchJSONRPC
willmeister Mar 19, 2020
e2ceb8d
Adding logic and test to disallow batch requests of batch requests
willmeister Mar 19, 2020
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
116 changes: 73 additions & 43 deletions packages/rollup-full-node/src/app/fullnode-rpc-server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
Logger,
JsonRpcRequest,
JsonRpcErrorResponse,
JsonRpcResponse,
} from '@eth-optimism/core-utils'

/* Internal Imports */
Expand Down Expand Up @@ -49,51 +50,80 @@ export class FullnodeRpcServer extends ExpressHttpServer {
*/
protected initRoutes(): void {
this.app.post('/', async (req, res) => {
let request: JsonRpcRequest
try {
request = req.body
if (!isJsonRpcRequest(request)) {
log.debug(`Received request of unsupported format: [${request}]`)
return res.json(buildJsonRpcError('INVALID_REQUEST', null))
}
return res.json(await this.handleRequest(req))
})
}

const result = await this.fullnodeHandler.handleRequest(
request.method,
request.params
)
return res.json({
id: request.id,
jsonrpc: request.jsonrpc,
result,
})
} catch (err) {
if (err instanceof RevertError) {
log.debug(`Request reverted. Request: ${JSON.stringify(request)}`)
const errorResponse: JsonRpcErrorResponse = buildJsonRpcError(
'REVERT_ERROR',
request.id
)
errorResponse.error.message = err.message
return res.json(errorResponse)
}
if (err instanceof UnsupportedMethodError) {
log.debug(
`Received request with unsupported method: [${JSON.stringify(
request
)}]`
)
return res.json(buildJsonRpcError('METHOD_NOT_FOUND', request.id))
} else if (err instanceof InvalidParametersError) {
log.debug(
`Received request with valid method but invalid parameters: [${JSON.stringify(
request
)}]`
/**
* Handles the provided request, returning the appropriate response object
* @param req The request to handle
* @param inBatchRequest Whether or not this is being called within the context of handling a batch requset
* @returns The JSON-stringifiable response object.
*/
protected async handleRequest(
req: any,
inBatchRequest: boolean = false
): Promise<JsonRpcResponse | JsonRpcResponse[]> {
let request: JsonRpcRequest
try {
request = req.body
if (Array.isArray(request) && !inBatchRequest) {
log.debug(`Received batch request: [${JSON.stringify(request)}]`)
const requestArray: any[] = request as any[]
return Promise.all(
requestArray.map(
(x) =>
this.handleRequest({ body: x }, true) as Promise<JsonRpcResponse>
)
return res.json(buildJsonRpcError('INVALID_PARAMS', request.id))
}
logError(log, `Uncaught exception at endpoint-level`, err)
return res.json(buildJsonRpcError('INTERNAL_ERROR', request.id))
)
}
})

if (!isJsonRpcRequest(request)) {
log.debug(
`Received request of unsupported format: [${JSON.stringify(request)}]`
)
return buildJsonRpcError('INVALID_REQUEST', null)
}

const result = await this.fullnodeHandler.handleRequest(
request.method,
request.params
)
return {
id: request.id,
jsonrpc: request.jsonrpc,
result,
}
} catch (err) {
if (err instanceof RevertError) {
log.debug(`Request reverted. Request: ${JSON.stringify(request)}`)
const errorResponse: JsonRpcErrorResponse = buildJsonRpcError(
'REVERT_ERROR',
request.id
)
errorResponse.error.message = err.message
return errorResponse
}
if (err instanceof UnsupportedMethodError) {
log.debug(
`Received request with unsupported method: [${JSON.stringify(
request
)}]`
)
return buildJsonRpcError('METHOD_NOT_FOUND', request.id)
} else if (err instanceof InvalidParametersError) {
log.debug(
`Received request with valid method but invalid parameters: [${JSON.stringify(
request
)}]`
)
return buildJsonRpcError('INVALID_PARAMS', request.id)
}
logError(log, `Uncaught exception at endpoint-level`, err)
return buildJsonRpcError(
'INTERNAL_ERROR',
request && request.id ? request.id : null
)
}
}
}
181 changes: 128 additions & 53 deletions packages/rollup-full-node/test/app/fullnode-rpc-server.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,31 @@ const request = async (
})
}

const getBadPayloads = () => {
return [
{
jsonrpc: '2.0',
method: defaultSupportedMethods[0],
},
{
id: '1',
jsonrpc: '2.0',
method: defaultSupportedMethods[0],
},
{
id: 1,
method: defaultSupportedMethods[0],
},
{
id: 1,
jsonrpc: 2.0,
method: defaultSupportedMethods[0],
},
{ id: 1, jsonrpc: '2.0' },
{ id: 1, jsonrpc: '2.0', method: unsupportedMethod },
]
}

const host = '0.0.0.0'
const port = 9999

Expand All @@ -77,75 +102,125 @@ describe('FullnodeHandler RPC Server', () => {
}
})

it('should work for valid requests & methods', async () => {
const results: AxiosResponse[] = await Promise.all(
Array.from(defaultSupportedMethods).map((x) =>
request(client, { id: 1, jsonrpc: '2.0', method: x })
describe('single requests', () => {
it('should work for valid requests & methods', async () => {
const results: AxiosResponse[] = await Promise.all(
Array.from(defaultSupportedMethods).map((x) =>
request(client, { id: 1, jsonrpc: '2.0', method: x })
)
)
)

results.forEach((r) => {
r.status.should.equal(200)
results.forEach((r) => {
r.status.should.equal(200)

r.data.should.haveOwnProperty('id')
r.data['id'].should.equal(1)
r.data.should.haveOwnProperty('id')
r.data['id'].should.equal(1)

r.data.should.haveOwnProperty('jsonrpc')
r.data['jsonrpc'].should.equal('2.0')
r.data.should.haveOwnProperty('jsonrpc')
r.data['jsonrpc'].should.equal('2.0')

r.data.should.haveOwnProperty('result')
r.data['result'].should.equal(dummyResponse)
r.data.should.haveOwnProperty('result')
r.data['result'].should.equal(dummyResponse)
})
})
})

it('fails on bad format or method', async () => {
const results: AxiosResponse[] = await Promise.all([
request(client, { jsonrpc: '2.0', method: defaultSupportedMethods[0] }),
request(client, {
id: '1',
jsonrpc: '2.0',
method: defaultSupportedMethods[0],
}),
request(client, { id: 1, method: defaultSupportedMethods[0] }),
request(client, {
id: 1,
jsonrpc: 2.0,
method: defaultSupportedMethods[0],
}),
request(client, { id: 1, jsonrpc: '2.0' }),
request(client, { id: 1, jsonrpc: '2.0', method: unsupportedMethod }),
])
it('fails on bad format or method', async () => {
const results: AxiosResponse[] = await Promise.all(
getBadPayloads().map((x) => request(client, x))
)
results.forEach((r) => {
r.status.should.equal(200)

r.data.should.haveOwnProperty('id')
r.data.should.haveOwnProperty('jsonrpc')
r.data.should.haveOwnProperty('error')

results.forEach((r) => {
r.status.should.equal(200)
r.data['jsonrpc'].should.equal('2.0')
})
})

r.data.should.haveOwnProperty('id')
r.data.should.haveOwnProperty('jsonrpc')
r.data.should.haveOwnProperty('error')
it('reverts properly', async () => {
const result: AxiosResponse = await request(client, {
id: 1,
jsonrpc: '2.0',
method: revertMethod,
})

result.status.should.equal(200)

result.data.should.haveOwnProperty('id')
result.data.should.haveOwnProperty('jsonrpc')
result.data.should.haveOwnProperty('error')
result.data['error'].should.haveOwnProperty('message')
result.data['error'].should.haveOwnProperty('code')
result.data['error']['message'].should.equal(
JSONRPC_ERRORS.REVERT_ERROR.message
)
result.data['error']['code'].should.equal(
JSONRPC_ERRORS.REVERT_ERROR.code
)

r.data['jsonrpc'].should.equal('2.0')
result.data['jsonrpc'].should.equal('2.0')
})
})

it('reverts properly', async () => {
const result: AxiosResponse = await request(client, {
id: 1,
jsonrpc: '2.0',
method: revertMethod,
describe('batch requests', () => {
it('should work for valid requests & methods', async () => {
const batchRequest = Array.from(
defaultSupportedMethods
).map((method, id) => ({ jsonrpc: '2.0', id, method }))
const result: AxiosResponse = await request(client, batchRequest)

result.status.should.equal(200)
const results = result.data

results.forEach((r, id) => {
r.should.haveOwnProperty('id')
r['id'].should.equal(id)

r.should.haveOwnProperty('jsonrpc')
r['jsonrpc'].should.equal('2.0')

r.should.haveOwnProperty('result')
r['result'].should.equal(dummyResponse)
})
})
it('should fail on bad format or for valid requests & methods', async () => {
const result: AxiosResponse = await request(client, getBadPayloads())

result.status.should.equal(200)
result.status.should.equal(200)
const results = result.data

result.data.should.haveOwnProperty('id')
result.data.should.haveOwnProperty('jsonrpc')
result.data.should.haveOwnProperty('error')
result.data['error'].should.haveOwnProperty('message')
result.data['error'].should.haveOwnProperty('code')
result.data['error']['message'].should.equal(
JSONRPC_ERRORS.REVERT_ERROR.message
)
result.data['error']['code'].should.equal(JSONRPC_ERRORS.REVERT_ERROR.code)
results.forEach((r) => {
r.should.haveOwnProperty('id')
r.should.haveOwnProperty('jsonrpc')
r.should.haveOwnProperty('error')

result.data['jsonrpc'].should.equal('2.0')
r['jsonrpc'].should.equal('2.0')
})
})
it('should not allow batches of batches', async () => {
const batchOfBatches = Array.from(
defaultSupportedMethods
).map((method, id) => [{ jsonrpc: '2.0', id, method }])
const result: AxiosResponse = await request(client, batchOfBatches)

result.status.should.equal(200)
const results = result.data

results.forEach((r) => {
r.should.haveOwnProperty('id')
r.should.haveOwnProperty('jsonrpc')
r.should.haveOwnProperty('error')
r['error'].should.haveOwnProperty('message')
r['error'].should.haveOwnProperty('code')
r['error']['message'].should.equal(
JSONRPC_ERRORS.INVALID_REQUEST.message
)
r['error']['code'].should.equal(JSONRPC_ERRORS.INVALID_REQUEST.code)

r['jsonrpc'].should.equal('2.0')
})
})
})
})