chore: Rename GroupPermission -> GroupMembership (outline#7214)

* GroupPermission -> GroupMembership

* Add group membership source

* wip

Author: tommoor

plugins/webhooks/client/components/WebhookSubscriptionForm.tsx

@@ -41,6 +41,8 @@ const WEBHOOK_EVENTS = {
     "documents.title_change",
     "documents.add_user",
     "documents.remove_user",
+    "documents.add_group",
+    "documents.remove_group",
   ],
   collections: [
     "collections.create",

plugins/webhooks/server/tasks/DeliverWebhookTask.ts

@@ -20,7 +20,7 @@ import {
   View,
   Share,
   UserMembership,
-  GroupPermission,
+  GroupMembership,
   GroupUser,
   Comment,
 } from "@server/models";
@@ -42,6 +42,7 @@ import {
   presentCollectionGroupMembership,
   presentComment,
 } from "@server/presenters";
+import presentDocumentGroupMembership from "@server/presenters/documentGroupMembership";
 import BaseTask from "@server/queues/tasks/BaseTask";
 import {
   CollectionEvent,
@@ -50,6 +51,7 @@ import {
   CommentEvent,
   DocumentEvent,
   DocumentUserEvent,
+  DocumentGroupEvent,
   Event,
   FileOperationEvent,
   GroupEvent,
@@ -138,6 +140,10 @@ export default class DeliverWebhookTask extends BaseTask<Props> {
       case "documents.remove_user":
         await this.handleDocumentUserEvent(subscription, event);
         return;
+      case "documents.add_group":
+      case "documents.remove_group":
+        await this.handleDocumentGroupEvent(subscription, event);
+        return;
       case "documents.update.delayed":
       case "documents.update.debounced":
         // Ignored
@@ -478,7 +484,7 @@ export default class DeliverWebhookTask extends BaseTask<Props> {
     subscription: WebhookSubscription,
     event: CollectionGroupEvent
   ): Promise<void> {
-    const model = await GroupPermission.scope([
+    const model = await GroupMembership.scope([
       "withGroup",
       "withCollection",
     ]).findOne({
@@ -581,6 +587,36 @@ export default class DeliverWebhookTask extends BaseTask<Props> {
     });
   }
 
+  private async handleDocumentGroupEvent(
+    subscription: WebhookSubscription,
+    event: DocumentGroupEvent
+  ): Promise<void> {
+    const model = await GroupMembership.scope([
+      "withGroup",
+      "withDocument",
+    ]).findOne({
+      where: {
+        documentId: event.documentId,
+        groupId: event.modelId,
+      },
+      paranoid: false,
+    });
+
+    const document =
+      model && (await presentDocument(undefined, model.document!));
+
+    await this.sendWebhook({
+      event,
+      subscription,
+      payload: {
+        id: event.modelId,
+        model: model && presentDocumentGroupMembership(model),
+        document,
+        group: model && presentGroup(model.group),
+      },
+    });
+  }
+
   private async handleRevisionEvent(
     subscription: WebhookSubscription,
     event: RevisionEvent

server/migrations/20240709031512-group-permission-source-id.js

@@ -0,0 +1,33 @@
+"use strict";
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.addColumn("group_permissions", "sourceId", {
+      type: Sequelize.UUID,
+      onDelete: "cascade",
+      references: {
+        model: "group_permissions",
+      },
+      allowNull: true,
+    });
+
+    await queryInterface.removeConstraint("group_permissions", "group_permissions_documentId_fkey")
+    await queryInterface.changeColumn("group_permissions", "documentId", {
+      type: Sequelize.UUID,
+      onDelete: "cascade",
+      references: {
+        model: "documents",
+      },
+    });
+  },
+  async down(queryInterface) {
+    await queryInterface.removeConstraint("group_permissions", "group_permissions_documentId_fkey")
+    await queryInterface.changeColumn("group_permissions", "documentId", {
+      type: Sequelize.UUID,
+      references: {
+        model: "documents",
+      },
+    });
+    await queryInterface.removeColumn("group_permissions", "sourceId");
+  },
+};

server/models/Collection.ts

@@ -42,7 +42,7 @@ import { ValidationError } from "@server/errors";
 import Document from "./Document";
 import FileOperation from "./FileOperation";
 import Group from "./Group";
-import GroupPermission from "./GroupPermission";
+import GroupMembership from "./GroupMembership";
 import GroupUser from "./GroupUser";
 import Team from "./Team";
 import User from "./User";
@@ -63,7 +63,7 @@ import NotContainsUrl from "./validators/NotContainsUrl";
         required: false,
       },
       {
-        model: GroupPermission,
+        model: GroupMembership,
         as: "collectionGroupMemberships",
         required: false,
         // use of "separate" property: sequelize breaks when there are
@@ -110,7 +110,7 @@ import NotContainsUrl from "./validators/NotContainsUrl";
         required: false,
       },
       {
-        model: GroupPermission,
+        model: GroupMembership,
         as: "collectionGroupMemberships",
         required: false,
         // use of "separate" property: sequelize breaks when there are
@@ -322,13 +322,13 @@ class Collection extends ParanoidModel<
   @HasMany(() => UserMembership, "collectionId")
   memberships: UserMembership[];
 
-  @HasMany(() => GroupPermission, "collectionId")
-  collectionGroupMemberships: GroupPermission[];
+  @HasMany(() => GroupMembership, "collectionId")
+  collectionGroupMemberships: GroupMembership[];
 
   @BelongsToMany(() => User, () => UserMembership)
   users: User[];
 
-  @BelongsToMany(() => Group, () => GroupPermission)
+  @BelongsToMany(() => Group, () => GroupMembership)
   groups: Group[];
 
   @BelongsTo(() => User, "createdById")

server/models/Group.ts

@@ -11,7 +11,7 @@ import {
   DataType,
   Scopes,
 } from "sequelize-typescript";
-import GroupPermission from "./GroupPermission";
+import GroupMembership from "./GroupMembership";
 import GroupUser from "./GroupUser";
 import Team from "./Team";
 import User from "./User";
@@ -90,7 +90,7 @@ class Group extends ParanoidModel<
         groupId: model.id,
       },
     });
-    await GroupPermission.destroy({
+    await GroupMembership.destroy({
       where: {
         groupId: model.id,
       },
@@ -109,8 +109,8 @@ class Group extends ParanoidModel<
   @HasMany(() => GroupUser, { as: "members", foreignKey: "groupId" })
   groupUsers: GroupUser[];
 
-  @HasMany(() => GroupPermission, "groupId")
-  collectionGroupMemberships: GroupPermission[];
+  @HasMany(() => GroupMembership, "groupId")
+  collectionGroupMemberships: GroupMembership[];
 
   @BelongsTo(() => Team, "teamId")
   team: Team;

server/models/GroupPermission.test.ts server/models/GroupMembership.test.ts

@@ -1,20 +1,20 @@
 import { buildCollection, buildGroup, buildUser } from "@server/test/factories";
-import GroupPermission from "./GroupPermission";
+import GroupMembership from "./GroupMembership";
 
-describe("GroupPermission", () => {
+describe("GroupMembership", () => {
   describe("withCollection scope", () => {
     it("should return the collection", async () => {
       const collection = await buildCollection();
       const group = await buildGroup();
       const user = await buildUser({ teamId: group.teamId });
 
-      await GroupPermission.create({
+      await GroupMembership.create({
         createdById: user.id,
         groupId: group.id,
         collectionId: collection.id,
       });
 
-      const permission = await GroupPermission.scope("withCollection").findOne({
+      const permission = await GroupMembership.scope("withCollection").findOne({
         where: {
           groupId: group.id,
           collectionId: collection.id,