Skip to content

🪢 Open source agent evals & observability: Trace, evaluate, and improve LLM applications with one open platform.

17.6 KB
Raw Blame
import {
  getBillingCycleAnchor,
  getBillingCycleStart,
  getBillingCycleEnd,
  getDaysToLookBack,
  startOfDayUTC,
  endOfDayUTC,
} from "@langfuse/shared/src/server";
import { type Organization } from "@langfuse/shared";

describe("getBillingCycleAnchor", () => {
  it("returns cloudBillingCycleAnchor when set", () => {
    const org = {
      id: "org-1",
      cloudBillingCycleAnchor: new Date("2024-01-15T10:30:00Z"),
      createdAt: new Date("2024-01-01T00:00:00Z"),
    } as Organization;

    const result = getBillingCycleAnchor(org);

    expect(result).toEqual(new Date("2024-01-15T00:00:00Z")); // start of day
  });

  it("falls back to createdAt when cloudBillingCycleAnchor is null", () => {
    const org = {
      id: "org-1",
      cloudBillingCycleAnchor: null,
      createdAt: new Date("2024-01-01T10:30:00Z"),
    } as Organization;

    const result = getBillingCycleAnchor(org);

    expect(result).toEqual(new Date("2024-01-01T00:00:00Z")); // start of day
  });
});

