Skip to content

armgit / dub

Public Imported from GitHub
0

The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.

Draw the share earnings image from the chart values in the URL

Rafibfd258401e8a
diff --git a/apps/web/app/(ee)/partners.dub.co/(dashboard)/overview/earnings-chart.tsx b/apps/web/app/(ee)/partners.dub.co/(dashboard)/overview/earnings-chart.tsx
index f0e653c33a..ffc9738192 100644
--- a/apps/web/app/(ee)/partners.dub.co/(dashboard)/overview/earnings-chart.tsx
+++ b/apps/web/app/(ee)/partners.dub.co/(dashboard)/overview/earnings-chart.tsx
@@ -86,9 +86,7 @@ export function EarningsChart() {
<ShareEarningsModal
showModal={showShareModal}
setShowModal={setShowShareModal}
- start={start}
- end={end}
- interval={interval}
+ timeseries={timeseries}
/>
<div className="px-5 py-4">
<div className="flex items-start justify-between gap-2">
diff --git a/apps/web/app/(ee)/partners.dub.co/(dashboard)/programs/[programSlug]/(enrolled)/page-client.tsx b/apps/web/app/(ee)/partners.dub.co/(dashboard)/programs/[programSlug]/(enrolled)/page-client.tsx
index d7539bf709..eea332e94b 100644
--- a/apps/web/app/(ee)/partners.dub.co/(dashboard)/programs/[programSlug]/(enrolled)/page-client.tsx
+++ b/apps/web/app/(ee)/partners.dub.co/(dashboard)/programs/[programSlug]/(enrolled)/page-client.tsx
@@ -196,8 +196,6 @@ function EarningsChart() {
const { start, end, interval } = useContext(ProgramOverviewContext);
const [showShareModal, setShowShareModal] = useState(false);
- const { programEnrollment } = useProgramEnrollment();
-
const { data: timeseries, error } = usePartnerProfileEarningsTimeseries({
programIdOrSlug: programSlug as string,
interval,
@@ -239,16 +237,11 @@ function EarningsChart() {
return (
<div>
- {programEnrollment?.program && (
- <ShareEarningsModal
- showModal={showShareModal}
- setShowModal={setShowShareModal}
- programId={programEnrollment.program.id}
- start={start}
- end={end}
- interval={interval}
- />
- )}
+ <ShareEarningsModal
+ showModal={showShareModal}
+ setShowModal={setShowShareModal}
+ timeseries={timeseries}
+ />
<div className="flex flex-col-reverse items-start justify-between gap-4 md:flex-row">
<div className="flex items-center gap-0">
<div>
diff --git a/apps/web/app/api/og/partner-earnings/route.tsx b/apps/web/app/api/og/partner-earnings/route.tsx
index f05a6f4a5b..ceddcfe114 100644
--- a/apps/web/app/api/og/partner-earnings/route.tsx
+++ b/apps/web/app/api/og/partner-earnings/route.tsx
@@ -1,7 +1,4 @@
-import { getPartnerEarningsTimeseries } from "@/lib/api/partner-profile/get-partner-earnings-timeseries";
-import { getProgramEnrollmentOrThrow } from "@/lib/api/programs/get-program-enrollment-or-throw";
import { withPartnerProfile } from "@/lib/auth/partner";
-import { getPartnerEarningsTimeseriesSchema } from "@/lib/zod/schemas/partner-profile";
import { currencyFormatter, formatDate } from "@dub/utils";
import { ImageResponse } from "next/og";
import * as z from "zod/v4";
@@ -15,54 +12,38 @@ const BACKGROUND_IMAGES = {
dark: "https://assets.dub.co/misc/partner-earnings-share-dark.jpg",
};
-export const GET = withPartnerProfile(async ({ partner, searchParams }) => {
- const {
- programId: programIdOrSlug,
- background,
- ...filters
- } = getPartnerEarningsTimeseriesSchema
- .extend({
- // without a program, the image shows the earnings of all programs
- programId: z.string().optional(),
- background: z.enum(["light", "dark"]).optional().default("light"),
- })
- .parse(searchParams);
+// the chart has at most about 120 points, so this limit only stops abuse
+const MAX_POINTS = 1000;
+
+// the share modal sends the chart values that it already shows, so the image needs no database query.
+// A partner can fake these values, which is fine for a share image.
+const querySchema = z.object({
+ background: z.enum(["light", "dark"]).optional().default("light"),
+ // the earnings of each period in cents, comma separated
+ earnings: z
+ .string()
+ .optional()
+ .default("")
+ .transform((value) => (value ? value.split(",").map(Number) : []))
+ .pipe(z.array(z.number().int()).max(MAX_POINTS)),
+ // the start of the first and the last period
+ start: z.iso.datetime({ offset: true }).optional(),
+ end: z.iso.datetime({ offset: true }).optional(),
+});
- const programId = programIdOrSlug
- ? (
- await getProgramEnrollmentOrThrow({
- partnerId: partner.id,
- programId: programIdOrSlug,
- include: {},
- })
- ).programId
- : undefined;
+export const GET = withPartnerProfile(async ({ searchParams }) => {
+ const { background, earnings, start, end } = querySchema.parse(searchParams);
- const [interSemibold, timeseries] = await Promise.all([
- loadGoogleFont("Inter:wght@600"),
- getPartnerEarningsTimeseries({
- partnerId: partner.id,
- programId,
- filters,
- }),
- ]);
+ const interSemibold = await loadGoogleFont("Inter:wght@600");
- const total = timeseries.reduce((acc, { earnings }) => acc + earnings, 0);
+ const total = earnings.reduce((acc, value) => acc + value, 0);
- const startLabel =
- timeseries.length > 0
- ? formatDate(new Date(timeseries[0].start), {
- month: "short",
- year: "numeric",
- })
- : "";
- const endLabel =
- timeseries.length > 0
- ? formatDate(new Date(timeseries[timeseries.length - 1].start), {
- month: "short",
- year: "numeric",
- })
- : "";
+ const startLabel = start
+ ? formatDate(new Date(start), { month: "short", year: "numeric" })
+ : "";
+ const endLabel = end
+ ? formatDate(new Date(end), { month: "short", year: "numeric" })
+ : "";
const logoColor = background === "dark" ? "#ffffff" : "#000000";
@@ -111,7 +92,7 @@ export const GET = withPartnerProfile(async ({ partner, searchParams }) => {
</div>
<div tw="flex mt-6" style={{ width: 1130, height: 430 }}>
- <Chart data={timeseries} background={background} />
+ <Chart data={earnings} background={background} />
</div>
<div tw="flex justify-between mt-4">
@@ -176,7 +157,7 @@ function Chart({
data,
background,
}: {
- data: { start: string; earnings: number }[];
+ data: number[];
background: "light" | "dark";
}) {
if (!data || data.length === 0) {
@@ -200,7 +181,7 @@ function Chart({
const chartWidth = width - padding.left - padding.right;
const chartHeight = height - padding.top - padding.bottom;
- const maxEarnings = Math.max(...data.map((d) => d.earnings), 1);
+ const maxEarnings = Math.max(...data, 1);
const scaleX = (index: number) =>
padding.left + (chartWidth / (data.length - 1)) * index;
@@ -219,7 +200,7 @@ function Chart({
if (data.length === 1) {
const singleX = padding.left + chartWidth / 2;
- const singleY = scaleY(data[0].earnings);
+ const singleY = scaleY(data[0]);
return (
<svg
viewBox={`0 0 ${width} ${height}`}
@@ -231,9 +212,9 @@ function Chart({
}
const linePath = data
- .map((d, index) => {
+ .map((value, index) => {
const x = scaleX(index);
- const y = scaleY(d.earnings);
+ const y = scaleY(value);
return `${index === 0 ? "M" : "L"} ${x} ${y}`;
})
.join(" ");
@@ -241,7 +222,7 @@ function Chart({
const areaPath = `${linePath} L ${scaleX(data.length - 1)} ${padding.top + chartHeight} L ${padding.left} ${padding.top + chartHeight} Z`;
const lastX = scaleX(data.length - 1);
- const lastY = scaleY(data[data.length - 1].earnings);
+ const lastY = scaleY(data[data.length - 1]);
return (
<svg
diff --git a/apps/web/playwright/api/partner-profile/earnings.spec.ts b/apps/web/playwright/api/partner-profile/earnings.spec.ts
index 6084ff4358..b80d694c87 100644
--- a/apps/web/playwright/api/partner-profile/earnings.spec.ts
+++ b/apps/web/playwright/api/partner-profile/earnings.spec.ts
@@ -237,9 +237,9 @@ test.describe("GET /partner-profile/earnings", () => {
}),
]);
- const byCustomer = await partnerApi.get<
- { id: string; _count: number }[]
- >("/api/partner-profile/earnings/count?groupBy=customerId");
+ const byCustomer = await partnerApi.get<{ id: string; _count: number }[]>(
+ "/api/partner-profile/earnings/count?groupBy=customerId",
+ );
expect(byCustomer.status).toEqual(200);
expect(byCustomer.data).toEqual([
expect.objectContaining({
@@ -686,7 +686,7 @@ test.describe("GET /partner-profile/earnings", () => {
}
});
- test("returns 404 from the per-program timeseries and the OG image for another program", async ({
+ test("returns 404 from the per-program timeseries for another program", async ({
playwright,
}) => {
await withPartnerApi(playwright, async (partnerApi) => {
@@ -695,16 +695,10 @@ test.describe("GET /partner-profile/earnings", () => {
"/api/partner-profile/earnings/timeseries?programIdOrSlug=prog_doesnotexist",
),
).toMatchObject({ status: 404 });
-
- expect(
- await partnerApi.get(
- "/api/og/partner-earnings?programId=prog_doesnotexist",
- ),
- ).toMatchObject({ status: 404 });
});
});
- test("returns the OG image of all programs without a program", async ({
+ test("returns the OG image from the chart values in the URL", async ({
playwright,
}) => {
// the API client parses JSON, so read the PNG with a plain request
@@ -715,11 +709,17 @@ test.describe("GET /partner-profile/earnings", () => {
try {
const response = await context.get(
- "/api/og/partner-earnings?interval=all&timezone=UTC",
+ "/api/og/partner-earnings?earnings=0,1500,4200&start=2026-08-01T00:00:00.000Z&end=2026-10-01T00:00:00.000Z",
);
expect(response.status()).toEqual(200);
expect(response.headers()["content-type"]).toContain("image/png");
+
+ const invalidResponse = await context.get(
+ "/api/og/partner-earnings?earnings=0,abc",
+ );
+
+ expect(invalidResponse.status()).toEqual(422);
} finally {
await context.dispose();
}
diff --git a/apps/web/ui/partners/earnings/share-earnings-modal.tsx b/apps/web/ui/partners/earnings/share-earnings-modal.tsx
index 817b9797fd..0929962bdb 100644
--- a/apps/web/ui/partners/earnings/share-earnings-modal.tsx
+++ b/apps/web/ui/partners/earnings/share-earnings-modal.tsx
@@ -1,6 +1,5 @@
"use client";
-import { IntervalOptions } from "@/lib/analytics/types";
import { Button, LoadingSpinner, Modal, Tooltip } from "@dub/ui";
import { ReferredVia } from "@dub/ui/icons";
import { cn } from "@dub/utils";
@@ -24,11 +23,8 @@ type BackgroundType = (typeof BACKGROUND_OPTIONS)[number]["id"];
type ShareEarningsModalProps = {
showModal: boolean;
setShowModal: Dispatch<SetStateAction<boolean>>;
- // without a program, the image shows the earnings of all programs
- programId?: string;
- start?: Date;
- end?: Date;
- interval: IntervalOptions;
+ // the chart values, sent to the image route so that it needs no database query
+ timeseries?: { start: string; earnings: number }[];
};
// the share icon next to an earnings chart title
@@ -50,10 +46,7 @@ export function ShareChartButton({ onClick }: { onClick: () => void }) {
export function ShareEarningsModal({
showModal,
setShowModal,
- programId,
- start,
- end,
- interval,
+ timeseries,
}: ShareEarningsModalProps) {
return (
<Modal
@@ -63,10 +56,7 @@ export function ShareEarningsModal({
>
<ShareEarningsModalInner
setShowModal={setShowModal}
- programId={programId}
- start={start}
- end={end}
- interval={interval}
+ timeseries={timeseries}
/>
</Modal>
);
@@ -74,28 +64,28 @@ export function ShareEarningsModal({
function ShareEarningsModalInner({
setShowModal,
- programId,
- start,
- end,
- interval,
+ timeseries,
}: Omit<ShareEarningsModalProps, "showModal">) {
const [background, setBackground] = useState<BackgroundType>("light");
- const [isLoading, setIsLoading] = useState(false);
+ const [isLoading, setIsLoading] = useState(true);
const [blob, setBlob] = useState<Blob | null>(null);
const imageUrl = useMemo(() => {
- const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
+ if (!timeseries) return null;
+
return `/api/og/partner-earnings?${new URLSearchParams({
- ...(programId && { programId }),
background,
- interval,
- timezone,
- ...(start && { start: start.toISOString() }),
- ...(end && { end: end.toISOString() }),
+ earnings: timeseries.map(({ earnings }) => earnings).join(","),
+ ...(timeseries.length > 0 && {
+ start: timeseries[0].start,
+ end: timeseries[timeseries.length - 1].start,
+ }),
}).toString()}`;
- }, [programId, background, interval, start, end]);
+ }, [timeseries, background]);
useEffect(() => {
+ if (!imageUrl) return;
+
const abortController = new AbortController();
setIsLoading(true);