refactor: extract cache info to separate files and add more mutations

packages/hoppscotch-app/helpers/backend/GQLClient.ts

@@ -25,7 +25,9 @@ import * as TE from "fp-ts/TaskEither"
 import { pipe, constVoid } from "fp-ts/function"
 import { subscribe } from "wonka"
 import clone from "lodash/clone"
-import gql from "graphql-tag"
+import { keyDefs } from "./caching/keys"
+import { optimisticDefs } from "./caching/optimistic"
+import { updatesDef } from "./caching/updates"
 import {
   getAuthIDToken,
   probableUser$,
@@ -49,91 +51,9 @@ const client = createClient({
     dedupExchange,
     // TODO: Extract this outttttttt
     offlineExchange({
-      keys: {
+      keys: keyDefs,
-        User: (data) => (data as any).uid,
+      optimistic: optimisticDefs,
-        TeamMember: (data) => (data as any).membershipID,
+      updates: updatesDef,
-        Team: (data) => data.id as any,
-      },
-      optimistic: {
-        deleteTeam: () => true,
-        leaveTeam: () => true,
-      },
-      updates: {
-        Mutation: {
-          deleteTeam: (_r, { teamID }, cache, _info) => {
-            cache.updateQuery(
-              {
-                query: gql`
-                  query {
-                    myTeams {
-                      id
-                    }
-                  }
-                `,
-              },
-              (data: any) => {
-                console.log(data)
-                data.myTeams = (data as any).myTeams.filter(
-                  (x: any) => x.id !== teamID
-                )
-
-                return data
-              }
-            )
-
-            cache.invalidate({
-              __typename: "Team",
-              id: teamID as any,
-            })
-          },
-          leaveTeam: (_r, { teamID }, cache, _info) => {
-            cache.updateQuery(
-              {
-                query: gql`
-                  query {
-                    myTeams {
-                      id
-                    }
-                  }
-                `,
-              },
-              (data: any) => {
-                console.log(data)
-                data.myTeams = (data as any).myTeams.filter(
-                  (x: any) => x.id !== teamID
-                )
-
-                return data
-              }
-            )
-
-            cache.invalidate({
-              __typename: "Team",
-              id: teamID as any,
-            })
-          },
-          createTeam: (result, _args, cache, _info) => {
-            cache.updateQuery(
-              {
-                query: gql`
-                  {
-                    myTeams {
-                      id
-                    }
-                  }
-                `,
-              },
-              (data: any) => {
-                console.log(result)
-                console.log(data)
-
-                data.myTeams.push(result.createTeam)
-                return data
-              }
-            )
-          },
-        },
-      },
       storage,
     }),
     authExchange({

packages/hoppscotch-app/helpers/backend/caching/keys.ts

@@ -0,0 +1,7 @@
+import { KeyingConfig } from "@urql/exchange-graphcache";
+
+export const keyDefs: KeyingConfig = {
+  User: (data) => (data as any).uid,
+  TeamMember: (data) => (data as any).membershipID,
+  Team: (data) => data.id as any,
+}

packages/hoppscotch-app/helpers/backend/caching/optimistic.ts

@@ -0,0 +1,13 @@
+import { OptimisticMutationConfig } from "@urql/exchange-graphcache"
+
+export const optimisticDefs: OptimisticMutationConfig = {
+  deleteTeam: () => true,
+  leaveTeam: () => true,
+  renameTeam: ({ teamID, newName }) => ({
+    __typename: "Team",
+    id: teamID,
+    name: newName,
+  }),
+  removeTeamMember: () => true,
+  // TODO: updateTeamMemberRole
+}

packages/hoppscotch-app/helpers/backend/caching/updates.ts

@@ -0,0 +1,147 @@
+import { UpdatesConfig } from "@urql/exchange-graphcache"
+import gql from "graphql-tag"
+
+export const updatesDef: Partial<UpdatesConfig> = {
+  Mutation: {
+    deleteTeam: (_r, { teamID }, cache, _info) => {
+      cache.updateQuery(
+        {
+          query: gql`
+            query {
+              myTeams {
+                id
+              }
+            }
+          `,
+        },
+        (data: any) => {
+          data.myTeams = (data as any).myTeams.filter(
+            (x: any) => x.id !== teamID
+          )
+
+          return data
+        }
+      )
+
+      cache.invalidate({
+        __typename: "Team",
+        id: teamID as any,
+      })
+    },
+    leaveTeam: (_r, { teamID }, cache, _info) => {
+      cache.updateQuery(
+        {
+          query: gql`
+            query {
+              myTeams {
+                id
+              }
+            }
+          `,
+        },
+        (data: any) => {
+          data.myTeams = (data as any).myTeams.filter(
+            (x: any) => x.id !== teamID
+          )
+
+          return data
+        }
+      )
+
+      cache.invalidate({
+        __typename: "Team",
+        id: teamID as any,
+      })
+    },
+    createTeam: (result, _args, cache, _info) => {
+      cache.updateQuery(
+        {
+          query: gql`
+            {
+              myTeams {
+                id
+              }
+            }
+          `,
+        },
+        (data: any) => {
+          data.myTeams.push(result.createTeam)
+          return data
+        }
+      )
+    },
+    renameTeam: (_result, { teamID, newName }, cache, _info) => {
+      cache.updateQuery(
+        {
+          query: gql`
+            query GetTeam($teamID: ID!) {
+              team(teamID: $teamID) {
+                id
+                name
+              }
+            }
+          `,
+          variables: {
+            teamID,
+          },
+        },
+        (data: any) => {
+          data.team.name = newName
+          return data
+        }
+      )
+    },
+    removeTeamMember: (_result, { userUid, teamID }, cache) => {
+      cache.updateQuery(
+        {
+          query: gql`
+            query GetTeam($teamID: ID!) {
+              team(teamID: $teamID) {
+                members {
+                  user {
+                    uid
+                  }
+                }
+              }
+            }
+          `,
+          variables: {
+            teamID,
+          },
+        },
+        (data: any) => {
+          data.team.members = data.team.members.filter(
+            (x: any) => x.user.uid !== userUid
+          )
+          return data
+        }
+      )
+    },
+    updateTeamMemberRole: (result, { userUid, teamID }, cache) => {
+      cache.updateQuery(
+        {
+          query: gql`
+            query GetTeam($teamID: ID!) {
+              team(teamID: $teamID) {
+                members {
+                  user {
+                    uid
+                  }
+                }
+              }
+            }
+          `,
+          variables: {
+            teamID,
+          },
+        },
+        (data: any) => {
+          data.team.members = data.team.members.map((x: any) =>
+            x.user.uid !== userUid ? x : result
+          )
+          return data
+        }
+      )
+    },
+  },
+}

packages/hoppscotch-app/helpers/backend/mutations/Team.ts

@@ -18,6 +18,21 @@ type ExitTeamErrors =
 
 type CreateTeamErrors = "team/name_invalid" | "ea/not_invite_or_admin"
 
+type RenameTeamErrors =
+  | "ea/not_invite_or_admin"
+  | "team/invalid_id"
+  | "team/not_required_role"
+
+type UpdateTeamMemberRoleErrors =
+  | "ea/not_invite_or_admin"
+  | "team/invalid_id"
+  | "team/not_required_role"
+
+type RemoveTeamMemberErrors =
+  | "ea/not_invite_or_admin"
+  | "team/invalid_id"
+  | "team/not_required_role"
+
 export const createTeam = (name: TeamName) =>
   pipe(
     runMutation<
@@ -85,3 +100,83 @@ export const leaveTeam = (teamID: string) =>
       additionalTypenames: ["Team"],
     }
   )
+
+export const renameTeam = (teamID: string, newName: TeamName) =>
+  pipe(
+    runMutation<
+      {
+        renameTeam: {
+          id: string
+          name: TeamName
+        }
+      },
+      RenameTeamErrors
+    >(
+      gql`
+        mutation RenameTeam($newName: String!, $teamID: ID!) {
+          renameTeam(newName: $newName, teamID: $teamID) {
+            id
+            name
+          }
+        }
+      `,
+      {
+        newName,
+        teamID,
+      }
+    ),
+    TE.map(({ renameTeam }) => renameTeam)
+  )
+
+export const updateTeamMemberRole = (
+  userUid: string,
+  teamID: string,
+  newRole: TeamMemberRole
+) =>
+  pipe(
+    runMutation<
+      {
+        updateTeamMemberRole: {
+          membershipID: string
+          role: TeamMemberRole
+        }
+      },
+      UpdateTeamMemberRoleErrors
+    >(
+      gql`
+          mutation UpdateTeamMemberRole(
+            $newRole: TeamMemberRole!,
+            $userUid: ID!,
+            teamID: ID!
+          ) {
+            updateTeamMemberRole(
+              newRole: $newRole
+              userUid: $userUid
+              teamID: $teamID
+            ) {
+              membershipID
+              role
+            }
+          }
+        `,
+      {
+        newRole,
+        userUid,
+        teamID,
+      }
+    ),
+    TE.map(({ updateTeamMemberRole }) => updateTeamMemberRole)
+  )
+
+export const removeTeamMember = (userUid: string, teamID: string) =>
+  runMutation<void, RemoveTeamMemberErrors>(
+    gql`
+      mutation RemoveTeamMember($userUid: ID!, $teamID: ID!) {
+        removeTeamMember(userUid: $userUid, teamID: $teamID)
+      }
+    `,
+    {
+      userUid,
+      teamID,
+    }
+  )