Update GH Actions (#14)

* add unittest step

* use nvmrc for `node-version`

* init playwright

* fix playwright action issue

* update artifact path

* headless only

* remove playwright

* init mock server

* explain how to run playwright tests

.env.example

@@ -20,4 +20,4 @@ DISCORD_CLIENT_SECRET=""
 
 # OAuth Mock
 OAUTH_MOCK_ENABLED=false
-#OAUTH_MOCK_ENDPOINT="http://localhost"
+OAUTH_MOCK_ENDPOINT="http://localhost:8080"

.github/workflows/ci.yml

@@ -55,3 +55,14 @@ jobs:
 
       - name: Typecheck
         run: pnpm typecheck
+
+  unittest:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup
+        uses: ./tooling/github/setup
+
+      - name: Unittest
+        run: pnpm test

README.md

@@ -41,7 +41,7 @@ This project is a monorepo based on turborepo.
 ├── apps
 │   └── frontend - Contains the logic for the site
 ├── packages
-│   ├── auth - Based on lucia-auth.com / same as we have at itaps monorepo
+│   ├── auth - Based on lucia-auth.com
 │   ├── db - Contains all the database related stuff ( prisma schema, migrations, seeds etc. )
 │   ├── helpers - Helper functions 🤷‍♂️
 │   ├── locales - contains the translations for the `frontend` app
@@ -85,11 +85,26 @@ This project is a monorepo based on turborepo.
 ## Todos
 
 - [ ] Add unit tests
-- [ ] Add more docs ( like how to activate/use mock users )
 - [ ] Integrate https://github.com/sadmann7/shadcn-table to have an example
 - [ ] Maybe: Adding a RBAC solution ( maybe via casl? )
 - [ ] Add a contribution guide
 
+## Running playwright tests
+
+We have prepared some simple testcases to test the authentication in the nextjs app.
+
+To make it runable inside a CI or locally, we're using an [oauth mock server](https://github.com/axa-group/oauth2-mock-server) to make it easier to run the tests and ensuring everything works as expected without having to add some magic to bypass the tests.
+
+With this, we automatically test the authentication flow.
+
+By running `pnpm dev`, the oauth mock server will start, too.
+
+You only have to set `OAUTH_MOCK_ENABLED` to `true` in your `.env` file.
+
+Last step is to open a new terminal tab and run `pnpm test:e2e:nextjs` to start the playwright tests.
+
+You can find the complete playwright configuration in `tooling/playwright`.
+
 ## Credits
 
 Without the amazing work of the [T3 OSS Community](https://github.com/t3-oss), this project wouldn't exists.

apps/mock-server/eslint.config.js

@@ -0,0 +1,4 @@
+import baseConfig, { restrictEnvAccess } from "@acme/eslint-config/base"
+
+/** @type {import('typescript-eslint').Config} */
+export default [...baseConfig]

apps/mock-server/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "mock-server",
+  "version": "2.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "clean": "git clean -xdf .cache .turbo dist node_modules .next",
+    "clean:cache": "git clean -xdf .cache",
+    "dev": "tsx --watch src/server.ts",
+    "format": "prettier --check . --ignore-path ../../.gitignore",
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit"
+  },
+  "prettier": "@acme/prettier-config",
+  "dependencies": {
+    "@acme/logging": "workspace:*",
+    "oauth2-mock-server": "7.2.0"
+  },
+  "devDependencies": {
+    "@acme/eslint-config": "workspace:*",
+    "@acme/prettier-config": "workspace:*",
+    "@acme/tailwind-config": "workspace:*",
+    "@acme/tsconfig": "workspace:*",
+    "@types/node": "22.10.2",
+    "eslint": "9.17.0",
+    "prettier": "3.4.2",
+    "tsx": "4.19.2",
+    "typescript": "5.7.2"
+  }
+}

apps/mock-server/src/server.ts

@@ -0,0 +1,10 @@
+import { OAuth2Server } from "oauth2-mock-server"
+
+import { createLogger } from "@acme/logging"
+
+const logger = createLogger("console")
+const server = new OAuth2Server()
+await server.issuer.keys.generate("RS256")
+
+await server.start(8080, "localhost")
+logger.info("Issuer URL:", server.issuer.url) // -> http://localhost:8080

apps/mock-server/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "extends": "@acme/tsconfig/base.json",
+  "compilerOptions": {
+    "lib": ["es2022", "dom", "dom.iterable"],
+    "jsx": "preserve",
+    "typeRoots": ["types"],
+    "baseUrl": ".",
+    "paths": {
+      "~/*": ["./src/*"]
+    },
+
+    "module": "esnext"
+  },
+  "include": [".", "dist/types/**/*.ts", "types"],
+  "exclude": ["node_modules"]
+}

apps/nextjs/playwright.config.ts

@@ -1,10 +1,6 @@
 import playwrightConfig from "@acme/playwright"
 
-const baseUrl = process.env.APPLICATION_URL
-  ? `${process.env.APPLICATION_URL}`
-  : process.env.LOCAL_HTTPS
-    ? "https://localhost:3000"
-    : "http://localhost:3000"
+const baseUrl = process.env.APPLICATION_URL ?? "http://localhost:3000"
 
 export default playwrightConfig({
   basePath: "/",

package.json

@@ -32,9 +32,8 @@
     "test": "vitest --project=unit",
     "test:ui": "vitest --ui",
     "prune": "turbo prune --docker",
-    "prepare_test": "turbo run build --filter @acme/* --filter !./apps/*",
     "turbo": "turbo",
-    "test:e2e:frontend": "pnpm -F frontend test:e2e",
+    "test:e2e:nextjs": "pnpm -F nextjs test:e2e",
     "playwright:init": "pnpm -F playwright test:init"
   },
   "devDependencies": {

packages/auth/src/providers/mock-user.ts

@@ -8,7 +8,7 @@ const callbackUrl = env.APPLICATION_URL
 
 const oauthMock = new MockProvider("dummy-client-id", "dummy-client-secret", {
   baseUrl: env.OAUTH_MOCK_ENDPOINT ?? "http://localhost",
-  redirectURI: `${callbackUrl}/api/auth/mock_user/callback`,
+  redirectURI: `${callbackUrl}`,
 })
 
 export const name = "Mock User"