cfw-autumn/server/tests/basic/multi-feature/multi_feature3.ts

import { expect } from "chai";
import chalk from "chalk";
import { Autumn } from "@/external/autumn/autumnCli.js";
import { features } from "tests/global.js";
import { setupBefore } from "tests/before.js";
import { initCustomer } from "tests/utils/init.js";
import {
  AppEnv,
  BillingInterval,
  EntInterval,
  UsageModel,
} from "@autumn/shared";
import { createProduct } from "tests/utils/productUtils.js";
import { getMainCusProduct } from "tests/utils/cusProductUtils/cusProductUtils.js";
import {
  getLifetimeFreeCusEnt,
  getUsageCusEnt,
} from "tests/utils/cusProductUtils/cusEntSearchUtils.js";

import {
  constructFeatureItem,
  constructFeaturePriceItem,
} from "@/internal/products/product-items/productItemUtils.js";
import { SupabaseClient } from "@supabase/supabase-js";
import { timeout } from "@/utils/genUtils.js";
import {
  advanceClockForInvoice,
  advanceTestClock,
} from "tests/utils/stripeUtils.js";
import { initCustomerWithTestClock } from "tests/utils/testInitUtils.js";
import { addDays } from "date-fns";

// Scenario 1: prepaid + pay per use monthly -> prepaid + pay per use monthly
let pro = {
  id: "multiFeature3Pro",
  name: "Multi Feature 3 Pro",
  items: {
    lifetime: constructFeatureItem({
      feature_id: features.metered1.id,
      included_usage: 50,
      interval: EntInterval.Lifetime,
    }),
    payPerUse: constructFeaturePriceItem({
      feature_id: features.metered1.id,
      included_usage: 0,
      price: 0.5,
      interval: BillingInterval.Month,
      usage_model: UsageModel.PayPerUse,
    }),
  },
};

export const getLifetimeAndUsageCusEnts = async ({
  customerId,
  sb,
  orgId,
  env,
  featureId,
}: {
  customerId: string;
  sb: SupabaseClient;
  orgId: string;
  env: AppEnv;
  featureId: string;
}) => {
  let mainCusProduct = await getMainCusProduct({
    customerId,
    sb,
    orgId,
    env,
  });

  let lifetimeCusEnt = getLifetimeFreeCusEnt({
    cusProduct: mainCusProduct,
    featureId,
  });

  let usageCusEnt = getUsageCusEnt({
    cusProduct: mainCusProduct,
    featureId,
  });

  return { lifetimeCusEnt, usageCusEnt };
};

// UNCOMMENT FROM HERE
describe(`${chalk.yellowBright(
  "multi-feature/multi_feature3: Testing lifetime + pay per use, advance test clock"
)}`, () => {
  let autumn: Autumn;
  let customerId = "multiFeature3Customer";

  let totalUsage = 0;

  let testClockId: string;
  before(async function () {
    await setupBefore(this);

    let { customer, testClockId: _testClockId } =
      await initCustomerWithTestClock({
        customerId,
        sb: this.sb,
        org: this.org,
        env: this.env,
      });

    testClockId = _testClockId;

    autumn = this.autumn;

    await createProduct({
      autumn,
      product: pro,
    });
  });

  it("should attach pro product to customer", async function () {
    await autumn.attach({
      customerId,
      productId: pro.id,
    });

    let { lifetimeCusEnt, usageCusEnt } = await getLifetimeAndUsageCusEnts({
      customerId,
      sb: this.sb,
      orgId: this.org.id,
      env: this.env,
      featureId: features.metered1.id,
    });

    expect(lifetimeCusEnt?.balance).to.equal(pro.items.lifetime.included_usage);

    expect(usageCusEnt?.balance).to.equal(pro.items.payPerUse.included_usage);
  });

  let overageValue = 30;
  it("should use lifetime allowance + overage", async function () {
    let value = pro.items.lifetime.included_usage as number;
    value += overageValue;

    await autumn.events.send({
      customerId,
      value,
      featureId: features.metered1.id,
    });

    totalUsage += value;

    await timeout(3000);

    let { lifetimeCusEnt, usageCusEnt } = await getLifetimeAndUsageCusEnts({
      customerId,
      sb: this.sb,
      orgId: this.org.id,
      env: this.env,
      featureId: features.metered1.id,
    });

    expect(lifetimeCusEnt?.balance).to.equal(0);
    expect(usageCusEnt?.balance).to.equal(-overageValue);
  });

  it("cycle 1:should have correct usage after first cycle", async function () {
    let advanceTo = addDays(new Date(), 30).getTime();
    await advanceTestClock({
      stripeCli: this.stripeCli,
      testClockId,
      advanceTo,
    });

    // let { invoices } = await autumn.customers.get(customerId);
    // expect(invoices[0].total).to.equal(overageValue * (pro.items.payPerUse.amount ?? 0));

    let { lifetimeCusEnt, usageCusEnt } = await getLifetimeAndUsageCusEnts({
      customerId,
      sb: this.sb,
      orgId: this.org.id,
      env: this.env,
      featureId: features.metered1.id,
    });

    expect(lifetimeCusEnt?.balance).to.equal(0);
    expect(usageCusEnt?.balance).to.equal(0);
  });
});