feat(auth): set up App Store modules

packages/fxa-auth-server/bin/key_server.js

@@ -9,7 +9,7 @@ const jwtool = require('fxa-jwtool');
 const { StatsD } = require('hot-shots');
 const { Container } = require('typedi');
 const { StripeHelper } = require('../lib/payments/stripe');
-const { PlayBilling } = require('../lib/payments/google-play');
+const { PlayBilling } = require('../lib/payments/iap/google-play');
 const { CurrencyHelper } = require('../lib/payments/currencies');
 const {
   AuthLogger,

packages/fxa-auth-server/config/index.ts

@@ -780,6 +780,28 @@ const conf = convict({
         env: 'PAYPAL_NVP_SIGNATURE',
       },
     },
+    appStore: {
+      credentials: {
+        doc: 'Map of AppStore Connect credentials by app bundle ID',
+        format: Object,
+        default: {
+          // Cannot use an actual bundleId (e.g. 'org.mozilla.ios.FirefoxVPN') as the key
+          // due to https://github.com/mozilla/node-convict/issues/250
+          org_mozilla_ios_FirefoxVPN: {
+            issuerId: 'issuer_id',
+            serverApiKey: 'key',
+            serverApiKeyId: 'key_id',
+          },
+        },
+        env: 'APP_STORE_CREDENTIALS',
+      },
+      sandbox: {
+        doc: 'Apple App Store Sandbox mode',
+        format: Boolean,
+        env: 'APP_STORE_SANDBOX',
+        default: true,
+      },
+    },
     playApiServiceAccount: {
       credentials: {
         client_email: {

packages/fxa-auth-server/lib/payments/capability.ts

@@ -11,9 +11,9 @@ import { commaSeparatedListToArray } from './utils';
 import error from '../error';
 import { authEvents } from '../events';
 import { AuthLogger, AuthRequest, ProfileClient } from '../types';
-import { PlayBilling } from './google-play/play-billing';
-import { SubscriptionPurchase } from './google-play/subscription-purchase';
-import { PurchaseQueryError } from './google-play/types';
+import { PlayBilling } from './iap/google-play/play-billing';
+import { SubscriptionPurchase } from './iap/google-play/subscription-purchase';
+import { PurchaseQueryError } from './iap/google-play/types';
 import { StripeHelper } from './stripe';
 
 function hex(blob: Buffer | string): string {

packages/fxa-auth-server/lib/payments/iap/apple-app-store/app-store-helper.ts

@@ -0,0 +1,78 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+import {
+  AppStoreServerAPI,
+  Environment,
+  StatusResponse,
+} from 'app-store-server-api';
+import { Container } from 'typedi';
+
+import { AppConfig, AuthLogger } from '../../../types';
+import { AppStoreHelperError } from './types/errors';
+
+export class AppStoreHelper {
+  private log: AuthLogger;
+  private appStoreServerApiClients: {
+    [key: string]: AppStoreServerAPI;
+  };
+  private credentialsByBundleId: any;
+  private environment: Environment;
+
+  constructor() {
+    this.log = Container.get(AuthLogger);
+    const {
+      subscriptions: { appStore },
+    } = Container.get(AppConfig);
+    this.credentialsByBundleId = {};
+    // Initialize App Store Server API client per bundle ID
+    this.environment = appStore.sandbox
+      ? Environment.Sandbox
+      : Environment.Production;
+    this.appStoreServerApiClients = {};
+    for (const [bundleIdWithUnderscores, credentials] of Object.entries(
+      appStore.credentials
+    )) {
+      // Cannot use an actual bundleId (e.g. 'org.mozilla.ios.FirefoxVPN') as the key
+      // due to https://github.com/mozilla/node-convict/issues/250
+      const bundleId = bundleIdWithUnderscores.replace('_', '.');
+      this.credentialsByBundleId[bundleId] = credentials;
+      this.clientByBundleId(bundleId);
+    }
+  }
+
+  /**
+   * Returns an App Store Server API client by bundleId, initializing it first
+   * if needed.
+   */
+  clientByBundleId(bundleId: string): AppStoreServerAPI {
+    if (this.appStoreServerApiClients.hasOwnProperty(bundleId)) {
+      return this.appStoreServerApiClients[bundleId];
+    }
+    if (!this.credentialsByBundleId.hasOwnProperty(bundleId)) {
+      const libraryError = new Error(
+        `No App Store credentials found for app with bundleId: ${bundleId}.`
+      );
+      libraryError.name = AppStoreHelperError.CREDENTIALS_NOT_FOUND;
+      throw libraryError;
+    }
+    const { serverApiKey, serverApiKeyId, issuerId } =
+      this.credentialsByBundleId[bundleId];
+    this.appStoreServerApiClients[bundleId] = new AppStoreServerAPI(
+      serverApiKey,
+      serverApiKeyId,
+      issuerId,
+      bundleId,
+      this.environment
+    );
+    return this.appStoreServerApiClients[bundleId];
+  }
+
+  async getSubscriptionStatuses(
+    bundleId: string,
+    originalTransactionId: string
+  ): Promise<StatusResponse> {
+    const apiClient = this.clientByBundleId(bundleId);
+    return apiClient.getSubscriptionStatuses(originalTransactionId);
+  }
+}

packages/fxa-auth-server/lib/payments/iap/apple-app-store/apple-iap.ts

@@ -0,0 +1,29 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+import { Firestore } from '@google-cloud/firestore';
+import { Container } from 'typedi';
+
+import { AppConfig, AuthFirestore, AuthLogger } from '../../../types';
+import { AppStoreHelper } from './app-store-helper';
+import { PurchaseManager } from './purchase-manager';
+
+export class AppleIAP {
+  private firestore: Firestore;
+  private log: AuthLogger;
+  private prefix: string;
+
+  public purchaseManager: PurchaseManager;
+  constructor() {
+    this.log = Container.get(AuthLogger);
+    const appStoreHelper = new AppStoreHelper();
+
+    this.firestore = Container.get(AuthFirestore);
+    const { authFirestore } = Container.get(AppConfig);
+    this.prefix = `${authFirestore.prefix}iap-`;
+    const purchasesDbRef = this.firestore.collection(
+      `${this.prefix}app-store-purchases`
+    );
+    this.purchaseManager = new PurchaseManager(purchasesDbRef, appStoreHelper);
+  }
+}

packages/fxa-auth-server/lib/payments/iap/apple-app-store/errors.ts

@@ -0,0 +1,17 @@
+/**
+ * Error Codes representing an error that is temporary to Apple
+ * and should be retried again without changes.
+ * https://developer.apple.com/documentation/appstoreserverapi/error_codes
+ */
+export const APP_STORE_RETRY_ERRORS = [4040002, 4040004, 5000001, 4040006];
+
+export class AppStoreRetryableError extends Error {
+  public errorCode: number;
+  public errorMessage: string;
+
+  constructor(errorCode: number, errorMessage: string) {
+    super(errorMessage);
+    this.name = 'AppStoreRetryableError';
+    this.errorCode = errorCode;
+  }
+}

packages/fxa-auth-server/lib/payments/iap/apple-app-store/index.ts

@@ -0,0 +1,5 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+export { AppleIAP } from './apple-iap';