v1.0.7 Release

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,8 +1,9 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: bug
+title: '[BUG] '
+labels: 
+  - "🐞 goal: bugfix"
 assignees: ''
 
 ---

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,8 +1,8 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: enhancement
+title: '[FEATURE] '
+labels: '⭐️ goal: new feature'
 assignees: ''
 
 ---

.github/workflows/main.yml

@@ -4,41 +4,99 @@ on:
   [push]
 
 jobs:
-  build_and_test:
+  # Job for installing dependencies and linting code
+  Lint:
     runs-on: ubuntu-latest
     timeout-minutes: 5
-
     steps:
     - name: Checkout repository
       uses: actions/checkout@v4
 
     - name: Set up Node.js
       uses: actions/setup-node@v4
       with:
-        node-version: '20.14.0'
-        cache: 'npm'
+        node-version: 20
 
-    - name: Install dependencies
-      run: npm install
+    - name: Cache Node.js modules
+      uses: actions/cache@v4
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-node-
 
-    - name: Build the Next.js application
-      env:
-          STRIPE_KEY: ${{ secrets.STRIPE_KEY }}
-          NEXTAUTH_URL: ${{secrets.NEXTAUTH_URL}}
-          NEXTAUTH_SECRET: ${{secrets.NEXTAUTH_SECRET}}
-          AUTH_GITHUB_ID: ${{secrets.AUTH_GITHUB_ID}}
-          AUTH_GITHUB_SECRET: ${{secrets.AUTH_GITHUB_SECRET}}
-          GOOGLE_CLIENT_ID: ${{secrets.GOOGLE_CLIENT_ID}}
-          GOOGLE_CLIENT_SECRET: ${{secrets.GOOGLE_CLIENT_SECRET}}
-      run: npm run build --if-present
+    - name: Install dependencies
+      run: npm ci
 
     - name: Code linting
       run: npm run lint
 
-    - name: Run tests and collect coverage
+  # Job for building and running tests
+  End-to-end-Tests:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Cypress run
+      uses: cypress-io/github-action@v6
+      env:
+        NEXTAUTH_URL: ${{secrets.NEXTAUTH_URL}}
+        STRIPE_KEY: ${{ secrets.STRIPE_KEY }}
+        NEXTAUTH_SECRET: ${{secrets.NEXTAUTH_SECRET}}
+        AUTH_GITHUB_ID: ${{secrets.AUTH_GITHUB_ID}}
+        AUTH_GITHUB_SECRET: ${{secrets.AUTH_GITHUB_SECRET}}
+        GOOGLE_CLIENT_ID: ${{secrets.GOOGLE_CLIENT_ID}}
+        GOOGLE_CLIENT_SECRET: ${{secrets.GOOGLE_CLIENT_SECRET}}
+      with:
+        build: npm run build
+        start: npm start
+        spec: |
+          cypress/e2e/*.cy.ts
+
+    - name: Install Playwright Browsers
+      run: npx playwright install --with-deps
+
+    - name: Run Playwright tests
+      run: npx playwright test
+
+    - name: Upload Playwright Report
+      if: always()
+      uses: actions/upload-artifact@v4
+      with:
+        name: playwright-report
+        path: playwright-report/
+        retention-days: 30
+
+  # Job for running unit tests and uploading coverage report
+  Unit-Tests:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: 20
+
+    - name: Cache Node.js modules
+      uses: actions/cache@v4
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-node-
+
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Run unit tests
       run: npm run test
 
     - name: Upload coverage to Codecov
       uses: codecov/[email protected]
       with:
-          token: ${{ secrets.CODECOV_TOKEN }}
+        token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -39,3 +39,7 @@ next-env.d.ts
 .vscode/tasks.json
 /certificates/*
 cypress.env.json
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

cypress.config.ts

@@ -4,6 +4,7 @@ export default defineConfig({
   chromeWebSecurity: false,
 
   e2e: {
+    baseUrl: 'http://localhost:3000',
     setupNodeEvents(on, config) {
       return require('./cypress/plugins/index.ts')(on, config)
     },

cypress/e2e/auth/dashboard_access.cy.ts

@@ -0,0 +1,14 @@
+describe("Accessing Dashboard Page With Authentication", () => {
+  beforeEach(() => {
+    cy.stubGoogleLogin();
+  });
+
+  it('Should display dashboard', () => {
+    cy.get("[data-cy='authenticated']")
+    .should("exist")
+    .then(() => {
+      cy.log("Cypress login successful");
+    });
+  })
+});
+

cypress/e2e/dashboard_access.cy.ts

@@ -0,0 +1,10 @@
+describe("Accessing Dashboard Page Without Authentication", () => {
+    it("should redirect to the login page if user is not authenticated", () => {
+      cy.visit("/dashboard");
+
+      cy.url().should("include", "api/auth/signin");
+
+      cy.get("button").should("contain.text", "Sign in with Google");
+    });
+  });
+

cypress/e2e/redirect_to_login.cy.ts

@@ -0,0 +1,9 @@
+describe("Redirection to Sign-In Page", () => {
+  it("should redirect unauthenticated user from root url to sign-in page", () => {
+    cy.visit("/");
+
+    cy.url().should("include", "/api/auth/signin");
+
+    cy.get("button").should("contain.text", "Sign in with Google");
+  });
+});

cypress/fixtures/session.json

@@ -0,0 +1,9 @@
+{
+    "user": {
+      "name": "Morty Smith",
+      "email": "[email protected]",
+      "image": "/path/to/your/mock/user.jpg"
+    },
+    "expires": "3000-01-01T00:00:00.000Z",
+    "accessToken": "abcdefghijklmnopqrst"
+  }

cypress/global.d.ts

@@ -0,0 +1,9 @@
+declare namespace Cypress {
+  // noinspection JSUnusedGlobalSymbols
+  interface Chainable {
+    /**
+     * Logs in via the next-auth session cookie for the JWT strategy ONLY!
+     */
+    stubGoogleLogin(): Chainable<any>;
+  }
+}

cypress/support/auth-provider-commands/next-auth.ts

@@ -0,0 +1,12 @@
+Cypress.Commands.add("stubGoogleLogin", () => {
+  Cypress.log({
+    displayName: "STUB GOOGLE LOGIN",
+    message: [`🔐 Authenticating`],
+  });
+
+  cy.intercept("/api/auth/session", {fixture: "session.json"}).as("session");
+
+  cy.setCookie("next-auth.session-token", Cypress.env("NEXTAUTH_JWT_SECRET"));
+  cy.visit("/dashboard");
+  cy.wait("@session");
+});

cypress/support/commands.ts

@@ -34,4 +34,7 @@
 //       visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
 //     }
 //   }
-// }
+// }
+
+// Import commands for third-party auth providers
+import "./auth-provider-commands/next-auth";

jest.config.ts

@@ -20,6 +20,7 @@ const config: Config = {
 
   // Indicates which provider should be used to instrument code for coverage
   coverageProvider: "v8",
+  modulePathIgnorePatterns: ["playwright"],
 
   // The test environment that will be used for testing
   testEnvironment: "jsdom",