coop-cloud-chaos-patchs/outline
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Display document views (#849)

Browse Source 
* Display who has viewed a document in the header

* Add overflow, display of WHEN last viewed
Cleanup old document attributes
Add firstViewedAt, lastViewedAt to API response

* Cleanup

* Added: API documentation for views endpoints

* Include views for deleted users
This commit is contained in:
Tom Moor
2019-01-08 22:49:20 -08:00
committed by GitHub
parent 11b0ac0c66
commit c78bf3c4bf
14 changed files with 216 additions and 123 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
server/api/documents.js
View File

@ -148,7 +148,7 @@ router.post('documents.starred', auth(), pagination(), async ctx => {
const user = ctx.state.user;
const collectionIds = await user.collectionIds();
const views = await Star.findAll({
const stars = await Star.findAll({
where: {
userId: user.id,
},
@ -175,7 +175,7 @@ router.post('documents.starred', auth(), pagination(), async ctx => {
});
const data = await Promise.all(
views.map(view => presentDocument(ctx, view.document))
stars.map(star => presentDocument(ctx, star.document))
);
ctx.body = {

38
server/api/views.js
View File

@ -2,51 +2,47 @@
import Router from 'koa-router';
import auth from '../middlewares/authentication';
import { presentView } from '../presenters';
import { View, Document } from '../models';
import { View, Document, User } from '../models';
import policy from '../policies';
const { authorize } = policy;
const router = new Router();
router.post('views.list', auth(), async ctx => {
const { id } = ctx.body;
ctx.assertUuid(id, 'id is required');
const { documentId } = ctx.body;
ctx.assertUuid(documentId, 'documentId is required');
const user = ctx.state.user;
const document = await Document.findById(id);
const document = await Document.findById(documentId);
authorize(user, 'read', document);
const views = await View.findAll({
where: { documentId: id },
where: { documentId },
order: [['updatedAt', 'DESC']],
include: [
{
model: User,
paranoid: false,
},
],
});
let users = [];
let count = 0;
await Promise.all(
views.map(async view => {
count = view.count;
return users.push(await presentView(ctx, view));
})
);
const data = views.map(view => presentView(ctx, view));
ctx.body = {
data: {
users,
count,
},
data,
};
});
router.post('views.create', auth(), async ctx => {
const { id } = ctx.body;
ctx.assertUuid(id, 'id is required');
const { documentId } = ctx.body;
ctx.assertUuid(documentId, 'documentId is required');
const user = ctx.state.user;
const document = await Document.findById(id);
const document = await Document.findById(documentId);
authorize(user, 'read', document);
await View.increment({ documentId: document.id, userId: user.id });
await View.increment({ documentId, userId: user.id });
ctx.body = {
success: true,

19
server/api/views.test.js
View File

@ -1,6 +1,7 @@
/* eslint-disable flowtype/require-valid-file-annotation */
import TestServer from 'fetch-test-server';
import app from '..';
import { View } from '../models';
import { flushdb, seed } from '../test/support';
import { buildUser } from '../test/factories';
@ -12,16 +13,22 @@ afterAll(server.close);
describe('#views.list', async () => {
it('should return views for a document', async () => {
const { user, document } = await seed();
await View.increment({ documentId: document.id, userId: user.id });
const res = await server.post('/api/views.list', {
body: { token: user.getJwtToken(), id: document.id },
body: { token: user.getJwtToken(), documentId: document.id },
});
const body = await res.json();
expect(res.status).toEqual(200);
expect(body.data[0].count).toBe(1);
expect(body.data[0].user.name).toBe(user.name);
});
it('should require authentication', async () => {
const { document } = await seed();
const res = await server.post('/api/views.list', {
body: { id: document.id },
body: { documentId: document.id },
});
const body = await res.json();
@ -33,7 +40,7 @@ describe('#views.list', async () => {
const { document } = await seed();
const user = await buildUser();
const res = await server.post('/api/views.list', {
body: { token: user.getJwtToken(), id: document.id },
body: { token: user.getJwtToken(), documentId: document.id },
});
expect(res.status).toEqual(403);
});
@ -43,7 +50,7 @@ describe('#views.create', async () => {
it('should allow creating a view record for document', async () => {
const { user, document } = await seed();
const res = await server.post('/api/views.create', {
body: { token: user.getJwtToken(), id: document.id },
body: { token: user.getJwtToken(), documentId: document.id },
});
const body = await res.json();
@ -54,7 +61,7 @@ describe('#views.create', async () => {
it('should require authentication', async () => {
const { document } = await seed();
const res = await server.post('/api/views.create', {
body: { id: document.id },
body: { documentId: document.id },
});
const body = await res.json();
@ -66,7 +73,7 @@ describe('#views.create', async () => {
const { document } = await seed();
const user = await buildUser();
const res = await server.post('/api/views.create', {
body: { token: user.getJwtToken(), id: document.id },
body: { token: user.getJwtToken(), documentId: document.id },
});
expect(res.status).toEqual(403);
});

21
server/pages/developers/Api.js
View File

@ -560,6 +560,27 @@ export default function Pricing() {
<Argument id="id" description="Share ID" required />
</Arguments>
</Method>
<Method method="views.list" label="List document views">
<Description>
List all users that have viewed a document and the overall view
count.
</Description>
<Arguments>
<Argument id="documentId" description="Document ID" required />
</Arguments>
</Method>
<Method method="views.create" label="Create a document view">
<Description>
Creates a new view for a document. This is documented in the
interests of thoroughness however it is recommended that views are
not created from outside of the Outline UI.
</Description>
<Arguments>
<Argument id="documentId" description="Document ID" required />
</Arguments>
</Method>
</Methods>
</Content>
</Grid>

9
server/presenters/document.js
View File

@ -32,8 +32,6 @@ async function present(ctx: Object, document: Document, options: ?Options) {
updatedAt: document.updatedAt,
updatedBy: undefined,
publishedAt: document.publishedAt,
firstViewedAt: undefined,
lastViewedAt: undefined,
team: document.teamId,
collaborators: [],
starred: !!(document.starred && document.starred.length),
@ -41,7 +39,6 @@ async function present(ctx: Object, document: Document, options: ?Options) {
pinned: undefined,
collectionId: undefined,
collection: undefined,
views: undefined,
};
if (!options.isPublic) {
@ -54,12 +51,6 @@ async function present(ctx: Object, document: Document, options: ?Options) {
data.collection = await presentCollection(ctx, document.collection);
}
if (document.views && document.views.length === 1) {
data.views = document.views[0].count;
data.firstViewedAt = document.views[0].createdAt;
data.lastViewedAt = document.views[0].updatedAt;
}
// This could be further optimized by using ctx.cache
data.collaborators = await User.findAll({
where: {

18
server/presenters/view.js
View File

@ -1,18 +1,16 @@
// @flow
import { View, User } from '../models';
import { View } from '../models';
import { presentUser } from '../presenters';
async function present(ctx: Object, view: View) {
let data = {
function present(ctx: Object, view: View) {
return {
id: view.id,
documentId: view.documentId,
count: view.count,
user: undefined,
firstViewedAt: view.createdAt,
lastViewedAt: view.updatedAt,
user: presentUser(ctx, view.user),
};
const user = await ctx.cache.get(
view.userId,
async () => await User.findById(view.userId)
);
data.user = await presentUser(ctx, user);
return data;
}
export default present;