Merge pull request #621 from UTDNebula/develop

Sync with develop (Migrating from Railway => Neon)

Author: akevinge

.eslintrc.js

@@ -1,32 +1,53 @@
 module.exports = {
   parser: '@typescript-eslint/parser',
-  // Specifies the ESLint parser
   parserOptions: {
     ecmaVersion: 2020,
-    // Allows for the parsing of modern ECMAScript features
+    // Allows for the parsing of modern ECMAScript features.
     sourceType: 'module',
-    // Allows for the use of imports
+    // Allows for the use of imports.
     ecmaFeatures: {
-      jsx: true, // Allows for the parsing of JSX
+      jsx: true, // Allows for the parsing of JSX.
     },
-    // project: ['./tsconfig.json'],
   },
 
-  plugins: ['simple-import-sort', 'unused-imports'],
+  plugins: ['unused-imports'],
   extends: [
     'plugin:react-hooks/recommended',
     'plugin:react/recommended',
     'plugin:@typescript-eslint/recommended',
+    'plugin:import/recommended',
+    'plugin:import/typescript',
     'prettier',
   ],
   rules: {
     // Place to specify ESLint rules. Can be used to overwrite rules specified from the extended configs
     // e.g. '@typescript-eslint/explicit-function-return-type': 'off',
     'react/prop-types': 'warn',
     'react/jsx-key': 'warn',
-    'simple-import-sort/imports': process.env.NODE_ENV === 'test' ? 'error' : 'off',
-    'simple-import-sort/exports': process.env.NODE_ENV === 'test' ? 'error' : 'off',
     'react/react-in-jsx-scope': 'off',
+    // Configuration for import. See: https://github.com/import-js/eslint-plugin-import/tree/main.
+    'import/order': [
+      'warn',
+      {
+        groups: [
+          'builtin',
+          'external',
+          'internal',
+          ['parent', 'sibling'],
+          'index',
+          'object',
+          'type',
+        ],
+        alphabetize: {
+          order: 'asc',
+          caseInsensitive: true,
+        },
+        'newlines-between': 'always',
+      },
+    ],
+    'import/no-named-as-default': 'off',
+    // Configuration for unused-imports. See: https://github.com/sweepline/eslint-plugin-unused-imports#usage.
+    '@typescript-eslint/no-unused-vars': 'off',
     'unused-imports/no-unused-imports': process.env.NODE_ENV === 'test' ? 'error' : 'warn',
     'unused-imports/no-unused-vars': [
       'warn',
@@ -40,7 +61,11 @@ module.exports = {
   },
   settings: {
     react: {
-      version: 'detect', // Tells eslint-plugin-react to automatically detect the version of React to use
+      version: 'detect', // Tells eslint-plugin-react to automatically detect the version of React to use.
+    },
+    'import/resolver': {
+      typescript: true,
+      node: true,
     },
   },
 };

.github/workflows/build.yml

@@ -47,6 +47,7 @@ jobs:
         env:
           # Prisma
           DATABASE_URL: postgresql://postgres:postgres@localhost:5432/postgres?schema=public
+          DIRECT_DATABASE_URL: postgresql://postgres:postgres@localhost:5432/postgres?schema=public
           PLATFORM_DATABASE_URL: mongodb://localhost:27017/platformDB # This is a dead connection URL - build does not need live DB.
 
           # Next Auth

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

@@ -0,0 +1,42 @@
+name: Delete Neon Branch
+
+env:
+  VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
+  VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
+
+on:
+  pull_request:
+    types:
+      - closed
+  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
+        run: |
+          branch_id=$(curl --silent \
+            "https://console.neon.tech/api/v2/projects/${{ secrets.NEON_PROJECT_ID }}/branches" \
+            --header "Accept: application/json" \
+            --header "Content-Type: application/json" \
+            --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 \
+            ) \
+            
+          echo "branch_id=${branch_id}" >> $GITHUB_OUTPUT
+
+      - name: Delete Neon Branch
+        uses: neondatabase/delete-branch-action@v2
+        with:
+          project_id: ${{ secrets.NEON_PROJECT_ID }}
+          branch_id: ${{ steps.get_branch_id.outputs.branch_id }}
+          api_key: ${{ secrets.NEON_API_KEY }}

.github/workflows/deploy-preview.yml

@@ -0,0 +1,48 @@
+name: Deploy Preview
+
+on: 
+  pull_request:
+    branches:
+      - "develop"
+  workflow_dispatch:
+    
+env:
+  VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
+  VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
+
+jobs:
+  deploy-preview:
+    permissions: write-all
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Neon Database Create Branch Action
+        uses: neondatabase/create-branch-action@v3
+        id: create_branch
+        with:
+          project_id: ${{ secrets.NEON_PROJECT_ID }}
+          branch_name: ${{ github.event.pull_request.head.ref || github.head_ref }}
+          api_key: ${{ secrets.NEON_API_KEY }}
+          username: ${{ secrets.PG_USERNAME }}
+          password: ${{ secrets.PG_PASSWORD }}
+
+      - name: Install Vercel CLI
+        run: npm install --global vercel@latest
+
+      - 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
+
+      - name: Comment on Pull Request
+        uses: thollander/actions-comment-pull-request@v2
+        with:
+          message: |
+            Vercel Preview URL :rocket: : ${{ steps.deploy.outputs.preview_url }}
+            Neon branch :elephant: : https://console.neon.tech/app/projects/${{ secrets.NEON_PROJECT_ID }}/branches/${{ steps.create_branch.outputs.branch_id }}

.github/workflows/tests.yml

@@ -31,6 +31,7 @@ jobs:
     env:
       # Prisma
       DATABASE_URL: postgresql://postgres:postgres@localhost:5432/postgres?schema=public
+      DIRECT_DATABASE_URL: postgresql://postgres:postgres@localhost:5432/postgres?schema=public
       PLATFORM_DATABASE_URL: ${{ secrets.PLATFORM_DATABASE_URL }}
 
     steps:

CODEOWNERS

@@ -1,5 +1,5 @@
 # Request project lead by default
-* @syl15
+* @akevinge
 
 # Request all Project Nebula Maintainers to review other pull requests
 src/**/* @UTDNebula/Planner-Maintainers

SECURITY.md

@@ -1,6 +1,7 @@
 import { defineConfig } from 'cypress';
-import { prisma } from 'cypress/support/constants';
 import dotenv from 'dotenv';
+
+import { prisma } from 'cypress/support/constants';
 import { seedTemplates } from 'prisma/seedTemplates';
 import { seedTestUser } from 'prisma/seedTestUser';