@oneuptime/common 12.0.17 → 12.0.19

package/Tests/Server/Utils/Marketing/LinkedIn.test.ts

@@ -1,282 +0,0 @@
-import Attribution from "../../../../Server/Utils/Attribution";
-import MarketingConversion from "../../../../Models/DatabaseModels/MarketingConversion";
-import LinkedInProvider from "../../../../Server/Utils/Marketing/Providers/LinkedIn";
-import { ConversionSkip } from "../../../../Server/Utils/Marketing/ConversionUploadProvider";
-import { JSONObject } from "../../../../Types/JSON";
-import { MarketingConversionType } from "../../../../Types/Marketing/MarketingConversion";
-import ObjectID from "../../../../Types/ObjectID";
-import axios, { AxiosError } from "axios";
-import {
-  afterEach,
-  beforeEach,
-  describe,
-  expect,
-  jest,
-  test,
-} from "@jest/globals";
-import { SpyInstance } from "jest-mock";
-
-/*
- * ---------------------------------------------------------------------------
- * LinkedIn Conversions API.
- *
- * LinkedIn is the platform where enhanced matching matters most for this
- * product: it is where enterprise buyers are advertised to, and an enterprise
- * cycle is exactly the case where the li_fat_id from the original click is
- * long gone by the time the deal closes. LinkedIn accepts several userIds per
- * event and resolves whichever it can, so both identifiers are sent.
- *
- * Conversion rules are per-type and operator-configured, so an unset rule id
- * must leave the conversion PENDING rather than discard it.
- * ---------------------------------------------------------------------------
- */
-
-jest.mock("../../../../Server/EnvironmentConfig", () => {
-  return {
-    LinkedInApiVersion: "202606",
-    LinkedInConversionsAccessToken: "linkedin-token",
-    LinkedInSignUpConversionId: "1111",
-    LinkedInPaidSubscriptionConversionId: "2222",
-    LinkedInMeetingBookedConversionId: "3333",
-  };
-});
-
-type MakeConversionFunction = (
-  data?: Partial<MarketingConversion>,
-) => MarketingConversion;
-
-const makeConversion: MakeConversionFunction = (
-  data: Partial<MarketingConversion> = {},
-): MarketingConversion => {
-  return Object.assign(new MarketingConversion(), {
-    id: new ObjectID("33333333-3333-4333-8333-333333333333"),
-    conversionType: MarketingConversionType.SignUp,
-    conversionAt: new Date("2026-07-22T10:11:12.345Z"),
-    clickIds: { li_fat_id: "linkedin-click" },
-    ...data,
-  });
-};
-
-type UploadedBodyFunction = (postSpy: SpyInstance<any>) => JSONObject;
-
-const uploadedBody: UploadedBodyFunction = (
-  postSpy: SpyInstance<any>,
-): JSONObject => {
-  return postSpy.mock.calls[0]?.[1] as JSONObject;
-};
-
-describe("LinkedInProvider", () => {
-  let provider: LinkedInProvider;
-  let postSpy: SpyInstance<any>;
-
-  beforeEach(() => {
-    provider = new LinkedInProvider();
-    postSpy = jest.spyOn(axios, "post") as SpyInstance<any>;
-    jest
-      .spyOn(Date, "now")
-      .mockReturnValue(new Date("2026-07-23T10:11:12.345Z").getTime());
-  });
-
-  afterEach(() => {
-    jest.restoreAllMocks();
-  });
-
-  test("reports configured when the access token exists", () => {
-    expect(provider.isConfigured()).toBe(true);
-  });
-
-  describe("identifiers", () => {
-    test("accepts a conversion with only a click id", () => {
-      expect(provider.getSkipReason(makeConversion())).toBeNull();
-    });
-
-    test("accepts a conversion with only an email", () => {
-      expect(
-        provider.getSkipReason(
-          makeConversion({ clickIds: {}, email: "ada@example.com" }),
-        ),
-      ).toBeNull();
-    });
-
-    test("permanently skips a conversion with neither", () => {
-      expect(provider.getSkipReason(makeConversion({ clickIds: {} }))).toEqual({
-        reason: "No LinkedIn click id (li_fat_id) and no email to match on",
-        isPermanent: true,
-      });
-    });
-
-    test("sends both identifiers when both are known", async () => {
-      postSpy.mockResolvedValueOnce({} as never);
-
-      await provider.upload([makeConversion({ email: "Ada@Example.com" })]);
-
-      expect(uploadedBody(postSpy)["user"]).toEqual({
-        userIds: [
-          {
-            idType: "LINKEDIN_FIRST_PARTY_ADS_TRACKING_UUID",
-            idValue: "linkedin-click",
-          },
-          {
-            idType: "SHA256_EMAIL",
-            idValue: Attribution.hashEmail("ada@example.com"),
-          },
-        ],
-      });
-    });
-
-    /*
-     * The click id used to be sent as an empty idValue when absent, which is a
-     * userId LinkedIn can never resolve rather than an absent one.
-     */
-    test("sends only the email identifier when there is no click id", async () => {
-      postSpy.mockResolvedValueOnce({} as never);
-
-      await provider.upload([
-        makeConversion({ clickIds: {}, email: "ada@example.com" }),
-      ]);
-
-      expect(uploadedBody(postSpy)["user"]).toEqual({
-        userIds: [
-          {
-            idType: "SHA256_EMAIL",
-            idValue: Attribution.hashEmail("ada@example.com"),
-          },
-        ],
-      });
-    });
-
-    test("never sends the address in the clear", async () => {
-      postSpy.mockResolvedValueOnce({} as never);
-
-      await provider.upload([makeConversion({ email: "ada@example.com" })]);
-
-      expect(JSON.stringify(uploadedBody(postSpy))).not.toContain(
-        "ada@example.com",
-      );
-    });
-  });
-
-  describe("conversion rules", () => {
-    test.each([
-      [MarketingConversionType.SignUp, "1111"],
-      [MarketingConversionType.PaidSubscription, "2222"],
-      [MarketingConversionType.MeetingBooked, "3333"],
-    ])(
-      "reports %s against its own conversion rule",
-      async (
-        conversionType: MarketingConversionType,
-        expectedRuleId: string,
-      ) => {
-        postSpy.mockResolvedValueOnce({} as never);
-
-        await provider.upload([
-          makeConversion({ conversionType: conversionType }),
-        ]);
-
-        expect(uploadedBody(postSpy)["conversion"]).toBe(
-          `urn:lla:llaPartnerConversion:${expectedRuleId}`,
-        );
-      },
-    );
-
-    test.each([MarketingConversionType.MeetingBooked])(
-      "attaches no conversionValue to %s even when the row holds one",
-      async (conversionType: MarketingConversionType) => {
-        postSpy.mockResolvedValueOnce({} as never);
-
-        await provider.upload([
-          makeConversion({
-            conversionType: conversionType,
-            conversionValueInUSDCents: 500000,
-          }),
-        ]);
-
-        expect(uploadedBody(postSpy)["conversionValue"]).toBeUndefined();
-      },
-    );
-
-    test("attaches conversionValue to a paid subscription", async () => {
-      postSpy.mockResolvedValueOnce({} as never);
-
-      await provider.upload([
-        makeConversion({
-          conversionType: MarketingConversionType.PaidSubscription,
-          conversionValueInUSDCents: 12999,
-        }),
-      ]);
-
-      expect(uploadedBody(postSpy)["conversionValue"]).toEqual({
-        currencyCode: "USD",
-        amount: "129.99",
-      });
-    });
-  });
-
-  test("keys the event on the conversion row id so retries dedupe", async () => {
-    postSpy.mockResolvedValueOnce({} as never);
-
-    await provider.upload([makeConversion()]);
-
-    expect(uploadedBody(postSpy)["eventId"]).toBe(
-      "33333333-3333-4333-8333-333333333333",
-    );
-  });
-
-  test("permanently skips a conversion outside LinkedIn's 90-day window", () => {
-    const skip: ConversionSkip | null = provider.getSkipReason(
-      makeConversion({ conversionAt: new Date("2026-01-01T00:00:00.000Z") }),
-    );
-
-    expect(skip).toEqual({
-      reason: "Conversion older than LinkedIn's 90-day window",
-      isPermanent: true,
-    });
-  });
-
-  describe("failure handling", () => {
-    type BuildAxiosErrorFunction = (status: number) => AxiosError;
-
-    const buildAxiosError: BuildAxiosErrorFunction = (
-      status: number,
-    ): AxiosError => {
-      const error: AxiosError = new AxiosError("rejected");
-      Object.assign(error, { response: { status: status, data: {} } });
-      return error;
-    };
-
-    test.each([400, 422])(
-      "records a %s as a permanent per-event failure",
-      async (status: number) => {
-        postSpy.mockRejectedValueOnce(buildAxiosError(status) as never);
-
-        const result: { permanentFailures: Map<number, string> } =
-          await provider.upload([makeConversion()]);
-
-        expect(result.permanentFailures.get(0)).toContain(`HTTP ${status}`);
-      },
-    );
-
-    /*
-     * Anything that is not a definitive validation rejection is transport
-     * level. It must throw so the whole batch stays pending and is retried —
-     * recording it as a permanent failure would discard a conversion because
-     * the token had expired or LinkedIn had a bad minute.
-     */
-    test.each([401, 429, 500, 503])(
-      "throws on a %s so the batch is retried",
-      async (status: number) => {
-        postSpy.mockRejectedValueOnce(buildAxiosError(status) as never);
-
-        await expect(provider.upload([makeConversion()])).rejects.toBeDefined();
-      },
-    );
-
-    test("throws on a network error with no response at all", async () => {
-      postSpy.mockRejectedValueOnce(new Error("socket hang up") as never);
-
-      await expect(provider.upload([makeConversion()])).rejects.toThrow(
-        "socket hang up",
-      );
-    });
-  });
-});

