Android promotion info is pulled through

guardian · Mar 13, 2024 · 3abe9bd · 3abe9bd
1 parent 8036806
commit 3abe9bd
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 8 deletions.
diff --git a/typescript/src/pubsub/google.ts b/typescript/src/pubsub/google.ts
@@ -23,7 +23,9 @@ interface SubscriptionNotification {
 }
 
 interface MetaData {
-    freeTrial: boolean
+    freeTrial: boolean,
+    promotionType: number | null,
+    promotionCode: string | null
 }
 
 export function parsePayload(body: Option<string>): Error | DeveloperNotification {
@@ -62,8 +64,11 @@ async function fetchMetadata(notification: DeveloperNotification): Promise<MetaD
             notification.subscriptionNotification.purchaseToken,
             notification.packageName
         );
+
         return {
-            freeTrial : subscription?.paymentState === GOOGLE_PAYMENT_STATE.FREE_TRIAL
+            freeTrial : subscription?.paymentState === GOOGLE_PAYMENT_STATE.FREE_TRIAL,
+            promotionType : subscription?.promotionType ?? null,
+            promotionCode : subscription?.promotionCode ?? null
         }
     } catch (exception) {
         // here we really don't want to stop the processing of that event if we can't fetch metadata,
@@ -90,6 +95,16 @@ export function toDynamoEvent(notification: DeveloperNotification, metaData?: Me
         console.warn(`Unknown package name ${notification.packageName}`)
     }
 
+    // See: https://developers.google.com/android-publisher/api-ref/rest/v3/purchases.subscriptions#SubscriptionPurchase
+    let promotionType
+    if (metaData?.promotionType === 0) {
+        promotionType = "ONE_TIME_CODE"
+    } else if (metaData?.promotionType === 1) {
+        promotionType = "VANITY_CODE"
+    } else {
+        promotionType = null
+    }
+
     return new SubscriptionEvent(
         notification.subscriptionNotification.purchaseToken,
         eventTimestamp + "|" + eventTypeString,
@@ -102,8 +117,8 @@ export function toDynamoEvent(notification: DeveloperNotification, metaData?: Me
         notification,
         null,
         dateToSecondTimestamp(thirtyMonths(eventTime)),
-        null,      // string | null ; Introduced during the Apple extension of SubscriptionEvent [2023-11-03]
-        null,      // string | null ; Introduced during the Apple extension of SubscriptionEvent [2023-11-03]
+        metaData?.promotionCode ?? null, // `promotionCode` (only present when the `promotionType` is a "VANITY_CODE") is taken as the `promotional_offer_id`
+        promotionType ?? null, // `promotionType` is taken as the `promotional_offer_name` 
         undefined, // any ; Introduced during the Apple extension of SubscriptionEvent [2023-11-03]
         undefined, // any ; Introduced during the Apple extension of SubscriptionEvent [2023-11-03]
         undefined  // any ; Introduced during the Apple extension of SubscriptionEvent [2023-11-03]

diff --git a/typescript/src/services/google-play.ts b/typescript/src/services/google-play.ts
@@ -47,7 +47,9 @@ export interface GoogleResponseBody {
     expiryTimeMillis: string,
     userCancellationTimeMillis: string,
     autoRenewing: boolean,
-    paymentState: 0 | 1 | 2 | 3
+    paymentState: 0 | 1 | 2 | 3,
+    promotionType: number,
+    promotionCode: string
 }
 
 export async function fetchGoogleSubscription(subscriptionId: string, purchaseToken: string, packageName: string): Promise<GoogleResponseBody | null> {

diff --git a/typescript/tests/pubsub/pubsub.test.ts b/typescript/tests/pubsub/pubsub.test.ts
@@ -23,7 +23,7 @@ describe("The google pubsub", () => {
 
         const mockSqsFunction: Mock<Promise<any>, [string, {purchaseToken: string}]> = jest.fn((queurl, event) => Promise.resolve({}));
 
-        const mockFetchMetadataFunction: Mock<Promise<any>> = jest.fn(event => Promise.resolve({freeTrial: true}));
+        const mockFetchMetadataFunction: Mock<Promise<any>> = jest.fn(event => Promise.resolve({freeTrial: true, promotionType: 1, promotionCode: "100"}));
 
         const receivedEvent = {
             "version":"1.0",
@@ -89,8 +89,8 @@ describe("The google pubsub", () => {
             },
             null,
             1582319167,
-            null,
-            null,
+            "100",
+            "VANITY_CODE",
             undefined,
             undefined,
             undefined