Function decreaseProgrammaticCredits

front/lib/api/programmatic_usage/tracking.ts:120–251

(
  auth: Authenticator,
  {
    amountMicroUsd,
    userMessageOrigin,
  }: {
    amountMicroUsd: number;
    userMessageOrigin: UserMessageOrigin;
  },
  parentLogger?: Logger
)

// This method might be called with credits depleted. In that case we log amounts
// for tracking but do not take any other action.
export async function decreaseProgrammaticCredits(
  auth: Authenticator,
  {
    amountMicroUsd,
    userMessageOrigin,
  }: {
    amountMicroUsd: number;
    userMessageOrigin: UserMessageOrigin;
  },
  parentLogger?: Logger
): Promise<{
  totalConsumedMicroUsd: number;
  totalInitialMicroUsd: number;
  activeCredits: CreditResource[];
}> {
  const localLogger = parentLogger ?? logger;
  const workspace = auth.getNonNullableWorkspace();
  const activeCredits = await CreditResource.listActive(auth);

  const sortedCredits = [...activeCredits].sort(compareCreditsForConsumption);

  const totalConsumedBeforeMicroUsd = activeCredits.reduce(
    (sum, c) => sum + c.consumedAmountMicroUsd,
    0
  );
  const totalInitialMicroUsd = activeCredits.reduce(
    (sum, c) => sum + c.initialAmountMicroUsd,
    0
  );

  let remainingAmountMicroUsd = amountMicroUsd;
  let consumedAmountMicroUsd = 0;

  while (remainingAmountMicroUsd > 0) {
    const credit = sortedCredits.shift();
    if (!credit) {
      // Create an excess credit to track over-consumption.
      // This ensures that sum(consumed credits) = total usage.
      const now = new Date();
      try {
        await CreditResource.makeNew(auth, {
          type: "excess",
          initialAmountMicroUsd: remainingAmountMicroUsd,
          consumedAmountMicroUsd: remainingAmountMicroUsd,
          startDate: now,
          expirationDate: now,
        });
        localLogger.warn(
          {
            initialAmountMicroUsd: amountMicroUsd,
            remainingAmountMicroUsd,
          },
          "[Programmatic Usage Tracking] No more credits available, created excess credit."
        );
      } catch (err) {
        localLogger.error(
          {
            initialAmountMicroUsd: amountMicroUsd,