UserPermission and GroupPermission models (#5860)

* fix: rename to group_permissions

* fix: delete null collectionId records before setting non null constraint

* fix: use scope with collectionId not null

* fix: update model with documentId

* fix: rename to GroupPermission

* fix: rename collection_users to user_permissions

* fix: teamPermanentDeleter test

* fix: use scope with collectionId not null

* fix: update model with documentId

* fix: rename to UserPermission

* fix: create views upon table rename for zero downtime

* fix: remove comments

server/routes/api/collections/collections.test.ts

@@ -1,6 +1,6 @@
 import { CollectionPermission } from "@shared/types";
 import { colorPalette } from "@shared/utils/collections";
-import { Document, CollectionUser, CollectionGroup } from "@server/models";
+import { Document, UserPermission, GroupPermission } from "@server/models";
 import {
   buildUser,
   buildAdmin,
@@ -310,7 +310,7 @@ describe("#collections.export", () => {
     const collection = await buildCollection({ teamId: team.id });
     collection.permission = null;
     await collection.save();
-    await CollectionUser.create({
+    await UserPermission.create({
       createdById: admin.id,
       collectionId: collection.id,
       userId: admin.id,
@@ -750,13 +750,13 @@ describe("#collections.group_memberships", () => {
       permission: null,
       teamId: user.teamId,
     });
-    await CollectionUser.create({
+    await UserPermission.create({
       createdById: user.id,
       collectionId: collection.id,
       userId: user.id,
       permission: CollectionPermission.ReadWrite,
     });
-    await CollectionGroup.create({
+    await GroupPermission.create({
       createdById: user.id,
       collectionId: collection.id,
       groupId: group.id,
@@ -792,19 +792,19 @@ describe("#collections.group_memberships", () => {
       permission: null,
       teamId: user.teamId,
     });
-    await CollectionUser.create({
+    await UserPermission.create({
       createdById: user.id,
       collectionId: collection.id,
       userId: user.id,
       permission: CollectionPermission.ReadWrite,
     });
-    await CollectionGroup.create({
+    await GroupPermission.create({
       createdById: user.id,
       collectionId: collection.id,
       groupId: group.id,
       permission: CollectionPermission.ReadWrite,
     });
-    await CollectionGroup.create({
+    await GroupPermission.create({
       createdById: user.id,
       collectionId: collection.id,
       groupId: group2.id,
@@ -835,19 +835,19 @@ describe("#collections.group_memberships", () => {
       permission: null,
       teamId: user.teamId,
     });
-    await CollectionUser.create({
+    await UserPermission.create({
       createdById: user.id,
       collectionId: collection.id,
       userId: user.id,
       permission: CollectionPermission.ReadWrite,
     });
-    await CollectionGroup.create({
+    await GroupPermission.create({
       createdById: user.id,
       collectionId: collection.id,
       groupId: group.id,
       permission: CollectionPermission.ReadWrite,
     });
-    await CollectionGroup.create({
+    await GroupPermission.create({
       createdById: user.id,
       collectionId: collection.id,
       groupId: group2.id,
@@ -926,7 +926,7 @@ describe("#collections.memberships", () => {
     const user2 = await buildUser({
       name: "Won't find",
     });
-    await CollectionUser.create({
+    await UserPermission.create({
       createdById: user2.id,
       collectionId: collection.id,
       userId: user2.id,
@@ -953,13 +953,13 @@ describe("#collections.memberships", () => {
       teamId: team.id,
     });
     const user2 = await buildUser();
-    await CollectionUser.create({
+    await UserPermission.create({
       createdById: user.id,
       collectionId: collection.id,
       userId: user.id,
       permission: CollectionPermission.ReadWrite,
     });
-    await CollectionUser.create({
+    await UserPermission.create({
       createdById: user2.id,
       collectionId: collection.id,
       userId: user2.id,
@@ -1026,7 +1026,7 @@ describe("#collections.info", () => {
     });
     collection.permission = null;
     await collection.save();
-    await CollectionUser.destroy({
+    await UserPermission.destroy({
       where: {
         collectionId: collection.id,
         userId: user.id,
@@ -1050,7 +1050,7 @@ describe("#collections.info", () => {
     });
     collection.permission = null;
     await collection.save();
-    await CollectionUser.create({
+    await UserPermission.create({
       collectionId: collection.id,
       userId: user.id,
       createdById: user.id,
@@ -1342,7 +1342,7 @@ describe("#collections.update", () => {
     const collection = await buildCollection({ teamId: team.id });
     collection.permission = null;
     await collection.save();
-    await CollectionUser.create({
+    await UserPermission.create({
       collectionId: collection.id,
       userId: admin.id,
       createdById: admin.id,
@@ -1371,7 +1371,7 @@ describe("#collections.update", () => {
     const collection = await buildCollection({ teamId: team.id });
     collection.permission = null;
     await collection.save();
-    await CollectionUser.create({
+    await UserPermission.create({
       collectionId: collection.id,
       userId: admin.id,
       createdById: admin.id,
@@ -1432,7 +1432,7 @@ describe("#collections.update", () => {
     });
     collection.permission = null;
     await collection.save();
-    await CollectionUser.update(
+    await UserPermission.update(
       {
         createdById: user.id,
         permission: CollectionPermission.Read,

server/routes/api/collections/collections.ts

@@ -16,8 +16,8 @@ import { transaction } from "@server/middlewares/transaction";
 import validate from "@server/middlewares/validate";
 import {
   Collection,
-  CollectionUser,
-  CollectionGroup,
+  UserPermission,
+  GroupPermission,
   Team,
   Event,
   User,
@@ -220,7 +220,7 @@ router.post(
     const group = await Group.findByPk(groupId);
     authorize(user, "read", group);
 
-    let membership = await CollectionGroup.findOne({
+    let membership = await GroupPermission.findOne({
       where: {
         collectionId: id,
         groupId,
@@ -228,7 +228,7 @@ router.post(
     });
 
     if (!membership) {
-      membership = await CollectionGroup.create({
+      membership = await GroupPermission.create({
         collectionId: id,
         groupId,
         permission,
@@ -310,7 +310,7 @@ router.post(
     }).findByPk(id);
     authorize(user, "read", collection);
 
-    let where: WhereOptions<CollectionGroup> = {
+    let where: WhereOptions<GroupPermission> = {
       collectionId: id,
     };
     let groupWhere;
@@ -340,8 +340,8 @@ router.post(
     };
 
     const [total, memberships] = await Promise.all([
-      CollectionGroup.count(options),
-      CollectionGroup.findAll({
+      GroupPermission.count(options),
+      GroupPermission.findAll({
         ...options,
         order: [["createdAt", "DESC"]],
         offset: ctx.state.pagination.offset,
@@ -379,7 +379,7 @@ router.post(
     const user = await User.findByPk(userId);
     authorize(actor, "read", user);
 
-    let membership = await CollectionUser.findOne({
+    let membership = await UserPermission.findOne({
       where: {
         collectionId: id,
         userId,
@@ -389,7 +389,7 @@ router.post(
     });
 
     if (!membership) {
-      membership = await CollectionUser.create(
+      membership = await UserPermission.create(
         {
           collectionId: id,
           userId,
@@ -485,7 +485,7 @@ router.post(
     }).findByPk(id);
     authorize(user, "read", collection);
 
-    let where: WhereOptions<CollectionUser> = {
+    let where: WhereOptions<UserPermission> = {
       collectionId: id,
     };
     let userWhere;
@@ -515,8 +515,8 @@ router.post(
     };
 
     const [total, memberships] = await Promise.all([
-      CollectionUser.count(options),
-      CollectionUser.findAll({
+      UserPermission.count(options),
+      UserPermission.findAll({
         ...options,
         order: [["createdAt", "DESC"]],
         offset: ctx.state.pagination.offset,
@@ -627,7 +627,7 @@ router.post(
       permission !== CollectionPermission.ReadWrite &&
       collection.permission === CollectionPermission.ReadWrite
     ) {
-      await CollectionUser.findOrCreate({
+      await UserPermission.findOrCreate({
         where: {
           collectionId: collection.id,
           userId: user.id,