New authentication provider with tests #112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

jakebromberg wants to merge 52 commits into main from new-authentication-provider-with-tests

+22,767 −26,861

.github/workflows/ci.yml

-Original file line number
+Diff line change
@@ -0,0 +1,81 @@
+    name: CI
+    on:
+      push:
+        branches: [main]
+      pull_request:
+        branches: [main]
+    jobs:
+      lint-and-typecheck:
+        name: Lint & Type Check
+        runs-on: ubuntu-latest
+        steps:
+          - name: Checkout
+            uses: actions/checkout@v4
+          - name: Set up Node.js
+            uses: actions/setup-node@v4
+            with:
+              node-version: "20"
+              cache: "npm"
+          - name: Install dependencies
+            run: npm ci
+          - name: Type check
+            run: npx tsc --noEmit
+      unit-tests:
+        name: Unit Tests
+        runs-on: ubuntu-latest
+        steps:
+          - name: Checkout
+            uses: actions/checkout@v4
+          - name: Set up Node.js
+            uses: actions/setup-node@v4
+            with:
+              node-version: "20"
+              cache: "npm"
+          - name: Install dependencies
+            run: npm ci
+          - name: Run unit tests
+            run: npm run test:run
+          - name: Upload coverage
+            uses: actions/upload-artifact@v4
+            if: always()
+            with:
+              name: coverage-report
+              path: coverage/
+              retention-days: 7
+      build:
+        name: Build
+        runs-on: ubuntu-latest
+        env:
+          NEXT_PUBLIC_BACKEND_URL: http://localhost:8080
+          NEXT_PUBLIC_BETTER_AUTH_URL: http://localhost:8082/auth
+          NEXT_PUBLIC_DASHBOARD_HOME_PAGE: /dashboard/flowsheet
+          NEXT_PUBLIC_VERSION: ci
+          NEXT_PUBLIC_DEFAULT_EXPERIENCE: modern
+          NEXT_PUBLIC_ENABLED_EXPERIENCES: modern,classic
+          NEXT_PUBLIC_ALLOW_EXPERIENCE_SWITCHING: "true"
+        steps:
+          - name: Checkout
+            uses: actions/checkout@v4
+          - name: Set up Node.js
+            uses: actions/setup-node@v4
+            with:
+              node-version: "20"
+              cache: "npm"
+          - name: Install dependencies
+            run: npm ci
+          - name: Build
+            run: npm run build

.github/workflows/e2e-tests.yml

