yuuza/outline
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Draft Documents (#518)

Browse Source 
* Mostly there

* Fix up specs

* Working scope, updated tests

* Don't record view on draft

* PR feedback

* Highlight drafts nav item

* Bugaboos

* Styling

* Refactoring, gradually addressing Jori feedback

* Show collection in drafts list
Flow fixes

* Ensure menu actions are hidden when draft
This commit is contained in:
Tom Moor
2018-02-27 22:41:12 -08:00
committed by GitHub
parent 79a0272230
commit 9142d975df
30 changed files with 519 additions and 194 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
server/api/documents.js
View File

@@ -1,6 +1,6 @@
// @flow
import Router from 'koa-router';
import { Op } from 'sequelize';
import auth from './middlewares/authentication';
import pagination from './middlewares/pagination';
import { presentDocument, presentRevision } from '../presenters';
@@ -102,6 +102,28 @@ router.post('documents.starred', auth(), pagination(), async ctx => {
};
});
router.post('documents.drafts', auth(), pagination(), async ctx => {
let { sort = 'updatedAt', direction } = ctx.body;
if (direction !== 'ASC') direction = 'DESC';
const user = ctx.state.user;
const documents = await Document.findAll({
where: { userId: user.id, publishedAt: { [Op.eq]: null } },
order: [[sort, direction]],
offset: ctx.state.pagination.offset,
limit: ctx.state.pagination.limit,
});
const data = await Promise.all(
documents.map(document => presentDocument(ctx, document))
);
ctx.body = {
pagination: ctx.state.pagination,
data,
};
});
router.post('documents.info', auth(), async ctx => {
const { id } = ctx.body;
ctx.assertPresent(id, 'id is required');
@@ -188,9 +210,10 @@ router.post('documents.unstar', auth(), async ctx => {
});
router.post('documents.create', auth(), async ctx => {
const { collection, title, text, parentDocument, index } = ctx.body;
ctx.assertPresent(collection, 'collection is required');
ctx.assertUuid(collection, 'collection must be an uuid');
const { title, text, publish, parentDocument, index } = ctx.body;
const collectionId = ctx.body.collection;
ctx.assertPresent(collectionId, 'collection is required');
ctx.assertUuid(collectionId, 'collection must be an uuid');
ctx.assertPresent(title, 'title is required');
ctx.assertPresent(text, 'text is required');
if (parentDocument)
@@ -200,44 +223,48 @@ router.post('documents.create', auth(), async ctx => {
const user = ctx.state.user;
authorize(user, 'create', Document);
const ownerCollection = await Collection.findOne({
const collection = await Collection.findOne({
where: {
id: collection,
id: collectionId,
teamId: user.teamId,
},
});
authorize(user, 'publish', ownerCollection);
authorize(user, 'publish', collection);
let parentDocumentObj = {};
if (parentDocument && ownerCollection.type === 'atlas') {
if (parentDocument && collection.type === 'atlas') {
parentDocumentObj = await Document.findOne({
where: {
id: parentDocument,
atlasId: ownerCollection.id,
atlasId: collection.id,
},
});
authorize(user, 'read', parentDocumentObj);
}
const newDocument = await Document.create({
const publishedAt = publish === false ? null : new Date();
let document = await Document.create({
parentDocumentId: parentDocumentObj.id,
atlasId: ownerCollection.id,
atlasId: collection.id,
teamId: user.teamId,
userId: user.id,
lastModifiedById: user.id,
createdById: user.id,
publishedAt,
title,
text,
});
// reload to get all of the data needed to present (user, collection etc)
const document = await Document.findById(newDocument.id);
if (ownerCollection.type === 'atlas') {
await ownerCollection.addDocumentToStructure(document, index);
if (publishedAt && collection.type === 'atlas') {
await collection.addDocumentToStructure(document, index);
}
document.collection = ownerCollection;
// reload to get all of the data needed to present (user, collection etc)
// we need to specify publishedAt to bypass default scope that only returns
// published documents
document = await Document.find({
where: { id: document.id, publishedAt },
});
ctx.body = {
data: await presentDocument(ctx, document),
@@ -245,7 +272,7 @@ router.post('documents.create', auth(), async ctx => {
});
router.post('documents.update', auth(), async ctx => {
const { id, title, text, lastRevision } = ctx.body;
const { id, title, text, publish, lastRevision } = ctx.body;
ctx.assertPresent(id, 'id is required');
ctx.assertPresent(title || text, 'title or text is required');
@@ -259,6 +286,7 @@ router.post('documents.update', auth(), async ctx => {
}
// Update document
if (publish) document.publishedAt = new Date();
if (title) document.title = title;
if (text) document.text = text;
document.lastModifiedById = user.id;
@@ -266,7 +294,11 @@ router.post('documents.update', auth(), async ctx => {
await document.save();
const collection = document.collection;
if (collection.type === 'atlas') {
await collection.updateDocument(document);
if (document.publishedAt) {
await collection.updateDocument(document);
} else if (publish) {
await collection.addDocumentToStructure(document);
}
}
document.collection = collection;

80
server/api/documents.test.js
View File

@@ -10,9 +10,37 @@ const server = new TestServer(app.callback());
beforeEach(flushdb);
afterAll(server.close);
describe('#documents.info', async () => {
it('should return published document', async () => {
const { user, document } = await seed();
const res = await server.post('/api/documents.info', {
body: { token: user.getJwtToken(), id: document.id },
});
const body = await res.json();
expect(res.status).toEqual(200);
expect(body.data.id).toEqual(document.id);
});
it('should return drafts', async () => {
const { user, document } = await seed();
document.publishedAt = null;
await document.save();
const res = await server.post('/api/documents.info', {
body: { token: user.getJwtToken(), id: document.id },
});
const body = await res.json();
expect(res.status).toEqual(200);
expect(body.data.id).toEqual(document.id);
});
});
describe('#documents.list', async () => {
it('should return documents', async () => {
const { user, document } = await seed();
const res = await server.post('/api/documents.list', {
body: { token: user.getJwtToken() },
});
@@ -23,6 +51,20 @@ describe('#documents.list', async () => {
expect(body.data[0].id).toEqual(document.id);
});
it('should not return unpublished documents', async () => {
const { user, document } = await seed();
document.publishedAt = null;
await document.save();
const res = await server.post('/api/documents.list', {
body: { token: user.getJwtToken() },
});
const body = await res.json();
expect(res.status).toEqual(200);
expect(body.data.length).toEqual(1);
});
it('should allow changing sort direction', async () => {
const { user, document } = await seed();
const res = await server.post('/api/documents.list', {
@@ -54,6 +96,22 @@ describe('#documents.list', async () => {
});
});
describe('#documents.drafts', async () => {
it('should return unpublished documents', async () => {
const { user, document } = await seed();
document.publishedAt = null;
await document.save();
const res = await server.post('/api/documents.drafts', {
body: { token: user.getJwtToken() },
});
const body = await res.json();
expect(res.status).toEqual(200);
expect(body.data.length).toEqual(1);
});
});
describe('#documents.revision', async () => {
it("should return a document's revisions", async () => {
const { user, document } = await seed();
@@ -263,6 +321,7 @@ describe('#documents.create', async () => {
collection: collection.id,
title: 'new document',
text: 'hello',
publish: true,
},
});
const body = await res.json();
@@ -293,7 +352,7 @@ describe('#documents.create', async () => {
expect(body.data.text).toBe('# Untitled document');
});
it('should create as a child', async () => {
it('should create as a child and add to collection if published', async () => {
const { user, document, collection } = await seed();
const res = await server.post('/api/documents.create', {
body: {
@@ -302,6 +361,7 @@ describe('#documents.create', async () => {
title: 'new document',
text: 'hello',
parentDocument: document.id,
publish: true,
},
});
const body = await res.json();
@@ -328,6 +388,24 @@ describe('#documents.create', async () => {
expect(res.status).toEqual(403);
expect(body).toMatchSnapshot();
});
it('should create as a child and not add to collection', async () => {
const { user, document, collection } = await seed();
const res = await server.post('/api/documents.create', {
body: {
token: user.getJwtToken(),
collection: collection.id,
title: 'new document',
text: 'hello',
parentDocument: document.id,
},
});
const body = await res.json();
expect(res.status).toEqual(200);
expect(body.data.title).toBe('new document');
expect(body.data.collection.documents.length).toBe(2);
});
});
describe('#documents.update', async () => {