lukechilds
/
onionoo-node-client
mirror of https://github.com/lukechilds/onionoo-node-client.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Remove internal caching logic

got-cache
Luke Childs 7 years ago
parent
05371dd92d
commit
f141fb8b9c
3 changed files with 5 additions and 215 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 5
      package.json
  2. 82
      src/index.js
  3. 133
      test/cache.js

5
package.json
View File

@ -26,16 +26,11 @@
}, },
"homepage": "https://github.com/lukechilds/onionoo-node-client", "homepage": "https://github.com/lukechilds/onionoo-node-client",
"dependencies": { "dependencies": {
"cache-manager": "2.5.0",
"deep-assign": "2.0.0",
"expired": "1.3.12",
"got": "8.0.0" "got": "8.0.0"
}, },
"devDependencies": { "devDependencies": {
"ava": "^0.24.0", "ava": "^0.24.0",
"coveralls": "^3.0.0", "coveralls": "^3.0.0",
"date-fns": "^1.21.1",
"delay": "^2.0.0",
"nock": "^9.0.2", "nock": "^9.0.2",
"nyc": "^11.0.0", "nyc": "^11.0.0",
"xo": "^0.19.0" "xo": "^0.19.0"

82
src/index.js
View File

@ -1,8 +1,5 @@
const querystring = require('querystring'); const querystring = require('querystring');
const got = require('got'); const got = require('got');
const cacheManager = require('cache-manager');
const expired = require('expired');
const deepAssign = require('deep-assign');
const pkg = require('../package.json'); const pkg = require('../package.json');
class Onionoo { class Onionoo {
@ -21,13 +18,6 @@ class Onionoo {
'uptime' 'uptime'
] ]
}, options); }, options);
if (options.cache !== false) {
this.options.cache = cacheManager.caching(Object.assign({
store: 'memory',
ttl: 18000, // 5 hours
max: 500
}, options.cache));
}
// Return object containing endpoint methods // Return object containing endpoint methods
return this.options.endpoints.reduce((onionoo, endpoint) => { return this.options.endpoints.reduce((onionoo, endpoint) => {
@ -46,75 +36,13 @@ class Onionoo {
let url = `${this.options.baseUrl}/${endpoint}`; let url = `${this.options.baseUrl}/${endpoint}`;
url += qs ? `?${qs}` : ''; url += qs ? `?${qs}` : '';
// If caching is disabled, just make the request // Make request
if (!this.options.cache) { return got(url, {
return this.makeRequest(url);
}
// If caching is enabled, check for url in cache
return this.options.cache.get(url)
.then(cachedResult => {
const options = {};
// If we have it cached
if (cachedResult) {
// Return the cached entry if it's still valid
if (!expired(cachedResult.headers)) {
return cachedResult;
// If it's stale, add last-modified date to headers
} else if (cachedResult.headers['last-modified']) {
options.headers = {
'if-modified-since': cachedResult.headers['last-modified']
};
}
}
// Make a request
return this.makeRequest(url, options)
.then(response => {
// If we get a 304, fill in the body
if (response.statusCode === 304) {
response.body = cachedResult.body;
}
// If we get a 200 or 304, cache it
if ([200, 304].includes(response.statusCode)) {
this.options.cache.set(url, response);
}
return response;
});
});
}
// Returns a promise for a request
makeRequest(url, options = {}) {
options = deepAssign({
headers: { headers: {
'user-agent': `onionoo-node-client v${pkg.version} (${pkg.homepage})` 'user-agent': `onionoo-node-client v${pkg.version} (${pkg.homepage})`
} },
}, options); json: true
});
return got(url, options)
.catch(err => {
// Don't throw 304 responses
if (err.statusCode === 304) {
return err.response;
}
throw err;
})
.then(response => {
// Format response
response = {
statusCode: response.statusCode,
statusMessage: response.statusMessage,
headers: response.headers,
body: response.body && JSON.parse(response.body)
};
return response;
});
} }
} }

133
test/cache.js
View File

@ -1,133 +0,0 @@
import test from 'ava';
import nock from 'nock';
import subSeconds from 'date-fns/sub_seconds';
import delay from 'delay';
import Onionoo from '../';
import data from './fixtures/data';
test('Cache can be disabled', async t => {
const onionoo = new Onionoo({cache: false});
const defaultEndpoint = data.defaultEndpoints[0];
const responseHeaders = {
date: new Date().toUTCString(),
age: 0,
'cache-control': 'public, max-age=300'
};
const scope = nock(data.defaultBaseUrl)
.get(`/${defaultEndpoint}`)
.reply(200, data.dummyResponse, responseHeaders);
const response = await onionoo[defaultEndpoint]();
t.deepEqual(response.body, data.dummyResponse);
t.truthy(scope.isDone());
const scope2 = nock(data.defaultBaseUrl)
.get(`/${defaultEndpoint}`)
.reply(200, data.dummyResponse, responseHeaders);
const response2 = await onionoo[defaultEndpoint]();
t.deepEqual(response2.body, data.dummyResponse);
t.truthy(scope2.isDone());
});
test('Responses with future max-age are cached', async t => {
const onionoo = new Onionoo();
const defaultEndpoint = data.defaultEndpoints[0];
const responseHeaders = {
date: new Date().toUTCString(),
age: 0,
'cache-control': 'public, max-age=300'
};
const scope = nock(data.defaultBaseUrl)
.get(`/${defaultEndpoint}`)
.reply(200, data.dummyResponse, responseHeaders);
const response = await onionoo[defaultEndpoint]();
t.deepEqual(response.body, data.dummyResponse);
t.truthy(scope.isDone());
const cachedResponse = await onionoo[defaultEndpoint]();
t.deepEqual(cachedResponse.body, data.dummyResponse);
});
test('Responses older than max-age are not cached', async t => {
const onionoo = new Onionoo();
const defaultEndpoint = data.defaultEndpoints[0];
const responseHeaders = {
date: subSeconds(new Date(), 15).toUTCString(),
age: 0,
'cache-control': 'public, max-age=10'
};
const scope = nock(data.defaultBaseUrl)
.get(`/${defaultEndpoint}`)
.reply(200, data.dummyResponse, responseHeaders);
const response = await onionoo[defaultEndpoint]();
t.deepEqual(response.body, data.dummyResponse);
t.truthy(scope.isDone());
const scope2 = nock(data.defaultBaseUrl)
.get(`/${defaultEndpoint}`)
.reply(200, data.dummyResponse, responseHeaders);
const response2 = await onionoo[defaultEndpoint]();
t.deepEqual(response2.body, data.dummyResponse);
t.truthy(scope2.isDone());
});
test('When expired, add last-modified date to headers and handle 304', async t => {
const onionoo = new Onionoo();
const defaultEndpoint = data.defaultEndpoints[0];
const initialDate = new Date().toUTCString();
const responseHeaders = {
date: initialDate,
age: 0,
'cache-control': 'public, max-age=1',
'last-modified': initialDate
};
const scope = nock(data.defaultBaseUrl)
.get(`/${defaultEndpoint}`)
.reply(200, data.dummyResponse, responseHeaders);
const response = await onionoo[defaultEndpoint]();
t.deepEqual(response.body, data.dummyResponse);
t.truthy(scope.isDone());
const requestHeaders = {
'if-modified-since': initialDate
};
const responseHeaders304 = {
date: new Date().toUTCString(),
age: 0,
'cache-control': 'public, max-age=10',
'last-modified': initialDate
};
const scope2 = nock(data.defaultBaseUrl, {requestHeaders})
.get(`/${defaultEndpoint}`)
.reply(304, null, responseHeaders304);
const response2 = await delay(2000).then(onionoo[defaultEndpoint]);
t.deepEqual(response2.body, data.dummyResponse);
t.truthy(scope2.isDone());
const cachedResponse = await onionoo[defaultEndpoint]();
t.deepEqual(cachedResponse.body, data.dummyResponse);
});
Write Preview
Loading…
Cancel
Save