-Original file line number
+Diff line change
@@ -0,0 +1,187 @@
+    name: E2E Tests
+    on:
+      push:
+        branches: [main, new-authentication-provider]
+      pull_request:
+        branches: [main]
+      workflow_dispatch:
+        inputs:
+          backend_ref:
+            description: 'Backend-Service branch/tag to use'
+            required: false
+            default: 'main'
+    env:
+      # Frontend configuration
+      NEXT_PUBLIC_BACKEND_URL: http://localhost:8085
+      NEXT_PUBLIC_BETTER_AUTH_URL: http://localhost:8084/auth
+      NEXT_PUBLIC_DASHBOARD_HOME_PAGE: /dashboard/flowsheet
+      NEXT_PUBLIC_VERSION: e2e
+      NEXT_PUBLIC_DEFAULT_EXPERIENCE: modern
+      NEXT_PUBLIC_ENABLED_EXPERIENCES: modern,classic
+      NEXT_PUBLIC_ALLOW_EXPERIENCE_SWITCHING: "true"
+      NEXT_PUBLIC_ONBOARDING_TEMP_PASSWORD: temppass123
+      SESSION_SECRET: e2e-secret-for-testing
+      APP_ORGANIZATION_ID: test-org-id-0000000000000000001
+      # E2E test config
+      E2E_BASE_URL: http://localhost:3000
+      # Backend service ports (E2E profile)
+      E2E_DB_PORT: 5434
+      E2E_AUTH_PORT: 8084
+      E2E_BACKEND_PORT: 8085
+    jobs:
+      e2e:
+        name: E2E Tests
+        runs-on: ubuntu-latest
+        timeout-minutes: 45
+        steps:
+          - name: Checkout dj-site
+            uses: actions/checkout@v4
+            with:
+              path: dj-site
+          - name: Checkout Backend-Service
+            uses: actions/checkout@v4
+            with:
+              repository: ${{ github.repository_owner }}/Backend-Service
+              ref: ${{ github.event.inputs.backend_ref || 'main' }}
+              path: Backend-Service
+              token: ${{ secrets.GITHUB_TOKEN }}
+          - name: Set up Node.js
+            uses: actions/setup-node@v4
+            with:
+              node-version: "20"
+              cache: "npm"
+              cache-dependency-path: |
+                dj-site/package-lock.json
+                Backend-Service/package-lock.json
+          - name: Create Backend .env file
+            working-directory: Backend-Service
+            run: |
+              cat > .env << 'EOF'
+              DB_HOST=localhost
+              DB_PORT=5434
+              DB_NAME=wxyc_db
+              DB_USERNAME=wxyc_admin
+              DB_PASSWORD='RadioIsEpic$1100'
+              BETTER_AUTH_SECRET=e2e-auth-secret-for-testing-min-32-chars
+              BETTER_AUTH_URL=http://localhost:8084/auth
+              BETTER_AUTH_TRUSTED_ORIGINS=http://localhost:3000
+              FRONTEND_SOURCE=http://localhost:3000
+              DEFAULT_ORG_SLUG=test-org
+              DEFAULT_ORG_NAME=Test Organization
+              APP_ORGANIZATION_ID=test-org-id-0000000000000000001
+              E2E_DB_PORT=5434
+              E2E_AUTH_PORT=8084
+              E2E_BACKEND_PORT=8085
+              EOF
+          - name: Set up Docker Buildx
+            uses: docker/setup-buildx-action@v3
+          - name: Start backend services with Docker Compose
+            working-directory: Backend-Service
+            run: |
+              # Build and start E2E services
+              docker compose -f dev_env/docker-compose.yml --env-file .env --profile e2e up -d e2e-db
+              # Wait for database to be ready
+              echo "Waiting for database..."
+              timeout 60 bash -c 'until docker compose -f dev_env/docker-compose.yml --env-file .env --profile e2e exec -T e2e-db pg_isready; do sleep 2; done'
+              # Run database initialization
+              docker compose -f dev_env/docker-compose.yml --env-file .env --profile e2e up e2e-db-init
+              # Start auth and backend services
+              docker compose -f dev_env/docker-compose.yml --env-file .env --profile e2e up -d e2e-auth e2e-backend
+              # Wait for services to be healthy
+              echo "Waiting for auth service..."
+              timeout 120 bash -c 'until curl -sf http://localhost:8084/healthcheck; do sleep 5; done'
+              echo "Waiting for backend service..."
+              timeout 120 bash -c 'until curl -sf http://localhost:8085/healthcheck; do sleep 5; done'
+          - name: Install Backend-Service dependencies
+            working-directory: Backend-Service
+            run: npm ci
+          - name: Build Backend-Service workspaces
+            working-directory: Backend-Service
+            run: npm run build
+          - name: Set up E2E test users
+            working-directory: Backend-Service
+            env:
+              DB_HOST: localhost
+              DB_PORT: 5434
+              DB_NAME: wxyc_db
+              DB_USERNAME: wxyc_admin
+              DB_PASSWORD: 'RadioIsEpic$1100'
+              BETTER_AUTH_JWKS_URL: http://localhost:8084/auth/.well-known/jwks.json
+            run: |
+              # Wait a moment for services to fully stabilize
+              sleep 5
+              npm run setup:e2e-users
+          - name: Install dj-site dependencies
+            working-directory: dj-site
+            run: npm ci
+          - name: Install Playwright browsers
+            working-directory: dj-site
+            run: npx playwright install --with-deps chromium
+          - name: Build dj-site
+            working-directory: dj-site
+            run: npm run build
+          - name: Start dj-site
+            working-directory: dj-site
+            run: |
+              npm run start &
+              # Wait for frontend to be ready
+              echo "Waiting for frontend..."
+              timeout 60 bash -c 'until curl -sf http://localhost:3000; do sleep 2; done'
+          - name: Run E2E tests
+            working-directory: dj-site
+            run: npm run test:e2e -- --reporter=html --reporter=github
+          - name: Show service logs on failure
+            if: failure()
+            working-directory: Backend-Service
+            run: |
+              echo "=== Auth Service Logs ==="
+              docker compose -f dev_env/docker-compose.yml --env-file .env --profile e2e logs e2e-auth --tail=100
+              echo ""
+              echo "=== Backend Service Logs ==="
+              docker compose -f dev_env/docker-compose.yml --env-file .env --profile e2e logs e2e-backend --tail=100
+          - name: Upload Playwright report
+            uses: actions/upload-artifact@v4
+            if: always()
+            with:
+              name: playwright-report
+              path: dj-site/playwright-report/
+              retention-days: 30
+          - name: Upload test results
+            uses: actions/upload-artifact@v4
+            if: failure()
+            with:
+              name: test-results
+              path: dj-site/test-results/
+              retention-days: 7
+          - name: Cleanup
+            if: always()
+            working-directory: Backend-Service
+            run: |
+              docker compose -f dev_env/docker-compose.yml --env-file .env --profile e2e down -v --remove-orphans

