browser/libs/common/src/billing/services/organization-billing.service.spec.ts

import { mock } from "jest-mock-extended";

import { ApiService } from "@bitwarden/common/abstractions/api.service";
import { OrganizationApiServiceAbstraction as OrganizationApiService } from "@bitwarden/common/admin-console/abstractions/organization/organization-api.service.abstraction";
import {
  BillingApiServiceAbstraction,
  PaymentInformation,
  SubscriptionInformation,
} from "@bitwarden/common/billing/abstractions";
import { PaymentMethodType, PlanType } from "@bitwarden/common/billing/enums";
import { OrganizationBillingService } from "@bitwarden/common/billing/services/organization-billing.service";
import { EncryptService } from "@bitwarden/common/key-management/crypto/abstractions/encrypt.service";
import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.service";
import { SyncService } from "@bitwarden/common/platform/sync";
import { newGuid } from "@bitwarden/guid";
// This import has been flagged as unallowed for this class. It may be involved in a circular dependency loop.
// eslint-disable-next-line no-restricted-imports
import { KeyService } from "@bitwarden/key-management";
import { UserId } from "@bitwarden/user-core";

import { OrganizationKeysRequest } from "../../admin-console/models/request/organization-keys.request";
import { OrganizationResponse } from "../../admin-console/models/response/organization.response";
import { EncString } from "../../key-management/crypto/models/enc-string";
import { SymmetricCryptoKey } from "../../platform/models/domain/symmetric-crypto-key";
import { OrgKey } from "../../types/key";

