Ghost/core/test/unit/helpers/get_spec.js
Rishabh Garg 303046bc0a
💡Added v3 API endpoint (#11073)
no issue

- Adds new /v3/ endpoint which currently aliases canary code
2019-09-03 12:33:31 +05:30

662 lines
25 KiB
JavaScript

var should = require('should'),
sinon = require('sinon'),
Promise = require('bluebird'),
// Stuff we are testing
helpers = require('../../../frontend/helpers'),
models = require('../../../server/models'),
api = require('../../../server/api'),
labs = require('../../../server/services/labs');
describe('{{#get}} helper', function () {
var fn, inverse, labsStub;
let locals = {};
before(function () {
models.init();
});
beforeEach(function () {
fn = sinon.spy();
inverse = sinon.spy();
labsStub = sinon.stub(labs, 'isSet').returns(true);
locals = {root: {_locals: {apiVersion: 'v0.1'}}, globalProp: {foo: 'bar'}};
});
afterEach(function () {
sinon.restore();
});
it('errors correctly if labs flag not set', function (done) {
labsStub.returns(false);
helpers.get.call(
{},
'posts',
{hash: {}, data: locals, fn: fn, inverse: inverse}
).then(function (result) {
labsStub.calledOnce.should.be.true();
fn.called.should.be.false();
inverse.called.should.be.false();
should.exist(result);
result.should.be.an.Object().with.property(
'string',
'<script>console.error("The {{#get}} helper requires your theme to have API access. ' +
'Please enable the v2 API via your theme\'s package.json file. ' +
'See https://ghost.org/docs/api/handlebars-themes/packagejson/");</script>'
);
done();
}).catch(done);
});
describe('posts v0.1', function () {
var browsePostsStub, readPostsStub, readTagsStub, readUsersStub, testPostsArr = [
{id: 1, title: 'Test Post 1', author: {slug: 'cameron'}},
{id: 2, title: 'Test Post 2', author: {slug: 'cameron'}, featured: true},
{id: 3, title: 'Test Post 3', tags: [{slug: 'test'}]},
{id: 4, title: 'Test Post 4'}
],
meta = {pagination: {}};
beforeEach(function () {
browsePostsStub = sinon.stub(api['v0.1'].posts, 'browse');
readPostsStub = sinon.stub(api['v0.1'].posts, 'read');
readTagsStub = sinon.stub(api['v0.1'].tags, 'read').returns(new Promise.resolve({tags: []}));
readUsersStub = sinon.stub(api['v0.1'].users, 'read').returns(new Promise.resolve({users: []}));
browsePostsStub.returns(new Promise.resolve({posts: testPostsArr, meta: meta}));
browsePostsStub.withArgs({limit: '3'}).returns(new Promise.resolve({
posts: testPostsArr.slice(0, 3),
meta: meta
}));
browsePostsStub.withArgs({limit: '1'}).returns(new Promise.resolve({posts: testPostsArr.slice(0, 1)}));
browsePostsStub.withArgs({filter: 'tags:test'}).returns(new Promise.resolve({posts: testPostsArr.slice(2, 3)}));
browsePostsStub.withArgs({filter: 'tags:none'}).returns(new Promise.resolve({posts: []}));
browsePostsStub.withArgs({filter: 'author:cameron'}).returns(new Promise.resolve({posts: testPostsArr.slice(0, 2)}));
browsePostsStub.withArgs({filter: 'featured:true'}).returns(new Promise.resolve({posts: testPostsArr.slice(2, 3)}));
readPostsStub.withArgs({id: '2'}).returns(new Promise.resolve({posts: testPostsArr.slice(1, 2)}));
});
it('should handle default browse posts call', function (done) {
helpers.get.call(
{},
'posts',
{hash: {}, data: locals, fn: fn, inverse: inverse}
).then(function () {
labsStub.calledOnce.should.be.true();
fn.called.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('posts');
fn.firstCall.args[0].posts.should.eql(testPostsArr);
fn.firstCall.args[0].posts.should.have.lengthOf(4);
inverse.called.should.be.false();
done();
}).catch(done);
});
it('should return pagination and meta pagination with default browse posts call', function (done) {
helpers.get.call(
{},
'posts',
{hash: {}, data: locals, fn: fn, inverse: inverse}
).then(function () {
fn.firstCall.args[0].pagination.should.be.an.Object();
fn.firstCall.args[0].meta.should.be.an.Object();
fn.firstCall.args[0].meta.pagination.should.be.an.Object();
inverse.called.should.be.false();
done();
}).catch(done);
});
it('should not return pagination if meta pagination does not exist', function (done) {
helpers.get.call(
{},
'posts',
{hash: {limit: '1'}, data: locals, fn: fn, inverse: inverse}
).then(function () {
should.not.exist(fn.firstCall.args[0].pagination);
should.not.exist(fn.firstCall.args[0].meta);
inverse.called.should.be.false();
done();
}).catch(done);
});
it('should handle browse posts call with limit 3', function (done) {
helpers.get.call(
{},
'posts',
{hash: {limit: '3'}, data: locals, fn: fn, inverse: inverse}
).then(function () {
fn.calledOnce.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('posts');
fn.firstCall.args[0].posts.should.have.lengthOf(3);
fn.firstCall.args[0].posts.should.eql(testPostsArr.slice(0, 3));
inverse.called.should.be.false();
done();
}).catch(done);
});
it('should handle browse posts call with limit 1', function (done) {
helpers.get.call(
{},
'posts',
{hash: {limit: '1'}, data: locals, fn: fn, inverse: inverse}
).then(function () {
fn.calledOnce.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('posts');
fn.firstCall.args[0].posts.should.have.lengthOf(1);
fn.firstCall.args[0].posts.should.eql(testPostsArr.slice(0, 1));
inverse.called.should.be.false();
done();
}).catch(done);
});
it('should handle browse posts call with limit 1', function (done) {
helpers.get.call(
{},
'posts',
{hash: {limit: '1'}, data: locals, fn: fn, inverse: inverse}
).then(function () {
fn.calledOnce.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('posts');
fn.firstCall.args[0].posts.should.have.lengthOf(1);
fn.firstCall.args[0].posts.should.eql(testPostsArr.slice(0, 1));
inverse.called.should.be.false();
done();
}).catch(done);
});
it('should handle browse post call with explicit tag', function (done) {
helpers.get.call(
{},
'posts',
{hash: {filter: 'tags:test'}, data: locals, fn: fn, inverse: inverse}
).then(function () {
fn.calledOnce.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('posts');
fn.firstCall.args[0].posts.should.have.lengthOf(1);
fn.firstCall.args[0].posts.should.eql(testPostsArr.slice(2, 3));
inverse.called.should.be.false();
done();
}).catch(done);
});
it('should handle browse post call with explicit author', function (done) {
helpers.get.call(
{},
'posts',
{hash: {filter: 'author:cameron'}, data: locals, fn: fn, inverse: inverse}
).then(function () {
fn.calledOnce.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('posts');
fn.firstCall.args[0].posts.should.have.lengthOf(2);
fn.firstCall.args[0].posts.should.eql(testPostsArr.slice(0, 2));
inverse.called.should.be.false();
done();
}).catch(done);
});
it('should handle browse post call with featured:true', function (done) {
helpers.get.call(
{},
'posts',
{hash: {filter: 'featured:true'}, data: locals, fn: fn, inverse: inverse}
).then(function () {
fn.calledOnce.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('posts');
fn.firstCall.args[0].posts.should.have.lengthOf(1);
fn.firstCall.args[0].posts.should.eql(testPostsArr.slice(2, 3));
inverse.called.should.be.false();
done();
}).catch(done);
});
it('should handle read post by id call', function (done) {
helpers.get.call(
{},
'posts',
{hash: {id: '2'}, data: locals, fn: fn, inverse: inverse}
).then(function () {
fn.calledOnce.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('posts');
fn.firstCall.args[0].posts.should.have.lengthOf(1);
fn.firstCall.args[0].posts.should.eql(testPostsArr.slice(1, 2));
inverse.called.should.be.false();
done();
}).catch(done);
});
it('should handle empty result set', function (done) {
helpers.get.call(
{},
'posts',
{hash: {filter: 'tags:none'}, data: locals, fn: fn, inverse: inverse}
).then(function () {
fn.calledOnce.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('posts');
fn.firstCall.args[0].posts.should.have.lengthOf(0);
inverse.called.should.be.false();
done();
}).catch(done);
});
});
describe('users v0.1', function () {
let browseUsersStub;
const meta = {pagination: {}};
beforeEach(function () {
browseUsersStub = sinon.stub(api['v0.1'].users, 'browse');
browseUsersStub.returns(new Promise.resolve({users: [], meta: meta}));
});
it('browse users v0.1', function (done) {
helpers.get.call(
{},
'users',
{hash: {}, data: locals, fn: fn, inverse: inverse}
).then(function () {
labsStub.calledOnce.should.be.true();
fn.called.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('users');
fn.firstCall.args[0].users.should.eql([]);
inverse.called.should.be.false();
done();
}).catch(done);
});
});
describe('authors v0.1', function () {
let browseUsersStub;
const meta = {pagination: {}};
beforeEach(function () {
browseUsersStub = sinon.stub(api['v0.1'].users, 'browse');
browseUsersStub.returns(new Promise.resolve({users: [], meta: meta}));
});
it('browse users v0.1', function (done) {
helpers.get.call(
{},
'authors',
{hash: {}, data: locals, fn: fn, inverse: inverse}
).then(function () {
inverse.calledOnce.should.be.true();
should.exist(inverse.args[0][1].data.error);
done();
}).catch(done);
});
});
describe('users v2', function () {
let browseUsersStub;
const meta = {pagination: {}};
beforeEach(function () {
locals = {root: {_locals: {apiVersion: 'v2'}}};
browseUsersStub = sinon.stub(api.v2, 'authorsPublic').get(() => {
return {
browse: sinon.stub().resolves({authors: [], meta: meta})
};
});
});
it('browse users', function (done) {
helpers.get.call(
{},
'users',
{hash: {}, data: locals, fn: fn, inverse: inverse}
).then(function () {
// We don't use the labs helper for v2
labsStub.calledOnce.should.be.false();
fn.called.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('authors');
fn.firstCall.args[0].authors.should.eql([]);
inverse.called.should.be.false();
done();
}).catch(done);
});
});
describe('authors v2', function () {
let browseUsersStub;
const meta = {pagination: {}};
beforeEach(function () {
locals = {root: {_locals: {apiVersion: 'v2'}}};
browseUsersStub = sinon.stub(api.v2, 'authorsPublic').get(() => {
return {
browse: sinon.stub().resolves({authors: [], meta: meta})
};
});
});
it('browse users', function (done) {
helpers.get.call(
{},
'authors',
{hash: {}, data: locals, fn: fn, inverse: inverse}
).then(function () {
// We don't use the labs helper for v2
labsStub.calledOnce.should.be.false();
fn.called.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('authors');
fn.firstCall.args[0].authors.should.eql([]);
inverse.called.should.be.false();
done();
}).catch(done);
});
});
describe('users canary', function () {
let browseUsersStub;
const meta = {pagination: {}};
beforeEach(function () {
locals = {root: {_locals: {apiVersion: 'canary'}}};
browseUsersStub = sinon.stub(api.canary, 'authorsPublic').get(() => {
return {
browse: sinon.stub().resolves({authors: [], meta: meta})
};
});
});
it('browse users', function (done) {
helpers.get.call(
{},
'users',
{hash: {}, data: locals, fn: fn, inverse: inverse}
).then(function () {
// We don't use the labs helper for canary
labsStub.calledOnce.should.be.false();
fn.called.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('authors');
fn.firstCall.args[0].authors.should.eql([]);
inverse.called.should.be.false();
done();
}).catch(done);
});
});
describe('authors canary', function () {
let browseUsersStub;
const meta = {pagination: {}};
beforeEach(function () {
locals = {root: {_locals: {apiVersion: 'canary'}}};
browseUsersStub = sinon.stub(api.canary, 'authorsPublic').get(() => {
return {
browse: sinon.stub().resolves({authors: [], meta: meta})
};
});
});
it('browse users', function (done) {
helpers.get.call(
{},
'authors',
{hash: {}, data: locals, fn: fn, inverse: inverse}
).then(function () {
// We don't use the labs helper for canary
labsStub.calledOnce.should.be.false();
fn.called.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('authors');
fn.firstCall.args[0].authors.should.eql([]);
inverse.called.should.be.false();
done();
}).catch(done);
});
});
describe('users v3', function () {
let browseUsersStub;
const meta = {pagination: {}};
beforeEach(function () {
locals = {root: {_locals: {apiVersion: 'v3'}}};
browseUsersStub = sinon.stub(api.v3, 'authorsPublic').get(() => {
return {
browse: sinon.stub().resolves({authors: [], meta: meta})
};
});
});
it('browse users', function (done) {
helpers.get.call(
{},
'users',
{hash: {}, data: locals, fn: fn, inverse: inverse}
).then(function () {
// We don't use the labs helper for v3
labsStub.calledOnce.should.be.false();
fn.called.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('authors');
fn.firstCall.args[0].authors.should.eql([]);
inverse.called.should.be.false();
done();
}).catch(done);
});
});
describe('authors v3', function () {
let browseUsersStub;
const meta = {pagination: {}};
beforeEach(function () {
locals = {root: {_locals: {apiVersion: 'v3'}}};
browseUsersStub = sinon.stub(api.v3, 'authorsPublic').get(() => {
return {
browse: sinon.stub().resolves({authors: [], meta: meta})
};
});
});
it('browse users', function (done) {
helpers.get.call(
{},
'authors',
{hash: {}, data: locals, fn: fn, inverse: inverse}
).then(function () {
// We don't use the labs helper for v3
labsStub.calledOnce.should.be.false();
fn.called.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('authors');
fn.firstCall.args[0].authors.should.eql([]);
inverse.called.should.be.false();
done();
}).catch(done);
});
});
describe('general error handling', function () {
it('should return an error for an unknown resource', function (done) {
helpers.get.call(
{},
'magic',
{hash: {}, data: locals, fn: fn, inverse: inverse}
).then(function () {
fn.called.should.be.false();
inverse.calledOnce.should.be.true();
inverse.firstCall.args[1].should.be.an.Object().and.have.property('data');
inverse.firstCall.args[1].data.should.be.an.Object().and.have.property('error');
inverse.firstCall.args[1].data.error.should.eql('Invalid resource given to get helper');
done();
}).catch(done);
});
it('should handle error from the API', function (done) {
helpers.get.call(
{},
'posts',
{hash: {status: 'thing!'}, data: locals, fn: fn, inverse: inverse}
).then(function () {
fn.called.should.be.false();
inverse.calledOnce.should.be.true();
inverse.firstCall.args[1].should.be.an.Object().and.have.property('data');
inverse.firstCall.args[1].data.should.be.an.Object().and.have.property('error');
inverse.firstCall.args[1].data.error.should.match(/^Validation/);
done();
}).catch(done);
});
it('should show warning for call without any options', function (done) {
helpers.get.call(
{},
'posts',
{data: locals}
).then(function () {
fn.called.should.be.false();
inverse.called.should.be.false();
done();
}).catch(done);
});
});
describe('path resolution', function () {
var browseStub, readStub,
pubDate = new Date(),
resource = {
post: {id: 3, title: 'Test 3', author: {slug: 'cameron'}, tags: [{slug: 'test'}, {slug: 'magic'}], published_at: pubDate}
};
beforeEach(function () {
browseStub = sinon.stub(api['v0.1'].posts, 'browse').returns(new Promise.resolve());
readStub = sinon.stub(api['v0.1'].posts, 'read').returns(new Promise.resolve());
});
it('should resolve post.tags alias', function (done) {
helpers.get.call(
resource,
'posts',
{hash: {filter: 'tags:[{{post.tags}}]'}, data: locals, fn: fn, inverse: inverse}
).then(function () {
browseStub.firstCall.args.should.be.an.Array().with.lengthOf(1);
browseStub.firstCall.args[0].should.be.an.Object().with.property('filter');
browseStub.firstCall.args[0].filter.should.eql('tags:[test,magic]');
done();
}).catch(done);
});
it('should resolve post.author alias', function (done) {
helpers.get.call(
resource,
'posts',
{hash: {filter: 'author:{{post.author}}'}, data: locals, fn: fn, inverse: inverse}
).then(function () {
browseStub.firstCall.args.should.be.an.Array().with.lengthOf(1);
browseStub.firstCall.args[0].should.be.an.Object().with.property('filter');
browseStub.firstCall.args[0].filter.should.eql('author:cameron');
done();
}).catch(done);
});
it('should resolve basic path', function (done) {
helpers.get.call(
resource,
'posts',
{hash: {filter: 'id:-{{post.id}}'}, data: locals, fn: fn, inverse: inverse}
).then(function () {
browseStub.firstCall.args.should.be.an.Array().with.lengthOf(1);
browseStub.firstCall.args[0].should.be.an.Object().with.property('filter');
browseStub.firstCall.args[0].filter.should.eql('id:-3');
done();
}).catch(done);
});
it('should handle arrays the same as handlebars', function (done) {
helpers.get.call(
resource,
'posts',
{hash: {filter: 'tags:{{post.tags.[0].slug}}'}, data: locals, fn: fn, inverse: inverse}
).then(function () {
browseStub.firstCall.args.should.be.an.Array().with.lengthOf(1);
browseStub.firstCall.args[0].should.be.an.Object().with.property('filter');
browseStub.firstCall.args[0].filter.should.eql('tags:test');
done();
}).catch(done);
});
it('should handle dates', function (done) {
helpers.get.call(
resource,
'posts',
{hash: {filter: 'published_at:<=\'{{post.published_at}}\''}, data: locals, fn: fn, inverse: inverse}
).then(function () {
browseStub.firstCall.args.should.be.an.Array().with.lengthOf(1);
browseStub.firstCall.args[0].should.be.an.Object().with.property('filter');
browseStub.firstCall.args[0].filter.should.eql(`published_at:<='${pubDate.toISOString()}'`);
done();
}).catch(done);
});
it('should output nothing if path does not resolve', function (done) {
helpers.get.call(
resource,
'posts',
{hash: {filter: 'id:{{post.thing}}'}, data: locals, fn: fn, inverse: inverse}
).then(function () {
browseStub.firstCall.args.should.be.an.Array().with.lengthOf(1);
browseStub.firstCall.args[0].should.be.an.Object().with.property('filter');
browseStub.firstCall.args[0].filter.should.eql('id:');
done();
}).catch(done);
});
it('should resolve global props', function (done) {
helpers.get.call(
resource,
'posts',
{hash: {filter: 'slug:{{@globalProp.foo}}'}, data: locals, fn: fn, inverse: inverse}
).then(function () {
browseStub.firstCall.args.should.be.an.Array().with.lengthOf(1);
browseStub.firstCall.args[0].should.be.an.Object().with.property('filter');
browseStub.firstCall.args[0].filter.should.eql('slug:bar');
done();
}).catch(done);
});
});
});