.gitignore

-Original file line number
+Diff line change
@@ Expand Up / @@ -12,6 +12,9 @@ @@
     # testing
     /coverage
+    /test-results/
+    /playwright-report/
+    /playwright/.cache/
     # next.js
     /.next/
@@ Expand Down Expand Up / @@ -39,3 +42,7 @@ yarn-error.log* @@
     # typescript
     *.tsbuildinfo
     next-env.d.ts
+    e2e/.auth
+    e2e/.e2e-ports
+    e2e/.djsite.log
+    e2e/.djsite.pid

README.md

-Original file line number
+Diff line change
@@ Expand Up @@
     - Github Pages: For hosting the frontend and automating publication.
     - Axios: A JavaScript library used for making HTTP requests to the AWS API Gateway.
+    ## Local Development Prerequisites
+    The frontend requires the WXYC Backend-Service to be running locally for full functionality. Without the backend:
+    - Authentication will not work
+    - API calls (flowsheet, library, etc.) will fail
+    - Most features will be unavailable
+    **Option 1: Manual Setup**
+. Clone and start [Backend-Service](https://github.com/WXYC/Backend-Service) following its Quick Start guide
+. Ensure both backend (:8080) and auth (:8082) services are running
+. Continue with frontend setup below
+    **Option 2: Automated Setup**
+    Use the setup script from [wxyc-shared](https://github.com/WXYC/wxyc-shared) to automatically configure the entire stack.
     ## Installation and Setup
 . Clone the repository: `git clone https://github.com/WXYC/dj-site.git`
 . Navigate to the project directory: `cd dj-site`
 . Install dependencies: `npm install`
-. Run the application: `npm run dev`
-. Access the application locally: Open your web browser and visit `http://localhost:3000`
+. Create `.env.local` with required environment variables (see below)
+. Run the application: `npm run dev`
+. Access the application locally: Open your web browser and visit `http://localhost:3000`
+    ## Environment Variables
+    Create a `.env.local` file in the project root with the following variables:
+    ```bash
+    # Backend API URL (required)
+    NEXT_PUBLIC_BACKEND_URL=http://localhost:8080
+    # Better Auth service URL (required for authentication)
+    NEXT_PUBLIC_BETTER_AUTH_URL=http://localhost:8082/auth
+    # Default page after login
+    NEXT_PUBLIC_DASHBOARD_HOME_PAGE=/dashboard/flowsheet
+    # UI Experience settings
+    NEXT_PUBLIC_DEFAULT_EXPERIENCE=modern
+    NEXT_PUBLIC_ENABLED_EXPERIENCES=modern,classic
+    NEXT_PUBLIC_ALLOW_EXPERIENCE_SWITCHING=true
+    ```
+    ### Environment Variable Reference
+    | Variable | Required | Description |
+    |----------|----------|-------------|
+    | `NEXT_PUBLIC_BACKEND_URL` | Yes | Backend API base URL |
+    | `NEXT_PUBLIC_BETTER_AUTH_URL` | Yes | Auth service URL (must end with `/auth`) |
+    | `NEXT_PUBLIC_DASHBOARD_HOME_PAGE` | No | Redirect path after login |
+    | `NEXT_PUBLIC_DEFAULT_EXPERIENCE` | No | Default UI theme (`modern` or `classic`) |
+    | `NEXT_PUBLIC_ENABLED_EXPERIENCES` | No | Comma-separated list of available themes |
+    | `NEXT_PUBLIC_ALLOW_EXPERIENCE_SWITCHING` | No | Enable theme switching in UI |
+    ## Authentication Flow
+    The application uses [Better Auth](https://www.better-auth.com/) for authentication, running as a separate service within Backend-Service.
+    **How it works:**
+. User submits credentials on the login page
+. Frontend sends request to Better Auth service (`NEXT_PUBLIC_BETTER_AUTH_URL`)
+. Better Auth validates credentials against the PostgreSQL database
+. On success, Better Auth returns a JWT token stored in an HTTP-only cookie
+. Subsequent API requests include the token automatically
+. Backend validates tokens via JWKS endpoint
+    **Test credentials** (local development):
+    - Username: `test_member`, `test_dj1`, `test_dj2`, `test_music_director`, or `test_station_manager`
+    - Password: `testpassword123`
     ## Testing
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New authentication provider with tests #112

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

New authentication provider with tests #112

Are you sure you want to change the base?

New authentication provider with tests #112

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!