describe("getBillingCycleStart", () => {
  it("handles anchor on 15th consistently across months", () => {
    const org = {
      id: "org-1",
      cloudBillingCycleAnchor: new Date("2024-01-15T00:00:00Z"),
      createdAt: new Date("2024-01-01T00:00:00Z"),
    } as Organization;

    // March 15th reference → cycle starts March 15
    expect(getBillingCycleStart(org, new Date("2024-03-20T10:00:00Z"))).toEqual(
      new Date("2024-03-15T00:00:00Z"),
    );

    // February 10th reference → cycle starts January 15 (previous month)
    expect(getBillingCycleStart(org, new Date("2024-02-10T10:00:00Z"))).toEqual(
      new Date("2024-01-15T00:00:00Z"),
    );
  });

  it("handles anchor on 31st → adjusts to last day of month", () => {
    const org = {
      id: "org-1",
      cloudBillingCycleAnchor: new Date("2024-01-31T00:00:00Z"),
      createdAt: new Date("2024-01-01T00:00:00Z"),
    } as Organization;

    // February (29 days in 2024, leap year) - reference after cycle day → Feb 29
    expect(getBillingCycleStart(org, new Date("2024-03-05T10:00:00Z"))).toEqual(
      new Date("2024-02-29T00:00:00Z"),
    );

    // April (30 days) - reference after cycle day → April 30
    expect(getBillingCycleStart(org, new Date("2024-05-05T10:00:00Z"))).toEqual(
      new Date("2024-04-30T00:00:00Z"),
    );

    // March (31 days) - reference after cycle day → March 31
    expect(getBillingCycleStart(org, new Date("2024-04-05T10:00:00Z"))).toEqual(
      new Date("2024-03-31T00:00:00Z"),
    );
  });

  it("handles leap year February correctly", () => {
    const org = {
      id: "org-1",
      cloudBillingCycleAnchor: new Date("2024-01-31T00:00:00Z"),
      createdAt: new Date("2024-01-01T00:00:00Z"),
    } as Organization;

    // 2024 is leap year - reference after Feb 29 → Feb 29
    expect(getBillingCycleStart(org, new Date("2024-03-01T10:00:00Z"))).toEqual(
      new Date("2024-02-29T00:00:00Z"),
    );

    // 2025 is not leap year - reference after Feb 28 → Feb 28
    const org2025 = {
      ...org,
      cloudBillingCycleAnchor: new Date("2025-01-31T00:00:00Z"),
    } as Organization;

    expect(
      getBillingCycleStart(org2025, new Date("2025-03-01T10:00:00Z")),
    ).toEqual(new Date("2025-02-28T00:00:00Z"));
  });

  it("handles reference date before cycle start in current month", () => {
    const org = {
      id: "org-1",
      cloudBillingCycleAnchor: new Date("2024-01-15T00:00:00Z"),
      createdAt: new Date("2024-01-01T00:00:00Z"),
    } as Organization;

    // Feb 10 (before Feb 15) → goes back to Jan 15
    expect(getBillingCycleStart(org, new Date("2024-02-10T10:00:00Z"))).toEqual(
      new Date("2024-01-15T00:00:00Z"),
    );

    // Feb 15 exactly → stays at Feb 15
    expect(getBillingCycleStart(org, new Date("2024-02-15T00:00:00Z"))).toEqual(
      new Date("2024-02-15T00:00:00Z"),
    );

    // Feb 20 (after Feb 15) → stays at Feb 15
    expect(getBillingCycleStart(org, new Date("2024-02-20T10:00:00Z"))).toEqual(
      new Date("2024-02-15T00:00:00Z"),
    );
  });

  it("handles month boundaries with 31st anchor across year transition", () => {
    const org = {
      id: "org-1",
      cloudBillingCycleAnchor: new Date("2023-12-31T00:00:00Z"),
      createdAt: new Date("2023-12-01T00:00:00Z"),
    } as Organization;

    // Jan 2024 - reference after Jan 31 → Jan 31
    expect(getBillingCycleStart(org, new Date("2024-02-05T10:00:00Z"))).toEqual(
      new Date("2024-01-31T00:00:00Z"),
    );

    // Feb 2024 (leap year) - reference after Feb 29 → Feb 29
    expect(getBillingCycleStart(org, new Date("2024-03-01T10:00:00Z"))).toEqual(
      new Date("2024-02-29T00:00:00Z"),
    );
  });

  it("handles year crossover with December anchor", () => {
    const org = {
      id: "org-1",
      cloudBillingCycleAnchor: new Date("2023-12-15T00:00:00Z"),
      createdAt: new Date("2023-12-01T00:00:00Z"),
    } as Organization;

    // Jan 10 (before Jan 15) → goes back to Dec 15 previous year
    expect(getBillingCycleStart(org, new Date("2024-01-10T10:00:00Z"))).toEqual(
      new Date("2023-12-15T00:00:00Z"),
    );

    // Jan 15 exactly → Jan 15 current year
    expect(getBillingCycleStart(org, new Date("2024-01-15T00:00:00Z"))).toEqual(
      new Date("2024-01-15T00:00:00Z"),
    );

    // Jan 20 (after Jan 15) → Jan 15 current year
    expect(getBillingCycleStart(org, new Date("2024-01-20T10:00:00Z"))).toEqual(
      new Date("2024-01-15T00:00:00Z"),
    );
  });

  it("uses createdAt as fallback when cloudBillingCycleAnchor is null", () => {
    const org = {
      id: "org-1",
      cloudBillingCycleAnchor: null,
      createdAt: new Date("2024-01-15T10:30:00Z"),
    } as Organization;

    expect(getBillingCycleStart(org, new Date("2024-02-20T10:00:00Z"))).toEqual(
      new Date("2024-02-15T00:00:00Z"),
    );
  });
});

