Typescript CreatePaymentMethodLambda #7017

rupertbates · 2025-05-12T10:45:45Z

What are you doing in this PR?

This PR migrates the CreatePaymentMethod lambda to Typescript it follows on from #7008 and is part of the work to fully migrate support-workers from Scala to Typescript.

Trello Card

Why are you doing this?

Things to test

Make sure FailureHandler understands the errors thrown from TS
Stripe payment in US, UK & AU
Stripe hosted payment
PayPal payment
GoCardless payment

github-actions · 2025-05-12T10:48:08Z

Deploy build 14984 of `support::stripe-patrons-data` to CODE

All deployment options

From guardian/actions-riff-raff.

github-actions · 2025-05-12T10:48:12Z

Size Change: 0 B

Total Size: 1.49 MB

ℹ️ View Unchanged

Filename	Size
`./support-frontend/public/compiled-assets/javascripts/[countryGroupId]/events/router.js`	95.4 kB
`./support-frontend/public/compiled-assets/javascripts/[countryGroupId]/router.js`	104 kB
`./support-frontend/public/compiled-assets/javascripts/ausMomentMap.js`	108 kB
`./support-frontend/public/compiled-assets/javascripts/contributionsRedirectStyles.js`	20 B
`./support-frontend/public/compiled-assets/javascripts/downForMaintenancePage.js`	72 kB
`./support-frontend/public/compiled-assets/javascripts/error404Page.js`	72 kB
`./support-frontend/public/compiled-assets/javascripts/error500Page.js`	71.9 kB
`./support-frontend/public/compiled-assets/javascripts/favicons.js`	618 B
`./support-frontend/public/compiled-assets/javascripts/paperSubscriptionLandingPage.js`	92.8 kB
`./support-frontend/public/compiled-assets/javascripts/payPalErrorPage.js`	70.1 kB
`./support-frontend/public/compiled-assets/javascripts/payPalErrorPageStyles.js`	20 B
`./support-frontend/public/compiled-assets/javascripts/promotionTerms.js`	78.4 kB
`./support-frontend/public/compiled-assets/javascripts/subscriptionsLandingPage.js`	102 kB
`./support-frontend/public/compiled-assets/javascripts/unsupportedBrowserStyles.js`	20 B
`./support-frontend/public/compiled-assets/javascripts/weeklySubscriptionCheckoutPage.js`	162 kB
`./support-frontend/public/compiled-assets/javascripts/weeklySubscriptionLandingPage.js`	95.7 kB
`./support-frontend/public/compiled-assets/webpack/128.js`	7.12 kB
`./support-frontend/public/compiled-assets/webpack/167.js`	24.5 kB
`./support-frontend/public/compiled-assets/webpack/230.js`	28.6 kB
`./support-frontend/public/compiled-assets/webpack/249.js`	34 kB
`./support-frontend/public/compiled-assets/webpack/286.js`	14.6 kB
`./support-frontend/public/compiled-assets/webpack/340.js`	5 kB
`./support-frontend/public/compiled-assets/webpack/709.js`	109 kB
`./support-frontend/public/compiled-assets/webpack/760.js`	5.79 kB
`./support-frontend/public/compiled-assets/webpack/774.js`	7 kB
`./support-frontend/public/compiled-assets/webpack/793.js`	4.35 kB
`./support-frontend/public/compiled-assets/webpack/8.js`	20.1 kB
`./support-frontend/public/compiled-assets/webpack/801.js`	2.18 kB
`./support-frontend/public/compiled-assets/webpack/916.js`	8.9 kB
`./support-frontend/public/compiled-assets/webpack/948.js`	3.5 kB
`./support-frontend/public/compiled-assets/webpack/checkout.js`	18.6 kB
`./support-frontend/public/compiled-assets/webpack/GuardianAdLiteLanding.js`	8.43 kB
`./support-frontend/public/compiled-assets/webpack/LandingPage.js`	15.3 kB
`./support-frontend/public/compiled-assets/webpack/oneTimeCheckout.js`	7.33 kB
`./support-frontend/public/compiled-assets/webpack/ThankYou.js`	43.2 kB

_{compressed-size-action}

github-actions · 2025-05-12T10:50:28Z

Deploy build 24248 of `support:support-workers-mono` to CODE

All deployment options

From guardian/actions-riff-raff.

rupertbates · 2025-06-03T14:37:40Z

support-workers/package.json

