nocca
Version:
NodeJS Mock Server
251 lines (150 loc) • 6.05 kB
JavaScript
;
var $utils = require('../../utils');
module.exports = {
interface: 'cacheRepository',
id: 'cacheConglomerate',
name: 'Cache Conglomerate Repository',
description: 'The gotta-cache-em-all solution, creates one big pile-o-caches',
constructor: CacheConglomerate
};
function CacheConglomerate (Nocca) {
var caches = {};
var recordedCaches = [];
var self = this;
self.logger = Nocca.logger.child({ module: module.exports.id });
self.invoke = invoke;
self.setCaches = setCaches;
self.considerRecording = considerRecording;
self.matchRequest = matchRequest;
// initialize plugin when Nocca says it's ok to do so
if (!Nocca.initialized) {
Nocca.pubsub.subscribe(Nocca.constants.PUBSUB_NOCCA_INITIALIZE_PLUGIN, _init);
}
else {
_init();
}
// listen for publications with caches
Nocca.pubsub.subscribe('CACHE_CONGLOMERATE_SET_CACHES', self.setCaches);
function invoke () {
return self;
}
function _init () {
// add routes
var routes = [
// replace caches
['GET:/plugins/cacheConglomerate/caches', apiGetCaches, 'Returns current playback caches'],
// remove all cacheList sessions
['DELETE:/plugins/cacheConglomerate/caches', apiDeleteCaches, 'Removes all playback caches'],
// add caches
['POST:/plugins/cacheConglomerate/caches', apiAddCaches, 'Add caches to playback caches (expects array of caches)'],
// replace caches
['PUT:/plugins/cacheConglomerate/caches', apiReplaceCaches, 'Replace playback caches (expects array of caches)'],
// export recorded caches
['GET:/plugins/cacheConglomerate/recorded-caches', apiGetRecordedCaches, 'Returns recorded caches from memory']
];
routes.forEach(function (routeConfig) {
Nocca.pubsub.publish(Nocca.constants.PUBSUB_REST_ROUTE_ADDED, routeConfig);
});
}
function getCaches () {
var cacheSnapshot = [];
Object.keys(caches).forEach(function (cacheKey) {
cacheSnapshot.push(caches[cacheKey]);
});
return cacheSnapshot;
}
function setCaches (cacheArray) {
if (typeof cacheArray === 'string') {
// try json parsing it
cacheArray = JSON.parse(cacheArray);
}
if (Array.isArray(cacheArray)) {
// then parse and reassign caches
cacheArray.forEach(function (cache) {
var cacheKey = generateCacheQueueKey(cache.endpointKey, cache.requestKey);
if (typeof caches[cacheKey] !== 'undefined') {
// overwriting cache! should warn
self.logger.warn('Cache Conglomerate has a double cache entry, overwriting old cache. Key: ' + cacheKey);
}
// use cacheKey to assign cache
caches[cacheKey] = cache;
});
self.logger.info('Cache conglomerate filled with ' + Object.keys(caches).length + ' unique caches');
}
else {
throw 'setCaches() should be called with an array, got ' + (typeof cacheArray);
}
}
function clearCaches () {
Object.keys(caches).forEach(function (cacheKey) {
delete caches[cacheKey];
});
}
function considerRecording (reqContext) {
// reserve a spot in the caches
var i = recordedCaches.push({}) - 1;
// always recording, so always extracting the cache
return Nocca.usePlugin(reqContext.config.cacheExtractor)(reqContext)
.then(function (cache) {
self.logger.info('Recorded cache');
// fill reserved spot
recordedCaches[i] = cache;
return reqContext;
});
}
function matchRequest (reqContext) {
var cacheKey = generateCacheQueueKey(reqContext.endpoint.key, reqContext.requestKey);
var cache;
// when found, parse to httpMessage format
if (typeof caches[cacheKey] !== 'undefined') {
cache = Nocca.httpMessageFactory.createResponse(caches[cacheKey].playbackResponse);
self.logger.info('<<<< Providing cache response');
}
return cache;
}
function generateCacheQueueKey (endpointKey, requestKey) {
return endpointKey + '' + requestKey;
}
// R E S T - A P I F U N C T I O N A L I T Y
function apiGetRecordedCaches (apiReq) {
apiReq.ok().end(recordedCaches);
}
function apiGetCaches (apiReq) {
apiReq.ok().end(getCaches());
}
function apiAddCaches (apiReq) {
$utils.readBody(apiReq.req)
.then(function (body) {
var newCaches = JSON.parse(body);
if (Array.isArray(newCaches)) {
setCaches(newCaches);
apiReq.ok().end(getCaches());
}
else {
apiReq.badRequest().end('Payload should be an array of caches');
}
}).fail(function () {
apiReq.badRequest().end('Unable to read request');
});
}
function apiReplaceCaches (apiReq) {
$utils.readBody(apiReq.req)
.then(function (body) {
var newCaches = JSON.parse(body);
if (Array.isArray(newCaches)) {
clearCaches();
setCaches(newCaches);
apiReq.ok().end(getCaches());
}
else {
apiReq.badRequest().end('Payload should be an array of caches');
}
}).fail(function () {
apiReq.badRequest().end('Unable to read request');
});
}
function apiDeleteCaches (apiReq) {
clearCaches();
apiReq.ok().end(getCaches());
}
}