-
Notifications
You must be signed in to change notification settings - Fork 48
chore(nextjs): add unit test coverage for untested code paths in @asgardeo/nextjs SDK #205
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
Merged
Merged
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
133 changes: 133 additions & 0 deletions
133
packages/nextjs/src/server/actions/__tests__/createOrganization.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| /** | ||
| * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com). | ||
| * | ||
| * WSO2 LLC. licenses this file to you under the Apache License, | ||
| * Version 2.0 (the "License"); you may not use this file except | ||
| * in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import { describe, it, expect, vi, beforeEach, afterEach, Mock } from 'vitest'; | ||
|
|
||
| // Adjust these paths if your project structure is different | ||
| import createOrganization from '../createOrganization'; | ||
|
|
||
| // Use the same class so we can assert instanceof and status code propagation | ||
| import { AsgardeoAPIError, Organization, CreateOrganizationPayload } from '@asgardeo/node'; | ||
|
|
||
| // ---- Mocks ---- | ||
| vi.mock('../../../AsgardeoNextClient', () => { | ||
| // We return a default export with a static getInstance function we can stub | ||
| return { | ||
| default: { | ||
| getInstance: vi.fn(), | ||
| }, | ||
| }; | ||
| }); | ||
|
|
||
| vi.mock('../getSessionId', () => ({ | ||
| default: vi.fn(), | ||
| })); | ||
|
|
||
| // Pull the mocked modules so we can access their spies | ||
| import AsgardeoNextClient from '../../../AsgardeoNextClient'; | ||
| import getSessionId from '../getSessionId'; | ||
|
|
||
| describe('createOrganization (Next.js server action)', () => { | ||
| const mockClient = { | ||
| createOrganization: vi.fn(), | ||
| }; | ||
|
|
||
| const basePayload: CreateOrganizationPayload = { | ||
| name: 'Team Viewer', | ||
| orgHandle: 'team-viewer', | ||
| description: 'Screen sharing organization', | ||
| parentId: 'parent-123', | ||
| type: 'TENANT', | ||
| }; | ||
|
|
||
| const mockOrg: Organization = { | ||
| id: 'org-001', | ||
| name: 'Team Viewer', | ||
| orgHandle: 'team-viewer', | ||
| }; | ||
|
|
||
| beforeEach(() => { | ||
| vi.resetAllMocks(); | ||
|
|
||
| // Default: getInstance returns our mock client | ||
| (AsgardeoNextClient.getInstance as unknown as Mock).mockReturnValue(mockClient); | ||
| // Default: getSessionId resolves to a session id | ||
| (getSessionId as unknown as Mock).mockResolvedValue('sess-abc'); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| vi.restoreAllMocks(); | ||
| }); | ||
|
|
||
| it('should create an organization successfully when a sessionId is provided', async () => { | ||
| mockClient.createOrganization.mockResolvedValueOnce(mockOrg); | ||
|
|
||
| const result = await createOrganization(basePayload, 'sess-123'); | ||
|
|
||
| expect(AsgardeoNextClient.getInstance).toHaveBeenCalledTimes(1); | ||
| expect(getSessionId).not.toHaveBeenCalled(); | ||
| expect(mockClient.createOrganization).toHaveBeenCalledWith(basePayload, 'sess-123'); | ||
| expect(result).toEqual(mockOrg); | ||
| }); | ||
|
|
||
| it('should fall back to getSessionId when sessionId is undefined', async () => { | ||
| mockClient.createOrganization.mockResolvedValueOnce(mockOrg); | ||
|
|
||
| const result = await createOrganization(basePayload, undefined as unknown as string); | ||
|
|
||
| expect(getSessionId).toHaveBeenCalledTimes(1); | ||
| expect(mockClient.createOrganization).toHaveBeenCalledWith(basePayload, 'sess-abc'); | ||
| expect(result).toEqual(mockOrg); | ||
| }); | ||
|
|
||
| it('should fall back to getSessionId when sessionId is null', async () => { | ||
| mockClient.createOrganization.mockResolvedValueOnce(mockOrg); | ||
|
|
||
| const result = await createOrganization(basePayload, null as unknown as string); | ||
|
|
||
| expect(getSessionId).toHaveBeenCalledTimes(1); | ||
| expect(mockClient.createOrganization).toHaveBeenCalledWith(basePayload, 'sess-abc'); | ||
| expect(result).toEqual(mockOrg); | ||
| }); | ||
|
|
||
| it('should not call getSessionId when an empty string is passed (empty string is not nullish)', async () => { | ||
| mockClient.createOrganization.mockResolvedValueOnce(mockOrg); | ||
|
|
||
| const result = await createOrganization(basePayload, ''); | ||
|
|
||
| expect(getSessionId).not.toHaveBeenCalled(); | ||
| expect(mockClient.createOrganization).toHaveBeenCalledWith(basePayload, ''); | ||
| expect(result).toEqual(mockOrg); | ||
| }); | ||
|
|
||
| it('should wrap an AsgardeoAPIError thrown by client.createOrganization, preserving statusCode', async () => { | ||
| const original = new AsgardeoAPIError( | ||
| 'Upstream validation failed', | ||
| 'ORG_CREATE_400', | ||
| 'server', | ||
| 400 | ||
| ); | ||
| mockClient.createOrganization.mockRejectedValueOnce(original); | ||
|
|
||
| await expect(createOrganization(basePayload, 'sess-1')).rejects.toMatchObject({ | ||
| constructor: AsgardeoAPIError, | ||
| statusCode: 400, | ||
| message: expect.stringContaining('Failed to create the organization: Upstream validation failed'), | ||
| }); | ||
| }); | ||
| }); | ||
145 changes: 145 additions & 0 deletions
145
packages/nextjs/src/server/actions/__tests__/getAccessToken.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| /** | ||
| * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com). | ||
| * | ||
| * WSO2 LLC. licenses this file to you under the Apache License, | ||
| * Version 2.0 (the "License"); you may not use this file except | ||
| * in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| // src/server/actions/__tests__/getAccessToken.test.ts | ||
| import { describe, it, expect, vi, beforeEach, afterEach, Mock } from 'vitest'; | ||
|
|
||
| // SUT | ||
| import getAccessToken from '../getAccessToken'; | ||
|
|
||
| // ---- Mocks ---- | ||
| vi.mock('next/headers', () => { | ||
| return { | ||
| cookies: vi.fn(), | ||
| }; | ||
| }); | ||
|
|
||
| vi.mock('../../../utils/SessionManager', () => { | ||
| return { | ||
| default: { | ||
| getSessionCookieName: vi.fn(), | ||
| verifySessionToken: vi.fn(), | ||
| }, | ||
| }; | ||
| }); | ||
|
|
||
| // Pull mocked modules so we can control them | ||
| import { cookies } from 'next/headers'; | ||
| import SessionManager from '../../../utils/SessionManager'; | ||
|
|
||
| // A tiny helper type for the cookie store the SUT expects | ||
| type CookieVal = { value: string }; | ||
| type CookieStore = { get: (name: string) => CookieVal | undefined }; | ||
|
|
||
| describe('getAccessToken', () => { | ||
| const SESSION_COOKIE_NAME = 'app_session'; | ||
|
|
||
| const makeCookieStore = (map: Record<string, string | undefined>): CookieStore => ({ | ||
| get: (name: string) => { | ||
| const v = map[name]; | ||
| return typeof v === 'string' ? { value: v } : undefined; | ||
| }, | ||
| }); | ||
|
|
||
| beforeEach(() => { | ||
| vi.resetAllMocks(); | ||
|
|
||
| // Default cookie name | ||
| (SessionManager.getSessionCookieName as unknown as Mock).mockReturnValue(SESSION_COOKIE_NAME); | ||
|
|
||
| // Default cookies() returns an object with get() | ||
| (cookies as unknown as Mock).mockResolvedValue(makeCookieStore({})); | ||
|
|
||
| // Default verification returns an object with a string token | ||
| (SessionManager.verifySessionToken as unknown as Mock).mockResolvedValue({ | ||
| accessToken: 'tok-123', | ||
| }); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| vi.restoreAllMocks(); | ||
| }); | ||
|
|
||
| it('should return the access token when the session cookie exists and verification succeeds', async () => { | ||
| // Arrange | ||
| (cookies as unknown as Mock).mockResolvedValue( | ||
| makeCookieStore({ [SESSION_COOKIE_NAME]: 'signed.jwt.token' }), | ||
| ); | ||
|
|
||
| // Act | ||
| const token = await getAccessToken(); | ||
|
|
||
| // Assert | ||
| expect(SessionManager.getSessionCookieName).toHaveBeenCalledTimes(1); | ||
| expect(cookies).toHaveBeenCalledTimes(1); | ||
| expect(SessionManager.verifySessionToken).toHaveBeenCalledWith('signed.jwt.token'); | ||
| expect(token).toBe('tok-123'); | ||
| }); | ||
|
|
||
| it('should return undefined when the session cookie is missing', async () => { | ||
| // Arrange: no cookie present (default makeCookieStore({})) | ||
| // Act | ||
| const token = await getAccessToken(); | ||
|
|
||
| // Assert | ||
| expect(SessionManager.getSessionCookieName).toHaveBeenCalledTimes(1); | ||
| expect(SessionManager.verifySessionToken).not.toHaveBeenCalled(); | ||
| expect(token).toBeUndefined(); | ||
| }); | ||
|
|
||
| it('should return undefined when the session cookie value is an empty string', async () => { | ||
| (cookies as unknown as Mock).mockResolvedValue( | ||
| makeCookieStore({ [SESSION_COOKIE_NAME]: '' }), | ||
| ); | ||
|
|
||
| const token = await getAccessToken(); | ||
|
|
||
| expect(SessionManager.verifySessionToken).not.toHaveBeenCalled(); | ||
| expect(token).toBeUndefined(); | ||
| }); | ||
|
|
||
| it('should return undefined when verifySessionToken throws (invalid or expired session)', async () => { | ||
| (cookies as unknown as Mock).mockResolvedValue( | ||
| makeCookieStore({ [SESSION_COOKIE_NAME]: 'bad.token' }), | ||
| ); | ||
| (SessionManager.verifySessionToken as unknown as Mock).mockRejectedValue( | ||
| new Error('invalid signature'), | ||
| ); | ||
|
|
||
| const token = await getAccessToken(); | ||
|
|
||
| expect(SessionManager.verifySessionToken).toHaveBeenCalledWith('bad.token'); | ||
| expect(token).toBeUndefined(); | ||
| }); | ||
|
|
||
| it('should return undefined when verification succeeds but accessToken is missing', async () => { | ||
| (cookies as unknown as Mock).mockResolvedValue( | ||
| makeCookieStore({ [SESSION_COOKIE_NAME]: 'signed.jwt.token' }), | ||
| ); | ||
| (SessionManager.verifySessionToken as unknown as Mock).mockResolvedValue({ | ||
| // no accessToken field | ||
| sub: 'user@tenant', | ||
| }); | ||
|
|
||
| const token = await getAccessToken(); | ||
|
|
||
| expect(token).toBeUndefined(); | ||
| }); | ||
|
|
||
|
|
||
| }); |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.