TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-25 11:55:03 +03:00
Code Issues Projects Releases Wiki Activity

Supported restricting limit="all" in get helper (#13903)

Browse Source 
refs https://github.com/TryGhost/Team/issues/1251

With sites that have a huge number of resources, using limit="all" can
cause OOM errors at the Node level. Administrators now have the ability
to cap limit="all" requests via config. This only affects the get helper
used in themes, not the API, this is by design as themes have less
visibility of issues.
This commit is contained in:
Fabien 'egg' O'Carroll 2021-12-16 13:59:39 +02:00 committed by GitHub
parent 18a58e6cb0
commit 0c853a372b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 78 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
core/frontend/helpers/get.js
View File

@ -109,6 +109,10 @@ function parseOptions(globals, data, options) {
options.filter = resolvePaths(globals, data, options.filter);
}
if (options.limit === 'all' && config.get('getHelperLimitAllMax')) {
options.limit = config.get('getHelperLimitAllMax');
}
return options;
}

74
test/unit/frontend/helpers/get.test.js
View File

@ -8,6 +8,7 @@ const get = require('../../../../core/frontend/helpers/get');
const models = require('../../../../core/server/models');
const api = require('../../../../core/server/api');
const proxy = require('../../../../core/frontend/services/proxy');
describe('{{#get}} helper', function () {
let fn;
@ -314,4 +315,77 @@ describe('{{#get}} helper', function () {
}).catch(done);
});
});
describe('limit=all max', function () {
let browseStub;
beforeEach(function () {
browseStub = sinon.stub().resolves();
sinon.stub(api.v2, 'postsPublic').get(() => {
return {
browse: browseStub
};
});
sinon.stub(api.v3, 'postsPublic').get(() => {
return {
browse: browseStub
};
});
sinon.stub(api.canary, 'postsPublic').get(() => {
return {
browse: browseStub
};
});
});
it('Behaves normally without config', async function () {
locals = {root: {_locals: {apiVersion: 'v2'}}};
await get.call(
{},
'posts',
{hash: {limit: 'all'}, data: locals, fn: fn, inverse: inverse}
);
browseStub.firstCall.args[0].limit.should.eql('all');
locals = {root: {_locals: {apiVersion: 'v3'}}};
await get.call(
{},
'posts',
{hash: {limit: 'all'}, data: locals, fn: fn, inverse: inverse}
);
browseStub.secondCall.args[0].limit.should.eql('all');
locals = {root: {_locals: {apiVersion: 'canary'}}};
await get.call(
{},
'posts',
{hash: {limit: 'all'}, data: locals, fn: fn, inverse: inverse}
);
browseStub.thirdCall.args[0].limit.should.eql('all');
});
it('Replaces "all" with "getHelperLimitAllMax" config, if present', async function () {
sinon.stub(proxy.config, 'get').withArgs('getHelperLimitAllMax').returns(2);
locals = {root: {_locals: {apiVersion: 'v2'}}};
await get.call(
{},
'posts',
{hash: {limit: 'all'}, data: locals, fn: fn, inverse: inverse}
);
browseStub.firstCall.args[0].limit.should.eql(2);
locals = {root: {_locals: {apiVersion: 'v3'}}};
await get.call(
{},
'posts',
{hash: {limit: 'all'}, data: locals, fn: fn, inverse: inverse}
);
browseStub.secondCall.args[0].limit.should.eql(2);
locals = {root: {_locals: {apiVersion: 'canary'}}};
await get.call(
{},
'posts',
{hash: {limit: 'all'}, data: locals, fn: fn, inverse: inverse}
);
browseStub.thirdCall.args[0].limit.should.eql(2);
});
});
});