Support user and team preferences (#4081)

* feat: support user preferences

* feat: support team preferences

* fix: update snapshots

* feat: update last visited url by user

* fix: update snapshots

* fix: use path instead of complete url

* fix: do not expose preferences to other users with the exception of admin

* feat: support defaultDocumentStatus as a team preference

* feat: allow edit even when collaborative editing is enabled

* Revert "feat: allow edit even when collaborative editing is enabled"

This reverts commit a22a02a406d01eb418dab32249b8b846bf77c59b.

* Revert "feat: support defaultDocumentStatus as a team preference"

This reverts commit 4928cffe5c682952b1e469a3e50a1a34d05dcc58.

* fix: keep preference as a boolean

server/routes/api/__snapshots__/users.test.ts.snap

@@ -14,6 +14,7 @@ Object {
     "language": "en_US",
     "lastActiveAt": null,
     "name": "User 1",
+    "preferences": null,
     "updatedAt": "2018-01-02T00:00:00.000Z",
   },
   "ok": true,
@@ -69,6 +70,7 @@ Object {
     "language": "en_US",
     "lastActiveAt": null,
     "name": "User 1",
+    "preferences": null,
     "updatedAt": "2018-01-02T00:00:00.000Z",
   },
   "ok": true,
@@ -106,6 +108,7 @@ Object {
     "language": "en_US",
     "lastActiveAt": null,
     "name": "User 1",
+    "preferences": null,
     "updatedAt": "2018-01-02T00:00:00.000Z",
   },
   "ok": true,
@@ -143,6 +146,7 @@ Object {
     "language": "en_US",
     "lastActiveAt": null,
     "name": "User 1",
+    "preferences": null,
     "updatedAt": "2018-01-02T00:00:00.000Z",
   },
   "ok": true,
@@ -198,6 +202,7 @@ Object {
     "language": "en_US",
     "lastActiveAt": null,
     "name": "User 1",
+    "preferences": null,
     "updatedAt": "2018-01-02T00:00:00.000Z",
   },
   "ok": true,
@@ -262,6 +267,7 @@ Object {
     "language": "en_US",
     "lastActiveAt": null,
     "name": "User 1",
+    "preferences": null,
     "updatedAt": "2018-01-02T00:00:00.000Z",
   },
   "ok": true,

server/routes/api/users.test.ts

@@ -393,6 +393,46 @@ describe("#users.update", () => {
     expect(body.data.name).toEqual("New name");
   });
 
+  it("should fail upon sending invalid user preference", async () => {
+    const { user } = await seed();
+    const res = await server.post("/api/users.update", {
+      body: {
+        token: user.getJwtToken(),
+        name: "New name",
+        preferences: { invalidPreference: "invalidValue" },
+      },
+    });
+    expect(res.status).toEqual(400);
+  });
+
+  it("should fail upon sending invalid user preference value", async () => {
+    const { user } = await seed();
+    const res = await server.post("/api/users.update", {
+      body: {
+        token: user.getJwtToken(),
+        name: "New name",
+        preferences: { rememberLastPath: "invalidValue" },
+      },
+    });
+    expect(res.status).toEqual(400);
+  });
+
+  it("should update rememberLastPath user preference", async () => {
+    const { user } = await seed();
+    const res = await server.post("/api/users.update", {
+      body: {
+        token: user.getJwtToken(),
+        name: "New name",
+        preferences: {
+          rememberLastPath: true,
+        },
+      },
+    });
+    const body = await res.json();
+    expect(res.status).toEqual(200);
+    expect(body.data.preferences.rememberLastPath).toBe(true);
+  });
+
   it("should require authentication", async () => {
     const res = await server.post("/api/users.update");
     const body = await res.json();

server/routes/api/users.ts

@@ -17,7 +17,7 @@ import logger from "@server/logging/Logger";
 import auth from "@server/middlewares/authentication";
 import { rateLimiter } from "@server/middlewares/rateLimiter";
 import { Event, User, Team } from "@server/models";
-import { UserFlag, UserRole } from "@server/models/User";
+import { UserFlag, UserRole, UserPreference } from "@server/models/User";
 import { can, authorize } from "@server/policies";
 import { presentUser, presentPolicies } from "@server/presenters";
 import {
@@ -26,6 +26,8 @@ import {
   assertPresent,
   assertArray,
   assertUuid,
+  assertKeysIn,
+  assertBoolean,
 } from "@server/validation";
 import pagination from "./middlewares/pagination";
 
@@ -174,7 +176,7 @@ router.post("users.info", auth(), async (ctx) => {
 
 router.post("users.update", auth(), async (ctx) => {
   const { user } = ctx.state;
-  const { name, avatarUrl, language } = ctx.body;
+  const { name, avatarUrl, language, preferences } = ctx.body;
   if (name) {
     user.name = name;
   }
@@ -184,6 +186,16 @@ router.post("users.update", auth(), async (ctx) => {
   if (language) {
     user.language = language;
   }
+  if (preferences) {
+    assertKeysIn(preferences, UserPreference);
+    if (preferences.rememberLastPath) {
+      assertBoolean(preferences.rememberLastPath);
+      user.setPreference(
+        UserPreference.RememberLastPath,
+        preferences.rememberLastPath
+      );
+    }
+  }
   await user.save();
   await Event.create({
     name: "users.update",