Skip to content

Added caching option to allow returning cached data before an update. #50

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

Open
codealchemist wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Added caching option to allow returning cached data before an update. #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e3e7458
added option to return cached data before updating cache; added unit …
codealchemist Sep 23, 2016
86d338f
removed commented code
codealchemist Sep 23, 2016
262ba5e
removed arrow function
codealchemist Sep 23, 2016
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
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,14 +111,15 @@ If null will be given, the body will be served as string.
#### `timeout {number} `
Set a timeout (in milliseconds) for the request.

#### `cache {{ cache: boolean, expires: number }}`
#### `cache {{ cache: boolean, expires: number, cachedFirst: boolean }}`
Requistify has built-in Redis based caching mechanism. For using this feature, set the cache property to true using the following object:

```javascript
requestify.get('http://examples.com/api/foo', {
cache: {
cache: true, // Will set caching to true for this request.
expires: 3600 // Time for cache to expire in milliseconds
expires: 3600, // Time for cache to expire in milliseconds
cachedFirst: false // Will return cached data before updating cache
}
});
```
Expand Down
18 changes: 17 additions & 1 deletion lib/requestify.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,14 @@ var Requestify = (function() {
cache.get(request.getFullUrl())
.then(function(data) {
if (!data || (expirationTime(data) <= new Date().getTime())) {
// cachedFirst indicates if we should return the cached data
// before updating it
if (request.cache.cachedFirst) {
// return cached data
defer.resolve(new Response(data.code, data.headers, data.body));
}

// make request and update cache
call(request, defer);
return;
}
Expand All @@ -180,7 +188,15 @@ var Requestify = (function() {
/**
* Execute HTTP request based on the given method and body
* @param {string} url - The URL to execute
* @param {{ method: string, dataType: string, headers: object, body: object, cookies: object, auth: object }} options
* @param {{
* method: string,
* dataType: string,
* headers: object,
* body: object,
* cookies: object,
* auth: object,
* cache: object
* }} options
* @returns {Q.promise} - Returns a promise, once resolved || rejected, Response object is given
*/
request: function(url, options) {
Expand Down
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
"description": "Simplifies node HTTP request making (HTTP client) with caching support.",
"version": "0.2.3",
"scripts": {
"test": "mocha -R spec test/**/*.js test/*.js"
"test": "mocha -R spec test/**/*.js test/*.js",
"test-watch": "mocha --watch -R spec test/**/*.js test/*.js"
},
"license": "MIT",
"tags": [
Expand Down
48 changes: 40 additions & 8 deletions test/requestify-spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,31 @@ var mocha = require('mocha'),
expect = require('chai').expect,
rewire = require('rewire'),
requestify = rewire('../lib/requestify.js'),
Q = require('q');
Q = require('q'),
Response = require('../lib/response');

describe('Requestify', function() {
var cacheStub;
var cacheStub,
cachedDataStub;

afterEach(function() {
requestify.responseEncoding('utf8');
});

beforeEach(function() {
cachedDataStub = {
created: new Date().getTime(),
code: 200,
headers: 'Content-Type:application/javascript; charset=utf-8',
body: {rock: "yeah!"}
};
cacheStub = {
setCacheTransporter: sinon.stub(),
get: sinon.stub(),
get: sinon.stub().returns(Q.resolve(cachedDataStub)),
// get: sinon.stub(),
set: sinon.stub(),
purge: sinon.stub(),
isTransportAvailable: sinon.stub()
isTransportAvailable: function() { return true }
};

requestify.__set__('cache', cacheStub);
Expand All @@ -41,18 +50,19 @@ describe('Requestify', function() {

describe('#request()', function() {
var httpStub,
httpsStub,
cacheStub;
httpsStub;

beforeEach(function() {
httpStub = sinon.stub().returns({
on: function() {},
end: function() {}
end: function() {},
abort: function() {}
});

httpsStub = sinon.stub().returns({
on: function() {},
end: function() {}
end: function() {},
abort: function() {}
});

requestify.__set__('http', {
Expand Down Expand Up @@ -97,6 +107,28 @@ describe('Requestify', function() {
method: 'POST'
})).to.have.property('then');
});

it('Should return cached response before updating cache', function(done) {
var success = sinon.spy();
requestify.cacheTransporter();
var response = new Response(cachedDataStub.code, cachedDataStub.headers, cachedDataStub.body);

requestify.request('http://wix.com', {
method: 'GET',
cache: {
cache: true,
cachedFirst: true,
expires: -1 // force update
}
}).then(function(response) {
try {
expect(response).to.eql(response);
done();
} catch (e) {
done(e);
}
});
});
});

describe('Method specific public methods', function() {
Expand Down