package/Tests/Server/Utils/Marketing/Meta.test.ts

@@ -1,304 +0,0 @@
-import Attribution from "../../../../Server/Utils/Attribution";
-import MarketingConversion from "../../../../Models/DatabaseModels/MarketingConversion";
-import MetaProvider from "../../../../Server/Utils/Marketing/Providers/Meta";
-import { ConversionSkip } from "../../../../Server/Utils/Marketing/ConversionUploadProvider";
-import { JSONObject } from "../../../../Types/JSON";
-import { MarketingConversionType } from "../../../../Types/Marketing/MarketingConversion";
-import ObjectID from "../../../../Types/ObjectID";
-import axios, { AxiosResponse } from "axios";
-import {
-  afterEach,
-  beforeEach,
-  describe,
-  expect,
-  jest,
-  test,
-} from "@jest/globals";
-import { SpyInstance } from "jest-mock";
-
-/*
- * ---------------------------------------------------------------------------
- * Meta Conversions API.
- *
- * Two things this file is really about:
- *
- *   - WHAT A CONVERSION IS CALLED. Meta's event names carry meaning to the
- *     optimiser. `Purchase` demands a value and pulls the event into the
- *     revenue optimisation pool; `Schedule` and `Lead` do not. The provider
- *     used to send `isSignUp ? CompleteRegistration : Purchase`, so anything
- *     that was not a signup was revenue by default.
- *
- *   - HOW A PERSON IS IDENTIFIED. Meta matches on a click id, a hashed email,
- *     or both. Requiring fbclid — which the provider used to — discarded every
- *     conversion whose click id had not survived to the moment of conversion,
- *     which is nearly all of a sales-led funnel.
- * ---------------------------------------------------------------------------
- */
-
-jest.mock("../../../../Server/EnvironmentConfig", () => {
-  return {
-    MetaConversionsPixelId: "pixel-id",
-    MetaConversionsAccessToken: "meta-access-token",
-    MetaGraphApiVersion: "v22.0",
-  };
-});
-
-type MakeConversionFunction = (
-  data?: Partial<MarketingConversion>,
-) => MarketingConversion;
-
-const makeConversion: MakeConversionFunction = (
-  data: Partial<MarketingConversion> = {},
-): MarketingConversion => {
-  return Object.assign(new MarketingConversion(), {
-    id: new ObjectID("11111111-1111-4111-8111-111111111111"),
-    conversionType: MarketingConversionType.SignUp,
-    conversionAt: new Date("2026-07-22T10:11:12.345Z"),
-    clickIds: { fbclid: "meta-click" },
-    ...data,
-  });
-};
-
-type ResponseFunction = (data: JSONObject) => AxiosResponse<JSONObject>;
-
-const response: ResponseFunction = (
-  data: JSONObject,
-): AxiosResponse<JSONObject> => {
-  return { data } as AxiosResponse<JSONObject>;
-};
-
-type UploadedEventFunction = (postSpy: SpyInstance<any>) => JSONObject;
-
-const uploadedEvent: UploadedEventFunction = (
-  postSpy: SpyInstance<any>,
-): JSONObject => {
-  const body: JSONObject = postSpy.mock.calls[0]?.[1] as JSONObject;
-  return (body["data"] as Array<JSONObject>)[0]!;
-};
-
-describe("MetaProvider", () => {
-  let provider: MetaProvider;
-  let postSpy: SpyInstance<any>;
-
-  beforeEach(() => {
-    provider = new MetaProvider();
-    postSpy = jest.spyOn(axios, "post") as SpyInstance<any>;
-    // Meta only accepts events up to 7 days old; freeze inside that window.
-    jest
-      .spyOn(Date, "now")
-      .mockReturnValue(new Date("2026-07-23T10:11:12.345Z").getTime());
-  });
-
-  afterEach(() => {
-    jest.restoreAllMocks();
-  });
-
-  test("reports configured only when the pixel and token exist", () => {
-    expect(provider.isConfigured()).toBe(true);
-  });
-
-  describe("identifiers", () => {
-    test("accepts a conversion with only a click id", () => {
-      expect(
-        provider.getSkipReason(makeConversion({ clickIds: { fbclid: "x" } })),
-      ).toBeNull();
-    });
-
-    test("accepts a conversion with only an email", () => {
-      expect(
-        provider.getSkipReason(
-          makeConversion({ clickIds: {}, email: "ada@example.com" }),
-        ),
-      ).toBeNull();
-    });
-
-    test("permanently skips a conversion with neither", () => {
-      expect(provider.getSkipReason(makeConversion({ clickIds: {} }))).toEqual({
-        reason: "No Meta click id (fbclid) and no email to match on",
-        isPermanent: true,
-      });
-    });
-
-    test("permanently skips a conversion outside Meta's 7-day window", () => {
-      const skip: ConversionSkip | null = provider.getSkipReason(
-        makeConversion({
-          conversionAt: new Date("2026-07-01T00:00:00.000Z"),
-        }),
-      );
-
-      expect(skip).toEqual({
-        reason: "Conversion older than Meta's 7-day upload window",
-        isPermanent: true,
-      });
-    });
-
-    test("sends fbc and a hashed email when both are known", async () => {
-      postSpy.mockResolvedValueOnce(response({ events_received: 1 }) as never);
-
-      await provider.upload([makeConversion({ email: "Ada@Example.com" })]);
-
-      /*
-       * fbc is fb.1.{creationTimeMs}.{fbclid} per Meta's spec, and the
-       * creation time it uses is the conversion time — the original click
-       * timestamp is not stored.
-       */
-      expect(uploadedEvent(postSpy)["user_data"]).toEqual({
-        fbc: `fb.1.${new Date("2026-07-22T10:11:12.345Z").getTime()}.meta-click`,
-        em: [Attribution.hashEmail("ada@example.com")],
-      });
-    });
-
-    /*
-     * fbc is built by splicing the click id into a template, so an absent
-     * click id must omit the field entirely rather than send a well-formed
-     * string ending in nothing.
-     */
-    test("omits fbc entirely when there is no click id", async () => {
-      postSpy.mockResolvedValueOnce(response({ events_received: 1 }) as never);
-
-      await provider.upload([
-        makeConversion({ clickIds: {}, email: "ada@example.com" }),
-      ]);
-
-      const userData: JSONObject = uploadedEvent(postSpy)[
-        "user_data"
-      ] as JSONObject;
-
-      expect(userData["fbc"]).toBeUndefined();
-      expect(userData["em"]).toEqual([
-        Attribution.hashEmail("ada@example.com"),
-      ]);
-    });
-
-    test("never sends the address in the clear", async () => {
-      postSpy.mockResolvedValueOnce(response({ events_received: 1 }) as never);
-
-      await provider.upload([makeConversion({ email: "ada@example.com" })]);
-
-      expect(JSON.stringify(postSpy.mock.calls[0]?.[1])).not.toContain(
-        "ada@example.com",
-      );
-    });
-  });
-
-  describe("event naming", () => {
-    test.each([
-      [MarketingConversionType.SignUp, "CompleteRegistration"],
-      [MarketingConversionType.MeetingBooked, "Schedule"],
-      [MarketingConversionType.PaidSubscription, "Purchase"],
-    ])(
-      "sends %s as %s",
-      async (
-        conversionType: MarketingConversionType,
-        expectedEventName: string,
-      ) => {
-        postSpy.mockResolvedValueOnce(
-          response({ events_received: 1 }) as never,
-        );
-
-        await provider.upload([
-          makeConversion({ conversionType: conversionType }),
-        ]);
-
-        expect(uploadedEvent(postSpy)["event_name"]).toBe(expectedEventName);
-      },
-    );
-
-    /*
-     * The regression this exists for: a booked meeting reported as a Purchase
-     * carrying the row's value would teach Meta's optimiser that demos are
-     * revenue.
-     */
-    test.each([MarketingConversionType.MeetingBooked])(
-      "attaches no custom_data to %s even when the row holds a value",
-      async (conversionType: MarketingConversionType) => {
-        postSpy.mockResolvedValueOnce(
-          response({ events_received: 1 }) as never,
-        );
-
-        await provider.upload([
-          makeConversion({
-            conversionType: conversionType,
-            conversionValueInUSDCents: 500000,
-          }),
-        ]);
-
-        const event: JSONObject = uploadedEvent(postSpy);
-
-        expect(event["event_name"]).not.toBe("Purchase");
-        expect(event["custom_data"]).toBeUndefined();
-      },
-    );
-
-    /*
-     * Purchase is the one event Meta rejects without a value, and one rejected
-     * event fails the whole batch — so a custom-pricing subscription with no
-     * known revenue must still send a value, even a zero one.
-     */
-    test("sends a zero value for a purchase whose revenue is unknown", async () => {
-      postSpy.mockResolvedValueOnce(response({ events_received: 1 }) as never);
-
-      await provider.upload([
-        makeConversion({
-          conversionType: MarketingConversionType.PaidSubscription,
-        }),
-      ]);
-
-      expect(uploadedEvent(postSpy)["custom_data"]).toEqual({
-        value: 0,
-        currency: "USD",
-      });
-    });
-
-    test("sends the real value for a purchase that has one", async () => {
-      postSpy.mockResolvedValueOnce(response({ events_received: 1 }) as never);
-
-      await provider.upload([
-        makeConversion({
-          conversionType: MarketingConversionType.PaidSubscription,
-          conversionValueInUSDCents: 12999,
-        }),
-      ]);
-
-      expect(uploadedEvent(postSpy)["custom_data"]).toEqual({
-        value: 129.99,
-        currency: "USD",
-      });
-    });
-  });
-
-  describe("delivery", () => {
-    test("keys the event on the conversion row id so retries dedupe", async () => {
-      postSpy.mockResolvedValueOnce(response({ events_received: 1 }) as never);
-
-      await provider.upload([makeConversion()]);
-
-      expect(uploadedEvent(postSpy)["event_id"]).toBe(
-        "11111111-1111-4111-8111-111111111111",
-      );
-    });
-
-    test("posts to the configured pixel", async () => {
-      postSpy.mockResolvedValueOnce(response({ events_received: 1 }) as never);
-
-      await provider.upload([makeConversion()]);
-
-      expect(postSpy.mock.calls[0]?.[0]).toBe(
-        "https://graph.facebook.com/v22.0/pixel-id/events",
-      );
-    });
-
-    /*
-     * A partial acceptance is thrown, not recorded as a per-row failure: the
-     * response does not say WHICH events were dropped, so the only safe move is
-     * to retry the batch, which event_id makes idempotent.
-     */
-    test("throws when Meta accepts fewer events than were sent", async () => {
-      postSpy.mockResolvedValueOnce(response({ events_received: 1 }) as never);
-
-      await expect(
-        provider.upload([makeConversion(), makeConversion()]),
-      ).rejects.toThrow("Meta accepted 1 of 2 events");
-    });
-  });
-});