feat(testing): Add checkout and pricingTable page objects #5776
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@clerk/testing': patch | ||
| --- | ||
|
|
||
| Add `checkout` and `pricingTable` page objects. |
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 |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| import type { EnhancedPage } from './app'; | ||
| import { common } from './common'; | ||
|
|
||
| export const createCheckoutPageObject = (testArgs: { page: EnhancedPage }) => { | ||
| const { page } = testArgs; | ||
| const self = { | ||
| ...common(testArgs), | ||
| waitForMounted: (selector = '.cl-checkout-root') => { | ||
| return page.waitForSelector(selector, { state: 'attached' }); | ||
| }, | ||
| fillTestCard: async () => { | ||
| await self.fillCard({ | ||
| number: '4242424242424242', | ||
| expiration: '1234', | ||
| cvc: '123', | ||
| country: 'United States', | ||
| zip: '12345', | ||
| }); | ||
| }, | ||
| fillCard: async (card: { number: string; expiration: string; cvc: string; country: string; zip: string }) => { | ||
| const frame = page.frameLocator('iframe[src*="elements-inner-payment"]'); | ||
| await frame.getByLabel('Card number').fill(card.number); | ||
| await frame.getByLabel('Expiration date').fill(card.expiration); | ||
| await frame.getByLabel('Security code').fill(card.cvc); | ||
| await frame.getByLabel('Country').selectOption(card.country); | ||
| await frame.getByLabel('ZIP code').fill(card.zip); | ||
| }, | ||
| clickPayOrSubscribe: async () => { | ||
| await page.getByRole('button', { name: /subscribe|pay\s/i }).click(); | ||
| }, | ||
| clickAddPaymentMethod: async () => { | ||
| await page.getByRole('radio', { name: 'Add payment method' }).click(); | ||
| }, | ||
| clickPaymentMethods: async () => { | ||
| await page.getByRole('radio', { name: 'Payment Methods' }).click(); | ||
| }, | ||
| }; | ||
| return self; | ||
| }; |
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,11 +1,13 @@ | ||
| import type { Page } from '@playwright/test'; | ||
|
|
||
| import { createAppPageObject } from './app'; | ||
| import { createCheckoutPageObject } from './checkout'; | ||
| import { createClerkPageObject } from './clerk'; | ||
| import { createExpectPageObject } from './expect'; | ||
| import { createImpersonationPageObject } from './impersonation'; | ||
| import { createKeylessPopoverPageObject } from './keylessPopover'; | ||
| import { createOrganizationSwitcherComponentPageObject } from './organizationSwitcher'; | ||
| import { createPricingTablePageObject } from './pricingTable'; | ||
| import { createSessionTaskComponentPageObject } from './sessionTask'; | ||
| import { createSignInComponentPageObject } from './signIn'; | ||
| import { createSignUpComponentPageObject } from './signUp'; | ||
|
|
@@ -30,10 +32,12 @@ export const createPageObjects = ({ | |
| return { | ||
| page: app, | ||
| clerk: createClerkPageObject(testArgs), | ||
| checkout: createCheckoutPageObject(testArgs), | ||
|
Member
There was a problem hiding this comment. @dstaley since we only expose checkout as an internal component currently, shall we follow the pattern here as well ? We can drop the internal prefix later once, checkout is a standalone component.
Member
Author
There was a problem hiding this comment. I think given that Checkout is intended to be a public component in the near future we're fine to leave this as just |
||
| expect: createExpectPageObject(testArgs), | ||
| impersonation: createImpersonationPageObject(testArgs), | ||
| keylessPopover: createKeylessPopoverPageObject(testArgs), | ||
| organizationSwitcher: createOrganizationSwitcherComponentPageObject(testArgs), | ||
| pricingTable: createPricingTablePageObject(testArgs), | ||
| sessionTask: createSessionTaskComponentPageObject(testArgs), | ||
| signIn: createSignInComponentPageObject(testArgs), | ||
| signUp: createSignUpComponentPageObject(testArgs), | ||
|
|
||
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,24 @@ | ||
| import type { EnhancedPage } from './app'; | ||
| import { common } from './common'; | ||
|
|
||
| export const createPricingTablePageObject = (testArgs: { page: EnhancedPage }) => { | ||
| const { page } = testArgs; | ||
| const self = { | ||
| ...common(testArgs), | ||
| waitForMounted: (selector = '.cl-pricingTable-root') => { | ||
| return page.waitForSelector(selector, { state: 'attached' }); | ||
| }, | ||
| clickManageSubscription: async () => { | ||
| await page.getByText('Manage subscription').click(); | ||
| }, | ||
| clickResubscribe: async () => { | ||
| await page.getByText('Re-subscribe').click(); | ||
| }, | ||
| startCheckout: async ({ planSlug, shouldSwitch }: { planSlug: string; shouldSwitch?: boolean }) => { | ||
| const targetButtonName = | ||
| shouldSwitch === true ? 'Switch to this plan' : shouldSwitch === false ? 'Get started' : /get|switch/i; | ||
| await page.locator(`.cl-pricingTableCard__${planSlug}`).getByRole('button', { name: targetButtonName }).click(); | ||
| }, | ||
| }; | ||
| return self; | ||
| }; |
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
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.
Not a super strong opinion, but shouldSwitch is not super obvious.
switchPlansmaybe? Again not super strong opinion here.