migrate to code-first graphql using type-graphql and typegraphql-prisma (#90)

* WIP

* WIP

* complete migration from SDL-first graphql to code-first graphql using type-graphql

* WIP

* fix booking update resolver, and validate booking function

* add typegraphql auth checker, and migrate shield rules to auth checker rules

* fix tests

* fix eslint

* optimise build steps to build dist/ while building the docker image

* downgrade typegraphql-prisma to 0.16.4 to resolve graphql-scalars build dependencies

* fix dockerfile

* remove push condition on dev github action

Author: 98sean98

.eslintignore

@@ -1,3 +1,5 @@
 node_modules
 dist
-/src/generated
+/src/generated
+.eslintrc.js
+jest.config.js

.github/workflows/prod.yml

@@ -26,12 +26,6 @@ jobs:
         with:
           node-version: 14
 
-      - name: Install
-        run: npm install
-
-      - name: Build
-        run: npm run build
-
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v1
 

.gitignore

@@ -18,4 +18,5 @@ dist/
 
 src/generated
 
+schema.gql
 *.sql

Dockerfile

@@ -2,15 +2,14 @@ FROM node:14-alpine
 WORKDIR usr/src/app
 
 COPY package.json .
-
 RUN npm install
 
-COPY dist dist
-
-RUN mkdir prisma
-COPY prisma/schema.prisma prisma/
-COPY prisma/migrations prisma/migrations/
+COPY src src
+COPY prisma prisma
+COPY tsconfig.json .
 RUN npx prisma generate
 
+RUN npm run build
+
 EXPOSE 4000
 CMD ["npm", "run", "start"]

__tests__/bookings.ts

@@ -1,6 +1,4 @@
-import * as env from "dotenv";
-env.config();
-
+import "reflect-metadata";
 import gql from "graphql-tag";
 import moment from "moment";
 import { createTestServerWithUserLoggedIn } from "./utils/server";
@@ -44,28 +42,16 @@ const testRoomInfo: TestRoomInfo = {
 
 const testBookingInfo: TestBookingInfo = {
   user: "test123",
-  room: "123",
-  start: moment()
-    .startOf("hour")
-    .add(1, "hour")
-    .toDate(),
-  end: moment()
-    .startOf("hour")
-    .add(3, "hour")
-    .toDate(),
+  room: testRoomInfo.number,
+  start: moment().startOf("hour").add(1, "hour").toDate(),
+  end: moment().startOf("hour").add(3, "hour").toDate(),
   remark: "Hello",
 };
 
 const testInvalidBookingVariables = {
-  room_number: "123",
-  start: moment()
-    .startOf("hour")
-    .add(2, "hour")
-    .toISOString(),
-  end: moment()
-    .startOf("hour")
-    .add(3, "hour")
-    .toISOString(),
+  room_number: testRoomInfo.number,
+  start: moment().startOf("hour").add(2, "hour").toISOString(),
+  end: moment().startOf("hour").add(3, "hour").toISOString(),
   remark: "Hi",
 };
 
@@ -109,7 +95,9 @@ describe("Booking queries", () => {
         }
       }
     `;
+
     const response: GraphQLResponse = await client.query({ query });
+
     expect(response.data).toEqual({
       bookings: [
         {
@@ -119,8 +107,8 @@ describe("Booking queries", () => {
           room: {
             number: testRoomInfo.number,
           },
-          start: testBookingInfo.start,
-          end: testBookingInfo.end,
+          start: testBookingInfo.start.toISOString(),
+          end: testBookingInfo.end.toISOString(),
           remark: testBookingInfo.remark,
         },
       ],
@@ -142,7 +130,7 @@ describe("Booking validation", () => {
 
     // Attempt to create an invalid booking
     const mutation = gql`
-      mutation(
+      mutation (
         $room_number: String!
         $start: String!
         $end: String!
@@ -163,7 +151,7 @@ describe("Booking validation", () => {
       variables: testInvalidBookingVariables,
     });
 
-    expect(response.data).toEqual({ createBooking: null });
+    expect(response.errors[0].message).toBeDefined();
   });
 });
 
