Merge pull request #20210 from mozilla/fxa-12618

test(auth-server): migrate IAP and PayPal Mocha tests to Jest

Author: vbudhram

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

@@ -0,0 +1,138 @@
+/* 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/. */
+
+/** Migrated from test/local/payments/iap/apple-app-store/app-store-helper.js (Mocha → Jest). */
+
+import sinon from 'sinon';
+import { Container } from 'typedi';
+
+import { AuthLogger, AppConfig } from '../../../types';
+
+const { mockLog } = require('../../../../test/mocks');
+
+// Mock AppStoreServerAPI to avoid PKCS#8 key parsing
+const mockAppStoreServerAPI: any = {};
+jest.mock('app-store-server-api', () => {
+  const actual = jest.requireActual('app-store-server-api');
+  return {
+    ...actual,
+    AppStoreServerAPI: function () {
+      return mockAppStoreServerAPI;
+    },
+  };
+});
+
+// Must require after jest.mock
+const { AppStoreHelper } = require('./app-store-helper');
+
+const mockBundleIdWithUnderscores = 'org_mozilla_ios_FirefoxVPN';
+const mockBundleId = mockBundleIdWithUnderscores.replace(/_/g, '.');
+const mockConfig = {
+  subscriptions: {
+    appStore: {
+      credentials: {
+        [mockBundleIdWithUnderscores]: {
+          issuerId: 'issuer_id',
+          serverApiKey: 'key',
+          serverApiKeyId: 'key_id',
+        },
+      },
+      sandbox: true,
+    },
+  },
+};
+
+describe('AppStoreHelper', () => {
+  let appStoreHelper: any;
+  let sandbox: sinon.SinonSandbox;
+  let log: any;
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox();
+    log = mockLog();
+    Container.set(AuthLogger, log);
+    Container.set(AppConfig, mockConfig);
+    appStoreHelper = Container.get(AppStoreHelper);
+  });
+
+  afterEach(() => {
+    Container.reset();
+    sandbox.restore();
+  });
+
+  it('can be instantiated', () => {
+    const appStoreServerApiClients = {
+      [mockBundleId]: mockAppStoreServerAPI,
+    };
+    const credentialsByBundleId = {
+      [mockBundleId]:
+        mockConfig.subscriptions.appStore.credentials[
+          mockBundleIdWithUnderscores
+        ],
+    };
+    expect(appStoreHelper.log).toBe(log);
+    expect(appStoreHelper.appStoreServerApiClients).toEqual(
+      appStoreServerApiClients
+    );
+    expect(appStoreHelper.credentialsByBundleId).toEqual(credentialsByBundleId);
+    expect(appStoreHelper.environment).toBe('Sandbox');
+  });
+
+  describe('clientByBundleId', () => {
+    let mockApiClient: any;
+
+    beforeEach(() => {
+      mockApiClient = {};
+    });
+
+    it('returns the existing API client for the bundleId', () => {
+      appStoreHelper.appStoreServerApiClients[mockBundleId] = mockApiClient;
+      const actual = appStoreHelper.clientByBundleId(mockBundleId);
+      const expected = mockApiClient;
+      expect(actual).toEqual(expected);
+    });
+    it("initializes an API client for a given bundleId if it doesn't exist", () => {
+      appStoreHelper.appStoreServerApiClients = {};
+      const actual = appStoreHelper.clientByBundleId(mockBundleId);
+      const expected = mockAppStoreServerAPI;
+      expect(actual).toEqual(expected);
+    });
+    it('throws an error if no credentials are found for the given bundleId', () => {
+      appStoreHelper.appStoreServerApiClients = {};
+      appStoreHelper.credentialsByBundleId = {};
+      const expectedMessage = `No App Store credentials found for app with bundleId: ${mockBundleId}.`;
+      expect(() => appStoreHelper.clientByBundleId(mockBundleId)).toThrow(
+        expectedMessage
+      );
+    });
+  });
+
+  describe('getSubscriptionStatuses', () => {
+    it('calls the corresponding method on the API client', async () => {
+      const mockOriginalTransactionId = '100000000';
+      // Mock App Store Client API response
+      const expected = { data: 'wow' };
+      mockAppStoreServerAPI.getSubscriptionStatuses = sinon
+        .stub()
+        .resolves(expected);
+      appStoreHelper.clientByBundleId = sandbox
+        .stub()
+        .returns(mockAppStoreServerAPI);
+      const actual = await appStoreHelper.getSubscriptionStatuses(
+        mockBundleId,
+        mockOriginalTransactionId
+      );
+      expect(actual).toEqual(expected);
+
+      sinon.assert.calledOnceWithExactly(
+        appStoreHelper.clientByBundleId,
+        mockBundleId
+      );
+      sinon.assert.calledOnceWithExactly(
+        mockAppStoreServerAPI.getSubscriptionStatuses,
+        mockOriginalTransactionId
+      );
+    });
+  });
+});

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

@@ -0,0 +1,70 @@
+/* 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/. */
+
+/** Migrated from test/local/payments/iap/apple-app-store/apple-iap.js (Mocha → Jest). */
+
+// Mock AppStoreHelper to avoid PKCS#8 key parsing in AppStoreServerAPI constructor
+jest.mock('./app-store-helper', () => ({
+  AppStoreHelper: class MockAppStoreHelper {},
+}));
+
+import sinon from 'sinon';
+import { Container } from 'typedi';
+
+import { AuthFirestore, AuthLogger, AppConfig } from '../../../types';
+import { AppleIAP } from '.';
+
+const { mockLog } = require('../../../../test/mocks');
+
+const mockConfig = {
+  authFirestore: {
+    prefix: 'mock-fxa-',
+  },
+  subscriptions: {
+    appStore: {
+      credentials: {
+        org_mozilla_ios_FirefoxVPN: {
+          issuerId: 'issuer_id',
+          serverApiKey: 'key',
+          serverApiKeyId: 'key_id',
+        },
+      },
+    },
+  },
+};
+
+describe('AppleIAP', () => {
+  let collectionMock: sinon.SinonStub;
+  let purchasesDbRefMock: any;
+  let sandbox: sinon.SinonSandbox;
+  let firestore: any;
+  let log: any;
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox();
+    log = mockLog();
+    collectionMock = sinon.stub();
+    firestore = {
+      collection: collectionMock,
+    };
+    purchasesDbRefMock = {};
+    collectionMock.returns(purchasesDbRefMock);
+    Container.set(AuthFirestore, firestore);
+    Container.set(AuthLogger, log);
+    Container.set(AppConfig, mockConfig);
+    Container.remove(AppleIAP);
+  });
+
+  afterEach(() => {
+    Container.reset();
+    sandbox.restore();
+  });
+
+  it('can be instantiated', () => {
+    const appleIAP = Container.get(AppleIAP);
+    expect((appleIAP as any).log).toBe(log);
+    expect((appleIAP as any).firestore).toBe(firestore);
+    expect((appleIAP as any).prefix).toBe('mock-fxa-iap-');
+  });
+});