-
Notifications
You must be signed in to change notification settings - Fork 55
feat!: Generate AdminPortal from OpenAPI spec #1629
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
Draft
gjtorikian
wants to merge
1
commit into
main
Choose a base branch
from
oagen/own-admin-portal
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
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
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
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 |
|---|---|---|
| @@ -1,244 +1,39 @@ | ||
| // This file is auto-generated by oagen. Do not edit. | ||
|
|
||
| import fetch from 'jest-fetch-mock'; | ||
| import { fetchBody, fetchOnce } from '../common/utils/test-utils'; | ||
| import { | ||
| fetchOnce, | ||
| fetchURL, | ||
| fetchMethod, | ||
| fetchBody, | ||
| } from '../common/utils/test-utils'; | ||
| import { WorkOS } from '../workos'; | ||
| import generateLinkInvalid from './fixtures/generate-link-invalid.json'; | ||
| import portalLinkResponse from './fixtures/portal-link-response.json'; | ||
| import { GenerateLinkIntent } from '../common/interfaces'; | ||
|
|
||
| import portalLinkResponseFixture from './fixtures/portal-link-response.json'; | ||
|
|
||
| const workos = new WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU'); | ||
|
|
||
| describe('AdminPortal', () => { | ||
| beforeEach(() => fetch.resetMocks()); | ||
|
|
||
| describe('generateLink', () => { | ||
| describe('with a valid organization', () => { | ||
| describe('with the sso intent', () => { | ||
| it('returns an Admin Portal link', async () => { | ||
| fetchOnce(portalLinkResponse, { status: 201 }); | ||
|
|
||
| const { link } = await workos.adminPortal.generateLink({ | ||
| intent: GenerateLinkIntent.SSO, | ||
| organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3', | ||
| returnUrl: 'https://www.example.com', | ||
| }); | ||
|
|
||
| expect(fetchBody()).toEqual({ | ||
| intent: GenerateLinkIntent.SSO, | ||
| organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3', | ||
| return_url: 'https://www.example.com', | ||
| }); | ||
| expect(link).toEqual( | ||
| 'https://setup.workos.com?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...', | ||
| ); | ||
| }); | ||
| }); | ||
|
|
||
| describe('with the domain_verification intent', () => { | ||
| it('returns an Admin Portal link', async () => { | ||
| fetchOnce(portalLinkResponse, { status: 201 }); | ||
|
|
||
| const { link } = await workos.adminPortal.generateLink({ | ||
| intent: GenerateLinkIntent.DomainVerification, | ||
| organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3', | ||
| returnUrl: 'https://www.example.com', | ||
| }); | ||
|
|
||
| expect(fetchBody()).toEqual({ | ||
| intent: GenerateLinkIntent.DomainVerification, | ||
| organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3', | ||
| return_url: 'https://www.example.com', | ||
| }); | ||
| expect(link).toEqual( | ||
| 'https://setup.workos.com?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...', | ||
| ); | ||
| }); | ||
| }); | ||
|
|
||
| describe('with the dsync intent', () => { | ||
| it('returns an Admin Portal link', async () => { | ||
| fetchOnce(portalLinkResponse, { status: 201 }); | ||
|
|
||
| const { link } = await workos.adminPortal.generateLink({ | ||
| intent: GenerateLinkIntent.DSync, | ||
| organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3', | ||
| returnUrl: 'https://www.example.com', | ||
| }); | ||
|
|
||
| expect(fetchBody()).toEqual({ | ||
| intent: GenerateLinkIntent.DSync, | ||
| organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3', | ||
| return_url: 'https://www.example.com', | ||
| }); | ||
| expect(link).toEqual( | ||
| 'https://setup.workos.com?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...', | ||
| ); | ||
| }); | ||
| }); | ||
|
|
||
| describe('with the `audit_logs` intent', () => { | ||
| it('returns an Admin Portal link', async () => { | ||
| fetchOnce(portalLinkResponse, { status: 201 }); | ||
|
|
||
| const { link } = await workos.adminPortal.generateLink({ | ||
| intent: GenerateLinkIntent.AuditLogs, | ||
| organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3', | ||
| returnUrl: 'https://www.example.com', | ||
| }); | ||
|
|
||
| expect(fetchBody()).toEqual({ | ||
| intent: GenerateLinkIntent.AuditLogs, | ||
| organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3', | ||
| return_url: 'https://www.example.com', | ||
| }); | ||
| expect(link).toEqual( | ||
| 'https://setup.workos.com?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...', | ||
| ); | ||
| }); | ||
| }); | ||
|
|
||
| describe('with the `log_streams` intent', () => { | ||
| it('returns an Admin Portal link', async () => { | ||
| fetchOnce(portalLinkResponse, { status: 201 }); | ||
|
|
||
| const { link } = await workos.adminPortal.generateLink({ | ||
| intent: GenerateLinkIntent.LogStreams, | ||
| organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3', | ||
| returnUrl: 'https://www.example.com', | ||
| }); | ||
|
|
||
| expect(fetchBody()).toEqual({ | ||
| intent: GenerateLinkIntent.LogStreams, | ||
| organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3', | ||
| return_url: 'https://www.example.com', | ||
| }); | ||
| expect(link).toEqual( | ||
| 'https://setup.workos.com?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...', | ||
| ); | ||
| }); | ||
| }); | ||
| describe('with the `certificate_renewal` intent', () => { | ||
| it('returns an Admin Portal link', async () => { | ||
| fetchOnce(portalLinkResponse, { status: 201 }); | ||
|
|
||
| const { link } = await workos.adminPortal.generateLink({ | ||
| intent: GenerateLinkIntent.CertificateRenewal, | ||
| organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3', | ||
| returnUrl: 'https://www.example.com', | ||
| }); | ||
|
|
||
| expect(fetchBody()).toEqual({ | ||
| intent: GenerateLinkIntent.CertificateRenewal, | ||
| organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3', | ||
| return_url: 'https://www.example.com', | ||
| }); | ||
| expect(link).toEqual( | ||
| 'https://setup.workos.com?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...', | ||
| ); | ||
| }); | ||
| }); | ||
| describe('with the `bring_your_own_key` intent', () => { | ||
| it('returns an Admin Portal link', async () => { | ||
| fetchOnce(portalLinkResponse, { status: 201 }); | ||
|
|
||
| const { link } = await workos.adminPortal.generateLink({ | ||
| intent: GenerateLinkIntent.BringYourOwnKey, | ||
| organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3', | ||
| returnUrl: 'https://www.example.com', | ||
| }); | ||
|
|
||
| expect(fetchBody()).toEqual({ | ||
| intent: GenerateLinkIntent.BringYourOwnKey, | ||
| organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3', | ||
| return_url: 'https://www.example.com', | ||
| }); | ||
| expect(link).toEqual( | ||
| 'https://setup.workos.com?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...', | ||
| ); | ||
| }); | ||
| }); | ||
|
|
||
| describe('with intentOptions and adminEmails', () => { | ||
| it('serializes the new parameters correctly', async () => { | ||
| fetchOnce(portalLinkResponse, { status: 201 }); | ||
|
|
||
| const { link } = await workos.adminPortal.generateLink({ | ||
| intent: GenerateLinkIntent.SSO, | ||
| organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3', | ||
| returnUrl: 'https://www.example.com', | ||
| intentOptions: { | ||
| sso: { | ||
| bookmarkSlug: 'chatgpt', | ||
| providerType: 'GoogleSAML', | ||
| }, | ||
| }, | ||
| adminEmails: ['admin@example.com'], | ||
| }); | ||
|
|
||
| expect(fetchBody()).toEqual({ | ||
| intent: 'sso', | ||
| organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3', | ||
| return_url: 'https://www.example.com', | ||
| intent_options: { | ||
| sso: { | ||
| bookmark_slug: 'chatgpt', | ||
| provider_type: 'GoogleSAML', | ||
| }, | ||
| }, | ||
| admin_emails: ['admin@example.com'], | ||
| }); | ||
| expect(link).toEqual( | ||
| 'https://setup.workos.com?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...', | ||
| ); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describe('with an invalid organization', () => { | ||
| it('throws an error', async () => { | ||
| fetchOnce(generateLinkInvalid, { | ||
| status: 400, | ||
| headers: { 'X-Request-ID': 'a-request-id' }, | ||
| }); | ||
|
|
||
| await expect( | ||
| workos.adminPortal.generateLink({ | ||
| intent: GenerateLinkIntent.SSO, | ||
| organization: 'bogus-id', | ||
| returnUrl: 'https://www.example.com', | ||
| }), | ||
| ).rejects.toThrow( | ||
| 'Could not find an organization with the id, bogus-id.', | ||
| ); | ||
| expect(fetchBody()).toEqual({ | ||
| intent: GenerateLinkIntent.SSO, | ||
| organization: 'bogus-id', | ||
| return_url: 'https://www.example.com', | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describe('with an invalid organization', () => { | ||
| it('throws an error', async () => { | ||
| fetchOnce(generateLinkInvalid, { | ||
| status: 400, | ||
| headers: { 'X-Request-ID': 'a-request-id' }, | ||
| }); | ||
|
|
||
| await expect( | ||
| workos.adminPortal.generateLink({ | ||
| intent: GenerateLinkIntent.SSO, | ||
| organization: 'bogus-id', | ||
| returnUrl: 'https://www.example.com', | ||
| }), | ||
| ).rejects.toThrow( | ||
| 'Could not find an organization with the id, bogus-id.', | ||
| ); | ||
| expect(fetchBody()).toEqual({ | ||
| intent: GenerateLinkIntent.SSO, | ||
| organization: 'bogus-id', | ||
| return_url: 'https://www.example.com', | ||
| }); | ||
| }); | ||
| it('sends the correct request and returns result', async () => { | ||
| fetchOnce(portalLinkResponseFixture); | ||
|
|
||
| const result = await workos.adminPortal.generateLink({ | ||
| organization: 'test_organization', | ||
| }); | ||
|
|
||
| expect(fetchMethod()).toBe('POST'); | ||
| expect(new URL(String(fetchURL())).pathname).toBe( | ||
| '/portal/generate_link', | ||
| ); | ||
| expect(fetchBody()).toEqual( | ||
| expect.objectContaining({ organization: 'test_organization' }), | ||
| ); | ||
| expect(result.link).toBe( | ||
| 'https://setup.workos.com?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...', | ||
| ); | ||
| }); | ||
| }); | ||
| }); |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
const payload = options;assignment adds no value —optionscan be passed directly toserializeGenerateLink.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!