describe("getBillingCycleEnd", () => {
  it("returns next month's cycle start for standard day", () => {
    const org = {
      id: "org-1",
      cloudBillingCycleAnchor: new Date("2024-01-15T00:00:00Z"),
      createdAt: new Date("2024-01-01T00:00:00Z"),
    } as Organization;

    // Jan 20 reference → next cycle is Feb 15
    expect(getBillingCycleEnd(org, new Date("2024-01-20T10:00:00Z"))).toEqual(
      new Date("2024-02-15T00:00:00Z"),
    );

    // Feb 20 reference → next cycle is March 15
    expect(getBillingCycleEnd(org, new Date("2024-02-20T10:00:00Z"))).toEqual(
      new Date("2024-03-15T00:00:00Z"),
    );
  });

  it("handles 31st anchor → adjusts to last day of shorter months", () => {
    const org = {
      id: "org-1",
      cloudBillingCycleAnchor: new Date("2024-01-31T00:00:00Z"),
      createdAt: new Date("2024-01-01T00:00:00Z"),
    } as Organization;

    // Jan 15 reference (before first cycle) → next cycle is Jan 31
    expect(getBillingCycleEnd(org, new Date("2024-01-15T10:00:00Z"))).toEqual(
      new Date("2024-01-31T00:00:00Z"),
    );

    // March 15 reference (in Feb-Mar cycle) → next cycle is March 31
    expect(getBillingCycleEnd(org, new Date("2024-03-15T10:00:00Z"))).toEqual(
      new Date("2024-03-31T00:00:00Z"),
    );

    // April 15 reference (in March-April cycle) → next cycle is April 30
    expect(getBillingCycleEnd(org, new Date("2024-04-15T10:00:00Z"))).toEqual(
      new Date("2024-04-30T00:00:00Z"),
    );
  });

  it("handles reference date on cycle day → returns next month", () => {
    const org = {
      id: "org-1",
      cloudBillingCycleAnchor: new Date("2024-01-15T00:00:00Z"),
      createdAt: new Date("2024-01-01T00:00:00Z"),
    } as Organization;

    // Reference on Feb 15 exactly → next cycle is March 15
    expect(getBillingCycleEnd(org, new Date("2024-02-15T00:00:00Z"))).toEqual(
      new Date("2024-03-15T00:00:00Z"),
    );
  });

  it("handles reference date after cycle day in current month", () => {
    const org = {
      id: "org-1",
      cloudBillingCycleAnchor: new Date("2024-01-15T00:00:00Z"),
      createdAt: new Date("2024-01-01T00:00:00Z"),
    } as Organization;

    // Jan 5 (before cycle day 15) → next cycle is Jan 15
    expect(getBillingCycleEnd(org, new Date("2024-01-05T10:00:00Z"))).toEqual(
      new Date("2024-01-15T00:00:00Z"),
    );
  });

  it("handles leap year February correctly", () => {
    const org = {
      id: "org-1",
      cloudBillingCycleAnchor: new Date("2024-01-31T00:00:00Z"),
      createdAt: new Date("2024-01-01T00:00:00Z"),
    } as Organization;

    // 2024 is leap year - Feb 15 reference (in Jan-Feb cycle) → next cycle is Feb 29
    expect(getBillingCycleEnd(org, new Date("2024-02-15T10:00:00Z"))).toEqual(
      new Date("2024-02-29T00:00:00Z"),
    );

    // 2025 is not leap year
    const org2025 = {
      ...org,
      cloudBillingCycleAnchor: new Date("2025-01-31T00:00:00Z"),
    } as Organization;

    // Feb 15 2025 reference → next cycle is Feb 28 (non-leap year)
    expect(
      getBillingCycleEnd(org2025, new Date("2025-02-15T10:00:00Z")),
    ).toEqual(new Date("2025-02-28T00:00:00Z"));
  });

  it("handles year boundary", () => {
    const org = {
      id: "org-1",
      cloudBillingCycleAnchor: new Date("2024-12-15T00:00:00Z"),
      createdAt: new Date("2024-12-01T00:00:00Z"),
    } as Organization;

    // Dec 20 reference → next cycle is Jan 15 next year
    expect(getBillingCycleEnd(org, new Date("2024-12-20T10:00:00Z"))).toEqual(
      new Date("2025-01-15T00:00:00Z"),
    );
  });

  it("uses createdAt as fallback when cloudBillingCycleAnchor is null", () => {
    const org = {
      id: "org-1",
      cloudBillingCycleAnchor: null,
      createdAt: new Date("2024-01-15T10:30:00Z"),
    } as Organization;

    // Feb 20 reference → next cycle is March 15
    expect(getBillingCycleEnd(org, new Date("2024-02-20T10:00:00Z"))).toEqual(
      new Date("2024-03-15T00:00:00Z"),
    );
  });
});

