Applying comments from review

Shopify · Aug 15, 2022 · 54b6057 · 54b6057
1 parent fa37ae5
commit 54b6057
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 20 deletions.
diff --git a/docs/usage/billing.md b/docs/usage/billing.md
@@ -40,21 +40,21 @@ This method will take in the following parameters:
 
 And return the following:
 
-| Parameter         | Type                   | Notes                                               |
-| ----------------- | ---------------------- | --------------------------------------------------- |
-| `hasPayment`      | `boolean`              | Whether the store has already paid for the app      |
-| `confirmationUrl` | `string` / `undefined` | The URL to redirect to if payment is still required |
+| Parameter           | Type                   | Notes                                               |
+| ------------------- | ---------------------- | --------------------------------------------------- |
+| `hasPayment`        | `boolean`              | Whether the store has already paid for the app      |
+| `confirmBillingUrl` | `string` / `undefined` | The URL to redirect to if payment is still required |
 
 Here's a typical example of how to use `check`:
 
 ```ts
-const {hasPayment, confirmationUrl} = await Shopify.Billing.check({
+const {hasPayment, confirmBillingUrl} = await Shopify.Billing.check({
   session,
   isTest: true,
 });
 
 if (!hasPayment) {
-  return redirect(confirmationUrl);
+  return redirect(confirmBillingUrl);
 }
 
 // Proceed with app logic

diff --git a/src/billing/__tests__/check.test.ts b/src/billing/__tests__/check.test.ts
@@ -47,7 +47,7 @@ describe('check', () => {
 
         expect(response).toEqual({
           hasPayment: false,
-          confirmationUrl: CONFIRMATION_URL,
+          confirmBillingUrl: CONFIRMATION_URL,
         });
         expect(fetchMock).toHaveBeenCalledTimes(2);
         expect(fetchMock).toHaveBeenNthCalledWith(
@@ -71,6 +71,26 @@ describe('check', () => {
       }),
     );
 
+    test('defaults to test purchases', async () => {
+      fetchMock.mockResponses(EMPTY_SUBSCRIPTIONS, PURCHASE_ONE_TIME_RESPONSE);
+
+      const response = await check({session});
+
+      expect(response).toEqual({
+        hasPayment: false,
+        confirmBillingUrl: CONFIRMATION_URL,
+      });
+      expect(fetchMock).toHaveBeenCalledTimes(2);
+
+      const parsedBody = JSON.parse(
+        fetchMock.mock.calls[1][1]!.body!.toString(),
+      );
+      expect(parsedBody).toMatchObject({
+        query: expect.stringContaining('appPurchaseOneTimeCreate'),
+        variables: expect.objectContaining({test: true}),
+      });
+    });
+
     test('does not request payment if there is one', async () => {
       fetchMock.mockResponses(EXISTING_ONE_TIME_PAYMENT);
 
@@ -81,7 +101,7 @@ describe('check', () => {
 
       expect(response).toEqual({
         hasPayment: true,
-        confirmationUrl: undefined,
+        confirmBillingUrl: undefined,
       });
       expect(fetchMock).toHaveBeenCalledTimes(1);
       expect(fetchMock).toHaveBeenNthCalledWith(
@@ -106,7 +126,7 @@ describe('check', () => {
 
       expect(response).toEqual({
         hasPayment: false,
-        confirmationUrl: CONFIRMATION_URL,
+        confirmBillingUrl: CONFIRMATION_URL,
       });
       expect(fetchMock).toHaveBeenCalledTimes(2);
       expect(fetchMock).toHaveBeenNthCalledWith(
@@ -135,7 +155,7 @@ describe('check', () => {
 
       expect(response).toEqual({
         hasPayment: true,
-        confirmationUrl: undefined,
+        confirmBillingUrl: undefined,
       });
       expect(fetchMock).toHaveBeenCalledTimes(2);
 
@@ -193,7 +213,7 @@ describe('check', () => {
 
         expect(response).toEqual({
           hasPayment: false,
-          confirmationUrl: CONFIRMATION_URL,
+          confirmBillingUrl: CONFIRMATION_URL,
         });
         expect(fetchMock).toHaveBeenCalledTimes(2);
         expect(fetchMock).toHaveBeenNthCalledWith(
@@ -217,6 +237,29 @@ describe('check', () => {
       }),
     );
 
+    test('defaults to test purchases', async () => {
+      fetchMock.mockResponses(
+        EMPTY_SUBSCRIPTIONS,
+        PURCHASE_SUBSCRIPTION_RESPONSE,
+      );
+
+      const response = await check({session});
+
+      expect(response).toEqual({
+        hasPayment: false,
+        confirmBillingUrl: CONFIRMATION_URL,
+      });
+      expect(fetchMock).toHaveBeenCalledTimes(2);
+
+      const parsedBody = JSON.parse(
+        fetchMock.mock.calls[1][1]!.body!.toString(),
+      );
+      expect(parsedBody).toMatchObject({
+        query: expect.stringContaining('appSubscriptionCreate'),
+        variables: expect.objectContaining({test: true}),
+      });
+    });
+
     test('does not request subscription if there is one', async () => {
       fetchMock.mockResponses(EXISTING_SUBSCRIPTION);
 
@@ -227,7 +270,7 @@ describe('check', () => {
 
       expect(response).toEqual({
         hasPayment: true,
-        confirmationUrl: undefined,
+        confirmBillingUrl: undefined,
       });
 
       expect(fetchMock).toHaveBeenCalledTimes(1);

diff --git a/src/billing/check.ts b/src/billing/check.ts
@@ -6,31 +6,31 @@ import {requestPayment} from './request_payment';
 
 interface CheckInterface {
   session: SessionInterface;
-  isTest: boolean;
+  isTest?: boolean;
 }
 
 interface CheckReturn {
   hasPayment: boolean;
-  confirmationUrl?: string;
+  confirmBillingUrl?: string;
 }
 
 export async function check({
   session,
-  isTest,
+  isTest = true,
 }: CheckInterface): Promise<CheckReturn> {
   if (!Context.BILLING) {
-    return {hasPayment: true, confirmationUrl: undefined};
+    return {hasPayment: true, confirmBillingUrl: undefined};
   }
 
-  let hasPayment;
-  let confirmationUrl;
+  let hasPayment: boolean;
+  let confirmBillingUrl: string | undefined;
 
   if (await hasActivePayment(session, isTest)) {
     hasPayment = true;
   } else {
     hasPayment = false;
-    confirmationUrl = await requestPayment(session, isTest);
+    confirmBillingUrl = await requestPayment(session, isTest);
   }
 
-  return {hasPayment, confirmationUrl};
+  return {hasPayment, confirmBillingUrl};
 }