Display document views (#849)

* 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

server/api/documents.js

@@ -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 = {

server/api/views.js

@@ -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,

server/api/views.test.js

@@ -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);
   });