Merge pull request #628 from UTDNebula/develop

Sync with develop: validator merge

Author: akevinge

.env.example

@@ -1,6 +1,11 @@
 # Prisma
+# In production, DATABASE_URL uses a connection pooler, so we need to separately set DIRECT_DATABASE_URL because Prisma Migrate requires a direct connection to the database. 
+# DIRECT_DATABASE_URL does not need to be set locally if you are not running database migrations.
+# See https://www.prisma.io/docs/guides/performance-and-optimization/connection-management/configure-pg-bouncer#prisma-migrate-and-pgbouncer-workaround for more details
 DATABASE_URL=
+DIRECT_DATABASE_URL=
 PLATFORM_DATABASE_URL=
+
 # Next Auth
 NEXTAUTH_URL=
 NEXTAUTH_SECRET=

.eslintrc.js

@@ -18,6 +18,7 @@ module.exports = {
     'plugin:import/recommended',
     'plugin:import/typescript',
     'prettier',
+    'next/core-web-vitals',
   ],
   rules: {
     // Place to specify ESLint rules. Can be used to overwrite rules specified from the extended configs

.github/workflows/build.yml

@@ -6,9 +6,11 @@ on:
     branches:
       - 'develop'
       - 'main'
+    paths-ignore:
+      - 'validator/**'
 
 jobs:
-  release:
+  build:
     name: Test build app
     runs-on: ubuntu-latest
 
@@ -33,7 +35,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Setup Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: 18
 

.github/workflows/delete-neon-branch.yml

@@ -8,16 +8,15 @@ on:
   pull_request:
     types:
       - closed
+    paths-ignore:
+      - 'validator/**'
   workflow_dispatch:
 
 jobs:
   delete-neon-branch:
     permissions: write-all
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      
       - name: Search branch by name
         id: get_branch_id
         # list all branches and filter by name
@@ -29,9 +28,7 @@ jobs:
             --header "Authorization: Bearer ${{ secrets.NEON_API_KEY }}" \
             | jq -r .branches \
             | jq -c '.[] | select(.name | contains("'${{ github.event.pull_request.head.ref || github.head_ref }}'")) .id' \
-            | jq -r \
-            ) \
-            
+            | jq -r)
           echo "branch_id=${branch_id}" >> $GITHUB_OUTPUT
 
       - name: Delete Neon Branch

.github/workflows/deploy-preview.yml

@@ -1,11 +1,13 @@
 name: Deploy Preview
 
-on: 
+on:
   pull_request:
     branches:
-      - "develop"
+      - 'develop'
+    paths-ignore:
+      - 'validator/**'
   workflow_dispatch:
-    
+
 env:
   VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
   VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
@@ -34,11 +36,11 @@ jobs:
       - name: Deploy Preview to Vercel
         id: deploy
         run: |
-          echo preview_url=$(vercel deploy \
-          --env DATABASE_URL=${{ steps.create_branch.outputs.db_url_with_pooler}}/neondb \
-          --build-env DIRECT_DATABASE_URL=${{ steps.create_branch.outputs.db_url}}/neondb \
-          --public --yes --token=${{ secrets.VERCEL_TOKEN }}) \
-          >> $GITHUB_OUTPUT
+          preview_url=$(vercel deploy \
+            --env DATABASE_URL="${{ steps.create_branch.outputs.db_url_with_pooler}}/neondb?pgbouncer=true&connect_timeout=15&pool_timeout=15" \
+            --build-env DIRECT_DATABASE_URL="${{ steps.create_branch.outputs.db_url}}/neondb?connect_timeout=10" \
+            --public --yes --token=${{ secrets.VERCEL_TOKEN }})
+          echo preview_url=$preview_url >> $GITHUB_OUTPUT
 
       - name: Comment on Pull Request
         uses: thollander/actions-comment-pull-request@v2

.github/workflows/format.yml

@@ -1,13 +1,14 @@
-name: Lint
+name: Check Formatting
 
 on:
   workflow_dispatch:
   pull_request:
-    types: [ready_for_review]
+    paths-ignore:
+      - 'validator/**'
 
 jobs:
-  run-linters:
-    name: Run linters
+  eslint:
+    name: Run ESLint + Prettier
     runs-on: ubuntu-latest
 
     steps:
@@ -22,5 +23,11 @@ jobs:
       - name: Install Node.js Dependencies
         run: npm ci
 
+      - name: Generate Prisma Client
+        run: npm run prisma:generate
+
+      - name: Run ESLint
+        run: npm run lint:check
+
       - name: Run Prettier
         run: npm run format:check

.github/workflows/tests.yml