@@ -176,11 +164,11 @@ describe("Booking mutations", () => {
     const room = await createRoom(testRoomInfo);
     const booking = await createBooking(testBookingInfo);
     const mutation = gql`
-      mutation(
+      mutation (
         $id: ID!
-        $room: String!
-        $start: String!
-        $end: String!
+        $room: String
+        $start: String
+        $end: String
         $remark: String
       ) {
         updateBooking(
@@ -197,9 +185,6 @@ describe("Booking mutations", () => {
     `;
     const testUpdatedBookingInfo = {
       id: booking.id,
-      room: testBookingInfo.room,
-      start: booking.start.toISOString(),
-      end: booking.end.toISOString(),
       remark: "HelloWorld",
     };
     const result: GraphQLResponse = await client.mutate({
@@ -224,7 +209,7 @@ describe("Booking mutations", () => {
     const client1 = createTestClient(testServer1);
 
     const mutation = gql`
-      mutation(
+      mutation (
         $id: ID!
         $room: String!
         $start: String!
@@ -254,7 +239,7 @@ describe("Booking mutations", () => {
       mutation,
       variables: testUpdatedBookingInfo,
     });
-    expect(result.errors[0].message).toEqual("Not Authorised!");
+    expect(result.errors[0].message).toBeDefined();
   });
 
   test("allow users to delete their own bookings", async () => {
@@ -265,7 +250,7 @@ describe("Booking mutations", () => {
     const room = await createRoom(testRoomInfo);
     const booking = await createBooking(testBookingInfo);
     const mutation = gql`
-      mutation($id: ID!) {
+      mutation ($id: ID!) {
         deleteBooking(id: $id) {
           id
         }
@@ -290,7 +275,7 @@ describe("Booking mutations", () => {
     const testServer1 = await createTestServerWithUserLoggedIn(user1);
     const client1 = createTestClient(testServer1);
     const mutation = gql`
-      mutation($id: ID!) {
+      mutation ($id: ID!) {
         deleteBooking(id: $id) {
           id
         }
@@ -301,6 +286,6 @@ describe("Booking mutations", () => {
       mutation,
       variables: { id: booking.id },
     });
-    expect(result.errors[0].message).toEqual("Not Authorised!");
+    expect(result.errors[0].message).toBeDefined();
   });
 });

__tests__/events/comments.ts

@@ -1,6 +1,4 @@
-import * as env from "dotenv";
-env.config();
-
+import "reflect-metadata";
 import gql from "graphql-tag";
 import { GraphQLResponse } from "apollo-server-types";
 import { createTestServerWithUserLoggedIn } from "../utils/server";
@@ -68,7 +66,7 @@ describe("event comment creation", () => {
     const testEvent: Event = await createEvent(testEventInfo);
 
     const mutation = gql`
-      mutation($eventId: ID!, $content: String!) {
+      mutation ($eventId: ID!, $content: String!) {
         createComment(eventId: $eventId, content: $content) {
           content
           user {
@@ -114,7 +112,7 @@ describe("event comment deletion", () => {
     const testComment: Comment = await createEventComment(eventCommentInfo);
 
     const mutation = gql`
-      mutation($id: ID!) {
+      mutation ($id: ID!) {
         deleteComment(id: $id) {
           id
         }
@@ -157,7 +155,7 @@ describe("invalid event comment deletion", () => {
     const testComment: Comment = await createEventComment(eventCommentInfo);
 
     const mutation = gql`
-      mutation($id: ID!) {
+      mutation ($id: ID!) {
         deleteComment(id: $id) {
           id
         }
@@ -169,6 +167,6 @@ describe("invalid event comment deletion", () => {
       variables: { id: testComment.id },
     });
 
-    expect(response.errors[0].message).toEqual("Not Authorised!");
+    expect(response.errors[0].message).toBeDefined();
   });
 });

__tests__/events/events.ts

@@ -1,5 +1,4 @@
-import * as env from "dotenv";
-env.config();
+import "reflect-metadata";
 import gql from "graphql-tag";
 import moment from "moment";
 import { GraphQLResponse } from "apollo-server-types";
@@ -34,14 +33,8 @@ const testUserInfo1: TestUserInfo = {
 const testEventInfo: TestEventInfo = {
   title: "test event",
   organiser: testUserInfo.username,
-  start: moment()
-    .startOf("hour")
-    .add(1, "hour")
-    .toDate(),
-  end: moment()
-    .startOf("hour")
-    .add(2, "hour")
-    .toDate(),
+  start: moment().startOf("hour").add(1, "hour").toDate(),
+  end: moment().startOf("hour").add(2, "hour").toDate(),
   venue: "test venue",
   image_url: "http://url",
   description: "test description",
@@ -88,8 +81,8 @@ describe("event queries", () => {
           organiser: {
             username: testUserInfo.username,
           },
-          start: testEventInfo.start,
-          end: testEventInfo.end,
+          start: testEventInfo.start.toISOString(),
+          end: testEventInfo.end.toISOString(),
           venue: testEventInfo.venue,
           image_url: testEventInfo.image_url,
           description: testEventInfo.description,
@@ -108,7 +101,7 @@ describe("event creation", () => {
     const client = createTestClient(testServer);
 
     const mutation = gql`
-      mutation(
+      mutation (
         $title: String!
         $start: String!
         $end: String!
@@ -155,8 +148,8 @@ describe("event creation", () => {
         organiser: {
           username: testUserInfo.username,
         },
-        start: testEventInfo.start,
-        end: testEventInfo.end,
+        start: testEventInfo.start.toISOString(),
+        end: testEventInfo.end.toISOString(),
         venue: testEventInfo.venue,
         image_url: "",
         description: testEventInfo.description,
@@ -176,7 +169,7 @@ describe("event deletion", () => {
     const event: Event = await createEvent(testEventInfo);
 
     const mutation = gql`
-      mutation($id: ID!) {
+      mutation ($id: ID!) {
         deleteEvent(id: $id) {
           id
         }
@@ -208,7 +201,7 @@ describe("invalid event deletion", () => {
     const event: Event = await createEvent(testEventInfo);
 
     const mutation = gql`
-      mutation($id: ID!) {
+      mutation ($id: ID!) {
         deleteEvent(id: $id) {
           id
         }
@@ -218,6 +211,6 @@ describe("invalid event deletion", () => {
       mutation,
       variables: { id: event.id },
     });
-    expect(response.errors[0].message).toEqual("Not Authorised!");
+    expect(response.errors[0].message).toBeDefined();
   });
 });

__tests__/events/subscribers.ts

@@ -1,6 +1,4 @@
-import * as env from "dotenv";
-env.config();
-
+import "reflect-metadata";
 import gql from "graphql-tag";
 import { GraphQLResponse } from "apollo-server-types";
 import { createTestServerWithUserLoggedIn } from "../utils/server";
@@ -54,7 +52,7 @@ describe("event subscriber addition", () => {
     const { id: event_id }: Event = await createEvent(testEventInfo);
 
     const mutation = gql`
-      mutation($id: ID!) {
+      mutation ($id: ID!) {
         addEventSubscriber(id: $id) {
           subscribers {
             id
@@ -91,7 +89,7 @@ describe("event subscriber removal for subscribed event", () => {
     await addEventSubscriber(addEventSubscriberInfo);
 
     const mutation = gql`
-      mutation($id: ID!) {
+      mutation ($id: ID!) {
         removeEventSubscriber(id: $id) {
           subscribers {
             id
@@ -122,7 +120,7 @@ describe("event subscriber removal for non-subscribed event", () => {
     const { id: event_id }: Event = await createEvent(testEventInfo);
 
     const mutation = gql`
-      mutation($id: ID!) {
+      mutation ($id: ID!) {
         removeEventSubscriber(id: $id) {
           id
         }