describe("OrganizationBillingService", () => {
  let apiService: jest.Mocked<ApiService>;
  let billingApiService: jest.Mocked<BillingApiServiceAbstraction>;
  let keyService: jest.Mocked<KeyService>;
  let encryptService: jest.Mocked<EncryptService>;
  let i18nService: jest.Mocked<I18nService>;
  let organizationApiService: jest.Mocked<OrganizationApiService>;
  let syncService: jest.Mocked<SyncService>;

  let sut: OrganizationBillingService;

  const mockUserId = newGuid() as UserId;

  beforeEach(() => {
    apiService = mock<ApiService>();
    billingApiService = mock<BillingApiServiceAbstraction>();
    keyService = mock<KeyService>();
    encryptService = mock<EncryptService>();
    i18nService = mock<I18nService>();
    organizationApiService = mock<OrganizationApiService>();
    syncService = mock<SyncService>();

    sut = new OrganizationBillingService(
      apiService,
      billingApiService,
      keyService,
      encryptService,
      i18nService,
      organizationApiService,
      syncService,
    );
  });

  afterEach(() => {
    return jest.resetAllMocks();
  });

  describe("purchaseSubscription()", () => {
    it("given valid subscription information, then it returns successful response", async () => {
      //Arrange
      const subscriptionInformation = {
        organization: { name: "test-business", billingEmail: "test@test.com" },
        plan: { type: PlanType.EnterpriseAnnually2023 },
        payment: {
          paymentMethod: ["card-token", PaymentMethodType.Card],
          billing: { postalCode: "12345" },
        },
      } as SubscriptionInformation;

      const organizationResponse = {
        name: subscriptionInformation.organization.name,
        billingEmail: subscriptionInformation.organization.billingEmail,
        planType: subscriptionInformation.plan!.type,
      } as OrganizationResponse;

      organizationApiService.create.mockResolvedValue(organizationResponse);
      keyService.makeOrgKey.mockResolvedValue([new EncString("encrypted-key"), {} as OrgKey]);
      keyService.makeKeyPair.mockResolvedValue(["key", new EncString("encrypted-key")]);
      encryptService.encryptString.mockResolvedValue(new EncString("collection-encrypted"));

      //Act
      const response = await sut.purchaseSubscription(subscriptionInformation, mockUserId);

      //Assert
      expect(organizationApiService.create).toHaveBeenCalledTimes(1);
      expect(response).toEqual(organizationResponse);
    });

    it("given organization creation fails, then it throws an error", async () => {
      // Arrange
      const subscriptionInformation = {
        organization: { name: "test-business", billingEmail: "test@test.com" },
        plan: { type: PlanType.EnterpriseAnnually2023 },
        payment: {
          paymentMethod: ["card-token", PaymentMethodType.Card],
          billing: { postalCode: "12345" },
        },
      } as SubscriptionInformation;

      organizationApiService.create.mockRejectedValue(new Error("Failed to create organization"));
      keyService.makeOrgKey.mockResolvedValue([new EncString("encrypted-key"), {} as OrgKey]);
      keyService.makeKeyPair.mockResolvedValue(["key", new EncString("encrypted-key")]);
      encryptService.encryptString.mockResolvedValue(new EncString("collection-encrypted"));

      // Act & Assert
      await expect(sut.purchaseSubscription(subscriptionInformation, mockUserId)).rejects.toThrow(
        "Failed to create organization",
      );
    });

    it("given key generation fails, then it throws an error", async () => {
      // Arrange
      const subscriptionInformation = {
        organization: { name: "test-business", billingEmail: "test@test.com" },
        plan: { type: PlanType.EnterpriseAnnually2023 },
        payment: {
          paymentMethod: ["card-token", PaymentMethodType.Card],
          billing: { postalCode: "12345" },
        },
      } as SubscriptionInformation;

      keyService.makeOrgKey.mockRejectedValue(new Error("Key generation failed"));

      // Act & Assert
      await expect(sut.purchaseSubscription(subscriptionInformation, mockUserId)).rejects.toThrow(
        "Key generation failed",
      );
    });

    it("given an invalid plan type, then it throws an error", async () => {
      // Arrange
      const subscriptionInformation = {
        organization: { name: "test-business", billingEmail: "test@test.com" },
        plan: { type: -1 as unknown as PlanType },
        payment: {
          paymentMethod: ["card-token", PaymentMethodType.Card],
          billing: { postalCode: "12345" },
        },
      } as SubscriptionInformation;

      // Act & Assert
      await expect(sut.purchaseSubscription(subscriptionInformation, mockUserId)).rejects.toThrow();
    });
  });

  describe("purchaseSubscriptionNoPaymentMethod()", () => {
    it("given valid subscription information, then it returns successful response", async () => {
      //Arrange
      const subscriptionInformation = {
        organization: { name: "test-business", billingEmail: "test@test.com" },
        plan: { type: PlanType.EnterpriseAnnually2023 },
      } as SubscriptionInformation;

      const organizationResponse = {
        name: subscriptionInformation.organization.name,
        plan: { type: subscriptionInformation.plan!.type },
        planType: subscriptionInformation.plan!.type,
      } as OrganizationResponse;

      organizationApiService.createWithoutPayment.mockResolvedValue(organizationResponse);
      keyService.makeOrgKey.mockResolvedValue([new EncString("encrypted-key"), {} as OrgKey]);
      keyService.makeKeyPair.mockResolvedValue(["key", new EncString("encrypted-key")]);
      encryptService.encryptString.mockResolvedValue(new EncString("collection-encrypted"));

      //Act
      const response = await sut.purchaseSubscriptionNoPaymentMethod(
        subscriptionInformation,
        mockUserId,
      );

      //Assert
      expect(organizationApiService.createWithoutPayment).toHaveBeenCalledTimes(1);
      expect(response).toEqual(organizationResponse);
    });

    it("given organization creation fails without payment method, then it throws an error", async () => {
      const subscriptionInformation = {
        organization: { name: "test-business", billingEmail: "test@test.com" },
        plan: { type: PlanType.EnterpriseAnnually2023 },
      } as SubscriptionInformation;

      organizationApiService.createWithoutPayment.mockRejectedValue(new Error("Creation failed"));
      keyService.makeOrgKey.mockResolvedValue([new EncString("encrypted-key"), {} as OrgKey]);
      keyService.makeKeyPair.mockResolvedValue(["key", new EncString("encrypted-key")]);
      encryptService.encryptString.mockResolvedValue(new EncString("collection-encrypted"));

      await expect(
        sut.purchaseSubscriptionNoPaymentMethod(subscriptionInformation, mockUserId),
      ).rejects.toThrow("Creation failed");
    });

    it("given key generation fails, then it throws an error", async () => {
      const subscriptionInformation = {
        organization: { name: "test-business", billingEmail: "test@test.com" },
        plan: { type: PlanType.EnterpriseAnnually2023 },
      } as SubscriptionInformation;

      keyService.makeOrgKey.mockRejectedValue(new Error("Key generation failed"));
      keyService.makeKeyPair.mockResolvedValue(["key", new EncString("encrypted-key")]);

      await expect(
        sut.purchaseSubscriptionNoPaymentMethod(subscriptionInformation, mockUserId),
      ).rejects.toThrow("Key generation failed");
    });
  });

  describe("startFree()", () => {
    it("given valid free plan information, then it creates a free organization", async () => {
      const subscriptionInformation = {
        organization: { name: "test-business", billingEmail: "test@test.com" },
        plan: { type: PlanType.Free },
      } as SubscriptionInformation;

      const organizationResponse = {
        name: subscriptionInformation.organization.name,
        billingEmail: subscriptionInformation.organization.billingEmail,
        planType: subscriptionInformation.plan!.type,
      } as OrganizationResponse;

      organizationApiService.create.mockResolvedValue(organizationResponse);
      keyService.makeOrgKey.mockResolvedValue([new EncString("encrypted-key"), {} as OrgKey]);
      keyService.makeKeyPair.mockResolvedValue(["key", new EncString("encrypted-key")]);
      encryptService.encryptString.mockResolvedValue(new EncString("collection-encrypted"));

      //Act
      const response = await sut.startFree(subscriptionInformation, mockUserId);

      //Assert
      expect(organizationApiService.create).toHaveBeenCalledTimes(1);
      expect(response).toEqual(organizationResponse);
    });

    it("given key generation fails, then it throws an error", async () => {
      const subscriptionInformation = {
        organization: { name: "test-business", billingEmail: "test@test.com" },
        plan: { type: PlanType.Free },
      } as SubscriptionInformation;

      keyService.makeOrgKey.mockRejectedValue(new Error("Key generation failed"));
      keyService.makeKeyPair.mockResolvedValue(["key", new EncString("encrypted-key")]);

      await expect(sut.startFree(subscriptionInformation, mockUserId)).rejects.toThrow(
        "Key generation failed",
      );
    });

    it("given organization creation fails, then it throws an error", async () => {
      // Arrange
      const subscriptionInformation = {
        organization: { name: "test-business", billingEmail: "test@test.com" },
        plan: { type: PlanType.Free },
      } as SubscriptionInformation;

      organizationApiService.create.mockRejectedValue(new Error("Failed to create organization"));
      keyService.makeOrgKey.mockResolvedValue([new EncString("encrypted-key"), {} as OrgKey]);
      keyService.makeKeyPair.mockResolvedValue(["key", new EncString("encrypted-key")]);
      encryptService.encryptString.mockResolvedValue(new EncString("collection-encrypted"));
      // Act & Assert
      await expect(sut.startFree(subscriptionInformation, mockUserId)).rejects.toThrow(
        "Failed to create organization",
      );
    });
  });

  describe("organization key creation methods", () => {
    const organizationKeys = {
      orgKey: new SymmetricCryptoKey(new Uint8Array(64)) as OrgKey,
      publicKeyEncapsulatedOrgKey: new EncString("encryptedOrgKey"),
      publicKey: "public-key",
      encryptedPrivateKey: new EncString("encryptedPrivateKey"),
    };
    const encryptedCollectionName = new EncString("encryptedCollectionName");
    const mockSubscription = {
      organization: {
        name: "Test Org",
        businessName: "Test Business",
        billingEmail: "test@example.com",
        initiationPath: "Registration form",
      },
      plan: {
        type: 0, // Free plan
        passwordManagerSeats: 0,
        subscribeToSecretsManager: false,
        isFromSecretsManagerTrial: false,
      },
    } as SubscriptionInformation;
    const mockResponse = { id: "org-id" } as OrganizationResponse;

    const expectedRequestObject = {
      name: "Test Org",
      businessName: "Test Business",
      billingEmail: "test@example.com",
      initiationPath: "Registration form",
      planType: 0,
      key: organizationKeys.publicKeyEncapsulatedOrgKey.encryptedString,
      keys: new OrganizationKeysRequest(
        organizationKeys.publicKey,
        organizationKeys.encryptedPrivateKey.encryptedString!,
      ),
      collectionName: encryptedCollectionName.encryptedString,
    };

    beforeEach(() => {
      keyService.makeOrgKey.mockResolvedValue([
        organizationKeys.publicKeyEncapsulatedOrgKey,
        organizationKeys.orgKey,
      ]);
      keyService.makeKeyPair.mockResolvedValue([
        organizationKeys.publicKey,
        organizationKeys.encryptedPrivateKey,
      ]);
      encryptService.encryptString.mockResolvedValueOnce(encryptedCollectionName);
      i18nService.t.mockReturnValue("Default Collection");

      organizationApiService.create.mockResolvedValue(mockResponse);
    });

    describe("purchaseSubscription", () => {
      it("sets the correct organization keys on the organization creation request", async () => {
        const subscriptionWithPayment = {
          ...mockSubscription,
          payment: {
            paymentMethod: ["test-token", PaymentMethodType.Card],
            billing: {
              postalCode: "12345",
              country: "US",
            },
          } as PaymentInformation,
        } as SubscriptionInformation;
        const result = await sut.purchaseSubscription(subscriptionWithPayment, mockUserId);

        expect(keyService.makeOrgKey).toHaveBeenCalledWith(mockUserId);
        expect(keyService.makeKeyPair).toHaveBeenCalledWith(organizationKeys.orgKey);
        expect(encryptService.encryptString).toHaveBeenCalledWith(
          "Default Collection",
          organizationKeys.orgKey,
        );
        expect(organizationApiService.create).toHaveBeenCalledWith(
          expect.objectContaining(expectedRequestObject),
        );
        expect(apiService.refreshIdentityToken).toHaveBeenCalled();
        expect(syncService.fullSync).toHaveBeenCalledWith(true);
        expect(result).toBe(mockResponse);
      });
    });

    describe("purchaseSubscriptionNoPaymentMethod", () => {
      it("sets the correct organization keys on the organization creation request", async () => {
        organizationApiService.createWithoutPayment.mockResolvedValue(mockResponse);

        const result = await sut.purchaseSubscriptionNoPaymentMethod(mockSubscription, mockUserId);

        expect(keyService.makeOrgKey).toHaveBeenCalledWith(mockUserId);
        expect(keyService.makeKeyPair).toHaveBeenCalledWith(organizationKeys.orgKey);
        expect(encryptService.encryptString).toHaveBeenCalledWith(
          "Default Collection",
          organizationKeys.orgKey,
        );
        expect(organizationApiService.createWithoutPayment).toHaveBeenCalledWith(
          expect.objectContaining(expectedRequestObject),
        );
        expect(apiService.refreshIdentityToken).toHaveBeenCalled();
        expect(syncService.fullSync).toHaveBeenCalledWith(true);
        expect(result).toBe(mockResponse);
      });
    });

    describe("startFree", () => {
      it("sets the correct organization keys on the organization creation request", async () => {
        const result = await sut.startFree(mockSubscription, mockUserId);

        expect(keyService.makeOrgKey).toHaveBeenCalledWith(mockUserId);
        expect(keyService.makeKeyPair).toHaveBeenCalledWith(organizationKeys.orgKey);
        expect(encryptService.encryptString).toHaveBeenCalledWith(
          "Default Collection",
          organizationKeys.orgKey,
        );
        expect(organizationApiService.create).toHaveBeenCalledWith(
          expect.objectContaining(expectedRequestObject),
        );
        expect(apiService.refreshIdentityToken).toHaveBeenCalled();
        expect(syncService.fullSync).toHaveBeenCalledWith(true);
        expect(result).toBe(mockResponse);
      });
    });

    describe("restartSubscription", () => {
      it("sets the correct organization keys on the organization creation request", async () => {
        const subscriptionWithPayment = {
          ...mockSubscription,
          payment: {
            paymentMethod: ["test-token", PaymentMethodType.Card],
            billing: {
              postalCode: "12345",
              country: "US",
            },
          } as PaymentInformation,
        } as SubscriptionInformation;

        await sut.restartSubscription("org-id", subscriptionWithPayment, mockUserId);

        expect(keyService.makeOrgKey).toHaveBeenCalledWith(mockUserId);
        expect(keyService.makeKeyPair).toHaveBeenCalledWith(organizationKeys.orgKey);
        expect(encryptService.encryptString).toHaveBeenCalledWith(
          "Default Collection",
          organizationKeys.orgKey,
        );
        expect(billingApiService.restartSubscription).toHaveBeenCalledWith(
          "org-id",
          expect.objectContaining(expectedRequestObject),
        );
      });
    });
  });
});