describe("getDaysToLookBack", () => {
  it("returns days in previous month for March reference (leap year)", () => {
    // March 2024, previous month is Feb with 29 days (leap year)
    const result = getDaysToLookBack(new Date("2024-03-15T10:00:00Z"));
    expect(result).toBe(29);
  });

  it("returns days in previous month for April reference", () => {
    // April 2024, previous month is March with 31 days
    const result = getDaysToLookBack(new Date("2024-04-15T10:00:00Z"));
    expect(result).toBe(31);
  });

  it("returns days in previous month for May reference", () => {
    // May 2024, previous month is April with 30 days
    const result = getDaysToLookBack(new Date("2024-05-15T10:00:00Z"));
    expect(result).toBe(30);
  });

  it("returns days in previous month for March in non-leap year", () => {
    // March 2025, previous month is Feb with 28 days (non-leap year)
    const result = getDaysToLookBack(new Date("2025-03-15T10:00:00Z"));
    expect(result).toBe(28);
  });

  it("handles January reference (previous month is December)", () => {
    // January 2024, previous month is December 2023 with 31 days
    const result = getDaysToLookBack(new Date("2024-01-15T10:00:00Z"));
    expect(result).toBe(31);
  });
});

describe("startOfDayUTC", () => {
  it("returns start of day in UTC for a date with time", () => {
    const result = startOfDayUTC(new Date("2024-09-30T14:30:45.123Z"));
    expect(result).toEqual(new Date("2024-09-30T00:00:00.000Z"));
  });

  it("returns same date if already at start of day UTC", () => {
    const result = startOfDayUTC(new Date("2024-09-30T00:00:00.000Z"));
    expect(result).toEqual(new Date("2024-09-30T00:00:00.000Z"));
  });

  it("handles date at end of day", () => {
    const result = startOfDayUTC(new Date("2024-09-30T23:59:59.999Z"));
    expect(result).toEqual(new Date("2024-09-30T00:00:00.000Z"));
  });

  it("handles date created in non-UTC timezone", () => {
    // Create a date from local time components (e.g., Germany timezone)
    const localDate = new Date("2024-09-30T14:30:00+02:00"); // 14:30 in Berlin = 12:30 UTC
    const result = startOfDayUTC(localDate);
    // Should return 2024-09-30 00:00:00 UTC regardless of input timezone
    expect(result).toEqual(new Date("2024-09-30T00:00:00.000Z"));
  });
});

describe("endOfDayUTC", () => {
  it("returns end of day in UTC for a date with time", () => {
    const result = endOfDayUTC(new Date("2024-09-30T14:30:45.123Z"));
    expect(result).toEqual(new Date("2024-09-30T23:59:59.999Z"));
  });

  it("returns end of day if already at start of day UTC", () => {
    const result = endOfDayUTC(new Date("2024-09-30T00:00:00.000Z"));
    expect(result).toEqual(new Date("2024-09-30T23:59:59.999Z"));
  });

  it("returns same date if already at end of day UTC", () => {
    const result = endOfDayUTC(new Date("2024-09-30T23:59:59.999Z"));
    expect(result).toEqual(new Date("2024-09-30T23:59:59.999Z"));
  });

  it("handles date created in non-UTC timezone", () => {
    // Create a date from local time components (e.g., Germany timezone)
    const localDate = new Date("2024-09-30T14:30:00+02:00"); // 14:30 in Berlin = 12:30 UTC
    const result = endOfDayUTC(localDate);
    // Should return 2024-09-30 23:59:59.999 UTC regardless of input timezone
    expect(result).toEqual(new Date("2024-09-30T23:59:59.999Z"));
  });

  it("handles year boundary", () => {
    const result = endOfDayUTC(new Date("2024-12-31T10:00:00Z"));
    expect(result).toEqual(new Date("2024-12-31T23:59:59.999Z"));
  });
});

