mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-15 11:34:24 +03:00
c6a95c6478
no issue
- this commit cleans up the usages of `include` and `withRelated`.
### API layer (`include`)
- as request parameter e.g. `?include=roles,tags`
- as theme API parameter e.g. `{{get .... include="author"}}`
- as internal API access e.g. `api.posts.browse({include: 'author,tags'})`
- the `include` notation is more readable than `withRelated`
- and it allows us to use a different easier format (comma separated list)
- the API utility transforms these more readable properties into model style (or into Ghost style)
### Model access (`withRelated`)
- e.g. `models.Post.findPage({withRelated: ['tags']})`
- driven by bookshelf
---
Commits explained.
* Reorder the usage of `convertOptions`
- 1. validation
- 2. options convertion
- 3. permissions
- the reason is simple, the permission layer access the model layer
- we have to prepare the options before talking to the model layer
- added `convertOptions` where it was missed (not required, but for consistency reasons)
* Use `withRelated` when accessing the model layer and use `include` when accessing the API layer
* Change `convertOptions` API utiliy
- API Usage
- ghost.api(..., {include: 'tags,authors'})
- `include` should only be used when calling the API (either via request or via manual usage)
- `include` is only for readability and easier format
- Ghost (Model Layer Usage)
- models.Post.findOne(..., {withRelated: ['tags', 'authors']})
- should only use `withRelated`
- model layer cannot read 'tags,authors`
- model layer has no idea what `include` means, speaks a different language
- `withRelated` is bookshelf
- internal usage
* include-count plugin: use `withRelated` instead of `include`
- imagine you outsource this plugin to git and publish it to npm
- `include` is an unknown option in bookshelf
* Updated `permittedOptions` in base model
- `include` is no longer a known option
* Remove all occurances of `include` in the model layer
* Extend `filterOptions` base function
- this function should be called as first action
- we clone the unfiltered options
- check if you are using `include` (this is a protection which could help us in the beginning)
- check for permitted and (later on default `withRelated`) options
- the usage is coming in next commit
* Ensure we call `filterOptions` as first action
- use `ghostBookshelf.Model.filterOptions` as first action
- consistent naming pattern for incoming options: `unfilteredOptions`
- re-added allowed options for `toJSON`
- one unsolved architecture problem:
- if you override a function e.g. `edit`
- then you should call `filterOptions` as first action
- the base implementation of e.g. `edit` will call it again
- future improvement
* Removed `findOne` from Invite model
- no longer needed, the base implementation is the same
235 lines
12 KiB
JavaScript
235 lines
12 KiB
JavaScript
var should = require('should'),
|
|
sinon = require('sinon'),
|
|
testUtils = require('../utils'),
|
|
_ = require('lodash'),
|
|
Promise = require('bluebird'),
|
|
Models = require('../../server/models'),
|
|
sandbox = sinon.sandbox.create();
|
|
|
|
describe('Database Migration (special functions)', function () {
|
|
before(testUtils.teardown);
|
|
afterEach(testUtils.teardown);
|
|
afterEach(function () {
|
|
sandbox.restore();
|
|
});
|
|
|
|
describe('Fixtures', function () {
|
|
// Custom assertion for detection that a permissions is assigned to the correct roles
|
|
should.Assertion.add('AssignedToRoles', function (roles) {
|
|
var roleNames;
|
|
this.params = {operator: 'to have role'};
|
|
|
|
should.exist(this.obj);
|
|
|
|
this.obj.should.be.an.Object().with.property(['roles']);
|
|
this.obj.roles.should.be.an.Array();
|
|
|
|
// Ensure the roles are in id order
|
|
roleNames = _(this.obj.roles).sortBy('id').map('name').value();
|
|
roleNames.should.eql(roles);
|
|
});
|
|
|
|
// Custom assertion to wrap all permissions
|
|
should.Assertion.add('CompletePermissions', function () {
|
|
this.params = {operator: 'to have a complete set of permissions'};
|
|
var permissions = this.obj;
|
|
|
|
// DB
|
|
permissions[0].name.should.eql('Export database');
|
|
permissions[0].should.be.AssignedToRoles(['Administrator']);
|
|
permissions[1].name.should.eql('Import database');
|
|
permissions[1].should.be.AssignedToRoles(['Administrator']);
|
|
permissions[2].name.should.eql('Delete all content');
|
|
permissions[2].should.be.AssignedToRoles(['Administrator']);
|
|
|
|
// Mail
|
|
permissions[3].name.should.eql('Send mail');
|
|
permissions[3].should.be.AssignedToRoles(['Administrator']);
|
|
|
|
// Notifications
|
|
permissions[4].name.should.eql('Browse notifications');
|
|
permissions[4].should.be.AssignedToRoles(['Administrator']);
|
|
permissions[5].name.should.eql('Add notifications');
|
|
permissions[5].should.be.AssignedToRoles(['Administrator']);
|
|
permissions[6].name.should.eql('Delete notifications');
|
|
permissions[6].should.be.AssignedToRoles(['Administrator']);
|
|
|
|
// Posts
|
|
permissions[7].name.should.eql('Browse posts');
|
|
permissions[7].should.be.AssignedToRoles(['Administrator', 'Editor', 'Author', 'Contributor']);
|
|
permissions[8].name.should.eql('Read posts');
|
|
permissions[8].should.be.AssignedToRoles(['Administrator', 'Editor', 'Author', 'Contributor']);
|
|
permissions[9].name.should.eql('Edit posts');
|
|
permissions[9].should.be.AssignedToRoles(['Administrator', 'Editor']);
|
|
permissions[10].name.should.eql('Add posts');
|
|
permissions[10].should.be.AssignedToRoles(['Administrator', 'Editor', 'Author', 'Contributor']);
|
|
permissions[11].name.should.eql('Delete posts');
|
|
permissions[11].should.be.AssignedToRoles(['Administrator', 'Editor']);
|
|
|
|
// Settings
|
|
permissions[12].name.should.eql('Browse settings');
|
|
permissions[12].should.be.AssignedToRoles(['Administrator', 'Editor', 'Author', 'Contributor']);
|
|
permissions[13].name.should.eql('Read settings');
|
|
permissions[13].should.be.AssignedToRoles(['Administrator', 'Editor', 'Author', 'Contributor']);
|
|
permissions[14].name.should.eql('Edit settings');
|
|
permissions[14].should.be.AssignedToRoles(['Administrator']);
|
|
|
|
// Slugs
|
|
permissions[15].name.should.eql('Generate slugs');
|
|
permissions[15].should.be.AssignedToRoles(['Administrator', 'Editor', 'Author', 'Contributor']);
|
|
|
|
// Tags
|
|
permissions[16].name.should.eql('Browse tags');
|
|
permissions[16].should.be.AssignedToRoles(['Administrator', 'Editor', 'Author', 'Contributor']);
|
|
permissions[17].name.should.eql('Read tags');
|
|
permissions[17].should.be.AssignedToRoles(['Administrator', 'Editor', 'Author', 'Contributor']);
|
|
permissions[18].name.should.eql('Edit tags');
|
|
permissions[18].should.be.AssignedToRoles(['Administrator', 'Editor']);
|
|
permissions[19].name.should.eql('Add tags');
|
|
permissions[19].should.be.AssignedToRoles(['Administrator', 'Editor', 'Author']);
|
|
permissions[20].name.should.eql('Delete tags');
|
|
permissions[20].should.be.AssignedToRoles(['Administrator', 'Editor']);
|
|
|
|
// Themes
|
|
permissions[21].name.should.eql('Browse themes');
|
|
permissions[21].should.be.AssignedToRoles(['Administrator', 'Editor', 'Author', 'Contributor']);
|
|
permissions[22].name.should.eql('Edit themes');
|
|
permissions[22].should.be.AssignedToRoles(['Administrator']);
|
|
permissions[23].name.should.eql('Activate themes');
|
|
permissions[23].should.be.AssignedToRoles(['Administrator']);
|
|
permissions[24].name.should.eql('Upload themes');
|
|
permissions[24].should.be.AssignedToRoles(['Administrator']);
|
|
permissions[25].name.should.eql('Download themes');
|
|
permissions[25].should.be.AssignedToRoles(['Administrator']);
|
|
permissions[26].name.should.eql('Delete themes');
|
|
permissions[26].should.be.AssignedToRoles(['Administrator']);
|
|
|
|
// Users
|
|
permissions[27].name.should.eql('Browse users');
|
|
permissions[27].should.be.AssignedToRoles(['Administrator', 'Editor', 'Author', 'Contributor']);
|
|
permissions[28].name.should.eql('Read users');
|
|
permissions[28].should.be.AssignedToRoles(['Administrator', 'Editor', 'Author', 'Contributor']);
|
|
permissions[29].name.should.eql('Edit users');
|
|
permissions[29].should.be.AssignedToRoles(['Administrator', 'Editor']);
|
|
permissions[30].name.should.eql('Add users');
|
|
permissions[30].should.be.AssignedToRoles(['Administrator', 'Editor']);
|
|
permissions[31].name.should.eql('Delete users');
|
|
permissions[31].should.be.AssignedToRoles(['Administrator', 'Editor']);
|
|
|
|
// Roles
|
|
permissions[32].name.should.eql('Assign a role');
|
|
permissions[32].should.be.AssignedToRoles(['Administrator', 'Editor']);
|
|
permissions[33].name.should.eql('Browse roles');
|
|
permissions[33].should.be.AssignedToRoles(['Administrator', 'Editor', 'Author', 'Contributor']);
|
|
|
|
// Clients
|
|
permissions[34].name.should.eql('Browse clients');
|
|
permissions[34].should.be.AssignedToRoles(['Administrator', 'Editor', 'Author', 'Contributor']);
|
|
permissions[35].name.should.eql('Read clients');
|
|
permissions[35].should.be.AssignedToRoles(['Administrator', 'Editor', 'Author', 'Contributor']);
|
|
permissions[36].name.should.eql('Edit clients');
|
|
permissions[36].should.be.AssignedToRoles(['Administrator', 'Editor', 'Author', 'Contributor']);
|
|
permissions[37].name.should.eql('Add clients');
|
|
permissions[37].should.be.AssignedToRoles(['Administrator', 'Editor', 'Author', 'Contributor']);
|
|
permissions[38].name.should.eql('Delete clients');
|
|
permissions[38].should.be.AssignedToRoles(['Administrator', 'Editor', 'Author', 'Contributor']);
|
|
|
|
// Subscribers
|
|
permissions[39].name.should.eql('Browse subscribers');
|
|
permissions[39].should.be.AssignedToRoles(['Administrator']);
|
|
permissions[40].name.should.eql('Read subscribers');
|
|
permissions[40].should.be.AssignedToRoles(['Administrator']);
|
|
permissions[41].name.should.eql('Edit subscribers');
|
|
permissions[41].should.be.AssignedToRoles(['Administrator']);
|
|
permissions[42].name.should.eql('Add subscribers');
|
|
permissions[42].should.be.AssignedToRoles(['Administrator', 'Editor', 'Author', 'Contributor']);
|
|
permissions[43].name.should.eql('Delete subscribers');
|
|
permissions[43].should.be.AssignedToRoles(['Administrator']);
|
|
|
|
// Invites
|
|
permissions[44].name.should.eql('Browse invites');
|
|
permissions[44].should.be.AssignedToRoles(['Administrator', 'Editor']);
|
|
permissions[45].name.should.eql('Read invites');
|
|
permissions[45].should.be.AssignedToRoles(['Administrator', 'Editor']);
|
|
permissions[46].name.should.eql('Edit invites');
|
|
permissions[46].should.be.AssignedToRoles(['Administrator', 'Editor']);
|
|
permissions[47].name.should.eql('Add invites');
|
|
permissions[47].should.be.AssignedToRoles(['Administrator', 'Editor']);
|
|
permissions[48].name.should.eql('Delete invites');
|
|
permissions[48].should.be.AssignedToRoles(['Administrator', 'Editor']);
|
|
|
|
// Redirects
|
|
permissions[49].name.should.eql('Download redirects');
|
|
permissions[49].should.be.AssignedToRoles(['Administrator']);
|
|
permissions[50].name.should.eql('Upload redirects');
|
|
permissions[50].should.be.AssignedToRoles(['Administrator']);
|
|
});
|
|
|
|
describe('Populate', function () {
|
|
beforeEach(testUtils.setup('default'));
|
|
|
|
it('should populate all fixtures correctly', function () {
|
|
var props = {
|
|
posts: Models.Post.findAll({withRelated: ['tags']}),
|
|
tags: Models.Tag.findAll(),
|
|
users: Models.User.findAll({
|
|
filter: 'status:inactive',
|
|
context: {internal: true},
|
|
withRelated: ['roles']
|
|
}),
|
|
clients: Models.Client.findAll(),
|
|
roles: Models.Role.findAll(),
|
|
permissions: Models.Permission.findAll({withRelated: ['roles']})
|
|
};
|
|
|
|
return Promise.props(props).then(function (result) {
|
|
should.exist(result);
|
|
|
|
// Post
|
|
should.exist(result.posts);
|
|
result.posts.length.should.eql(7);
|
|
result.posts.at(0).get('title').should.eql('Setting up your own Ghost theme');
|
|
|
|
// Tag
|
|
should.exist(result.tags);
|
|
result.tags.length.should.eql(1);
|
|
result.tags.at(0).get('name').should.eql('Getting Started');
|
|
|
|
// Post Tag relation
|
|
result.posts.at(0).related('tags').length.should.eql(1);
|
|
result.posts.at(0).related('tags').at(0).get('name').should.eql('Getting Started');
|
|
|
|
// Clients
|
|
should.exist(result.clients);
|
|
result.clients.length.should.eql(4);
|
|
result.clients.at(0).get('name').should.eql('Ghost Admin');
|
|
result.clients.at(1).get('name').should.eql('Ghost Frontend');
|
|
result.clients.at(2).get('name').should.eql('Ghost Scheduler');
|
|
result.clients.at(3).get('name').should.eql('Ghost Backup');
|
|
|
|
// User (Owner)
|
|
should.exist(result.users);
|
|
result.users.length.should.eql(1);
|
|
result.users.at(0).get('name').should.eql('Ghost');
|
|
result.users.at(0).get('status').should.eql('inactive');
|
|
result.users.at(0).related('roles').length.should.eql(1);
|
|
result.users.at(0).related('roles').at(0).get('name').should.eql('Owner');
|
|
|
|
// Roles
|
|
should.exist(result.roles);
|
|
result.roles.length.should.eql(5);
|
|
result.roles.at(0).get('name').should.eql('Administrator');
|
|
result.roles.at(1).get('name').should.eql('Editor');
|
|
result.roles.at(2).get('name').should.eql('Author');
|
|
result.roles.at(3).get('name').should.eql('Contributor');
|
|
result.roles.at(4).get('name').should.eql('Owner');
|
|
|
|
// Permissions
|
|
result.permissions.length.should.eql(53);
|
|
result.permissions.toJSON().should.be.CompletePermissions();
|
|
});
|
|
});
|
|
});
|
|
});
|
|
});
|