feat: Drop adminClient (2/2) (#2375)

* feat: Analytics * feat: Session summary * feat: Publish * feat: Move flow * feat: Find and replace * feat: getFlowData() * feat: insertFlow() * feat: getMostRecentPublishedFlow() * chore: Drop unused function * feat: Payment status * feat: Payment requests * feat: Operations * chore: Drop adminGraphQLClient * chore: Linting * fix: PR comments
theopensystemslab · Nov 3, 2023 · 7daacc5 · 7daacc5
1 parent 4e54d39
commit 7daacc5
Show file tree

Hide file tree

Showing 22 changed files with 256 additions and 171 deletions.
diff --git a/api.planx.uk/admin/session/summary.test.ts b/api.planx.uk/admin/session/summary.test.ts
@@ -14,7 +14,7 @@ describe("Session summary admin endpoint", () => {
         sessionId: "abc123",
       },
       data: {
-        lowcal_sessions_by_pk: {},
+        lowcalSession: {},
       },
     });
   });

diff --git a/api.planx.uk/admin/session/summary.ts b/api.planx.uk/admin/session/summary.ts
@@ -6,8 +6,8 @@ import {
 import { NextFunction, Request, Response } from "express";
 import { gql } from "graphql-request";
 
-import { adminGraphQLClient as adminClient } from "../../hasura";
 import { Breadcrumb, Flow, LowCalSession, Passport, Team } from "../../types";
+import { $api } from "../../client";
 
 /**
  * @swagger
@@ -28,9 +28,9 @@ export async function getSessionSummary(
   next: NextFunction,
 ) {
   try {
-    const data = await getSessionSummaryById(req.params.sessionId);
-    if (data) {
-      res.send(data);
+    const session = await getSessionSummaryById(req.params.sessionId);
+    if (session) {
+      res.send(session);
     } else {
       res.send({
         message: `Cannot find data for this session; double-check your sessionId is correct`,
@@ -72,11 +72,13 @@ interface SessionSummary {
 
 const getSessionSummaryById = async (
   sessionId: Session["id"],
-): Promise<SessionSummary> => {
-  const data = await adminClient.request(
+): Promise<SessionSummary | null> => {
+  const { lowcalSession } = await $api.client.request<
+    Record<"lowcalSession", SessionSummary | null>
+  >(
     gql`
       query GetSessionSummary($sessionId: uuid!) {
-        lowcal_sessions_by_pk(id: $sessionId) {
+        lowcalSession: lowcal_sessions_by_pk(id: $sessionId) {
           flow {
             id
             slug
@@ -112,5 +114,5 @@ const getSessionSummaryById = async (
     },
   );
 
-  return data?.lowcal_sessions_by_pk;
+  return lowcalSession;
 };
diff --git a/api.planx.uk/editor/copyFlow.test.ts b/api.planx.uk/editor/copyFlow.test.ts
@@ -10,7 +10,7 @@ beforeEach(() => {
     name: "GetFlowData",
     matchOnVariables: false,
     data: {
-      flows_by_pk: {
+      flow: {
         data: mockFlowData,
       },
     },
@@ -20,7 +20,7 @@ beforeEach(() => {
     name: "InsertFlow",
     matchOnVariables: false,
     data: {
-      insert_flows_one: {
+      flow: {
         id: 2,
       },
     },
@@ -30,7 +30,7 @@ beforeEach(() => {
     name: "InsertOperation",
     matchOnVariables: false,
     data: {
-      insert_operations_one: {
+      operation: {
         id: 1,
       },
     },

diff --git a/api.planx.uk/editor/copyPortalAsFlow.test.ts b/api.planx.uk/editor/copyPortalAsFlow.test.ts
@@ -10,7 +10,7 @@ beforeEach(() => {
     name: "GetFlowData",
     matchOnVariables: false,
     data: {
-      flows_by_pk: {
+      flow: {
         data: mockFlowData,
       },
     },

diff --git a/api.planx.uk/editor/findReplace.test.ts b/api.planx.uk/editor/findReplace.test.ts
@@ -10,7 +10,7 @@ beforeEach(() => {
     name: "GetFlowData",
     matchOnVariables: false,
     data: {
-      flows_by_pk: {
+      flow: {
         data: mockFlowData,
         slug: "test",
       },
@@ -21,7 +21,7 @@ beforeEach(() => {
     name: "UpdateFlow",
     matchOnVariables: false,
     data: {
-      update_flows_by_pk: {
+      flow: {
         data: replacedFlowData,
         slug: "test",
       },

diff --git a/api.planx.uk/editor/findReplace.ts b/api.planx.uk/editor/findReplace.ts
@@ -1,8 +1,9 @@
 import { Flow } from "./../types";
-import { adminGraphQLClient as adminClient } from "../hasura";
 import { gql } from "graphql-request";
 import { getFlowData } from "../helpers";
 import { Request, Response, NextFunction } from "express";
+import { getClient } from "../client";
+import { FlowGraph } from "@opensystemslab/planx-core/types";
 
 interface MatchResult {
   matches: Flow["data"];
@@ -49,6 +50,15 @@ const getMatches = (
   };
 };
 
+interface UpdateFlow {
+  flow: {
+    id: string;
+    slug: string;
+    data: FlowGraph;
+    updatedAt: string;
+  };
+}
+
 /**
  * @swagger
  * /flows/{flowId}/search:
@@ -136,14 +146,18 @@ const findAndReplaceInFlow = async (
       }
 
       // if matches, proceed with mutation to update flow data
-      const response = await adminClient.request(
+      const { client: $client } = getClient();
+      const response = await $client.request<UpdateFlow>(
         gql`
           mutation UpdateFlow($data: jsonb = {}, $id: uuid!) {
-            update_flows_by_pk(pk_columns: { id: $id }, _set: { data: $data }) {
+            flow: update_flows_by_pk(
+              pk_columns: { id: $id }
+              _set: { data: $data }
+            ) {
               id
               slug
               data
-              updated_at
+              updatedAt: updated_at
             }
           }
         `,
@@ -153,8 +167,7 @@ const findAndReplaceInFlow = async (
         },
       );
 
-      const updatedFlow =
-        response.update_flows_by_pk && response.update_flows_by_pk.data;
+      const updatedFlow = response.flow && response.flow.data;
 
       res.json({
         message: `Found ${

diff --git a/api.planx.uk/editor/moveFlow.test.ts b/api.planx.uk/editor/moveFlow.test.ts
@@ -26,7 +26,7 @@ beforeEach(() => {
       team_id: "1",
     },
     data: {
-      update_flows_by_pk: {
+      flow: {
         id: "1",
       },
     },

diff --git a/api.planx.uk/editor/moveFlow.ts b/api.planx.uk/editor/moveFlow.ts
@@ -1,7 +1,7 @@
 import { Request, Response, NextFunction } from "express";
 import { gql } from "graphql-request";
-import { adminGraphQLClient as adminClient } from "../hasura";
 import { Flow, Team } from "../types";
+import { $public, getClient } from "../client";
 
 const moveFlow = async (
   req: Request,
@@ -36,8 +36,12 @@ const moveFlow = async (
   }
 };
 
+interface GetTeam {
+  teams: Pick<Team, "id">[];
+}
+
 const getTeamIdBySlug = async (slug: Team["slug"]): Promise<Team["id"]> => {
-  const data = await adminClient.request(
+  const data = await $public.client.request<GetTeam>(
     gql`
       query GetTeam($slug: String!) {
         teams(where: { slug: { _eq: $slug } }) {
@@ -53,14 +57,19 @@ const getTeamIdBySlug = async (slug: Team["slug"]): Promise<Team["id"]> => {
   return data?.teams[0].id;
 };
 
+interface UpdateFlow {
+  flow: Pick<Flow, "id">;
+}
+
 const updateFlow = async (
   flowId: Flow["id"],
   teamId: Team["id"],
 ): Promise<Flow["id"]> => {
-  const data = await adminClient.request(
+  const { client: $client } = getClient();
+  const { flow } = await $client.request<UpdateFlow>(
     gql`
       mutation UpdateFlow($id: uuid!, $team_id: Int!) {
-        update_flows_by_pk(
+        flow: update_flows_by_pk(
           pk_columns: { id: $id }
           _set: { team_id: $team_id }
         ) {
@@ -74,7 +83,7 @@ const updateFlow = async (
     },
   );
 
-  return data?.update_flows_by_pk?.id;
+  return flow.id;
 };
 
 export { moveFlow };
diff --git a/api.planx.uk/editor/publish.test.ts b/api.planx.uk/editor/publish.test.ts
@@ -1,17 +1,28 @@
 import supertest from "supertest";
 
 import { queryMock } from "../tests/graphqlQueryMock";
-import { authHeader } from "../tests/mockJWT";
+import { authHeader, getJWT } from "../tests/mockJWT";
 import app from "../server";
 import { flowWithInviteToPay } from "../tests/mocks/inviteToPayData";
 import { FlowGraph } from "@opensystemslab/planx-core/types";
+import { userContext } from "../modules/auth/middleware";
+
+beforeAll(() => {
+  const getStoreMock = jest.spyOn(userContext, "getStore");
+  getStoreMock.mockReturnValue({
+    user: {
+      sub: "123",
+      jwt: getJWT({ role: "teamEditor" }),
+    },
+  });
+});
 
 beforeEach(() => {
   queryMock.mockQuery({
     name: "GetFlowData",
     matchOnVariables: false,
     data: {
-      flows_by_pk: {
+      flow: {
         data: mockFlowData,
       },
     },
@@ -21,8 +32,8 @@ beforeEach(() => {
     name: "GetMostRecentPublishedFlow",
     matchOnVariables: false,
     data: {
-      flows_by_pk: {
-        published_flows: [
+      flow: {
+        publishedFlows: [
           {
             data: mockFlowData,
           },
@@ -35,7 +46,7 @@ beforeEach(() => {
     name: "PublishFlow",
     matchOnVariables: false,
     data: {
-      insert_published_flows_one: {
+      publishedFlow: {
         data: mockFlowData,
       },
     },
@@ -89,7 +100,7 @@ describe("publish", () => {
       name: "GetFlowData",
       matchOnVariables: false,
       data: {
-        flows_by_pk: {
+        flow: {
           data: alteredFlow,
         },
       },
@@ -99,7 +110,7 @@ describe("publish", () => {
       name: "PublishFlow",
       matchOnVariables: false,
       data: {
-        insert_published_flows_one: {
+        publishedFlow: {
           data: alteredFlow,
         },
       },
@@ -147,7 +158,7 @@ describe("sections validation on diff", () => {
       name: "GetFlowData",
       matchOnVariables: false,
       data: {
-        flows_by_pk: {
+        flow: {
           data: alteredFlow,
         },
       },
@@ -182,7 +193,7 @@ describe("sections validation on diff", () => {
       name: "GetFlowData",
       matchOnVariables: false,
       data: {
-        flows_by_pk: {
+        flow: {
           data: flowWithSections,
         },
       },
@@ -214,7 +225,7 @@ describe("invite to pay validation on diff", () => {
       name: "GetFlowData",
       matchOnVariables: false,
       data: {
-        flows_by_pk: {
+        flow: {
           data: invalidatedFlow,
         },
       },
@@ -247,7 +258,7 @@ describe("invite to pay validation on diff", () => {
       name: "GetFlowData",
       matchOnVariables: false,
       data: {
-        flows_by_pk: {
+        flow: {
           data: alteredFlow,
         },
       },
@@ -276,7 +287,7 @@ describe("invite to pay validation on diff", () => {
       name: "GetFlowData",
       matchOnVariables: false,
       data: {
-        flows_by_pk: {
+        flow: {
           data: invalidatedFlow,
         },
       },
@@ -307,7 +318,7 @@ describe("invite to pay validation on diff", () => {
       name: "GetFlowData",
       matchOnVariables: false,
       data: {
-        flows_by_pk: {
+        flow: {
           data: invalidFlow,
         },
       },
@@ -340,7 +351,7 @@ describe("invite to pay validation on diff", () => {
       name: "GetFlowData",
       matchOnVariables: false,
       data: {
-        flows_by_pk: {
+        flow: {
           data: invalidatedFlow,
         },
       },
-Original file line number
+Diff line change
@@ Expand Up / @@ -14,7 +14,7 @@ describe("Session summary admin endpoint", () => { @@
             sessionId: "abc123",
           },
           data: {
-            lowcal_sessions_by_pk: {},
+            lowcalSession: {},
           },
         });
       });
@@ Expand Down @@