chore: Package Prisma into own NPM package

.github/labeler.yml

@@ -8,6 +8,5 @@
 "!! Database Migration !!":
   - changed-files:
       - any-glob-to-any-file:
-          - prisma/migrations/**
-          - prisma/schema.prisma
-          - prisma/seeds/**
+          - packages/database/prisma/**
+          - packages/database/src/fixtures/**

.github/workflows/cypress.yml

@@ -66,7 +66,7 @@ jobs:
             linux-yarn-
 
       - name: "Install dependencies"
-        run: yarn workspaces focus gcforms
+        run: yarn workspaces focus gcforms @gcforms/database
 
       - name: Cypress Tests
         uses: cypress-io/github-action@b8ba51a856ba5f4c15cf39007636d4ab04f23e3c # v6.10.2
@@ -76,7 +76,7 @@ jobs:
           browser: chrome
           headed: false
           build: yarn build:test
-          start: yarn start:test
+          start: yarn cypress:run
           wait-on: "http://localhost:3000"
           config: baseUrl=http://localhost:3000
       - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2

.github/workflows/playwright.yml

@@ -69,7 +69,7 @@ jobs:
             linux-yarn-
 
       - name: "Install dependencies"
-        run: yarn workspaces focus gcforms
+        run: yarn workspaces focus gcforms @gcforms/database
 
       - name: Install Playwright Browsers
         run: npx playwright install msedge --with-deps

.github/workflows/prod-deploy.yml

@@ -83,14 +83,6 @@ jobs:
           TASKDEF_ARN=`jq -r '.taskDefinitionArn' form_viewer.json | cut -f 1-6 -d "/"`
           jq --argjson port "$CONTAINER_PORT" --arg cname "$CONTAINER_NAME" --arg taskdefarn "$TASKDEF_ARN" '.Resources[0].TargetService.Properties.TaskDefinition = $taskdefarn | .Resources[0].TargetService.Properties.LoadBalancerInfo.ContainerName = $cname | .Resources[0].TargetService.Properties.LoadBalancerInfo.ContainerPort = $port' config/infrastructure/aws/appspec-template.json > form-viewer-appspec.json
 
-      - name: Run Prisma Migrations
-        id: prisma-migration
-        uses: ./.github/workflows/prisma-migration
-        with:
-          aws-account-id: ${{ env.AWS_ACCOUNT_ID }}
-          aws-region: ${{ env.AWS_REGION }}
-          app-env: production
-
       - name: Deploy image for Form Viewer
         timeout-minutes: 10
         # v1.4.11

.github/workflows/staging-db-migrate.yml

@@ -0,0 +1,30 @@
+name: Staging DB Migration
+on:
+  workflow_dispatch:
+  workflow_run:
+    workflows: ["Deploy to Staging"]
+    types:
+      - in_progress
+jobs:
+  run-check:
+    runs-on: ubuntu-latest
+    outputs:
+      has-migrations: ${{ steps.filter.outputs.migrations }}
+    steps:
+      - name: path-filter
+        uses: cds-snc/paths-filter@b316143212d841aed668b7b29240c719d603a9b9 # tag=v2.10.4
+        id: filter
+        with:
+          filters: |
+            migrations:
+              - 'packages/database/prisma/migrations/**'
+              - 'packages/database/src/fixtures/**'
+  migrate-db:
+    needs: [run-check]
+    if: ${{ needs.run-check.outputs.has-migrations == 'true' }}
+    runs-on:
+      - codebuild-Staging-Github-Runner-${{ github.run_id }}-${{ github.run_attempt }}
+    steps:
+      - run: yarn workspaces focus @gcforms/database
+      - run: yarn db:generate
+      - run: yarn db:prod

.github/workflows/staging-deploy.yml

@@ -84,26 +84,6 @@ jobs:
           TASKDEF_ARN=`jq -r '.taskDefinitionArn' form_viewer.json | cut -f 1-6 -d "/"`
           jq  --argjson port "$CONTAINER_PORT" --arg cname "$CONTAINER_NAME" --arg taskdefarn "$TASKDEF_ARN" '.Resources[0].TargetService.Properties.TaskDefinition = $taskdefarn | .Resources[0].TargetService.Properties.LoadBalancerInfo.ContainerName = $cname | .Resources[0].TargetService.Properties.LoadBalancerInfo.ContainerPort = $port' config/infrastructure/aws/appspec-template.json > form-viewer-appspec.json
 
-      - name: Prisma Filter
-        id: prisma-filter
-        uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
-        with:
-          # We include the ./seeds/** directory to trigger the workflow when a seed file is added or modified
-          filters: |
-            prisma:
-              - 'prisma/migrations/**'
-              - 'prisma/schema.prisma'
-              - 'prisma/seeds/**'
-
-      - name: Run Prisma Migrations
-        if: steps.prisma-filter.outputs.prisma == 'true'
-        id: prisma-migration
-        uses: ./.github/workflows/prisma-migration
-        with:
-          aws-account-id: ${{ env.AWS_ACCOUNT_ID }}
-          aws-region: ${{ env.AWS_REGION }}
-          app-env: staging
-
       - name: Deploy image for Form Viewer
         timeout-minutes: 10
         # v1.4.11

.gitignore

@@ -66,7 +66,7 @@ typings/
 # dotenv environment variables file
 .env*.local
 .env
-
+.env.yarn
 # Ignore cypress screenshots and videos
 cypress/screenshots
 cypress/videos
@@ -113,4 +113,7 @@ certificates
 dist
 
 test-results/
-playwright-report/
+playwright-report/
+
+# Ignore generated Prisma Code
+packages/database/src/generated

Dockerfile

@@ -22,12 +22,11 @@ ENV NEXT_PUBLIC_HCAPTCHA_SITE_KEY=$HCAPTCHA_SITE_KEY
 RUN corepack enable && yarn set version stable
 RUN yarn workspaces focus gcforms
 RUN yarn build
-RUN yarn workspaces focus gcforms --production
 
 FROM node:22-alpine AS final
 LABEL maintainer="-"
 
-ENV PORT 3000
+ENV PORT=3000
 ENV NODE_ENV=production
 
 ARG COGNITO_APP_CLIENT_ID

README.md

@@ -43,7 +43,7 @@ yarn install
 
 ### Set your environment variables
 
-Create an `.env` file at the root of the project and use the `.env.example` as a template. If you want you can find a ready to use version of the `.env` file in 1Password > Local Development .ENV secure note
+Create an `.env.yarn` file at the root of the project and use the `.env.example` as a template. If you want you can find a ready to use version of the `.env` file in 1Password > Local Development .ENV secure note
 
 ### Run the web application in development mode
 

__utils__/dbTearDown.ts

@@ -1,8 +1,7 @@
-import { PrismaClient } from "@prisma/client";
+import { prisma } from "@gcforms/database";
 import { logMessage } from "@lib/logger";
 
 export default async function teardown() {
-  const prisma = new PrismaClient();
   try {
     const tablenames = await prisma.$queryRaw<
       Array<{ tablename: string }>

__utils__/index.ts

@@ -1,7 +1 @@
-export {
-  prismaMock,
-  PrismaClientInitializationError,
-  PrismaClientKnownRequestError,
-  PrismaClientUnknownRequestError,
-  PrismaClientValidationError,
-} from "./prismaConnector";
+export { prismaMock } from "./prismaConnector";

__utils__/prismaConnector.ts

@@ -1,22 +1,15 @@
-import { PrismaClient, Prisma } from "@prisma/client";
-import { mockDeep, mockReset, DeepMockProxy } from "jest-mock-extended";
-import { prisma } from "@lib/integration/prismaConnector";
+import { mockReset, DeepMockProxy } from "jest-mock-extended";
+import { prisma, PrismaClient } from "@gcforms/database";
 
-export const {
-  PrismaClientInitializationError,
-  PrismaClientKnownRequestError,
-  PrismaClientUnknownRequestError,
-  PrismaClientValidationError,
-} = Prisma;
-
-jest.mock("@lib/integration/prismaConnector", () => {
+jest.mock("@gcforms/database", () => {
   // Only mock prisma when were running in the Node jest environment
   if (typeof window === "undefined") {
-    const originalModule = jest.requireActual("@lib/integration/prismaConnector");
+    const originalModule = jest.requireActual("@gcforms/database");
+    const { mockDeep } = jest.requireActual("jest-mock-extended");
     return {
       __esModule: true,
       ...originalModule,
-      prisma: mockDeep<PrismaClient>(),
+      prisma: mockDeep() as DeepMockProxy<PrismaClient>,
     };
   } else {
     return {};

app/(gcforms)/[locale]/(app administration)/admin/(with nav)/accounts/[id]/manage-permissions/components/server/PrivilegeList.tsx

@@ -1,6 +1,6 @@
 import { serverTranslation } from "@i18n";
 import { AppUser } from "@lib/types/user-types";
-import type { Privilege as PType } from "@prisma/client";
+import type { Privilege as PType } from "@gcforms/database";
 import { Privilege } from "../client/Privilege";
 
 type PrivilegeList = Omit<PType, "permissions" | "priority">[];

app/(gcforms)/[locale]/(app administration)/admin/(with nav)/events/actions.ts

@@ -8,7 +8,7 @@ import {
   BatchGetCommandOutput,
 } from "@aws-sdk/lib-dynamodb";
 import { logEvent } from "@lib/auditLogs";
-import { prisma } from "@lib/integration/prismaConnector";
+import { prisma } from "@gcforms/database";
 import { authorization } from "@lib/privileges";
 import { AccessControlError } from "@lib/auth/errors";
 import {

app/(gcforms)/[locale]/(form administration)/form-builder/[id]/responses/[[...statusFilter]]/components/ManageFormAccessDialog/actions.ts

@@ -1,7 +1,7 @@
 "use server";
 
 import { AuthenticatedAction } from "@lib/actions";
-import { prisma } from "@lib/integration/prismaConnector";
+import { prisma } from "@gcforms/database";
 import { TemplateUser } from "./types";
 import { AccessControlError } from "@lib/auth/errors";
 import {

app/(gcforms)/[locale]/(form administration)/form-builder/[id]/settings/manage/notifications/actions.ts

@@ -3,7 +3,7 @@
 import { AuthenticatedAction } from "@lib/actions";
 import { ServerActionError } from "@lib/types/form-builder-types";
 import { logMessage } from "@root/lib/logger";
-import { prisma, prismaErrors } from "@lib/integration/prismaConnector";
+import { prisma, prismaErrors } from "@gcforms/database";
 import { logEvent } from "@root/lib/auditLogs";
 import { getNotificationsUsers } from "@root/lib/notifications";
 

app/(gcforms)/[locale]/(form administration)/forms/components/Invitations/Invitations.tsx

@@ -1,7 +1,7 @@
 "use client";
 import { StarIcon } from "@serverComponents/icons/StarIcon";
 import { accept, decline } from "./actions";
-import { Invitation } from "@prisma/client";
+import { Invitation } from "@gcforms/database";
 import { useRouter } from "next/navigation";
 import { useTranslation } from "@i18n/client";
 import { Trans } from "react-i18next";

app/(gcforms)/[locale]/(form administration)/forms/page.tsx

@@ -11,7 +11,7 @@ import { getAllTemplatesForUser, TemplateOptions } from "@lib/templates";
 import { DeliveryOption } from "@lib/types";
 import { getOverdueTemplateIds } from "@lib/overdue";
 import { Invitations } from "./components/Invitations/Invitations";
-import { prisma } from "@lib/integration/prismaConnector";
+import { prisma } from "@gcforms/database";
 
 export type FormsTemplate = {
   id: string;

app/(gcforms)/[locale]/(user authentication)/auth/mfa/actions.ts

@@ -7,7 +7,7 @@ import { requestNew2FAVerificationCode } from "@lib/auth";
 import { signIn } from "@lib/auth";
 import { handleErrorById, Missing2FASession } from "@lib/auth/cognito";
 import { cookies } from "next/headers";
-import { prisma } from "@lib/integration/prismaConnector";
+import { prisma } from "@gcforms/database";
 import { CredentialsSignin } from "next-auth";
 import { getUnprocessedSubmissionsForUser } from "@lib/users";
 import { logMessage } from "@lib/logger";

app/(gcforms)/[locale]/(user authentication)/auth/reset-password/[[...token]]/action.ts

@@ -3,7 +3,7 @@
 import * as v from "valibot";
 import { serverTranslation } from "@i18n";
 import { sendPasswordResetLink, validateSecurityAnswers } from "@lib/auth";
-import { prisma, prismaErrors } from "@lib/integration/prismaConnector";
+import { prisma, prismaErrors } from "@gcforms/database";
 import { logEvent } from "@lib/auditLogs";
 import { hasError } from "@lib/hasError";
 import { logMessage } from "@lib/logger";

cypress.config.ts

@@ -1,26 +1,10 @@
 import { defineConfig } from "cypress";
-import { logMessage } from "@lib/logger";
-import terminalReport from "cypress-terminal-report/src/installLogsPrinter";
-import dbTearDown from "./__utils__/dbTearDown";
-import dbSeed from "./prisma/seeds/seed";
 
 export default defineConfig({
   video: false,
   defaultCommandTimeout: 10000,
   e2e: {
     baseUrl: "http://localhost:3000",
-    setupNodeEvents(on) {
-      on("before:run", async () => {
-        logMessage.info("Tearing down database");
-        await dbTearDown();
-        logMessage.info("Seeding database");
-        await dbSeed("test");
-      });
-      if (process.env.CYPRESS_DEBUG) {
-        logMessage.info("Enabling terminal report for Debugging");
-        terminalReport(on);
-      }
-    },
   },
   component: {
     devServer: {

cypress/plugins/index.ts

@@ -15,7 +15,7 @@
 /**
  * @type {Cypress.PluginConfig}
  */
