Typescript support workers #6480

rupertbates · 2024-11-04T16:40:55Z

What are you doing in this PR?

This PR is the first step in migrating the support-workers state machine from Scala to Typescript.

There are a lot of changes in this PR, but they broadly break down into the following categories:

CDK changes to support deploying a Typescript lamba
boiler plate for a Typescript project - package.json, tsconfig.json etc.
Typescript schemas for all the state models passed between the various lambdas
One Typescript lambda - the CreatePaymentMethod one

In retrospect it probably would have been better to do the infrastructure stuff on its own as a separate PR but I did a lot of this over 2 days of a hack day so I didn't have time to make and merge incremental PRs.

Once this PR is merged, the CreatePaymentMethod step of the state machine will run from the Typescript lambda whilst all the others continue to run from the Scala ones. We can then swap the other lambdas out one by one, and delete the old scala code.

I have tested this in code with the following:

Supporter plus purchase with Visa, Mastercard, Discovery, Google Pay, Apple Pay, PayPal and Direct Debit
Guardian Weekly gift purchase with credit card.
Newspaper with Amex
Ran the smoke tests successfully

github-actions · 2024-11-04T16:43:19Z

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

All deployment options

From guardian/actions-riff-raff.

github-actions · 2024-11-04T16:44:28Z

Size Change: 0 B

Total Size: 1.89 MB

ℹ️ View Unchanged

Filename	Size
`./public/compiled-assets/javascripts/[countryGroupId]/events/router.js`	90.3 kB
`./public/compiled-assets/javascripts/[countryGroupId]/router.js`	93.4 kB
`./public/compiled-assets/javascripts/ausMomentMap.js`	108 kB
`./public/compiled-assets/javascripts/contributionsRedirectStyles.js`	20 B
`./public/compiled-assets/javascripts/digitalSubscriptionLandingPage.js`	222 kB
`./public/compiled-assets/javascripts/downForMaintenancePage.js`	67.3 kB
`./public/compiled-assets/javascripts/error404Page.js`	67.3 kB
`./public/compiled-assets/javascripts/error500Page.js`	67.2 kB
`./public/compiled-assets/javascripts/favicons.js`	617 B
`./public/compiled-assets/javascripts/paperSubscriptionCheckoutPage.js`	163 kB
`./public/compiled-assets/javascripts/paperSubscriptionLandingPage.js`	87.6 kB
`./public/compiled-assets/javascripts/payPalErrorPage.js`	65.9 kB
`./public/compiled-assets/javascripts/payPalErrorPageStyles.js`	20 B
`./public/compiled-assets/javascripts/promotionTerms.js`	73.5 kB
`./public/compiled-assets/javascripts/subscriptionsLandingPage.js`	72.9 kB
`./public/compiled-assets/javascripts/subscriptionsRedemptionPage.js`	118 kB
`./public/compiled-assets/javascripts/unsupportedBrowserStyles.js`	20 B
`./public/compiled-assets/javascripts/weeklySubscriptionCheckoutPage.js`	160 kB
`./public/compiled-assets/javascripts/weeklySubscriptionLandingPage.js`	88.2 kB
`./public/compiled-assets/webpack/114.js`	12.2 kB
`./public/compiled-assets/webpack/127.js`	3.53 kB
`./public/compiled-assets/webpack/136.js`	2.17 kB
`./public/compiled-assets/webpack/163.js`	8.9 kB
`./public/compiled-assets/webpack/187.js`	20 kB
`./public/compiled-assets/webpack/192.js`	5.69 kB
`./public/compiled-assets/webpack/276.js`	4.39 kB
`./public/compiled-assets/webpack/344.js`	2 kB
`./public/compiled-assets/webpack/445.js`	6.87 kB
`./public/compiled-assets/webpack/492.js`	7.58 kB
`./public/compiled-assets/webpack/706.js`	107 kB
`./public/compiled-assets/webpack/719.js`	13.5 kB
`./public/compiled-assets/webpack/847.js`	26 kB
`./public/compiled-assets/webpack/969.js`	37.8 kB
`./public/compiled-assets/webpack/checkout.js`	17.2 kB
`./public/compiled-assets/webpack/GuardianAdLiteLanding.js`	8.27 kB
`./public/compiled-assets/webpack/LandingPage.js`	15.5 kB
`./public/compiled-assets/webpack/oneTimeCheckout.js`	6.07 kB
`./public/compiled-assets/webpack/ThankYou.js`	44.4 kB

_{compressed-size-action}

github-actions · 2024-11-04T16:45:02Z

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