@@ -6,13 +6,14 @@
  "scripts": {
    "test": "jest --group=-integration",
    "it-test": "jest --group=integration",
-    "lint": "eslint src/typescript/**/*.ts",
+    "lint:check": "eslint src/typescript/**/*.ts",
+    "lint:fix": "eslint src/typescript/**/*.ts --fix",


These match the commands in support-frontend now for consistency

This reverts commit 4c9d623. # Conflicts: # support-workers/package.json

rupertbates · 2025-06-05T13:52:31Z

support-workers/package.json

@@ -9,10 +9,11 @@
    "lint": "eslint src/typescript/**/*.ts",
    "check-formatting": "prettier --check **.ts",
    "build": "tsc",
+    "bundle": "esbuild src/typescript/lambdas/*.ts --bundle --platform=node --target=node22 --outdir=target/typescript",


I have introduced esbuild as a bundler because it was very difficult to get pnpm to produce a flat set of dependencies for deployment. It should also produce a smaller deployment artifact.

rupertbates · 2025-06-06T09:52:30Z

support-workers/src/typescript/model/billingPeriod.ts

+import { z } from 'zod';
+
+export const billingPeriodSchema = z.union([
+	z.literal('Monthly'), //TODO: share this with support-frontend


I've decided to do all the TODOs around sharing models in a follow up PR because it will probably involve some quite extensive changes

tjmw

I think this looks good, nice work! 👏

I've left a few comments / questions, all minor stuff.

tjmw · 2025-06-06T15:42:29Z

support-workers/package.json

-    "install-runtime-dependencies": "pnpm install --ignore-scripts --modules-dir target/typescript/node_modules --production",
-    "build-and-zip": "pnpm clean-target && pnpm build && pnpm install-runtime-dependencies && cd target/typescript && zip -r support-workers.zip ./* -x \".*\" -x \"__MACOSX\"",
-    "package": "pnpm check-formatting && pnpm lint && pnpm test && pnpm build-and-zip"
+    "zip": "cd target/typescript && zip -r support-workers.zip ./* -x \".*\" -x \"__MACOSX\"",


What's this exclude doing? -x \".*\" I'm finding it hard to parse!

It's dotfiles, probably not needed now that we are using esbuild actually

tjmw · 2025-06-06T15:43:10Z

support-workers/package.json

-    "package": "pnpm check-formatting && pnpm lint && pnpm test && pnpm build-and-zip"
+    "zip": "cd target/typescript && zip -r support-workers.zip ./* -x \".*\" -x \"__MACOSX\"",
+    "bundle-and-zip": "pnpm clean-target && pnpm bundle && pnpm zip",
+    "package": "pnpm check-formatting && pnpm lint:check && pnpm test && pnpm bundle-and-zip"


Does type checking happening implicitly in one of these commands? If not should it be added?

Yes it needs to be added 👍

tjmw · 2025-06-06T15:47:28Z

support-workers/src/typescript/model/paymentFields.ts

+	z.literal('StripeApplePay'),
+	z.literal('StripePaymentRequestButton'),


Any reason not to extract these out to named consts like the others?

tjmw · 2025-06-06T15:53:40Z

support-workers/src/typescript/model/paymentMethod.ts

+		directDebitPaymentGatewaySchema,
+		z.literal('Amazon Pay - Contributions USA'),
+	])
+	.or(stripePaymentGatewaySchema);


What does the .or do here? Is the result the same as adding stripePaymentGatewaySchema to the union?

Yes in this case it actually is, although it isn't in all cases 👍

If fact this schema wasn't actually used

tjmw · 2025-06-06T16:01:45Z

support-workers/src/typescript/test/stateSchemas.test.ts

+		const supporterPlus = createPaymentMethodStateSchema.parse(
+			createPaymentSupporterPlus,
+		);
+		expect(supporterPlus.product.currency).toBe('EUR');
+		expect(supporterPlus.acquisitionData?.ophanIds.pageviewId).toBe(
+			'9999999999999',
+		);


What do you think about splitting each of these product/payment method tests out to their own test/it block? I think it's helpful as it makes it clearer what's going on if there are failures.

tjmw · 2025-06-06T16:10:13Z

support-workers/src/typescript/lambdas/createPaymentMethodLambda.ts

+				),
+			);
+	}
+	return Promise.reject(new Error('Unknown payment method type'));


Is it worth including the unknown type in the error? Might be helpful to know what it was if we ever reach this line.

This is actually unreachable code, I'm surprised it wasn't being flagged by lint

prout-bot · 2025-06-09T13:39:42Z

Seen on PROD (merged by @rupertbates 8 minutes and 47 seconds ago)

Keep an eye out for the post deployment Playwright smoke tests github action
If the tests have failed, the post deployment test runbook should help troubleshoot.

Sentry Release: support-client-side, support

johnduffell · 2025-06-09T14:04:27Z

support-workers/package.json

+    "lint:check": "eslint src/typescript/**/*.ts",
+    "lint:fix": "eslint --fix src/typescript/**/*.ts",
    "check-formatting": "prettier --check **.ts",
    "build": "tsc",
+    "bundle": "esbuild src/typescript/lambdas/*.ts --bundle --platform=node --target=node22 --outdir=target/typescript",
    "clean-target": "rm -rf target && mkdir -p target",