-module.exports = () => {
-  // `on` is used to hook into various events Cypress emits
-  // `config` is the resolved Cypress config
+
+module.exports = (on: Cypress.PluginEvents) => {
+  if (Cypress.env("DEBUG")) require("cypress-terminal-report/src/installLogsPrinter")(on);
 };

cypress/support/e2e.ts

@@ -21,8 +21,7 @@ import "./commands";
 
 // Import Axe-Core library
 import "cypress-axe";
-import terminalReport from "cypress-terminal-report/src/installLogsCollector";
 
 // import flagsDefault from "../../flag_initialization/default_flag_settings.json";
 
-if (Cypress.env("DEBUG")) terminalReport();
+if (Cypress.env("DEBUG")) require("cypress-terminal-report/src/installLogsCollector")();

lib/appSettings.ts

@@ -1,4 +1,4 @@
-import { prisma, prismaErrors } from "@lib/integration/prismaConnector";
+import { prisma, prismaErrors } from "@gcforms/database";
 import { authorization } from "./privileges";
 import { AccessControlError } from "@lib/auth/errors";
 import { logEvent } from "./auditLogs";

lib/auth/cognito.ts

@@ -4,7 +4,7 @@ import {
   CognitoIdentityProviderServiceException,
 } from "@aws-sdk/client-cognito-identity-provider";
 import { logEvent } from "@lib/auditLogs";
-import { prisma, prismaErrors } from "@lib/integration/prismaConnector";
+import { prisma, prismaErrors } from "@gcforms/database";
 import { generateVerificationCode, sendVerificationCode } from "./2fa";
 import { registerFailed2FAAttempt, clear2FALockout } from "./2faLockout";
 import { logMessage } from "@lib/logger";

lib/auth/nextAuth.ts

@@ -4,7 +4,7 @@ import { validate2FAVerificationCode, userHasSecurityQuestions } from "@lib/auth
 import { PrismaAdapter } from "@auth/prisma-adapter";
 import { logMessage } from "@lib/logger";
 import { getOrCreateUser } from "@lib/users";
-import { prisma } from "@lib/integration/prismaConnector";
+import { prisma } from "@gcforms/database";
 import { getPrivilegeRulesForUser } from "@lib/privileges";
 import { getUserFeatureFlags } from "@lib/userFeatureFlags";
 import { logEvent } from "@lib/auditLogs";

lib/auth/passwordReset.ts

@@ -1,4 +1,4 @@
-import { prisma } from "@lib/integration/prismaConnector";
+import { prisma } from "@gcforms/database";
 import { generateVerificationCode } from "./2fa";
 import { logMessage } from "@lib/logger";
 import { sendEmail } from "@lib/integration/notifyConnector";

lib/auth/securityQuestions.ts

@@ -1,4 +1,4 @@
-import { prisma, prismaErrors } from "@lib/integration/prismaConnector";
+import { prisma, prismaErrors } from "@gcforms/database";
 import { scrypt, randomBytes } from "crypto";
 import { authorization } from "@lib/privileges";
 import { AccessControlError } from "@lib/auth/errors";