TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-09-20 17:17:36 +03:00
Code Issues Projects Releases Wiki Activity

Fixed "Error parsing filter" when a theme name contains . chars

Browse Source 
no issue

- we were passing the theme name directly in the model query filter string without any surrounding `'` chars meaning we were generating invalid filters
This commit is contained in:
Kevin Ansfield 2021-10-26 10:14:39 +01:00
parent 399e9e0239
commit 5c2f25d016
3 changed files with 34 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ghost/custom-theme-settings-service/lib/service.js
View File

@ -131,7 +131,7 @@ module.exports = class CustomThemeSettingsService {
async _syncRepositoryWithTheme(name, theme) {
const themeSettings = theme.customSettings || {};
const settingsCollection = await this._repository.browse({filter: `theme:${name}`});
const settingsCollection = await this._repository.browse({filter: `theme:'${name}'`});
let knownSettings = settingsCollection.toJSON();
// exit early if there's nothing to sync for this theme
@ -182,7 +182,7 @@ module.exports = class CustomThemeSettingsService {
}
}
const updatedSettingsCollection = await this._repository.browse({filter: `theme:${name}`});
const updatedSettingsCollection = await this._repository.browse({filter: `theme:'${name}'`});
return updatedSettingsCollection.toJSON();
}

1
ghost/custom-theme-settings-service/package.json
View File

@ -19,6 +19,7 @@
"access": "public"
},
"devDependencies": {
"@nexes/nql": "^0.6.0",
"c8": "7.10.0",
"mocha": "9.1.3",
"should": "13.2.3",

38
ghost/custom-theme-settings-service/test/service.test.js
View File

@ -5,6 +5,7 @@ require('./utils');
const _ = require('lodash');
const sinon = require('sinon');
const {ValidationError} = require('@tryghost/errors');
const nql = require('@nexes/nql-lang');
const Service = require('../lib/service');
const Cache = require('../lib/cache');
@ -34,7 +35,7 @@ class ModelStub {
// we only use 'theme:{themeName}' in filters
const [key, value] = options.filter.split(':');
const matcher = {};
matcher[key] = value;
matcher[key] = value.replace(/^'|'$/g, '');
foundSettings = this.knownSettings.filter(_.matches(matcher));
}
@ -116,8 +117,8 @@ describe('Service', function () {
});
model.findAll.callCount.should.equal(2);
model.findAll.getCall(0).firstArg.should.deepEqual({filter: 'theme:test'});
model.findAll.getCall(1).firstArg.should.deepEqual({filter: 'theme:test'});
model.findAll.getCall(0).firstArg.should.deepEqual({filter: `theme:'test'`});
model.findAll.getCall(1).firstArg.should.deepEqual({filter: `theme:'test'`});
// destroys records that no longer exist in theme
model.destroy.callCount.should.equal(1);
@ -320,10 +321,10 @@ describe('Service', function () {
// looks for existing settings, then re-fetches after sync. Twice for each activation
model.findAll.callCount.should.equal(4);
model.findAll.getCall(0).firstArg.should.deepEqual({filter: 'theme:test'});
model.findAll.getCall(1).firstArg.should.deepEqual({filter: 'theme:test'});
model.findAll.getCall(2).firstArg.should.deepEqual({filter: 'theme:new'});
model.findAll.getCall(3).firstArg.should.deepEqual({filter: 'theme:new'});
model.findAll.getCall(0).firstArg.should.deepEqual({filter: `theme:'test'`});
model.findAll.getCall(1).firstArg.should.deepEqual({filter: `theme:'test'`});
model.findAll.getCall(2).firstArg.should.deepEqual({filter: `theme:'new'`});
model.findAll.getCall(3).firstArg.should.deepEqual({filter: `theme:'new'`});
// adds new settings
model.add.callCount.should.equal(2);
@ -371,6 +372,29 @@ describe('Service', function () {
model.findAll.callCount.should.equal(1);
});
it('generates a valid filter string for theme names with dots', async function () {
await service.activateTheme('4.1.1-test', {
name: 'casper',
customSettings: {
// 'one' custom setting no longer exists
// 'two' - no change
two: {
type: 'select',
options: ['2', '3'],
default: '2'
}
}
});
model.findAll.callCount.should.equal(2);
should.exist(model.findAll.getCall(0).firstArg.filter);
should.doesNotThrow(() => nql.parse(model.findAll.getCall(0).firstArg.filter));
should.exist(model.findAll.getCall(1).firstArg.filter);
should.doesNotThrow(() => nql.parse(model.findAll.getCall(1).firstArg.filter));
});
});
describe('listSettings()', function () {