Moved portal offer redemption tests to e2e (TryGhost#26957)

9larsons · web-flow · commit 254ec47d4779 · 2026-03-25T16:07:14.000Z
ref https://linear.app/ghost/issue/PLA-9/ - migrates the remaining Portal offer redemption coverage into top-level e2e - adds the Portal offer page object and redemption flow support - deletes the legacy browser offers spec
diff --git a/e2e/helpers/pages/portal/account-page.ts b/e2e/helpers/pages/portal/account-page.ts
@@ -10,6 +10,8 @@ export class PortalAccountPage extends PortalPage {
     readonly resumeSubscriptionButton: Locator;
     readonly canceledBadge: Locator;
     readonly emailNewsletterHeading: Locator;
+    readonly freeTrialLabel: Locator;
+    readonly offerLabel: Locator;
 
     constructor(page: Page) {
         super(page);
@@ -22,6 +24,8 @@ export class PortalAccountPage extends PortalPage {
         this.resumeSubscriptionButton = this.portalFrame.getByRole('button', {name: 'Resume subscription'});
         this.canceledBadge = this.portalFrame.getByText('Canceled', {exact: true});
         this.emailNewsletterHeading = this.portalFrame.getByRole('heading', {name: 'Email newsletter'});
+        this.freeTrialLabel = this.portalFrame.getByText(/Free Trial – Ends/i);
+        this.offerLabel = this.portalFrame.getByTestId('offer-label');
     }
 
     cardLast4(last4: string): Locator {
diff --git a/e2e/helpers/pages/portal/index.ts b/e2e/helpers/pages/portal/index.ts
@@ -2,6 +2,7 @@ export * from './account-home-page';
 export * from './account-page';
 export * from './account-plan-page';
 export * from './newsletter-management-page';
+export * from './offer-page';
 export * from './portal-page';
 export * from './sign-in-page';
 export * from './sign-up-page';
diff --git a/e2e/helpers/pages/portal/offer-page.ts b/e2e/helpers/pages/portal/offer-page.ts
@@ -0,0 +1,50 @@
+import {Locator, Page} from '@playwright/test';
+import {PortalPage} from './portal-page';
+
+export class PortalOfferPage extends PortalPage {
+    readonly nameInput: Locator;
+    readonly emailInput: Locator;
+    readonly submitButton: Locator;
+    readonly continueButton: Locator;
+
+    constructor(page: Page) {
+        super(page);
+
+        this.nameInput = this.portalFrame.getByRole('textbox', {name: 'Name'});
+        this.emailInput = this.portalFrame.getByRole('textbox', {name: 'Email'});
+        this.submitButton = this.portalFrame.getByRole('button', {name: /Continue|Start .* free trial|Retry/});
+        this.continueButton = this.portalFrame.getByRole('button', {name: 'Continue'});
+    }
+
+    headingWithText(text: string): Locator {
+        return this.portalFrame.getByRole('heading', {name: text});
+    }
+
+    text(text: string | RegExp): Locator {
+        return this.portalFrame.getByText(text);
+    }
+
+    async fillAndSubmit(email: string, name?: string): Promise<void> {
+        if (name) {
+            await this.nameInput.fill(name);
+        }
+
+        await this.emailInput.fill(email);
+        await this.submitButton.click();
+    }
+
+    async continueIfVisible(): Promise<void> {
+        if (await this.continueButton.isVisible()) {
+            await this.continueButton.click();
+        }
+    }
+
+    async waitForOfferPage(title?: string): Promise<void> {
+        await this.waitForPortalToOpen();
+        await this.emailInput.waitFor({state: 'visible'});
+
+        if (title) {
+            await this.headingWithText(title).waitFor({state: 'visible'});
+        }
+    }
+}
diff --git a/e2e/helpers/playwright/flows/index.ts b/e2e/helpers/playwright/flows/index.ts
@@ -1,4 +1,5 @@
 export * from './donations';
+export * from './offers';
 export * from './sign-in';
 export * from './signup';
 export * from './tiers';
diff --git a/e2e/helpers/playwright/flows/offers.ts b/e2e/helpers/playwright/flows/offers.ts
@@ -0,0 +1,66 @@
+import {FakeStripeCheckoutPage, HomePage, PortalAccountPage} from '@/helpers/pages';
+import {MembersService} from '@/helpers/services/members/members-service';
+import {PortalOfferPage} from '@/portal-pages';
+import {faker} from '@faker-js/faker';
+import type {MemberSubscription} from '@/helpers/services/members/members-service';
+import type {Page} from '@playwright/test';
+import type {StripeTestService} from '@/helpers/services/stripe';
+
+export async function completeOfferSignupViaPortal(page: Page, stripe: StripeTestService, opts?: {emailAddress?: string; name?: string}): Promise<{emailAddress: string; name: string}> {
+    const offerPage = new PortalOfferPage(page);
+    const emailAddress = opts?.emailAddress ?? `test${faker.string.uuid()}@ghost.org`;
+    const name = opts?.name ?? faker.person.fullName();
+
+    await offerPage.fillAndSubmit(emailAddress, name);
+    await offerPage.continueIfVisible();
+
+    const fakeCheckoutPage = new FakeStripeCheckoutPage(page);
+    await fakeCheckoutPage.waitUntilLoaded();
+    await stripe.completeLatestSubscriptionCheckout({name});
+
+    const latestCheckoutSession = stripe.getCheckoutSessions().at(-1);
+    const successUrl = latestCheckoutSession?.response.success_url;
+
+    if (!successUrl) {
+        throw new Error('Latest Stripe checkout session does not include a success URL');
+    }
+
+    await page.goto(successUrl);
+
+    return {emailAddress, name};
+}
+
+export async function redeemOfferViaPortal(page: Page, stripe: StripeTestService, opts?: {
+    emailAddress?: string;
+    name?: string;
+}): Promise<{
+    accountPage: PortalAccountPage;
+    emailAddress: string;
+    name: string;
+    subscription: MemberSubscription;
+}> {
+    const membersService = new MembersService(page.request);
+    const {emailAddress, name} = await completeOfferSignupViaPortal(page, stripe, opts);
+
+    const homePage = new HomePage(page);
+    await homePage.goto();
+    await homePage.openAccountPortal();
+
+    const accountPage = new PortalAccountPage(page);
+    await accountPage.waitForPortalToOpen();
+    await accountPage.emailText(emailAddress).waitFor({state: 'visible'});
+
+    const member = await membersService.getByEmailWithSubscriptions(emailAddress);
+    const subscription = member.subscriptions[0];
+
+    if (!subscription) {
+        throw new Error(`Expected redeemed offer member ${emailAddress} to have a subscription`);
+    }
+
+    return {
+        accountPage,
+        emailAddress,
+        name,
+        subscription
+    };
+}
diff --git a/e2e/tests/public/portal-offers.test.ts b/e2e/tests/public/portal-offers.test.ts
@@ -1,6 +1,58 @@
 import {OffersService} from '@/helpers/services/offers/offers-service';
-import {PublicPage} from '@/helpers/pages';
-import {createPaidPortalTier, expect, test} from '@/helpers/playwright';
+import {PortalOfferPage, PublicPage} from '@/helpers/pages';
+import {SettingsService} from '@/helpers/services/settings/settings-service';
+import {createPaidPortalTier, expect, redeemOfferViaPortal, test} from '@/helpers/playwright';
+import type {AdminOffer, OfferCreateInput} from '@/helpers/services/offers/offers-service';
+import type {HttpClient} from '@/data-factory';
+import type {StripeTestService} from '@/helpers/services/stripe';
+
+const MEMBER_NAME = 'Testy McTesterson';
+
+type SignupOfferInput = Pick<OfferCreateInput, 'amount' | 'duration' | 'duration_in_months' | 'type'> & {
+    codePrefix: string;
+    tierNamePrefix: string;
+};
+
+// TODO: Move this setup into an OfferFactory-backed helper that owns tier creation,
+// portal settings, and Stripe sync instead of keeping it local to the test file.
+async function createSignupOffer(request: HttpClient, stripe: StripeTestService, input: SignupOfferInput): Promise<AdminOffer> {
+    const offersService = new OffersService(request);
+    const settingsService = new SettingsService(request);
+    const suffix = Date.now();
+    const tierName = `${input.tierNamePrefix} ${suffix}`;
+
+    await settingsService.updateSettings([{key: 'portal_button', value: true}]);
+
+    const tier = await createPaidPortalTier(request, {
+        name: tierName,
+        currency: 'usd',
+        monthly_price: 600,
+        yearly_price: 6000
+    });
+    await waitForTierStripeSync(stripe, tierName);
+
+    return await offersService.createOffer({
+        name: 'Black Friday Special',
+        code: `${input.codePrefix}-${suffix}`,
+        cadence: 'month',
+        amount: input.amount,
+        duration: input.duration,
+        duration_in_months: input.duration_in_months ?? null,
+        tierId: tier.id,
+        type: input.type
+    });
+}
+
+async function waitForTierStripeSync(stripe: StripeTestService, tierName: string): Promise<void> {
+    await expect.poll(() => {
+        const product = stripe.getProducts().find(item => item.name === tierName);
+        if (!product) {
+            return 0;
+        }
+
+        return stripe.getPrices().filter(item => item.product === product.id).length;
+    }, {timeout: 10000}).toBe(2);
+}
 
 test.describe('Ghost Public - Portal Offers', () => {
     test.use({stripeEnabled: true});
@@ -53,4 +105,112 @@ test.describe('Ghost Public - Portal Offers', () => {
         await expect(publicPage.portalPopupFrame).toHaveCount(0);
         await expect(page).not.toHaveURL(/#\/portal\/offers\//);
     });
+
+    test('free trial offer opens in portal - redemption shows free trial state', async ({page, stripe}) => {
+        const offer = await createSignupOffer(page.request, stripe!, {
+            amount: 14,
+            codePrefix: 'trial-offer',
+            duration: 'trial',
+            tierNamePrefix: 'Trial Offer Tier',
+            type: 'trial'
+        });
+
+        const publicPage = new PublicPage(page);
+        await publicPage.gotoOfferCode(offer.code);
+
+        const offerPage = new PortalOfferPage(page);
+        await offerPage.waitForOfferPage(offer.name);
+        await expect(offerPage.headingWithText(offer.name)).toBeVisible();
+        await expect(offerPage.text('14 days free')).toBeVisible();
+        await expect(offerPage.text('Try free for 14 days')).toBeVisible();
+
+        const {accountPage, subscription} = await redeemOfferViaPortal(page, stripe!, {name: MEMBER_NAME});
+        await expect(accountPage.freeTrialLabel).toBeVisible();
+        expect(subscription.offer?.id).toBe(offer.id);
+        expect(subscription.offer_redemptions?.some(item => item.id === offer.id)).toBe(true);
+        expect(subscription.status).toBe('trialing');
+    });
+
+    test('one-time discount offer opens in portal - redemption shows discounted plan label', async ({page, stripe}) => {
+        const offer = await createSignupOffer(page.request, stripe!, {
+            amount: 10,
+            codePrefix: 'once-offer',
+            duration: 'once',
+            tierNamePrefix: 'One-time Offer Tier',
+            type: 'percent'
+        });
+
+        const publicPage = new PublicPage(page);
+        await publicPage.gotoOfferCode(offer.code);
+
+        const offerPage = new PortalOfferPage(page);
+        await offerPage.waitForOfferPage(offer.name);
+        await expect(offerPage.headingWithText(offer.name)).toBeVisible();
+        await expect(offerPage.text(/^10% off$/)).toBeVisible();
+        await expect(offerPage.text(/\$5\.40/)).toBeVisible();
+        await expect(offerPage.text('10% off for first month')).toBeVisible();
+
+        const {accountPage, subscription} = await redeemOfferViaPortal(page, stripe!, {name: MEMBER_NAME});
+        await expect(accountPage.offerLabel).toContainText('$5.40/month');
+        await expect(accountPage.offerLabel).toContainText('Ends');
+        expect(subscription.offer?.id).toBe(offer.id);
+        expect(subscription.offer_redemptions?.some(item => item.id === offer.id)).toBe(true);
+        expect(subscription.offer?.duration).toBe('once');
+    });
+
+    test('repeating discount offer opens in portal - redemption shows discounted plan label', async ({page, stripe}) => {
+        const offer = await createSignupOffer(page.request, stripe!, {
+            amount: 10,
+            codePrefix: 'repeating-offer',
+            duration: 'repeating',
+            duration_in_months: 3,
+            tierNamePrefix: 'Repeating Offer Tier',
+            type: 'percent'
+        });
+
+        const publicPage = new PublicPage(page);
+        await publicPage.gotoOfferCode(offer.code);
+
+        const offerPage = new PortalOfferPage(page);
+        await offerPage.waitForOfferPage(offer.name);
+        await expect(offerPage.headingWithText(offer.name)).toBeVisible();
+        await expect(offerPage.text(/^10% off$/)).toBeVisible();
+        await expect(offerPage.text(/\$5\.40/)).toBeVisible();
+        await expect(offerPage.text('10% off for first 3 months')).toBeVisible();
+
+        const {accountPage, subscription} = await redeemOfferViaPortal(page, stripe!, {name: MEMBER_NAME});
+        await expect(accountPage.offerLabel).toContainText('$5.40/month');
+        await expect(accountPage.offerLabel).toContainText('Ends');
+        expect(subscription.offer?.id).toBe(offer.id);
+        expect(subscription.offer_redemptions?.some(item => item.id === offer.id)).toBe(true);
+        expect(subscription.offer?.duration).toBe('repeating');
+        expect(subscription.offer?.duration_in_months).toBe(3);
+    });
+
+    test('forever discount offer opens in portal - redemption shows discounted plan label', async ({page, stripe}) => {
+        const offer = await createSignupOffer(page.request, stripe!, {
+            amount: 10,
+            codePrefix: 'forever-offer',
+            duration: 'forever',
+            tierNamePrefix: 'Forever Offer Tier',
+            type: 'percent'
+        });
+
+        const publicPage = new PublicPage(page);
+        await publicPage.gotoOfferCode(offer.code);
+
+        const offerPage = new PortalOfferPage(page);
+        await offerPage.waitForOfferPage(offer.name);
+        await expect(offerPage.headingWithText(offer.name)).toBeVisible();
+        await expect(offerPage.text(/^10% off$/)).toBeVisible();
+        await expect(offerPage.text(/\$5\.40/)).toBeVisible();
+        await expect(offerPage.text('10% off forever')).toBeVisible();
+
+        const {accountPage, subscription} = await redeemOfferViaPortal(page, stripe!, {name: MEMBER_NAME});
+        await expect(accountPage.offerLabel).toContainText('$5.40/month');
+        await expect(accountPage.offerLabel).toContainText('Forever');
+        expect(subscription.offer?.id).toBe(offer.id);
+        expect(subscription.offer_redemptions?.some(item => item.id === offer.id)).toBe(true);
+        expect(subscription.offer?.duration).toBe('forever');
+    });
 });
diff --git a/ghost/core/test/e2e-browser/portal/offers.spec.js b/ghost/core/test/e2e-browser/portal/offers.spec.js

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`export * from './donations';`
	`2`	`+export * from './offers';`
`2`	`3`	`export * from './sign-in';`
`3`	`4`	`export * from './signup';`
`4`	`5`	`export * from './tiers';`