diff --git a/package-lock.json b/package-lock.json index a5bd379..5e61a2d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -13565,6 +13565,45 @@ "ms": "2.1.2" } }, + "engine.io": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/engine.io/-/engine.io-4.1.1.tgz", + "integrity": "sha512-t2E9wLlssQjGw0nluF6aYyfX8LwYU8Jj0xct+pAhfWfv/YrBn6TSNtEYsgxHIfaMqfrLx07czcMg9bMN6di+3w==", + "requires": { + "accepts": "~1.3.4", + "base64id": "2.0.0", + "cookie": "~0.4.1", + "cors": "~2.8.5", + "debug": "~4.3.1", + "engine.io-parser": "~4.0.0", + "ws": "~7.4.2" + } + }, + "engine.io-client": { + "version": "4.1.4", + "resolved": "https://registry.npmjs.org/engine.io-client/-/engine.io-client-4.1.4.tgz", + "integrity": "sha512-843fqAdKeUMFqKi1sSjnR11tJ4wi8sIefu6+JC1OzkkJBmjtc/gM/rZ53tJfu5Iae/3gApm5veoS+v+gtT0+Fg==", + "requires": { + "base64-arraybuffer": "0.1.4", + "component-emitter": "~1.3.0", + "debug": "~4.3.1", + "engine.io-parser": "~4.0.1", + "has-cors": "1.1.0", + "parseqs": "0.0.6", + "parseuri": "0.0.6", + "ws": "~7.4.2", + "xmlhttprequest-ssl": "~1.6.2", + "yeast": "0.1.2" + } + }, + "engine.io-parser": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/engine.io-parser/-/engine.io-parser-4.0.2.tgz", + "integrity": "sha512-sHfEQv6nmtJrq6TKuIz5kyEKH/qSdK56H/A+7DnAuUPWosnIZAS2NHNcPLmyjtY3cGS/MqJdZbUjW97JU72iYg==", + "requires": { + "base64-arraybuffer": "0.1.4" + } + }, "ipfs-utils": { "version": "6.0.4", "resolved": "https://registry.npmjs.org/ipfs-utils/-/ipfs-utils-6.0.4.tgz", @@ -13620,6 +13659,56 @@ "version": "3.1.22", "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.1.22.tgz", "integrity": "sha512-/2ZUaJX2ANuLtTvqTlgqBQNJoQO398KyJgZloL0PZkC0dpysjncRUPsFe3DUPzz/y3h+u7C46np8RMuvF3jsSQ==" + }, + "socket.io-adapter": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/socket.io-adapter/-/socket.io-adapter-2.1.0.tgz", + "integrity": "sha512-+vDov/aTsLjViYTwS9fPy5pEtTkrbEKsw2M+oVSoFGw6OD1IpvlV1VPhUzNbofCQ8oyMbdYJqDtGdmHQK6TdPg==" + }, + "socket.io-client-next": { + "version": "npm:socket.io-client@3.1.3", + "resolved": "https://registry.npmjs.org/socket.io-client/-/socket.io-client-3.1.3.tgz", + "integrity": "sha512-4sIGOGOmCg3AOgGi7EEr6ZkTZRkrXwub70bBB/F0JSkMOUFpA77WsL87o34DffQQ31PkbMUIadGOk+3tx1KGbw==", + "requires": { + "@types/component-emitter": "^1.2.10", + "backo2": "~1.0.2", + "component-emitter": "~1.3.0", + "debug": "~4.3.1", + "engine.io-client": "~4.1.0", + "parseuri": "0.0.6", + "socket.io-parser": "~4.0.4" + } + }, + "socket.io-next": { + "version": "npm:socket.io@3.1.2", + "resolved": "https://registry.npmjs.org/socket.io/-/socket.io-3.1.2.tgz", + "integrity": "sha512-JubKZnTQ4Z8G4IZWtaAZSiRP3I/inpy8c/Bsx2jrwGrTbKeVU5xd6qkKMHpChYeM3dWZSO0QACiGK+obhBNwYw==", + "requires": { + "@types/cookie": "^0.4.0", + "@types/cors": "^2.8.8", + "@types/node": ">=10.0.0", + "accepts": "~1.3.4", + "base64id": "~2.0.0", + "debug": "~4.3.1", + "engine.io": "~4.1.0", + "socket.io-adapter": "~2.1.0", + "socket.io-parser": "~4.0.3" + } + }, + "socket.io-parser": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/socket.io-parser/-/socket.io-parser-4.0.4.tgz", + "integrity": "sha512-t+b0SS+IxG7Rxzda2EVvyBZbvFPBCjJoyHuE0P//7OAsN23GItzDRdWa6ALxZI/8R5ygK7jAR6t028/z+7295g==", + "requires": { + "@types/component-emitter": "^1.2.10", + "component-emitter": "~1.3.0", + "debug": "~4.3.1" + } + }, + "xmlhttprequest-ssl": { + "version": "1.6.2", + "resolved": "https://registry.npmjs.org/xmlhttprequest-ssl/-/xmlhttprequest-ssl-1.6.2.tgz", + "integrity": "sha512-tYOaldF/0BLfKuoA39QMwD4j2m8lq4DIncqj1yuNELX4vz9+z/ieG/vwmctjJce+boFHXstqhWnHSxc4W8f4qg==" } } }, @@ -20152,128 +20241,6 @@ } } }, - "socket.io-client-next": { - "version": "npm:socket.io-client@3.1.3", - "resolved": "https://registry.npmjs.org/socket.io-client/-/socket.io-client-3.1.3.tgz", - "integrity": "sha512-4sIGOGOmCg3AOgGi7EEr6ZkTZRkrXwub70bBB/F0JSkMOUFpA77WsL87o34DffQQ31PkbMUIadGOk+3tx1KGbw==", - "requires": { - "@types/component-emitter": "^1.2.10", - "backo2": "~1.0.2", - "component-emitter": "~1.3.0", - "debug": "~4.3.1", - "engine.io-client": "~4.1.0", - "parseuri": "0.0.6", - "socket.io-parser": "~4.0.4" - }, - "dependencies": { - "debug": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", - "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", - "requires": { - "ms": "2.1.2" - } - }, - "engine.io-client": { - "version": "4.1.3", - "resolved": "https://registry.npmjs.org/engine.io-client/-/engine.io-client-4.1.3.tgz", - "integrity": "sha512-C3JYYyvna0FvSKOWGWpo0/EQ6MayO8uEKam1oedLZRpxLego9Fk6K3UH/Phieu1xPHauM7YqAygJ+6SraVc0Qg==", - "requires": { - "base64-arraybuffer": "0.1.4", - "component-emitter": "~1.3.0", - "debug": "~4.3.1", - "engine.io-parser": "~4.0.1", - "has-cors": "1.1.0", - "parseqs": "0.0.6", - "parseuri": "0.0.6", - "ws": "~7.4.2", - "xmlhttprequest-ssl": "~1.5.4", - "yeast": "0.1.2" - } - }, - "engine.io-parser": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/engine.io-parser/-/engine.io-parser-4.0.2.tgz", - "integrity": "sha512-sHfEQv6nmtJrq6TKuIz5kyEKH/qSdK56H/A+7DnAuUPWosnIZAS2NHNcPLmyjtY3cGS/MqJdZbUjW97JU72iYg==", - "requires": { - "base64-arraybuffer": "0.1.4" - } - }, - "socket.io-parser": { - "version": "4.0.4", - "resolved": "https://registry.npmjs.org/socket.io-parser/-/socket.io-parser-4.0.4.tgz", - "integrity": "sha512-t+b0SS+IxG7Rxzda2EVvyBZbvFPBCjJoyHuE0P//7OAsN23GItzDRdWa6ALxZI/8R5ygK7jAR6t028/z+7295g==", - "requires": { - "@types/component-emitter": "^1.2.10", - "component-emitter": "~1.3.0", - "debug": "~4.3.1" - } - } - } - }, - "socket.io-next": { - "version": "npm:socket.io@3.1.2", - "resolved": "https://registry.npmjs.org/socket.io/-/socket.io-3.1.2.tgz", - "integrity": "sha512-JubKZnTQ4Z8G4IZWtaAZSiRP3I/inpy8c/Bsx2jrwGrTbKeVU5xd6qkKMHpChYeM3dWZSO0QACiGK+obhBNwYw==", - "requires": { - "@types/cookie": "^0.4.0", - "@types/cors": "^2.8.8", - "@types/node": ">=10.0.0", - "accepts": "~1.3.4", - "base64id": "~2.0.0", - "debug": "~4.3.1", - "engine.io": "~4.1.0", - "socket.io-adapter": "~2.1.0", - "socket.io-parser": "~4.0.3" - }, - "dependencies": { - "debug": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", - "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", - "requires": { - "ms": "2.1.2" - } - }, - "engine.io": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/engine.io/-/engine.io-4.1.1.tgz", - "integrity": "sha512-t2E9wLlssQjGw0nluF6aYyfX8LwYU8Jj0xct+pAhfWfv/YrBn6TSNtEYsgxHIfaMqfrLx07czcMg9bMN6di+3w==", - "requires": { - "accepts": "~1.3.4", - "base64id": "2.0.0", - "cookie": "~0.4.1", - "cors": "~2.8.5", - "debug": "~4.3.1", - "engine.io-parser": "~4.0.0", - "ws": "~7.4.2" - } - }, - "engine.io-parser": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/engine.io-parser/-/engine.io-parser-4.0.2.tgz", - "integrity": "sha512-sHfEQv6nmtJrq6TKuIz5kyEKH/qSdK56H/A+7DnAuUPWosnIZAS2NHNcPLmyjtY3cGS/MqJdZbUjW97JU72iYg==", - "requires": { - "base64-arraybuffer": "0.1.4" - } - }, - "socket.io-adapter": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/socket.io-adapter/-/socket.io-adapter-2.1.0.tgz", - "integrity": "sha512-+vDov/aTsLjViYTwS9fPy5pEtTkrbEKsw2M+oVSoFGw6OD1IpvlV1VPhUzNbofCQ8oyMbdYJqDtGdmHQK6TdPg==" - }, - "socket.io-parser": { - "version": "4.0.4", - "resolved": "https://registry.npmjs.org/socket.io-parser/-/socket.io-parser-4.0.4.tgz", - "integrity": "sha512-t+b0SS+IxG7Rxzda2EVvyBZbvFPBCjJoyHuE0P//7OAsN23GItzDRdWa6ALxZI/8R5ygK7jAR6t028/z+7295g==", - "requires": { - "@types/component-emitter": "^1.2.10", - "component-emitter": "~1.3.0", - "debug": "~4.3.1" - } - } - } - }, "socket.io-parser": { "version": "3.4.1", "resolved": "https://registry.npmjs.org/socket.io-parser/-/socket.io-parser-3.4.1.tgz", diff --git a/package.json b/package.json index cc1bd98..f8c0e0e 100644 --- a/package.json +++ b/package.json @@ -11,22 +11,12 @@ "test:unit:rest": "export SVC_ENV=test && mocha --exit --timeout 15000 test/unit/rest-api/", "test:unit:jsonrpc": "export SVC_ENV=test && mocha --exit --timeout 15000 test/unit/json-rpc/", "test:e2e:auto": "export SVC_ENV=test && mocha --exit --timeout 15000 test/e2e/automated/", + "test:temp": "export SVC_ENV=test && mocha --exit --timeout 15000 -g '#rate-limit' test/unit/json-rpc/", "lint": "standard --env mocha --fix", "docs": "./node_modules/.bin/apidoc -i src/ -o docs", "coverage": "nyc report --reporter=text-lcov | coveralls", "coverage:report": "export SVC_ENV=test && nyc --reporter=html mocha --exit --timeout 15000 test/unit/biz-logic/ test/unit/json-rpc/ test/unit/rest-api/ test/e2e/automated/" }, - "keywords": [ - "koa-api-boilerplate", - "api", - "koa", - "koa2", - "boilerplate", - "es6", - "mongoose", - "passportjs", - "apidoc" - ], "author": "Chris Troutner ", "license": "MIT", "apidoc": { diff --git a/src/rpc/index.js b/src/rpc/index.js index c4fd63a..88f5505 100644 --- a/src/rpc/index.js +++ b/src/rpc/index.js @@ -50,9 +50,11 @@ class JSONRPC { if (parsedData.type === 'invalid') { return } - // Added the property "from" to parsed data - // necessary to the rate limits + + // Added the property "from" to the parsedData object; + // necessary for calculating rate limits (based on the IPFS ID). parsedData.from = from + // Default return string let retObj = _this.defaultResponse() diff --git a/src/rpc/rate-limit.js b/src/rpc/rate-limit.js index 6d912a7..83637a6 100644 --- a/src/rpc/rate-limit.js +++ b/src/rpc/rate-limit.js @@ -10,9 +10,11 @@ class RateLimit { constructor (options) { // Encapsulate dependencies this.RateLimitLib = RateLimitLib + + // Set default rate limit options. this.defaultOptions = { interval: { min: 1 }, - max: 1, + max: 60, onLimitReached: this.onLimitReached } @@ -25,16 +27,27 @@ class RateLimit { ip: '' }, user: '', - set: () => { } + set: () => {} } - // Stasblish provided options as the default options + + console.log( + `this.defaultOptions: ${JSON.stringify(this.defaultOptions, null, 2)}` + ) + console.log(`options: ${JSON.stringify(options, null, 2)}`) + + // Set rate limit settings. Default values are overwritten if user passes + // in an options object. this.rateLimitOptions = Object.assign({}, this.defaultOptions, options) - this.rateLimit = this.RateLimitLib.middleware(this.rateLimitOptions) + console.log( + `this.rateLimitOptions: ${JSON.stringify(this.rateLimitOptions, null, 2)}` + ) + this.rateLimit = this.RateLimitLib.middleware(this.rateLimitOptiolimiterns) } + // This function is called when the user hits their rate limits. onLimitReached () { try { - const error = new Error() + const error = new Error() // Establish provided options as the default options. error.message = 'Too many requests, please try again later.' error.status = 429 throw error @@ -44,21 +57,24 @@ class RateLimit { } } + // This is the middleware function called by the router. async limiter (from) { try { if (!from || typeof from !== 'string') { throw new Error('from must be a string') } - // Set context + // Set context.limiter + // This overrides the default koa behavior and adapts the rate limiter + // to work with the JSON RPC over IPFS. this.context.state.user = from this.context.request.ip = from this.context.user = from - await this.rateLimit(this.context, () => { }) + await this.rateLimit(this.context, () => {}) return true } catch (error) { - console.error('Error in limiter()') + console.error('Error in rate-limit.js/limiter()') throw error } } diff --git a/test/unit/json-rpc/a14-rate-limits.js b/test/unit/json-rpc/a14-rate-limits.js index f2604d0..4ae1d92 100644 --- a/test/unit/json-rpc/a14-rate-limits.js +++ b/test/unit/json-rpc/a14-rate-limits.js @@ -33,10 +33,14 @@ describe('#rate-limit', () => { assert.fail('unexpected error') } catch (error) { assert.equal(error.status, 429) - assert.include(error.message, 'Too many requests, please try again later.') + assert.include( + error.message, + 'Too many requests, please try again later.' + ) } }) }) + describe('#limiter', () => { it('should throw error if "from" input is not provider', async () => { try { @@ -46,18 +50,25 @@ describe('#rate-limit', () => { assert.include(error.message, 'from must be a string') } }) + it('should throw error 429', async () => { try { const _uut = new RateLimit({ max: 1 }) const from = 'Origin request' - const firtsRequest = await _uut.limiter(from) - assert.isTrue(firtsRequest) + const firstRequest = await _uut.limiter(from) + assert.isTrue(firstRequest) + + const secondRequest = await _uut.limiter(from) + assert.isTrue(secondRequest) await _uut.limiter(from) assert.fail('unexpected error') } catch (error) { - assert.include(error.message, 'Too many requests, please try again later.') + assert.include( + error.message, + 'Too many requests, please try again later.' + ) } }) })