Skip to content
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

chore(test): core test setup #9238

Merged
merged 8 commits into from
Nov 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,7 @@ docs/docs/reference/solidstart
docs/docs/reference/adapter

## Drizzle migration folder
.drizzle
.drizzle

## Test files
!vitest.config.js
10 changes: 7 additions & 3 deletions packages/core/package.json
ThangHuuVu marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@
"*.d.ts*",
"lib",
"providers",
"src"
"src",
"!vitest.config.js"
],
"exports": {
".": {
Expand Down Expand Up @@ -81,6 +82,7 @@
"clean": "rm -rf *.js *.d.ts* lib providers",
"css": "node scripts/generate-css",
"dev": "pnpm css && pnpm providers && tsc -w",
"test": "vitest",
"providers": "node scripts/generate-providers"
},
"devDependencies": {
Expand All @@ -90,6 +92,8 @@
"@types/react": "18.0.37",
"autoprefixer": "10.4.13",
"postcss": "8.4.19",
"postcss-nested": "6.0.0"
"postcss-nested": "6.0.0",
"vite": "^5.0.2",
"vitest": "^0.25.3"
}
}
}
9 changes: 9 additions & 0 deletions packages/core/test/constants.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
export const BASE_URL = "https://next-auth-example.com"
export const AUTH_URL = `${BASE_URL}/api/auth`
export const AUTH_SECRET = "secret"

const makeAuthAction = (action: string) => `${AUTH_URL}/${action}`

export const SESSION_ACTION = makeAuthAction("session")
export const SESSION_COOKIE_NAME = "__Secure-authjs.session-token"
export const CSRF_COOKIE_NAME = "__Host-authjs.csrf-token"
194 changes: 194 additions & 0 deletions packages/core/test/index.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,194 @@
import { describe, expect, it, vi } from "vitest"
import { Auth, AuthConfig } from "../src/index.js"
import GitHub from "../src/providers/github.js"
import {
AUTH_SECRET,
SESSION_ACTION,
SESSION_COOKIE_NAME,
} from "./constants.js"
import { decode, encode } from "../src/jwt.js"
import { parse } from "cookie"
import { defaultCallbacks } from "../src/lib/init.js"
import { Adapter, AdapterSession } from "../src/adapters.js"
import { randomString } from "../src/lib/utils/web.js"

const authConfig: AuthConfig = {
providers: [GitHub],
trustHost: true,
secret: AUTH_SECRET,
}

describe("JWT session", () => {
it("should return a valid JWT session response", async () => {
const authEvents: AuthConfig["events"] = {
session: () => {},
}
vi.spyOn(authEvents, "session")
authConfig.events = authEvents

vi.spyOn(defaultCallbacks, "jwt")
vi.spyOn(defaultCallbacks, "session")

const expectedSession = {
name: "test",
email: "[email protected]",
picture: "https://test.com/test.png",
}
const expectedSessionInBody = {
name: "test",
email: "[email protected]",
image: "https://test.com/test.png",
}
const encoded = await encode({
salt: SESSION_COOKIE_NAME,
secret: AUTH_SECRET,
token: expectedSession,
})
const request = new Request(SESSION_ACTION, {
headers: {
cookie: `${SESSION_COOKIE_NAME}=${encoded}`,
},
})
const response = (await Auth(request, authConfig)) as Response
const bodySession = await response.json()

let cookies = response.headers
.getSetCookie()
.reduce<Record<string, string>>((acc, cookie) => {
return { ...acc, ...parse(cookie) }
}, {})
const sessionToken = cookies[SESSION_COOKIE_NAME]
const decoded = await decode<{
// TODO: This shouldn't be necessary?
exp: number
iat: number
jti: string
}>({
salt: SESSION_COOKIE_NAME,
secret: AUTH_SECRET,
token: sessionToken,
})

const { exp, iat, jti, ...actualSession } = decoded || {}

expect(actualSession).toEqual(expectedSession)
expect(bodySession.user).toEqual(expectedSessionInBody)
expect(bodySession.expires).toBeDefined()
expect(authConfig.events?.session).toHaveBeenCalledOnce()
expect(defaultCallbacks.jwt).toHaveBeenCalledOnce()
expect(defaultCallbacks.session).toHaveBeenCalledOnce()
})
it("should return null if no JWT session in the requests cookies", async () => {
const request = new Request(SESSION_ACTION)
const response = (await Auth(request, authConfig)) as Response
const actual = await response.json()
expect(actual).toEqual(null)
})
it("should return null if JWT session is invalid", async () => {
const request = new Request(SESSION_ACTION, {
headers: {
cookie: `${SESSION_COOKIE_NAME}=invalid`,
},
})
const response = (await Auth(request, authConfig)) as Response
const actual = await response.json()
expect(actual).toEqual(null)
})
})

