Ghost/test/unit/services/routing/helpers/fetch-data_spec.js

const should = require('should');
const sinon = require('sinon');
const api = require('../../../../../core/server/api').v2;
const helpers = require('../../../../../core/frontend/services/routing/helpers');
const testUtils = require('../../../../utils');

describe('Unit - services/routing/helpers/fetch-data', function () {
    let posts;
    let tags;
    let locals;
    let browsePostsStub;
    let readTagsStub;

    beforeEach(function () {
        posts = [
            testUtils.DataGenerator.forKnex.createPost({url: '/a/'}),
            testUtils.DataGenerator.forKnex.createPost({url: '/b/'}),
            testUtils.DataGenerator.forKnex.createPost({url: '/c/'}),
            testUtils.DataGenerator.forKnex.createPost({url: '/d/'})
        ];

        tags = [
            testUtils.DataGenerator.forKnex.createTag(),
            testUtils.DataGenerator.forKnex.createTag(),
            testUtils.DataGenerator.forKnex.createTag(),
            testUtils.DataGenerator.forKnex.createTag()
        ];

        browsePostsStub = sinon.stub().resolves({
            posts: posts,
            meta: {
                pagination: {
                    pages: 2
                }
            }
        });
        sinon.stub(api, 'postsPublic').get(() => {
            return {
                browse: browsePostsStub
            };
        });

        readTagsStub = sinon.stub().resolves({tags: tags});
        sinon.stub(api, 'tagsPublic').get(() => {
            return {
                read: readTagsStub
            };
        });

        locals = {apiVersion: 'v2'};
    });

    afterEach(function () {
        sinon.restore();
    });

    it('should handle no options', function (done) {
        helpers.fetchData(null, null, locals).then(function (result) {
            should.exist(result);
            result.should.be.an.Object().with.properties('posts', 'meta');
            result.should.not.have.property('data');

            browsePostsStub.calledOnce.should.be.true();
            browsePostsStub.firstCall.args[0].should.be.an.Object();
            browsePostsStub.firstCall.args[0].should.have.property('include');
            browsePostsStub.firstCall.args[0].should.not.have.property('filter');

            done();
        }).catch(done);
    });

    it('should handle path options with page/limit', function (done) {
        helpers.fetchData({page: 2, limit: 10}, null, locals).then(function (result) {
            should.exist(result);
            result.should.be.an.Object().with.properties('posts', 'meta');
            result.should.not.have.property('data');

            result.posts.length.should.eql(posts.length);

            browsePostsStub.calledOnce.should.be.true();
            browsePostsStub.firstCall.args[0].should.be.an.Object();
            browsePostsStub.firstCall.args[0].should.have.property('include');
            browsePostsStub.firstCall.args[0].should.have.property('limit', 10);
            browsePostsStub.firstCall.args[0].should.have.property('page', 2);

            done();
        }).catch(done);
    });

    it('should handle multiple queries', function (done) {
        const pathOptions = {};

        const routerOptions = {
            data: {
                featured: {
                    type: 'browse',
                    resource: 'posts',
                    options: {
                        filter: 'featured:true',
                        limit: 3
                    }
                }
            }
        };

        helpers.fetchData(pathOptions, routerOptions, locals).then(function (result) {
            should.exist(result);
            result.should.be.an.Object().with.properties('posts', 'meta', 'data');
            result.data.should.be.an.Object().with.properties('featured');
            result.data.featured.should.be.an.Object().with.properties('posts', 'meta');
            result.data.featured.should.not.have.properties('data');

            result.posts.length.should.eql(posts.length);
            result.data.featured.length.should.eql(posts.length);
            // @TODO v3 will deprecate this style (featured.posts)
            result.data.featured.posts.length.should.eql(posts.length);

            browsePostsStub.calledTwice.should.be.true();
            browsePostsStub.firstCall.args[0].should.have.property('include', 'authors,tags');
            browsePostsStub.secondCall.args[0].should.have.property('filter', 'featured:true');
            browsePostsStub.secondCall.args[0].should.have.property('limit', 3);
            done();
        }).catch(done);
    });

    it('should handle multiple queries with page param', function (done) {
        const pathOptions = {
            page: 2
        };

        const routerOptions = {
            data: {
                featured: {
                    type: 'browse',
                    resource: 'posts',
                    options: {filter: 'featured:true', limit: 3}
                }
            }
        };

        helpers.fetchData(pathOptions, routerOptions, locals).then(function (result) {
            should.exist(result);

            result.should.be.an.Object().with.properties('posts', 'meta', 'data');
            result.data.should.be.an.Object().with.properties('featured');
            result.data.featured.should.be.an.Object().with.properties('posts', 'meta');
            result.data.featured.should.not.have.properties('data');

            result.posts.length.should.eql(posts.length);
            result.data.featured.length.should.eql(posts.length);
            // @TODO v3 will deprecate this style (featured.posts)
            result.data.featured.posts.length.should.eql(posts.length);

            browsePostsStub.calledTwice.should.be.true();
            browsePostsStub.firstCall.args[0].should.have.property('include', 'authors,tags');
            browsePostsStub.firstCall.args[0].should.have.property('page', 2);
            browsePostsStub.secondCall.args[0].should.have.property('filter', 'featured:true');
            browsePostsStub.secondCall.args[0].should.have.property('limit', 3);
            done();
        }).catch(done);
    });

    it('should handle queries with slug replacements', function (done) {
        const pathOptions = {
            slug: 'testing'
        };

        const routerOptions = {
            filter: 'tags:%s',
            data: {
                tag: {
                    controller: 'tagsPublic',
                    type: 'read',
                    resource: 'tags',
                    options: {slug: '%s'}
                }
            }
        };

        helpers.fetchData(pathOptions, routerOptions, locals).then(function (result) {
            should.exist(result);
            result.should.be.an.Object().with.properties('posts', 'meta', 'data');
            result.data.should.be.an.Object().with.properties('tag');

            result.posts.length.should.eql(posts.length);
            result.data.tag.length.should.eql(tags.length);

            browsePostsStub.calledOnce.should.be.true();
            browsePostsStub.firstCall.args[0].should.have.property('include');
            browsePostsStub.firstCall.args[0].should.have.property('filter', 'tags:testing');
            browsePostsStub.firstCall.args[0].should.not.have.property('slug');
            readTagsStub.firstCall.args[0].should.have.property('slug', 'testing');
            done();
        }).catch(done);
    });
});