@@ -6,6 +6,8 @@ on:
     branches:
       - 'develop'
       - 'main'
+    paths-ignore:
+      - 'validator/**'
 
 jobs:
   integration-tests:
@@ -30,10 +32,42 @@ jobs:
 
     env:
       # Prisma
-      DATABASE_URL: postgresql://postgres:postgres@localhost:5432/postgres?schema=public
       DIRECT_DATABASE_URL: postgresql://postgres:postgres@localhost:5432/postgres?schema=public
+      DATABASE_URL: postgresql://postgres:postgres@localhost:5432/postgres?schema=public
       PLATFORM_DATABASE_URL: ${{ secrets.PLATFORM_DATABASE_URL }}
 
+      # Next Auth
+      NEXTAUTH_URL: http://localhost:3000
+      NEXTAUTH_SECRET: abc
+
+      # Next Auth Discord Provider
+      DISCORD_CLIENT_ID: 123
+      DISCORD_CLIENT_SECRET: abc
+
+      # Next Auth Google Provider
+      GOOGLE_CLIENT_ID: 123
+      GOOGLE_CLIENT_SECRET: abc
+
+      # Next Auth Facebook provider
+      FACEBOOK_CLIENT_ID: 123
+      FACEBOOK_CLIENT_SECRET: abc
+
+      # Email Server
+      EMAIL_SERVER_HOST: host
+      EMAIL_SERVER_PORT: 1234
+      EMAIL_SERVER_USER: user
+      EMAIL_SERVER_PASSWORD: pass
+      EMAIL_FROM: noreply@example.com
+
+      # DEGREE VALIDATOR
+      VALIDATOR: ${{ secrets.VALIDATOR }}
+
+      NODE_ENV: test
+
+      # UMAMI
+      NEXT_PUBLIC_UMAMI_URL: hi
+      NEXT_PUBLIC_UMAMI_WEBSITE_ID: bye
+
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -46,57 +80,21 @@ jobs:
           mongodb-port: 27017
 
       - name: Setup Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: 18
 
       - name: Install dependencies
         run: |
           npm ci
 
-      - name: Prisma generate and push
-        run: |
-          npm run prisma:generate &&
-          npm run prisma:migrate:deploy
+      - name: Run build pipeline
+        run: npm run build
 
-      - name: Run Cypress e2e tests
+      - name: Start server and run e2e tests
         run: |
           npm run cypress:run
 
-        env:
-          # Next Auth
-          NEXTAUTH_URL: http://localhost:3000
-          NEXTAUTH_SECRET: abc
-
-          # Next Auth Discord Provider
-          DISCORD_CLIENT_ID: 123
-          DISCORD_CLIENT_SECRET: abc
-
-          # Next Auth Google Provider
-          GOOGLE_CLIENT_ID: 123
-          GOOGLE_CLIENT_SECRET: abc
-
-          # Next Auth Facebook provider
-          FACEBOOK_CLIENT_ID: 123
-          FACEBOOK_CLIENT_SECRET: abc
-
-          # Email Server
-          EMAIL_SERVER_HOST: host
-          EMAIL_SERVER_PORT: 1234
-          EMAIL_SERVER_USER: user
-          EMAIL_SERVER_PASSWORD: pass
-          EMAIL_FROM: noreply@example.com
-
-          # DEGREE VALIDATOR
-          VALIDATOR: ${{ secrets.VALIDATOR }}
-
-          NODE_ENV: test
-          VERCEL_ENV: preview
-
-          # UMAMI
-          NEXT_PUBLIC_UMAMI_URL: hi
-          NEXT_PUBLIC_UMAMI_WEBSITE_ID: bye
-
   unit-tests:
     name: Unit tests
     runs-on: ubuntu-latest
@@ -105,7 +103,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Setup Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: 18
 

.github/workflows/validator_test.yml

@@ -0,0 +1,34 @@
+name: Build Validator
+
+on:
+  workflow_dispatch:
+  pull_request:
+    paths:
+      - 'validator/**'
+
+jobs:
+  release:
+    name: Test validator
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: validator
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies
+        run: |
+          pip3 install -r requirements.txt
+
+      - name: Run tests
+        run: |
+          pytest --verbose
+
+      - name: Run type checker
+        run: |
+          mypy .

.gitignore

@@ -45,7 +45,6 @@ yarn-error.log*
 # Don't want IDE/code editor files in this repository
 # See docs/ide-config.md for more information.
 .idea
-.vscode
 .vs/
 
 prisma/generated

.vercelignore

@@ -0,0 +1,6 @@
+validator/
+tests/
+cypress/
+cypress.config.ts
+.github/
+.vscode/