describe("Database session", () => {
it("should return a valid database session response", async () => {
const authEvents: AuthConfig["events"] = {
session: () => {},
}
vi.spyOn(authEvents, "session")
authConfig.events = authEvents

vi.spyOn(defaultCallbacks, "jwt")
vi.spyOn(defaultCallbacks, "session")

const expectedSessionUser = {
name: "test",
email: "[email protected]",
image: "https://test.com/test.png",
}
const expectedSessionUserInBody = {
name: "test",
email: "[email protected]",
image: "https://test.com/test.png",
}
// 1 day from now
const currentExpires = new Date(Date.now() + 24 * 60 * 60 * 1000)
const expectedToken = randomString(32)
const expectedSession: AdapterSession = {
sessionToken: expectedToken,
userId: "userId",
expires: currentExpires,
}

const encoded = await encode({
salt: SESSION_COOKIE_NAME,
secret: AUTH_SECRET,
token: expectedSession,
})
const request = new Request(SESSION_ACTION, {
headers: {
cookie: `${SESSION_COOKIE_NAME}=${encoded}`,
},
})
const mockAdapter: Adapter = {
getSessionAndUser: vi.fn().mockResolvedValue({
session: expectedSession,
user: expectedSessionUser,
}),
deleteSession: vi.fn().mockResolvedValue(null),
updateSession: vi.fn().mockResolvedValue(null),

// not needed for this test but required for the assertion
createUser: vi.fn().mockResolvedValue(null),
getUser: vi.fn().mockResolvedValue(null),
getUserByAccount: vi.fn().mockResolvedValue(null),
getUserByEmail: vi.fn().mockResolvedValue(null),
updateUser: vi.fn().mockResolvedValue(null),
linkAccount: vi.fn().mockResolvedValue(null),
createSession: vi.fn().mockResolvedValue(null),
}

authConfig.adapter = mockAdapter
const response = (await Auth(request, authConfig)) as Response
const bodySession = await response.json()

let cookies = response.headers
.getSetCookie()
.reduce<Record<string, string>>((acc, cookie) => {
return { ...acc, ...parse(cookie) }
}, {})
const sessionToken = cookies[SESSION_COOKIE_NAME]
const decoded = await decode<{
// TODO: This shouldn't be necessary?
exp: number
iat: number
jti: string
}>({
salt: SESSION_COOKIE_NAME,
secret: AUTH_SECRET,
token: sessionToken,
})

const { exp, iat, jti, ...actualSession } = decoded || {}

expect(mockAdapter.getSessionAndUser).toHaveBeenCalledOnce()
expect(mockAdapter.deleteSession).not.toHaveBeenCalled()
expect(mockAdapter.updateSession).toHaveBeenCalled()
expect(defaultCallbacks.session).toHaveBeenCalledOnce()
expect(authConfig.events?.session).toHaveBeenCalledOnce()
expect(defaultCallbacks.jwt).not.toHaveBeenCalledOnce()

expect({
...actualSession,
expires: new Date((actualSession as AdapterSession).expires),
}).toEqual(expectedSession)
expect(bodySession.user).toEqual(expectedSessionUserInBody)
expect(bodySession.expires).toEqual(currentExpires.toISOString())
})
})
11 changes: 11 additions & 0 deletions packages/core/test/test-setup.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { afterAll, afterEach, beforeAll } from "vitest"

beforeAll(() => {
globalThis.crypto ??= require("node:crypto").webcrypto
})

afterAll(() => {
})

afterEach(() => {
})
11 changes: 11 additions & 0 deletions packages/core/vitest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/// <reference types="vitest" />

import { defineConfig } from 'vite'

// https://vitejs.dev/config/
export default defineConfig({
plugins: [],
test: {
setupFiles: ['./test/test-setup.ts'],
},
})
Loading
Loading