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

Added custom_theme_settings table/model (#13327)

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

- stores values of custom theme settings
  - will be merged with full settings data parsed from themes for API output
  - will be cached and made available for lookup in themes to avoid db roundtrips
- stores type of custom theme settings so we can coerce values and know if the type has changed when syncing
- records will be synced with themes upon activation
This commit is contained in:
Kevin Ansfield 2021-09-23 11:51:18 +01:00 committed by GitHub
parent 91907cd900
commit 57effd9585
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 54 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
core/server/data/exporter/table-lists.js
View File

@ -50,6 +50,7 @@ const TABLES_ALLOWLIST = [
'roles',
'roles_users',
'settings',
'custom_theme_settings',
'tags',
'users'
];

9
core/server/data/migrations/versions/4.16/01-add-custom-theme-settings-table.js Normal file
View File

@ -0,0 +1,9 @@
const utils = require('../../utils');
module.exports = utils.addTable('custom_theme_settings', {
id: {type: 'string', maxlength: 24, nullable: false, primary: true},
theme: {type: 'string', maxlength: 191, nullable: false},
key: {type: 'string', maxlength: 191, nullable: false},
type: {type: 'string', maxlength: 50, nullable: false},
value: {type: 'text', maxlength: 65535, nullable: true}
});

16
core/server/data/schema/schema.js
View File

@ -643,5 +643,21 @@ module.exports = {
entry_id: {type: 'string', maxlength: 24, nullable: true},
source_url: {type: 'string', maxlength: 2000, nullable: true},
metadata: {type: 'string', maxlength: 191, nullable: true}
},
custom_theme_settings: {
id: {type: 'string', maxlength: 24, nullable: false, primary: true},
theme: {type: 'string', maxlength: 191, nullable: false},
key: {type: 'string', maxlength: 191, nullable: false},
type: {
type: 'string',
maxlength: 50,
nullable: false,
validations: {
isIn: [[
'select'
]]
}
},
value: {type: 'text', maxlength: 65535, nullable: true}
}
};

9
core/server/models/custom-theme-setting.js Normal file
View File

@ -0,0 +1,9 @@
const ghostBookshelf = require('./base');
const CustomThemeSetting = ghostBookshelf.Model.extend({
tableName: 'custom_theme_settings'
});
module.exports = {
CustomThemeSetting: ghostBookshelf.model('CustomThemeSetting', CustomThemeSetting)
};

1
core/server/models/index.js
View File

@ -17,6 +17,7 @@ const models = [
'post',
'role',
'settings',
'custom-theme-setting',
'session',
'tag',
'tag-public',

6
test/regression/api/canary/admin/db.test.js
View File

@ -15,7 +15,7 @@ let ghost = testUtils.startGhost;
let request;
let eventsTriggered;
describe('DB API', function () {
describe('DB API (canary)', function () {
let backupKey;
let schedulerKey;
@ -59,8 +59,8 @@ describe('DB API', function () {
should.exist(jsonResponse.db);
jsonResponse.db.should.have.length(1);
// NOTE: 9 default tables + 1 from include parameters
Object.keys(jsonResponse.db[0].data).length.should.eql(10);
// NOTE: 10 default tables + 1 from include parameters
Object.keys(jsonResponse.db[0].data).length.should.eql(11);
});
});

6
test/regression/api/v2/admin/db.test.js
View File

@ -15,7 +15,7 @@ let ghost = testUtils.startGhost;
let request;
let eventsTriggered;
describe('DB API', function () {
describe('DB API (v2)', function () {
let backupKey;
let schedulerKey;
@ -59,8 +59,8 @@ describe('DB API', function () {
should.exist(jsonResponse.db);
jsonResponse.db.should.have.length(1);
// NOTE: 9 default tables + 1 from include parameters
Object.keys(jsonResponse.db[0].data).length.should.eql(10);
// NOTE: 10 default tables + 1 from include parameters
Object.keys(jsonResponse.db[0].data).length.should.eql(11);
});
});

6
test/regression/api/v3/admin/db.test.js
View File

@ -15,7 +15,7 @@ let ghost = testUtils.startGhost;
let request;
let eventsTriggered;
describe('DB API', function () {
describe('DB API (v3)', function () {
let backupKey;
let schedulerKey;
@ -59,8 +59,8 @@ describe('DB API', function () {
should.exist(jsonResponse.db);
jsonResponse.db.should.have.length(1);
// NOTE: 9 default tables + 1 from include parameters
Object.keys(jsonResponse.db[0].data).length.should.eql(10);
// NOTE: 10 default tables + 1 from include parameters
Object.keys(jsonResponse.db[0].data).length.should.eql(11);
});
});

1
test/regression/exporter/exporter.test.js
View File

@ -25,6 +25,7 @@ describe('Exporter', function () {
'actions',
'api_keys',
'brute',
'custom_theme_settings',
'email_batches',
'email_recipients',
'emails',

10
test/unit/data/exporter/index.test.js
View File

@ -40,8 +40,8 @@ describe('Exporter', function () {
it('should try to export all the correct tables (without excluded)', function (done) {
exporter.doExport().then(function (exportData) {
// NOTE: 9 default tables
const expectedCallCount = 9;
// NOTE: 10 default tables
const expectedCallCount = 10;
should.exist(exportData);
@ -62,6 +62,7 @@ describe('Exporter', function () {
knexMock.getCall(6).args[0].should.eql('settings');
knexMock.getCall(7).args[0].should.eql('tags');
knexMock.getCall(8).args[0].should.eql('posts_tags');
knexMock.getCall(9).args[0].should.eql('custom_theme_settings');
done();
}).catch(done);
@ -71,8 +72,8 @@ describe('Exporter', function () {
const include = ['mobiledoc_revisions', 'email_recipients'];
exporter.doExport({include}).then(function (exportData) {
// NOTE: 9 default tables + 2 includes
const expectedCallCount = 11;
// NOTE: 10 default tables + 2 includes
const expectedCallCount = 12;
should.exist(exportData);
@ -96,6 +97,7 @@ describe('Exporter', function () {
knexMock.getCall(8).args[0].should.eql('posts_tags');
knexMock.getCall(9).args[0].should.eql('mobiledoc_revisions');
knexMock.getCall(10).args[0].should.eql('email_recipients');
knexMock.getCall(11).args[0].should.eql('custom_theme_settings');
done();
}).catch(done);

2
test/unit/data/schema/integrity.test.js
View File

@ -32,7 +32,7 @@ const defaultSettings = require('../../../../core/server/data/schema/default-set
*/
describe('DB version integrity', function () {
// Only these variables should need updating
const currentSchemaHash = '939c4993e183e0664362383a875cfc2d';
const currentSchemaHash = '66e58a7b9081ccf78ac539a527f27332';
const currentFixturesHash = '8e04dbcb4b8e429e70989572fc9c67b9';
const currentSettingsHash = 'aa3fcbc8ab119b630aeda7366ead5493';
const currentRoutesHash = '3d180d52c663d173a6be791ef411ed01';

1
test/utils/fixtures/export/body-generator.js
View File

@ -141,6 +141,7 @@ const exportedBodyLatest = () => {
version: '4.1.2'
},
data: {
custom_theme_settings: [],
posts: [],
posts_authors: [],
posts_meta: [],