All deployment options

From guardian/actions-riff-raff.

rupertbates · 2025-01-30T15:22:36Z

cdk/lib/support-workers.ts

      "PreparePaymentMethodForReuse"
    ).addCatch(failureHandler, catchProps);

-    const createPaymentMethodLambda = createLambda(
+    const createPaymentMethodLambda = createTypescriptLambda(


This is the first and only (for now) lambda migrated to Typescript

rupertbates · 2025-01-31T17:05:33Z

support-workers/deploy-to-code.sh

@@ -0,0 +1,13 @@
+S3_BUCKET="membership-dist"


This is a shell script to simplify deploying the zipped artifact to CODE for a quicker testing cycle

rupertbates · 2025-01-31T17:09:38Z

support-workers/package.json

+    "check-formatting": "prettier --check **.ts",
+    "build": "tsc",
+    "clean-target": "rm -rf target && mkdir -p target",
+    "install-runtime-dependencies": "yarn install --modules-folder target/typescript/node_modules --production",


This line installs only the runtime (non-dev) dependencies into the target directory so they can be zipped up into the deployment artifact

rupertbates · 2025-02-03T10:36:54Z

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

@@ -0,0 +1,194 @@
+import { combinedAddressLine } from '../model/address';


Lambda and application code start here

rupertbates · 2025-02-03T10:38:38Z

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

@@ -0,0 +1,94 @@
+import {


Tests and json fixtures from here on except for some small utility classes and the tsconfig file at the end

cdk/lib/support-workers.ts

johnduffell · 2025-02-03T11:33:15Z

cdk/lib/support-workers.ts

+        fileName: `support-workers.jar`,
+        runtime: Runtime.JAVA_21,
        handler: `com.gu.support.workers.lambdas.${lambdaName}::handleRequest`,
        functionName: `${this.stack}-${lambdaName}Lambda-${this.stage}`,


assume everything is just a duplicate between scala->ts other than these 4 lines?

The functionName is the same so it's just the three lines difference

consider making it a function that only takes those 3 parameters, to make it clearer they are the same

johnduffell · 2025-02-03T11:33:32Z

cdk/lib/support-workers.ts

+      });
+      this.overrideLogicalId(lambda, {
+        logicalId: lambdaId,
+        reason: "Moving existing lambda to CDK",


this probably doesn't make sense any more does it?

The comment? I think it's roughly accurate, what else would we put?

so it's a permanent change? (I realise it was not added from your PR)
In my mind I thought it needed to be overridden during the switch over to avoid clashes and then it could be removed?
Maybe if it's needed to match up with log group names or state machine definitions it would be something like
"Align function name with state machine definition"?

johnduffell · 2025-02-03T14:28:21Z

.github/workflows/support-workers-build.yml

@@ -97,6 +102,13 @@ jobs:
                    - "-PreparePaymentMethodForReuseLambda-"
                  fileName: support-workers.jar
                dependencies: [cfn]
+              support-workers-typescript:


I'm glad you've distinguished them by their language as it's clearer 👍 (vs the change from product-move-api -> product-switch-api)

johnduffell · 2025-02-03T14:29:42Z

support-workers/deploy-to-code.sh

+S3_BUCKET="membership-dist"
+S3_KEY="support/CODE/support-workers-typescript/support-workers.zip"
+LAMBDA_FUNCTIONS=(
+  "-CreatePaymentMethodLambda-"


why not put the - where it's used rather than in (every) function name?
support-${function}-CODE

Otherwise it gets serialised to a date time which the Scala code can't deserialise. Once we are using TS lambdas for the whole state machine we could revisit this.

rupertbates force-pushed the support-workers-cdk branch from 4865852 to ab74f26 Compare November 8, 2024 12:16

rupertbates force-pushed the typescript-support-workers branch from 98a1a59 to 7860f54 Compare November 11, 2024 16:41

Base automatically changed from support-workers-cdk to main November 12, 2024 10:50

rupertbates force-pushed the typescript-support-workers branch 2 times, most recently from cfd14ef to 0324201 Compare November 13, 2024 13:24

rupertbates force-pushed the typescript-support-workers branch 2 times, most recently from 32d6a8b to 1bf2ef2 Compare December 19, 2024 13:42

rupertbates force-pushed the typescript-support-workers branch from 1bf2ef2 to 52c75a7 Compare January 29, 2025 13:17

rupertbates commented Jan 30, 2025

View reviewed changes

rupertbates force-pushed the typescript-support-workers branch from 5e7fbb5 to 0434c11 Compare January 31, 2025 15:47

rupertbates commented Jan 31, 2025

View reviewed changes

rupertbates force-pushed the typescript-support-workers branch 2 times, most recently from 26037ea to 48f39b0 Compare February 3, 2025 10:34

rupertbates commented Feb 3, 2025

View reviewed changes

rupertbates requested review from tjmw and johnduffell February 3, 2025 10:39

johnduffell reviewed Feb 3, 2025

View reviewed changes

cdk/lib/support-workers.ts Outdated Show resolved Hide resolved

johnduffell reviewed Feb 3, 2025

View reviewed changes

rupertbates added 2 commits February 3, 2025 13:36

package.json for support-workers

d837252

zod schemas for lambda state classes

b3b9d2e

rupertbates force-pushed the typescript-support-workers branch from 48f39b0 to 773b901 Compare February 3, 2025 13:36

johnduffell changed the title ~~Typescript support workers~~ Reimplement support-workers CreatePaymentMethod lambda in Typescript Feb 3, 2025

johnduffell reviewed Feb 3, 2025

View reviewed changes

rupertbates added 26 commits February 3, 2025 18:13

Rename lambda module to createPaymentMethod.ts

8afc3c6

Snapshot

18544f8

Correct filename for createPaymentMethodLambda.ts

700ca39

PaymentFields is now a discriminated union

519b1eb

Discriminated union for paymentFields and appliedPromotion schema

38c9d65

Working on createPaymentMethodLambda.ts

c17325f

PayPalService and supporting config

6589710

Start work on Stripe

7958755

Stripe and serviceHandler

d50cb2d

Remove Sepa

abbaa5b

Use groups runner for Jest tests

b831ea4

Fix test and package script

ca4fdd4

Don't specify dist directory

78bebc7

Add path to lambdas directory for handler

5afbcbe

Add path to lambdas directory for handler

fb331ed

Include node_modules in package zip

5ce458b

Parse lambda input

344c221

Add deploy to code script

e7978d1

Sort out state shape

f69a94a

Tidy up types

8206eee

Tidy up build script

23819df

Convert Stripe card type to Zuora card type

2d3c723

Add Guardian Ad-Lite

5420698

Keep firstDeliveryDate as a string in the base state model

77d54c0

Otherwise it gets serialised to a date time which the Scala code can't deserialise. Once we are using TS lambdas for the whole state machine we could revisit this.

Fix path to zip in support-workers-build.yml

44bebe2

Only bundle runtime dependencies in deployment artifact

dd44d6c

rupertbates force-pushed the typescript-support-workers branch from 8c4140a to 1811f3a Compare February 3, 2025 18:13

Tick off some TODOs

7657069

rupertbates force-pushed the typescript-support-workers branch from 1811f3a to 7657069 Compare February 3, 2025 18:19

johnduffell changed the title ~~Reimplement support-workers CreatePaymentMethod lambda in Typescript~~ Typescript support workers Feb 3, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Typescript support workers #6480

Typescript support workers #6480

rupertbates commented Nov 4, 2024 •

edited

Loading

github-actions bot commented Nov 4, 2024 •

edited

Loading

github-actions bot commented Nov 4, 2024 •

edited

Loading

github-actions bot commented Nov 4, 2024 •

edited

Loading

rupertbates Jan 30, 2025

rupertbates Jan 31, 2025

rupertbates Jan 31, 2025

rupertbates Feb 3, 2025

rupertbates Feb 3, 2025 •

edited

Loading

johnduffell Feb 3, 2025

rupertbates Feb 3, 2025

johnduffell Feb 3, 2025

johnduffell Feb 3, 2025

rupertbates Feb 3, 2025

johnduffell Feb 3, 2025

johnduffell Feb 3, 2025

johnduffell Feb 3, 2025

		@@ -0,0 +1,194 @@
		import { combinedAddressLine } from '../model/address';

Typescript support workers #6480

Are you sure you want to change the base?

Typescript support workers #6480

Conversation

rupertbates commented Nov 4, 2024 • edited Loading

What are you doing in this PR?

github-actions bot commented Nov 4, 2024 • edited Loading

github-actions bot commented Nov 4, 2024 • edited Loading

github-actions bot commented Nov 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rupertbates Feb 3, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rupertbates commented Nov 4, 2024 •

edited

Loading

github-actions bot commented Nov 4, 2024 •

edited

Loading

github-actions bot commented Nov 4, 2024 •

edited

Loading

github-actions bot commented Nov 4, 2024 •

edited

Loading

rupertbates Feb 3, 2025 •

edited

Loading