-    "install-runtime-dependencies": "pnpm install --ignore-scripts --modules-dir target/typescript/node_modules --production",
-    "build-and-zip": "pnpm clean-target && pnpm build && pnpm install-runtime-dependencies && cd target/typescript && zip -r support-workers.zip ./* -x \".*\" -x \"__MACOSX\"",
-    "package": "pnpm check-formatting && pnpm lint && pnpm test && pnpm build-and-zip"
+    "zip": "cd target/typescript && zip -r support-workers.zip ./* -x \".*\" -x \"__MACOSX\"",


is there a standard for what these commands should be?

in support service-lambdas we use type-check, lint or lint --fix and check-formatting or fix-formatting
Obviously I'm not working on support-workers much now, but it is already a bit of a pain to remember the commands so it would be nice if they could be consistent across projects

Yes I agree, I might make a health card to standardise them

johnduffell · 2025-06-09T14:11:11Z

support-workers/src/typescript/services/config.ts

+		Name: `/${stage}/support/support-workers/${configKeyName}`,
+		WithDecryption: true,
+	};
+	const command = new GetParameterCommand(params);


I'm actually doing a PR in support-service-lambdas (following the threads on chat) to add a module to retrieve all the separate config keys under a /stage/stack/app/* in one go and parse it as json as a whole.
It's interesting that you've gone for storing the whole config as JSON in a single key though, is that preferred over individual keys? As the idea is the module would encourage our standard supporter revenue way.

johnduffell · 2025-06-09T14:13:05Z

support-workers/src/typescript/services/config.ts

+export async function getConfig<I, O, T extends z.ZodType<O, z.ZodTypeDef, I>>(
+	stage: Stage,
+	configKeyName: string,
+	schema: T,
+): Promise<O> {


why <I, O, T extends z.ZodType<O, z.ZodTypeDef, I>>
with schema: T,
and not <O>
with schema: z.ZodType<O, z.ZodTypeDef, any>
? ( @tjmw and I were looking at similar code and wondering this morning )

rupertbates force-pushed the rb/typescript-support-workers-createPaymentMethod branch 5 times, most recently from 8a9088b to 62d4075 Compare June 3, 2025 14:34

rupertbates commented Jun 3, 2025

View reviewed changes

rupertbates force-pushed the rb/typescript-support-workers-createPaymentMethod branch 3 times, most recently from 6269470 to 192a611 Compare June 4, 2025 09:49

rupertbates added 5 commits June 5, 2025 14:04

Revert "Remove createPaymentMethodLambda to simplify the PR"

d5d6446

This reverts commit 4c9d623. # Conflicts: # support-workers/package.json

Switch createPaymentMethod to typescript

f214f44

Use ESBuild to build deployment files

5f89c1b

Tidy up package.json

ddab9e5

Remove dummy lambda

83d7d70

rupertbates force-pushed the rb/typescript-support-workers-createPaymentMethod branch from 477bf45 to 83d7d70 Compare June 5, 2025 13:09

rupertbates commented Jun 5, 2025

View reviewed changes

rupertbates added 5 commits June 5, 2025 14:57

Standardise lint commands

b7ce2f2

Country schema

6843acf

Fix package command

338559b

ServiceHandler -> ServiceProvider

e7cc032

pr feedback

6e8fe30

rupertbates force-pushed the rb/typescript-support-workers-createPaymentMethod branch from 630469d to 6e8fe30 Compare June 6, 2025 09:48

rupertbates commented Jun 6, 2025

View reviewed changes

rupertbates added 3 commits June 6, 2025 12:00

Pass requestInfo through in the state

f9eeee9

PR feedback

aa49741

Prettier

df65194

rupertbates force-pushed the rb/typescript-support-workers-createPaymentMethod branch from 5f409ee to df65194 Compare June 6, 2025 15:19

tjmw approved these changes Jun 6, 2025

View reviewed changes

rupertbates added 4 commits June 9, 2025 11:52

Build TS in package command

26b5c1f

PR feedback

d030a48

Remove unused schema

73c7e32

Break out multiple test cases into separate tests

f33915e

rupertbates merged commit 5a04958 into main Jun 9, 2025
18 checks passed

rupertbates deleted the rb/typescript-support-workers-createPaymentMethod branch June 9, 2025 13:30

prout-bot added Pending-on-PROD Seen-on-PROD and removed Pending-on-PROD labels Jun 9, 2025

johnduffell reviewed Jun 9, 2025

View reviewed changes

		z.literal('StripeApplePay'),
		z.literal('StripePaymentRequestButton'),

Typescript CreatePaymentMethodLambda #7017

Typescript CreatePaymentMethodLambda #7017

Uh oh!

Conversation

rupertbates commented May 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What are you doing in this PR?

Why are you doing this?

Things to test

Uh oh!

github-actions bot commented May 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tjmw left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

prout-bot commented Jun 9, 2025

Sentry Release: support-client-side, support

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rupertbates commented May 12, 2025 •

edited

Loading

github-actions bot commented May 12, 2025 •

edited

Loading

github-actions bot commented May 12, 2025 •

edited

Loading

github-actions bot commented May 12, 2025 •

edited

Loading