describe("Organization cloudBillingCycleAnchor persistence", () => {
  it("should preserve startOfDayUTC when creating and reading organization", async () => {
    const { prisma } = await import("@langfuse/shared/src/db");

    const inputDate = new Date("2024-09-30T14:30:45.123Z");
    const expectedDate = startOfDayUTC(inputDate); // 2024-09-30T00:00:00.000Z

    // Create organization with billing cycle anchor
    const org = await prisma.organization.create({
      data: {
        name: `Test Org ${Date.now()}`,
        cloudBillingCycleAnchor: expectedDate,
      },
    });

    // Read back from database
    const readOrg = await prisma.organization.findUnique({
      where: { id: org.id },
    });

    expect(readOrg).not.toBeNull();
    expect(readOrg!.cloudBillingCycleAnchor).toEqual(expectedDate);
    expect(readOrg!.cloudBillingCycleAnchor?.toISOString()).toBe(
      "2024-09-30T00:00:00.000Z",
    );

    // Cleanup
    await prisma.organization.delete({ where: { id: org.id } });
  });

  it("should preserve endOfDayUTC when creating and reading organization", async () => {
    const { prisma } = await import("@langfuse/shared/src/db");

    const inputDate = new Date("2024-09-30T14:30:45.123Z");
    const expectedDate = endOfDayUTC(inputDate); // 2024-09-30T23:59:59.999Z

    // Create organization with billing cycle anchor
    const org = await prisma.organization.create({
      data: {
        name: `Test Org ${Date.now()}`,
        cloudBillingCycleAnchor: expectedDate,
      },
    });

    // Read back from database
    const readOrg = await prisma.organization.findUnique({
      where: { id: org.id },
    });

    expect(readOrg).not.toBeNull();
    expect(readOrg!.cloudBillingCycleAnchor).toEqual(expectedDate);
    expect(readOrg!.cloudBillingCycleAnchor?.toISOString()).toBe(
      "2024-09-30T23:59:59.999Z",
    );

    // Cleanup
    await prisma.organization.delete({ where: { id: org.id } });
  });

  it("should preserve random time in UTC when creating and reading organization", async () => {
    const { prisma } = await import("@langfuse/shared/src/db");

    // Random time in the middle of the day
    const randomDate = new Date("2024-09-30T14:37:22.456Z");

    // Create organization with billing cycle anchor
    const org = await prisma.organization.create({
      data: {
        name: `Test Org ${Date.now()}`,
        cloudBillingCycleAnchor: randomDate,
      },
    });

    // Read back from database
    const readOrg = await prisma.organization.findUnique({
      where: { id: org.id },
    });

    expect(readOrg).not.toBeNull();
    expect(readOrg!.cloudBillingCycleAnchor).toEqual(randomDate);
    expect(readOrg!.cloudBillingCycleAnchor?.toISOString()).toBe(
      "2024-09-30T14:37:22.456Z",
    );

    // Cleanup
    await prisma.organization.delete({ where: { id: org.id } });
  });

  it("should handle null cloudBillingCycleAnchor correctly", async () => {
    const { prisma } = await import("@langfuse/shared/src/db");

    // Create organization without billing cycle anchor
    const org = await prisma.organization.create({
      data: {
        name: `Test Org ${Date.now()}`,
        cloudBillingCycleAnchor: null,
      },
    });

    // Read back from database
    const readOrg = await prisma.organization.findUnique({
      where: { id: org.id },
    });

    expect(readOrg).not.toBeNull();
    expect(readOrg!.cloudBillingCycleAnchor).toBeNull();

    // Cleanup
    await prisma.organization.delete({ where: { id: org.id } });
  });

  it("should correctly normalize different timezone inputs to UTC", async () => {
    const { prisma } = await import("@langfuse/shared/src/db");

    // Date created with timezone offset (Berlin time, +02:00)
    const berlinTime = new Date("2024-09-30T14:30:00+02:00"); // 12:30 UTC
    const expectedUTC = startOfDayUTC(berlinTime); // 2024-09-30T00:00:00.000Z

    // Create organization with billing cycle anchor
    const org = await prisma.organization.create({
      data: {
        name: `Test Org ${Date.now()}`,
        cloudBillingCycleAnchor: expectedUTC,
      },
    });

    // Read back from database
    const readOrg = await prisma.organization.findUnique({
      where: { id: org.id },
    });

    expect(readOrg).not.toBeNull();
    expect(readOrg!.cloudBillingCycleAnchor).toEqual(expectedUTC);
    expect(readOrg!.cloudBillingCycleAnchor?.toISOString()).toBe(
      "2024-09-30T00:00:00.000Z",
    );

    // Cleanup
    await prisma.organization.delete({ where: { id: org.id } });
  });
});