,
- "uuid": StringMatching /\\[a-f0-9\\]\\{8\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{12\\}/,
- "visibility": "public",
- },
- ],
-}
-`;
-
-exports[`Posts API Can read with post_revisions included 4: [headers] 1`] = `
-Object {
- "access-control-allow-origin": "http://127.0.0.1:2369",
- "cache-control": "no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0",
- "content-length": "1496",
- "content-type": "application/json; charset=utf-8",
- "content-version": StringMatching /v\\\\d\\+\\\\\\.\\\\d\\+/,
- "etag": StringMatching /\\(\\?:W\\\\/\\)\\?"\\(\\?:\\[ !#-\\\\x7E\\\\x80-\\\\xFF\\]\\*\\|\\\\r\\\\n\\[\\\\t \\]\\|\\\\\\\\\\.\\)\\*"/,
- "vary": "Accept-Version, Origin, Accept-Encoding",
- "x-powered-by": "Express",
-}
-`;
-
exports[`Posts API Create Can create a post with lexical 1: [body] 1`] = `
Object {
"posts": Array [
diff --git a/ghost/core/test/e2e-api/admin/pages-legacy.test.js b/ghost/core/test/e2e-api/admin/pages-legacy.test.js
new file mode 100644
index 0000000000..1b29886316
--- /dev/null
+++ b/ghost/core/test/e2e-api/admin/pages-legacy.test.js
@@ -0,0 +1,433 @@
+const should = require('should');
+const supertest = require('supertest');
+const moment = require('moment');
+const _ = require('lodash');
+const testUtils = require('../../utils');
+const config = require('../../../core/shared/config');
+const models = require('../../../core/server/models');
+const localUtils = require('./utils');
+
+describe('Pages API', function () {
+ let request;
+
+ before(async function () {
+ await localUtils.startGhost();
+ request = supertest.agent(config.get('url'));
+ await localUtils.doAuth(request, 'users:extra', 'posts');
+ });
+
+ it('Can retrieve all pages', async function () {
+ const res = await request.get(localUtils.API.getApiQuery('pages/'))
+ .set('Origin', config.get('url'))
+ .expect('Content-Type', /json/)
+ .expect('Cache-Control', testUtils.cacheRules.private)
+ .expect(200);
+
+ should.not.exist(res.headers['x-cache-invalidate']);
+ const jsonResponse = res.body;
+ should.exist(jsonResponse.pages);
+ localUtils.API.checkResponse(jsonResponse, 'pages');
+ jsonResponse.pages.should.have.length(6);
+
+ localUtils.API.checkResponse(jsonResponse.pages[0], 'page');
+ localUtils.API.checkResponse(jsonResponse.meta.pagination, 'pagination');
+ _.isBoolean(jsonResponse.pages[0].featured).should.eql(true);
+
+ // Absolute urls by default
+ jsonResponse.pages[0].url.should.match(new RegExp(`${config.get('url')}/p/[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}`));
+ jsonResponse.pages[1].url.should.eql(`${config.get('url')}/contribute/`);
+ });
+
+ it('Can retrieve pages with lexical format', async function () {
+ const res = await request.get(localUtils.API.getApiQuery('pages/?formats=lexical'))
+ .set('Origin', config.get('url'))
+ .expect('Content-Type', /json/)
+ .expect('Cache-Control', testUtils.cacheRules.private)
+ .expect(200);
+
+ should.not.exist(res.headers['x-cache-invalidate']);
+ const jsonResponse = res.body;
+ should.exist(jsonResponse.pages);
+ localUtils.API.checkResponse(jsonResponse, 'pages');
+ jsonResponse.pages.should.have.length(6);
+
+ const additionalProperties = ['lexical'];
+ const missingProperties = ['mobiledoc'];
+ localUtils.API.checkResponse(jsonResponse.pages[0], 'page', additionalProperties, missingProperties);
+ });
+
+ it('Can add a page', async function () {
+ const page = {
+ title: 'My Page',
+ page: false,
+ status: 'published',
+ feature_image_alt: 'Testing feature image alt',
+ feature_image_caption: 'Testing feature image caption'
+ };
+
+ const res = await request.post(localUtils.API.getApiQuery('pages/'))
+ .set('Origin', config.get('url'))
+ .send({pages: [page]})
+ .expect('Content-Type', /json/)
+ .expect('Cache-Control', testUtils.cacheRules.private)
+ .expect(201);
+
+ res.body.pages.length.should.eql(1);
+
+ localUtils.API.checkResponse(res.body.pages[0], 'page');
+ should.exist(res.headers['x-cache-invalidate']);
+
+ should.exist(res.headers.location);
+ res.headers.location.should.equal(`http://127.0.0.1:2369${localUtils.API.getApiQuery('pages/')}${res.body.pages[0].id}/`);
+
+ const model = await models.Post.findOne({
+ id: res.body.pages[0].id
+ }, testUtils.context.internal);
+
+ const modelJson = model.toJSON();
+
+ modelJson.title.should.eql(page.title);
+ modelJson.status.should.eql(page.status);
+ modelJson.type.should.eql('page');
+
+ modelJson.posts_meta.feature_image_alt.should.eql(page.feature_image_alt);
+ modelJson.posts_meta.feature_image_caption.should.eql(page.feature_image_caption);
+ });
+
+ it('Can add a page with mobiledoc', async function () {
+ const page = {
+ title: 'Mobiledoc test',
+ mobiledoc: JSON.stringify({
+ version: '0.3.1',
+ ghostVersion: '4.0',
+ markups: [],
+ atoms: [],
+ cards: [],
+ sections: [
+ [1, 'p', [
+ [0, [], 0, 'Testing post creation with mobiledoc']
+ ]]
+ ]
+ })
+ };
+
+ const res = await request.post(localUtils.API.getApiQuery('pages/?formats=mobiledoc,lexical'))
+ .set('Origin', config.get('url'))
+ .send({pages: [page]})
+ .expect('Content-Type', /json/)
+ .expect('Cache-Control', testUtils.cacheRules.private)
+ .expect(201);
+
+ res.body.pages.length.should.eql(1);
+ const [returnedPage] = res.body.pages;
+
+ const additionalProperties = ['lexical'];
+ localUtils.API.checkResponse(returnedPage, 'page', additionalProperties);
+
+ should.equal(returnedPage.mobiledoc, page.mobiledoc);
+ should.equal(returnedPage.lexical, null);
+ });
+
+ it('Can add a page with lexical', async function () {
+ const page = {
+ title: 'Lexical test',
+ lexical: JSON.stringify({
+ root: {
+ children: [
+ {
+ children: [
+ {
+ detail: 0,
+ format: 0,
+ mode: 'normal',
+ style: '',
+ text: 'Testing page creation with lexical',
+ type: 'text',
+ version: 1
+ }
+ ],
+ direction: 'ltr',
+ format: '',
+ indent: 0,
+ type: 'paragraph',
+ version: 1
+ }
+ ],
+ direction: 'ltr',
+ format: '',
+ indent: 0,
+ type: 'root',
+ version: 1
+ }
+ })
+ };
+
+ const res = await request.post(localUtils.API.getApiQuery('pages/?formats=mobiledoc,lexical,html'))
+ .set('Origin', config.get('url'))
+ .send({pages: [page]})
+ .expect('Content-Type', /json/)
+ .expect('Cache-Control', testUtils.cacheRules.private)
+ .expect(201);
+
+ res.body.pages.length.should.eql(1);
+ const [returnedPage] = res.body.pages;
+
+ const additionalProperties = ['lexical', 'html', 'reading_time'];
+ localUtils.API.checkResponse(returnedPage, 'page', additionalProperties);
+
+ should.equal(returnedPage.mobiledoc, null);
+ should.equal(returnedPage.lexical, page.lexical);
+ should.equal(returnedPage.html, 'Testing page creation with lexical
');
+ });
+
+ it('Can\'t add a page with both mobiledoc and lexical', async function () {
+ const page = {
+ title: 'Mobiledoc test',
+ mobiledoc: JSON.stringify({
+ version: '0.3.1',
+ ghostVersion: '4.0',
+ markups: [],
+ atoms: [],
+ cards: [],
+ sections: [
+ [1, 'p', [
+ [0, [], 0, 'Testing post creation with mobiledoc']
+ ]]
+ ]
+ }),
+ lexical: JSON.stringify({
+ editorState: {
+ root: {
+ children: [
+ {
+ children: [
+ {
+ detail: 0,
+ format: 0,
+ mode: 'normal',
+ style: '',
+ text: 'Testing post creation with lexical',
+ type: 'text',
+ version: 1
+ }
+ ],
+ direction: 'ltr',
+ format: '',
+ indent: 0,
+ type: 'paragraph',
+ version: 1
+ }
+ ],
+ direction: 'ltr',
+ format: '',
+ indent: 0,
+ type: 'root',
+ version: 1
+ }
+ },
+ lastSaved: 1663081361393,
+ source: 'Playground',
+ version: '0.4.1'
+ })
+ };
+
+ const res = await request.post(localUtils.API.getApiQuery('pages/?formats=mobiledoc,lexical'))
+ .set('Origin', config.get('url'))
+ .send({pages: [page]})
+ .expect('Content-Type', /json/)
+ .expect('Cache-Control', testUtils.cacheRules.private)
+ .expect(422);
+
+ const [error] = res.body.errors;
+ error.type.should.equal('ValidationError');
+ error.property.should.equal('lexical');
+ });
+
+ it('Can include free and paid tiers for public page', async function () {
+ const publicPost = testUtils.DataGenerator.forKnex.createPost({
+ type: 'page',
+ slug: 'free-to-see',
+ visibility: 'public',
+ published_at: moment().add(15, 'seconds').toDate() // here to ensure sorting is not modified
+ });
+ await models.Post.add(publicPost, {context: {internal: true}});
+
+ const publicPostRes = await request
+ .get(localUtils.API.getApiQuery(`pages/${publicPost.id}/`))
+ .set('Origin', config.get('url'))
+ .expect(200);
+ const publicPostData = publicPostRes.body.pages[0];
+ publicPostData.tiers.length.should.eql(2);
+ });
+
+ it('Can include free and paid tiers for members only page', async function () {
+ const membersPost = testUtils.DataGenerator.forKnex.createPost({
+ type: 'page',
+ slug: 'thou-shalt-not-be-seen',
+ visibility: 'members',
+ published_at: moment().add(45, 'seconds').toDate() // here to ensure sorting is not modified
+ });
+ await models.Post.add(membersPost, {context: {internal: true}});
+
+ const membersPostRes = await request
+ .get(localUtils.API.getApiQuery(`pages/${membersPost.id}/`))
+ .set('Origin', config.get('url'))
+ .expect(200);
+ const membersPostData = membersPostRes.body.pages[0];
+ membersPostData.tiers.length.should.eql(2);
+ });
+
+ it('Can include only paid tier for paid page', async function () {
+ const paidPost = testUtils.DataGenerator.forKnex.createPost({
+ type: 'page',
+ slug: 'thou-shalt-be-paid-for',
+ visibility: 'paid',
+ published_at: moment().add(30, 'seconds').toDate() // here to ensure sorting is not modified
+ });
+ await models.Post.add(paidPost, {context: {internal: true}});
+
+ const paidPostRes = await request
+ .get(localUtils.API.getApiQuery(`pages/${paidPost.id}/`))
+ .set('Origin', config.get('url'))
+ .expect(200);
+ const paidPostData = paidPostRes.body.pages[0];
+ paidPostData.tiers.length.should.eql(1);
+ });
+
+ it('Can include specific tier for page with tiers visibility', async function () {
+ const res = await request.get(localUtils.API.getApiQuery('tiers/'))
+ .set('Origin', config.get('url'))
+ .expect('Content-Type', /json/)
+ .expect('Cache-Control', testUtils.cacheRules.private)
+ .expect(200);
+
+ const jsonResponse = res.body;
+
+ const paidTier = jsonResponse.tiers.find(p => p.type === 'paid');
+
+ const tiersPage = testUtils.DataGenerator.forKnex.createPost({
+ type: 'page',
+ slug: 'thou-shalt-be-for-specific-tiers',
+ visibility: 'tiers',
+ published_at: moment().add(30, 'seconds').toDate() // here to ensure sorting is not modified
+ });
+
+ tiersPage.tiers = [paidTier];
+
+ await models.Post.add(tiersPage, {context: {internal: true}});
+
+ const tiersPageRes = await request
+ .get(localUtils.API.getApiQuery(`pages/${tiersPage.id}/`))
+ .set('Origin', config.get('url'))
+ .expect(200);
+ const tiersPageData = tiersPageRes.body.pages[0];
+
+ tiersPageData.tiers.length.should.eql(1);
+ });
+
+ it('Can update a page', async function () {
+ const page = {
+ title: 'updated page',
+ page: false
+ };
+
+ const res = await request
+ .get(localUtils.API.getApiQuery(`pages/${testUtils.DataGenerator.Content.posts[5].id}/`))
+ .set('Origin', config.get('url'))
+ .expect(200);
+
+ page.updated_at = res.body.pages[0].updated_at;
+
+ const res2 = await request.put(localUtils.API.getApiQuery('pages/' + testUtils.DataGenerator.Content.posts[5].id))
+ .set('Origin', config.get('url'))
+ .send({pages: [page]})
+ .expect('Content-Type', /json/)
+ .expect('Cache-Control', testUtils.cacheRules.private)
+ .expect(200);
+
+ should.exist(res2.headers['x-cache-invalidate']);
+ localUtils.API.checkResponse(res2.body.pages[0], 'page');
+
+ const model = await models.Post.findOne({
+ id: res2.body.pages[0].id
+ }, testUtils.context.internal);
+
+ model.get('type').should.eql('page');
+ });
+
+ it('Can update a page with restricted access to specific tier', async function () {
+ const page = {
+ title: 'updated page',
+ page: false
+ };
+
+ const res = await request
+ .get(localUtils.API.getApiQuery(`pages/${testUtils.DataGenerator.Content.posts[5].id}/`))
+ .set('Origin', config.get('url'))
+ .expect(200);
+
+ const resTiers = await request
+ .get(localUtils.API.getApiQuery(`tiers/`))
+ .set('Origin', config.get('url'))
+ .expect(200);
+
+ const tiers = resTiers.body.tiers;
+ page.updated_at = res.body.pages[0].updated_at;
+ page.visibility = 'tiers';
+ const paidTiers = tiers.filter((p) => {
+ return p.type === 'paid';
+ }).map((product) => {
+ return product;
+ });
+ page.tiers = paidTiers;
+
+ const res2 = await request.put(localUtils.API.getApiQuery('pages/' + testUtils.DataGenerator.Content.posts[5].id))
+ .set('Origin', config.get('url'))
+ .send({pages: [page]})
+ .expect('Content-Type', /json/)
+ .expect('Cache-Control', testUtils.cacheRules.private)
+ .expect(200);
+
+ should.exist(res2.headers['x-cache-invalidate']);
+ localUtils.API.checkResponse(res2.body.pages[0], 'page');
+ res2.body.pages[0].tiers.length.should.eql(paidTiers.length);
+
+ const model = await models.Post.findOne({
+ id: res2.body.pages[0].id
+ }, testUtils.context.internal);
+
+ model.get('type').should.eql('page');
+ });
+
+ it('Cannot get page via posts endpoint', async function () {
+ await request.get(localUtils.API.getApiQuery(`posts/${testUtils.DataGenerator.Content.posts[5].id}/`))
+ .set('Origin', config.get('url'))
+ .expect('Content-Type', /json/)
+ .expect('Cache-Control', testUtils.cacheRules.private)
+ .expect(404);
+ });
+
+ it('Cannot update page via posts endpoint', async function () {
+ const page = {
+ title: 'fails',
+ updated_at: new Date().toISOString()
+ };
+
+ await request.put(localUtils.API.getApiQuery('posts/' + testUtils.DataGenerator.Content.posts[5].id))
+ .set('Origin', config.get('url'))
+ .send({posts: [page]})
+ .expect('Content-Type', /json/)
+ .expect('Cache-Control', testUtils.cacheRules.private)
+ .expect(404);
+ });
+
+ it('Can delete a page', async function () {
+ const res = await request.del(localUtils.API.getApiQuery('pages/' + testUtils.DataGenerator.Content.posts[5].id))
+ .set('Origin', config.get('url'))
+ .expect('Cache-Control', testUtils.cacheRules.private)
+ .expect(204);
+
+ res.body.should.be.empty();
+ res.headers['x-cache-invalidate'].should.eql('/*');
+ });
+});
diff --git a/ghost/core/test/e2e-api/admin/pages.test.js b/ghost/core/test/e2e-api/admin/pages.test.js
index 1b29886316..d1d59cae1f 100644
--- a/ghost/core/test/e2e-api/admin/pages.test.js
+++ b/ghost/core/test/e2e-api/admin/pages.test.js
@@ -1,433 +1,69 @@
-const should = require('should');
-const supertest = require('supertest');
-const moment = require('moment');
-const _ = require('lodash');
-const testUtils = require('../../utils');
-const config = require('../../../core/shared/config');
-const models = require('../../../core/server/models');
-const localUtils = require('./utils');
+const {agentProvider, fixtureManager, mockManager, matchers} = require('../../utils/e2e-framework');
+const {anyArray, anyContentVersion, anyEtag, anyLocationFor, anyObject, anyObjectId, anyISODateTime, anyString, anyUuid} = matchers;
+
+const tierSnapshot = {
+ id: anyObjectId,
+ created_at: anyISODateTime,
+ updated_at: anyISODateTime
+};
+
+const matchPageShallowIncludes = {
+ id: anyObjectId,
+ uuid: anyUuid,
+ comment_id: anyString,
+ url: anyString,
+ authors: anyArray,
+ primary_author: anyObject,
+ tags: anyArray,
+ primary_tag: anyObject,
+ tiers: Array(2).fill(tierSnapshot),
+ created_at: anyISODateTime,
+ updated_at: anyISODateTime,
+ published_at: anyISODateTime
+};
describe('Pages API', function () {
- let request;
+ let agent;
before(async function () {
- await localUtils.startGhost();
- request = supertest.agent(config.get('url'));
- await localUtils.doAuth(request, 'users:extra', 'posts');
+ agent = await agentProvider.getAdminAPIAgent();
+ await fixtureManager.init('posts');
+ await agent.loginAsOwner();
});
- it('Can retrieve all pages', async function () {
- const res = await request.get(localUtils.API.getApiQuery('pages/'))
- .set('Origin', config.get('url'))
- .expect('Content-Type', /json/)
- .expect('Cache-Control', testUtils.cacheRules.private)
- .expect(200);
-
- should.not.exist(res.headers['x-cache-invalidate']);
- const jsonResponse = res.body;
- should.exist(jsonResponse.pages);
- localUtils.API.checkResponse(jsonResponse, 'pages');
- jsonResponse.pages.should.have.length(6);
-
- localUtils.API.checkResponse(jsonResponse.pages[0], 'page');
- localUtils.API.checkResponse(jsonResponse.meta.pagination, 'pagination');
- _.isBoolean(jsonResponse.pages[0].featured).should.eql(true);
-
- // Absolute urls by default
- jsonResponse.pages[0].url.should.match(new RegExp(`${config.get('url')}/p/[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}`));
- jsonResponse.pages[1].url.should.eql(`${config.get('url')}/contribute/`);
+ afterEach(function () {
+ mockManager.restore();
});
- it('Can retrieve pages with lexical format', async function () {
- const res = await request.get(localUtils.API.getApiQuery('pages/?formats=lexical'))
- .set('Origin', config.get('url'))
- .expect('Content-Type', /json/)
- .expect('Cache-Control', testUtils.cacheRules.private)
- .expect(200);
+ describe('Copy', function () {
+ it('Can copy a page', async function () {
+ const page = {
+ title: 'Test Page',
+ status: 'published'
+ };
- should.not.exist(res.headers['x-cache-invalidate']);
- const jsonResponse = res.body;
- should.exist(jsonResponse.pages);
- localUtils.API.checkResponse(jsonResponse, 'pages');
- jsonResponse.pages.should.have.length(6);
-
- const additionalProperties = ['lexical'];
- const missingProperties = ['mobiledoc'];
- localUtils.API.checkResponse(jsonResponse.pages[0], 'page', additionalProperties, missingProperties);
- });
-
- it('Can add a page', async function () {
- const page = {
- title: 'My Page',
- page: false,
- status: 'published',
- feature_image_alt: 'Testing feature image alt',
- feature_image_caption: 'Testing feature image caption'
- };
-
- const res = await request.post(localUtils.API.getApiQuery('pages/'))
- .set('Origin', config.get('url'))
- .send({pages: [page]})
- .expect('Content-Type', /json/)
- .expect('Cache-Control', testUtils.cacheRules.private)
- .expect(201);
-
- res.body.pages.length.should.eql(1);
-
- localUtils.API.checkResponse(res.body.pages[0], 'page');
- should.exist(res.headers['x-cache-invalidate']);
-
- should.exist(res.headers.location);
- res.headers.location.should.equal(`http://127.0.0.1:2369${localUtils.API.getApiQuery('pages/')}${res.body.pages[0].id}/`);
-
- const model = await models.Post.findOne({
- id: res.body.pages[0].id
- }, testUtils.context.internal);
-
- const modelJson = model.toJSON();
-
- modelJson.title.should.eql(page.title);
- modelJson.status.should.eql(page.status);
- modelJson.type.should.eql('page');
-
- modelJson.posts_meta.feature_image_alt.should.eql(page.feature_image_alt);
- modelJson.posts_meta.feature_image_caption.should.eql(page.feature_image_caption);
- });
-
- it('Can add a page with mobiledoc', async function () {
- const page = {
- title: 'Mobiledoc test',
- mobiledoc: JSON.stringify({
- version: '0.3.1',
- ghostVersion: '4.0',
- markups: [],
- atoms: [],
- cards: [],
- sections: [
- [1, 'p', [
- [0, [], 0, 'Testing post creation with mobiledoc']
- ]]
- ]
- })
- };
-
- const res = await request.post(localUtils.API.getApiQuery('pages/?formats=mobiledoc,lexical'))
- .set('Origin', config.get('url'))
- .send({pages: [page]})
- .expect('Content-Type', /json/)
- .expect('Cache-Control', testUtils.cacheRules.private)
- .expect(201);
-
- res.body.pages.length.should.eql(1);
- const [returnedPage] = res.body.pages;
-
- const additionalProperties = ['lexical'];
- localUtils.API.checkResponse(returnedPage, 'page', additionalProperties);
-
- should.equal(returnedPage.mobiledoc, page.mobiledoc);
- should.equal(returnedPage.lexical, null);
- });
-
- it('Can add a page with lexical', async function () {
- const page = {
- title: 'Lexical test',
- lexical: JSON.stringify({
- root: {
- children: [
- {
- children: [
- {
- detail: 0,
- format: 0,
- mode: 'normal',
- style: '',
- text: 'Testing page creation with lexical',
- type: 'text',
- version: 1
- }
- ],
- direction: 'ltr',
- format: '',
- indent: 0,
- type: 'paragraph',
- version: 1
- }
- ],
- direction: 'ltr',
- format: '',
- indent: 0,
- type: 'root',
- version: 1
- }
- })
- };
-
- const res = await request.post(localUtils.API.getApiQuery('pages/?formats=mobiledoc,lexical,html'))
- .set('Origin', config.get('url'))
- .send({pages: [page]})
- .expect('Content-Type', /json/)
- .expect('Cache-Control', testUtils.cacheRules.private)
- .expect(201);
-
- res.body.pages.length.should.eql(1);
- const [returnedPage] = res.body.pages;
-
- const additionalProperties = ['lexical', 'html', 'reading_time'];
- localUtils.API.checkResponse(returnedPage, 'page', additionalProperties);
-
- should.equal(returnedPage.mobiledoc, null);
- should.equal(returnedPage.lexical, page.lexical);
- should.equal(returnedPage.html, 'Testing page creation with lexical
');
- });
-
- it('Can\'t add a page with both mobiledoc and lexical', async function () {
- const page = {
- title: 'Mobiledoc test',
- mobiledoc: JSON.stringify({
- version: '0.3.1',
- ghostVersion: '4.0',
- markups: [],
- atoms: [],
- cards: [],
- sections: [
- [1, 'p', [
- [0, [], 0, 'Testing post creation with mobiledoc']
- ]]
- ]
- }),
- lexical: JSON.stringify({
- editorState: {
- root: {
- children: [
- {
- children: [
- {
- detail: 0,
- format: 0,
- mode: 'normal',
- style: '',
- text: 'Testing post creation with lexical',
- type: 'text',
- version: 1
- }
- ],
- direction: 'ltr',
- format: '',
- indent: 0,
- type: 'paragraph',
- version: 1
- }
- ],
- direction: 'ltr',
- format: '',
- indent: 0,
- type: 'root',
- version: 1
+ const {body: pageBody} = await agent
+ .post('/pages/?formats=mobiledoc,lexical,html', {
+ headers: {
+ 'content-type': 'application/json'
}
- },
- lastSaved: 1663081361393,
- source: 'Playground',
- version: '0.4.1'
- })
- };
+ })
+ .body({pages: [page]})
+ .expectStatus(201);
- const res = await request.post(localUtils.API.getApiQuery('pages/?formats=mobiledoc,lexical'))
- .set('Origin', config.get('url'))
- .send({pages: [page]})
- .expect('Content-Type', /json/)
- .expect('Cache-Control', testUtils.cacheRules.private)
- .expect(422);
+ const [pageResponse] = pageBody.pages;
- const [error] = res.body.errors;
- error.type.should.equal('ValidationError');
- error.property.should.equal('lexical');
- });
-
- it('Can include free and paid tiers for public page', async function () {
- const publicPost = testUtils.DataGenerator.forKnex.createPost({
- type: 'page',
- slug: 'free-to-see',
- visibility: 'public',
- published_at: moment().add(15, 'seconds').toDate() // here to ensure sorting is not modified
+ await agent
+ .post(`/pages/${pageResponse.id}/copy?formats=mobiledoc,lexical`)
+ .expectStatus(201)
+ .matchBodySnapshot({
+ pages: [Object.assign(matchPageShallowIncludes, {published_at: null})]
+ })
+ .matchHeaderSnapshot({
+ 'content-version': anyContentVersion,
+ etag: anyEtag,
+ location: anyLocationFor('pages')
+ });
});
- await models.Post.add(publicPost, {context: {internal: true}});
-
- const publicPostRes = await request
- .get(localUtils.API.getApiQuery(`pages/${publicPost.id}/`))
- .set('Origin', config.get('url'))
- .expect(200);
- const publicPostData = publicPostRes.body.pages[0];
- publicPostData.tiers.length.should.eql(2);
- });
-
- it('Can include free and paid tiers for members only page', async function () {
- const membersPost = testUtils.DataGenerator.forKnex.createPost({
- type: 'page',
- slug: 'thou-shalt-not-be-seen',
- visibility: 'members',
- published_at: moment().add(45, 'seconds').toDate() // here to ensure sorting is not modified
- });
- await models.Post.add(membersPost, {context: {internal: true}});
-
- const membersPostRes = await request
- .get(localUtils.API.getApiQuery(`pages/${membersPost.id}/`))
- .set('Origin', config.get('url'))
- .expect(200);
- const membersPostData = membersPostRes.body.pages[0];
- membersPostData.tiers.length.should.eql(2);
- });
-
- it('Can include only paid tier for paid page', async function () {
- const paidPost = testUtils.DataGenerator.forKnex.createPost({
- type: 'page',
- slug: 'thou-shalt-be-paid-for',
- visibility: 'paid',
- published_at: moment().add(30, 'seconds').toDate() // here to ensure sorting is not modified
- });
- await models.Post.add(paidPost, {context: {internal: true}});
-
- const paidPostRes = await request
- .get(localUtils.API.getApiQuery(`pages/${paidPost.id}/`))
- .set('Origin', config.get('url'))
- .expect(200);
- const paidPostData = paidPostRes.body.pages[0];
- paidPostData.tiers.length.should.eql(1);
- });
-
- it('Can include specific tier for page with tiers visibility', async function () {
- const res = await request.get(localUtils.API.getApiQuery('tiers/'))
- .set('Origin', config.get('url'))
- .expect('Content-Type', /json/)
- .expect('Cache-Control', testUtils.cacheRules.private)
- .expect(200);
-
- const jsonResponse = res.body;
-
- const paidTier = jsonResponse.tiers.find(p => p.type === 'paid');
-
- const tiersPage = testUtils.DataGenerator.forKnex.createPost({
- type: 'page',
- slug: 'thou-shalt-be-for-specific-tiers',
- visibility: 'tiers',
- published_at: moment().add(30, 'seconds').toDate() // here to ensure sorting is not modified
- });
-
- tiersPage.tiers = [paidTier];
-
- await models.Post.add(tiersPage, {context: {internal: true}});
-
- const tiersPageRes = await request
- .get(localUtils.API.getApiQuery(`pages/${tiersPage.id}/`))
- .set('Origin', config.get('url'))
- .expect(200);
- const tiersPageData = tiersPageRes.body.pages[0];
-
- tiersPageData.tiers.length.should.eql(1);
- });
-
- it('Can update a page', async function () {
- const page = {
- title: 'updated page',
- page: false
- };
-
- const res = await request
- .get(localUtils.API.getApiQuery(`pages/${testUtils.DataGenerator.Content.posts[5].id}/`))
- .set('Origin', config.get('url'))
- .expect(200);
-
- page.updated_at = res.body.pages[0].updated_at;
-
- const res2 = await request.put(localUtils.API.getApiQuery('pages/' + testUtils.DataGenerator.Content.posts[5].id))
- .set('Origin', config.get('url'))
- .send({pages: [page]})
- .expect('Content-Type', /json/)
- .expect('Cache-Control', testUtils.cacheRules.private)
- .expect(200);
-
- should.exist(res2.headers['x-cache-invalidate']);
- localUtils.API.checkResponse(res2.body.pages[0], 'page');
-
- const model = await models.Post.findOne({
- id: res2.body.pages[0].id
- }, testUtils.context.internal);
-
- model.get('type').should.eql('page');
- });
-
- it('Can update a page with restricted access to specific tier', async function () {
- const page = {
- title: 'updated page',
- page: false
- };
-
- const res = await request
- .get(localUtils.API.getApiQuery(`pages/${testUtils.DataGenerator.Content.posts[5].id}/`))
- .set('Origin', config.get('url'))
- .expect(200);
-
- const resTiers = await request
- .get(localUtils.API.getApiQuery(`tiers/`))
- .set('Origin', config.get('url'))
- .expect(200);
-
- const tiers = resTiers.body.tiers;
- page.updated_at = res.body.pages[0].updated_at;
- page.visibility = 'tiers';
- const paidTiers = tiers.filter((p) => {
- return p.type === 'paid';
- }).map((product) => {
- return product;
- });
- page.tiers = paidTiers;
-
- const res2 = await request.put(localUtils.API.getApiQuery('pages/' + testUtils.DataGenerator.Content.posts[5].id))
- .set('Origin', config.get('url'))
- .send({pages: [page]})
- .expect('Content-Type', /json/)
- .expect('Cache-Control', testUtils.cacheRules.private)
- .expect(200);
-
- should.exist(res2.headers['x-cache-invalidate']);
- localUtils.API.checkResponse(res2.body.pages[0], 'page');
- res2.body.pages[0].tiers.length.should.eql(paidTiers.length);
-
- const model = await models.Post.findOne({
- id: res2.body.pages[0].id
- }, testUtils.context.internal);
-
- model.get('type').should.eql('page');
- });
-
- it('Cannot get page via posts endpoint', async function () {
- await request.get(localUtils.API.getApiQuery(`posts/${testUtils.DataGenerator.Content.posts[5].id}/`))
- .set('Origin', config.get('url'))
- .expect('Content-Type', /json/)
- .expect('Cache-Control', testUtils.cacheRules.private)
- .expect(404);
- });
-
- it('Cannot update page via posts endpoint', async function () {
- const page = {
- title: 'fails',
- updated_at: new Date().toISOString()
- };
-
- await request.put(localUtils.API.getApiQuery('posts/' + testUtils.DataGenerator.Content.posts[5].id))
- .set('Origin', config.get('url'))
- .send({posts: [page]})
- .expect('Content-Type', /json/)
- .expect('Cache-Control', testUtils.cacheRules.private)
- .expect(404);
- });
-
- it('Can delete a page', async function () {
- const res = await request.del(localUtils.API.getApiQuery('pages/' + testUtils.DataGenerator.Content.posts[5].id))
- .set('Origin', config.get('url'))
- .expect('Cache-Control', testUtils.cacheRules.private)
- .expect(204);
-
- res.body.should.be.empty();
- res.headers['x-cache-invalidate'].should.eql('/*');
});
});
diff --git a/ghost/core/test/e2e-api/admin/posts.test.js b/ghost/core/test/e2e-api/admin/posts.test.js
index 593b5e7520..a5bc515e52 100644
--- a/ghost/core/test/e2e-api/admin/posts.test.js
+++ b/ghost/core/test/e2e-api/admin/posts.test.js
@@ -450,4 +450,36 @@ describe('Posts API', function () {
});
});
});
+
+ describe('Copy', function () {
+ it('Can copy a post', async function () {
+ const post = {
+ title: 'Test Post',
+ status: 'published'
+ };
+
+ const {body: postBody} = await agent
+ .post('/posts/?formats=mobiledoc,lexical,html', {
+ headers: {
+ 'content-type': 'application/json'
+ }
+ })
+ .body({posts: [post]})
+ .expectStatus(201);
+
+ const [postResponse] = postBody.posts;
+
+ await agent
+ .post(`/posts/${postResponse.id}/copy?formats=mobiledoc,lexical`)
+ .expectStatus(201)
+ .matchBodySnapshot({
+ posts: [Object.assign(matchPostShallowIncludes, {published_at: null})]
+ })
+ .matchHeaderSnapshot({
+ 'content-version': anyContentVersion,
+ etag: anyEtag,
+ location: anyLocationFor('posts')
+ });
+ });
+ });
});
diff --git a/ghost/core/test/unit/api/canary/utils/serializers/input/pages.test.js b/ghost/core/test/unit/api/canary/utils/serializers/input/pages.test.js
index acbf48140a..89b3602cfe 100644
--- a/ghost/core/test/unit/api/canary/utils/serializers/input/pages.test.js
+++ b/ghost/core/test/unit/api/canary/utils/serializers/input/pages.test.js
@@ -224,4 +224,26 @@ describe('Unit: endpoints/utils/serializers/input/pages', function () {
frame.data.pages[0].tags.should.eql([{name: 'name1'}, {name: 'name2'}]);
});
});
+
+ describe('copy', function () {
+ it('adds default formats if no formats are specified', function () {
+ const frame = {
+ options: {}
+ };
+
+ serializers.input.pages.copy({}, frame);
+
+ frame.options.formats.should.eql('mobiledoc');
+ });
+
+ it('adds default relations if no relations are specified', function () {
+ const frame = {
+ options: {}
+ };
+
+ serializers.input.pages.copy({}, frame);
+
+ frame.options.withRelated.should.eql(['tags', 'authors', 'authors.roles', 'tiers', 'count.signups', 'count.paid_conversions']);
+ });
+ });
});
diff --git a/ghost/core/test/unit/api/canary/utils/serializers/input/posts.test.js b/ghost/core/test/unit/api/canary/utils/serializers/input/posts.test.js
index ee8a9ceff2..14993685d6 100644
--- a/ghost/core/test/unit/api/canary/utils/serializers/input/posts.test.js
+++ b/ghost/core/test/unit/api/canary/utils/serializers/input/posts.test.js
@@ -339,4 +339,26 @@ describe('Unit: endpoints/utils/serializers/input/posts', function () {
});
});
});
+
+ describe('copy', function () {
+ it('adds default formats if no formats are specified', function () {
+ const frame = {
+ options: {}
+ };
+
+ serializers.input.posts.copy({}, frame);
+
+ frame.options.formats.should.eql('mobiledoc');
+ });
+
+ it('adds default relations if no relations are specified', function () {
+ const frame = {
+ options: {}
+ };
+
+ serializers.input.posts.copy({}, frame);
+
+ frame.options.withRelated.should.eql(['tags', 'authors', 'authors.roles', 'email', 'tiers', 'newsletter', 'count.clicks', 'post_revisions', 'post_revisions.author']);
+ });
+ });
});
diff --git a/ghost/posts-service/lib/PostsService.js b/ghost/posts-service/lib/PostsService.js
index f48296c0c5..ea968f3160 100644
--- a/ghost/posts-service/lib/PostsService.js
+++ b/ghost/posts-service/lib/PostsService.js
@@ -3,6 +3,7 @@ const {BadRequestError} = require('@tryghost/errors');
const tpl = require('@tryghost/tpl');
const errors = require('@tryghost/errors');
const ObjectId = require('bson-objectid').default;
+const omit = require('lodash/omit');
const messages = {
invalidVisibilityFilter: 'Invalid visibility filter.',
@@ -365,6 +366,75 @@ class PostsService {
return cacheInvalidate;
}
+
+ async copyPost(frame) {
+ const existingPost = await this.models.Post.findOne({
+ id: frame.options.id,
+ status: 'all'
+ }, frame.options);
+
+ const newPostData = omit(
+ existingPost.attributes,
+ [
+ 'id',
+ 'uuid',
+ 'slug',
+ 'comment_id',
+ 'created_at',
+ 'created_by',
+ 'updated_at',
+ 'updated_by',
+ 'published_at',
+ 'published_by',
+ 'canonical_url',
+ 'count__clicks'
+ ]
+ );
+
+ newPostData.title = `${existingPost.attributes.title} (Copy)`;
+ newPostData.status = 'draft';
+ newPostData.authors = existingPost.related('authors')
+ .map(author => ({id: author.get('id')}));
+ newPostData.tags = existingPost.related('tags')
+ .map(tag => ({id: tag.get('id')}));
+
+ const existingPostMeta = existingPost.related('posts_meta');
+
+ if (existingPostMeta.isNew() === false) {
+ newPostData.posts_meta = omit(
+ existingPostMeta.attributes,
+ [
+ 'id',
+ 'post_id'
+ ]
+ );
+ }
+
+ const existingPostTiers = existingPost.related('tiers');
+
+ if (existingPostTiers.length > 0) {
+ newPostData.tiers = existingPostTiers.map(tier => ({id: tier.get('id')}));
+ }
+
+ return this.models.Post.add(newPostData, frame.options);
+ }
+
+ /**
+ * Generates a location url for a copied post based on the original url generated by the API framework
+ *
+ * @param {string} url
+ * @returns {string}
+ */
+ generateCopiedPostLocationFromUrl(url) {
+ const urlParts = url.split('/');
+ const pageId = urlParts[urlParts.length - 2];
+
+ return urlParts
+ .slice(0, -4)
+ .concat(pageId)
+ .concat('')
+ .join('/');
+ }
}
module.exports = PostsService;
diff --git a/ghost/posts-service/test/PostsService.test.js b/ghost/posts-service/test/PostsService.test.js
index fcfd55d5b5..6a65ae943c 100644
--- a/ghost/posts-service/test/PostsService.test.js
+++ b/ghost/posts-service/test/PostsService.test.js
@@ -1,5 +1,6 @@
const {PostsService} = require('../index');
const assert = require('assert');
+const sinon = require('sinon');
describe('Posts Service', function () {
it('Can construct class', function () {
@@ -39,4 +40,208 @@ describe('Posts Service', function () {
]);
});
});
+
+ describe('copyPost', function () {
+ const makeModelStub = (key, value) => ({
+ get(k) {
+ if (k === key) {
+ return value;
+ }
+ }
+ });
+
+ const POST_ID = 'abc123';
+
+ let postModelStub, existingPostModel, frame;
+
+ const makePostService = () => new PostsService({
+ models: {
+ Post: postModelStub
+ }
+ });
+
+ beforeEach(function () {
+ postModelStub = {
+ add: sinon.stub(),
+ findOne: sinon.stub()
+ };
+
+ existingPostModel = {
+ attributes: {
+ id: POST_ID,
+ title: 'Test Post',
+ slug: 'test-post',
+ status: 'published'
+ },
+ related: sinon.stub()
+ };
+
+ frame = {
+ options: {
+ id: POST_ID
+ }
+ };
+
+ postModelStub.findOne.withArgs({
+ id: POST_ID,
+ status: 'all'
+ }, frame.options).resolves(existingPostModel);
+
+ postModelStub.add.resolves();
+
+ existingPostModel.related.withArgs('authors').returns([]);
+ existingPostModel.related.withArgs('tags').returns([]);
+ existingPostModel.related.withArgs('posts_meta').returns({
+ isNew: () => true
+ });
+ existingPostModel.related.withArgs('tiers').returns([]);
+ });
+
+ it('copies a post', async function () {
+ const copiedPost = {
+ attributes: {
+ id: 'def789'
+ }
+ };
+
+ postModelStub.add.resolves(copiedPost);
+
+ const result = await makePostService().copyPost(frame);
+
+ // Ensure copied post is created
+ assert.equal(
+ postModelStub.add.calledOnceWithExactly(
+ sinon.match.object,
+ frame.options
+ ),
+ true
+ );
+
+ // Ensure copied post is returned
+ assert.deepEqual(result, copiedPost);
+ });
+
+ it('omits unnecessary data from the copied post', async function () {
+ await makePostService().copyPost(frame);
+
+ const copiedPostData = postModelStub.add.getCall(0).args[0];
+
+ assert.equal(copiedPostData.id, undefined);
+ assert.equal(copiedPostData.slug, undefined);
+ });
+
+ it('updates the title of the copied post', async function () {
+ await makePostService().copyPost(frame);
+
+ const copiedPostData = postModelStub.add.getCall(0).args[0];
+
+ assert.equal(copiedPostData.title, 'Test Post (Copy)');
+ });
+
+ it('updates the status of the copied post', async function () {
+ await makePostService().copyPost(frame);
+
+ const copiedPostData = postModelStub.add.getCall(0).args[0];
+
+ assert.equal(copiedPostData.status, 'draft');
+ });
+
+ it('adds authors to the copied post', async function () {
+ existingPostModel.related.withArgs('authors').returns([
+ makeModelStub('id', 'author-1'),
+ makeModelStub('id', 'author-2')
+ ]);
+
+ await makePostService().copyPost(frame);
+
+ const copiedPostData = postModelStub.add.getCall(0).args[0];
+
+ assert.deepEqual(copiedPostData.authors, [
+ {id: 'author-1'},
+ {id: 'author-2'}
+ ]);
+ });
+
+ it('adds tags to the copied post', async function () {
+ existingPostModel.related.withArgs('tags').returns([
+ makeModelStub('id', 'tag-1'),
+ makeModelStub('id', 'tag-2')
+ ]);
+
+ await makePostService().copyPost(frame);
+
+ const copiedPostData = postModelStub.add.getCall(0).args[0];
+
+ assert.deepEqual(copiedPostData.tags, [
+ {id: 'tag-1'},
+ {id: 'tag-2'}
+ ]);
+ });
+
+ it('adds meta data to the copied post', async function () {
+ const postMetaModel = {
+ attributes: {
+ meta_title: 'Test Post',
+ meta_description: 'Test Post Description'
+ },
+ isNew: () => false
+ };
+
+ existingPostModel.related.withArgs('posts_meta').returns(postMetaModel);
+
+ await makePostService().copyPost(frame);
+
+ const copiedPostData = postModelStub.add.getCall(0).args[0];
+
+ assert.deepEqual(copiedPostData.posts_meta, postMetaModel.attributes);
+ });
+
+ it('adds tiers to the copied post', async function () {
+ existingPostModel.related.withArgs('tiers').returns([
+ makeModelStub('id', 'tier-1'),
+ makeModelStub('id', 'tier-2')
+ ]);
+
+ await makePostService().copyPost(frame);
+
+ const copiedPostData = postModelStub.add.getCall(0).args[0];
+
+ assert.deepEqual(copiedPostData.tiers, [
+ {id: 'tier-1'},
+ {id: 'tier-2'}
+ ]);
+ });
+
+ it('omits unnecessary meta data from the copied post', async function () {
+ const postMetaModel = {
+ attributes: {
+ post_id: POST_ID,
+ meta_title: 'Test Post',
+ meta_description: 'Test Post Description'
+ },
+ isNew: () => false
+ };
+
+ existingPostModel.related.withArgs('posts_meta').returns(postMetaModel);
+
+ await makePostService().copyPost(frame);
+
+ const copiedPostData = postModelStub.add.getCall(0).args[0];
+
+ assert.deepEqual(copiedPostData.posts_meta, {
+ meta_title: postMetaModel.attributes.meta_title,
+ meta_description: postMetaModel.attributes.meta_description
+ });
+ });
+ });
+
+ describe('generateCopiedPostLocationFromUrl', function () {
+ it('generates a location from the provided url', function () {
+ const postsService = new PostsService({});
+ const url = 'http://foo.bar/ghost/api/admin/posts/abc123/copy/def456/';
+ const expectedUrl = 'http://foo.bar/ghost/api/admin/posts/def456/';
+
+ assert.equal(postsService.generateCopiedPostLocationFromUrl(url), expectedUrl);
+ });
+ });
});