OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.
validation: refuse the inputs that were accepted and then ignored
Carl-Gerhard Lindesvärda777c49d2df2
diff --git a/packages/core/src/modules/email/email.constants.ts b/packages/core/src/modules/email/email.constants.tsindex 33439aed5..bb8d9cb3b 100644--- a/packages/core/src/modules/email/email.constants.ts+++ b/packages/core/src/modules/email/email.constants.ts@@ -1,3 +1,5 @@+import { z } from 'zod';+// Keys must match the template `category` in @openpanel/email. Each entry's// label + description drive the account email-preferences toggles.export const emailCategories = {@@ -25,3 +27,19 @@ export const emailCategories = {} as const;export type EmailCategory = keyof typeof emailCategories;++/**+ * The account email-preference toggles.+ *+ * `partialRecord`, not `record`: an enum-keyed `record` is EXHAUSTIVE in zod 4,+ * and the form sends only the toggles that changed. Keying off `emailCategories`+ * is what stops an unknown category reaching `emailUnsubscribe`, where nothing+ * would ever read it again.+ */+export const zUpdateEmailPreferences = z.object({+ categories: z.partialRecord(+ z.enum(Object.keys(emailCategories) as [EmailCategory, ...EmailCategory[]]),+ z.boolean()+ ),+});+export type IUpdateEmailPreferences = z.infer<typeof zUpdateEmailPreferences>;diff --git a/packages/core/src/modules/email/email.rpc.test.ts b/packages/core/src/modules/email/email.rpc.test.tsindex c04e0aa24..4daaf1887 100644--- a/packages/core/src/modules/email/email.rpc.test.ts+++ b/packages/core/src/modules/email/email.rpc.test.ts@@ -8,6 +8,7 @@ import { expect, test } from 'bun:test';import { stubHttpCtx } from '../../../test/rpc-fixtures';import { makeTrpcContext } from '../../rpc/base';import type { CookieOptions } from '../../shared/cookie';+import { zUpdateEmailPreferences } from './email.constants';import { emailRouter } from './email.rpc';const COOKIE_OPTIONS: CookieOptions = {@@ -54,3 +55,28 @@ test('unsubscribe rejects an invalid token before touching the database', async})).rejects.toMatchObject({ code: 'BAD_REQUEST' });});++// `updatePreferences` used to take `z.record(z.string(), z.boolean())`, so an+// unknown key was written to `emailUnsubscribe` where nothing reads it. The+// first cut of the fix used `z.record(z.enum(...))`, which in zod 4 is+// EXHAUSTIVE — it rejected a single real toggle, which is what the form sends.+// These pin both halves so that trap cannot come back.+test('updatePreferences accepts a subset of real categories', () => {+ expect(+ zUpdateEmailPreferences.safeParse({ categories: { weekly_digest: true } })+ .success+ ).toBe(true);+ expect(+ zUpdateEmailPreferences.safeParse({+ categories: { weekly_digest: true, onboarding: false },+ }).success+ ).toBe(true);+});++test('updatePreferences refuses a category that does not exist', () => {+ expect(+ zUpdateEmailPreferences.safeParse({+ categories: { not_a_real_category: false },+ }).success+ ).toBe(false);+});diff --git a/packages/core/src/modules/email/email.rpc.ts b/packages/core/src/modules/email/email.rpc.tsindex 84c932b44..44f5260f3 100644--- a/packages/core/src/modules/email/email.rpc.ts+++ b/packages/core/src/modules/email/email.rpc.ts@@ -27,7 +27,7 @@ import {publicProcedure,} from '../../rpc/base';import { TRPCAccessError, TRPCBadRequestError } from '../../rpc/errors';-import { emailCategories } from './email.constants';+import { emailCategories, zUpdateEmailPreferences } from './email.constants';export const emailRouter = createTRPCRouter({unsubscribe: publicProcedure@@ -76,7 +76,7 @@ export const emailRouter = createTRPCRouter({}),updatePreferences: protectedProcedure- .input(z.object({ categories: z.record(z.string(), z.boolean()) }))+ .input(zUpdateEmailPreferences).mutation(async ({ input, ctx }) => {const email = ctx.session.user?.email;if (!email) {diff --git a/packages/core/src/modules/group/group.rpc.ts b/packages/core/src/modules/group/group.rpc.tsindex 5eeb610b9..05075776c 100644--- a/packages/core/src/modules/group/group.rpc.ts+++ b/packages/core/src/modules/group/group.rpc.ts@@ -25,6 +25,8 @@ import {} from './group.service';const DEFAULT_LIST_TAKE = 50;+/** A list page, not an export. `/export/events` is the bulk path. */+const MAX_LIST_TAKE = 1000;const zGroupRef = z.object({ id: z.string(), projectId: z.string() });@@ -34,7 +36,12 @@ export const groupRouter = createTRPCRouter({z.object({projectId: z.string(),cursor: z.number().optional(),- take: z.number().default(DEFAULT_LIST_TAKE),+ take: z+ .number()+ .int()+ .min(1)+ .max(MAX_LIST_TAKE)+ .default(DEFAULT_LIST_TAKE),search: z.string().optional(),type: z.string().optional(),})@@ -148,7 +155,12 @@ export const groupRouter = createTRPCRouter({projectId: z.string(),groupId: z.string(),cursor: z.number().optional(),- take: z.number().default(DEFAULT_LIST_TAKE),+ take: z+ .number()+ .int()+ .min(1)+ .max(MAX_LIST_TAKE)+ .default(DEFAULT_LIST_TAKE),search: z.string().optional(),}))diff --git a/packages/core/src/modules/group/group.service.ts b/packages/core/src/modules/group/group.service.tsindex c532eae24..9a913bff5 100644--- a/packages/core/src/modules/group/group.service.ts+++ b/packages/core/src/modules/group/group.service.ts@@ -3,6 +3,7 @@import { toDots } from '@openpanel/shared';import { chQuery } from '../../ch-query';+import { TRPCBadRequestError } from '../../rpc/errors';import type { ServiceDeps, Services } from '../../services';import { getProfiles, type IServiceProfile } from '../profile/profile.service';import { formatClickhouseDate, toNullIfDefaultMinDate } from './src/dates';@@ -198,6 +199,13 @@ export async function createGroup(deps: ServiceDeps,input: IServiceUpsertGroup) {+ // `upsertGroup` merges onto an existing row, so without this a create+ // silently overwrote a group instead of telling the caller it was taken —+ // the inverse of the guard updateGroup and deleteGroup already carry.+ const existing = await getGroupById(deps, input.id, input.projectId);+ if (existing) {+ throw new TRPCBadRequestError(`Group ${input.id} already exists`);+ }await upsertGroup(deps, input);return getGroupById(deps, input.id, input.projectId);}diff --git a/packages/core/src/modules/import/import.constants.ts b/packages/core/src/modules/import/import.constants.tsindex 1e75669ff..454530353 100644--- a/packages/core/src/modules/import/import.constants.ts+++ b/packages/core/src/modules/import/import.constants.ts@@ -120,15 +120,22 @@ export type IImportConfig =| IMixpanelImportConfig| IAmplitudeImportConfig;-export const zCreateImport = z.object({- projectId: z.string().min(1),- provider: z.enum(['umami', 'plausible', 'mixpanel', 'amplitude']),- config: z.union([- zUmamiImportConfig,- zPlausibleImportConfig,- zMixpanelImportConfig,- zAmplitudeImportConfig,- ]),-});+export const zCreateImport = z+ .object({+ projectId: z.string().min(1),+ provider: z.enum(['umami', 'plausible', 'mixpanel', 'amplitude']),+ config: z.union([+ zUmamiImportConfig,+ zPlausibleImportConfig,+ zMixpanelImportConfig,+ zAmplitudeImportConfig,+ ]),+ })+ // The service only ever reads `config.provider`, so a mismatched top-level+ // `provider` was accepted and then silently ignored.+ .refine((input) => input.provider === input.config.provider, {+ path: ['provider'],+ message: 'provider must match config.provider',+ });export type ICreateImport = z.infer<typeof zCreateImport>;diff --git a/packages/core/src/modules/profile/profile.rpc.ts b/packages/core/src/modules/profile/profile.rpc.tsindex d13f898b6..0f79d02c8 100644--- a/packages/core/src/modules/profile/profile.rpc.ts+++ b/packages/core/src/modules/profile/profile.rpc.ts@@ -22,6 +22,8 @@ import {import { PROFILE_VALUE_COLUMNS } from './src/sql';const DEFAULT_LIST_TAKE = 50;+/** A list page, not an export. `/export/events` is the bulk path. */+const MAX_LIST_TAKE = 1000;/*** `list` and `powerUsers` had no date filter at all, so their cost grew with@@ -128,7 +130,12 @@ export const profileRouter = createTRPCRouter({z.object({projectId: z.string(),cursor: z.number().optional(),- take: z.number().default(DEFAULT_LIST_TAKE),+ take: z+ .number()+ .int()+ .min(1)+ .max(MAX_LIST_TAKE)+ .default(DEFAULT_LIST_TAKE),search: z.string().optional(),isExternal: z.boolean().optional(),filters: z.array(zChartEventFilter).default([]),@@ -154,7 +161,12 @@ export const profileRouter = createTRPCRouter({z.object({projectId: z.string(),cursor: z.number().optional(),- take: z.number().default(DEFAULT_LIST_TAKE),+ take: z+ .number()+ .int()+ .min(1)+ .max(MAX_LIST_TAKE)+ .default(DEFAULT_LIST_TAKE),...zProfileWindow,}))diff --git a/packages/core/src/modules/report/report.rpc.ts b/packages/core/src/modules/report/report.rpc.tsindex 376110d2a..1a0ccb19c 100644--- a/packages/core/src/modules/report/report.rpc.ts+++ b/packages/core/src/modules/report/report.rpc.ts@@ -13,15 +13,20 @@ import { createTRPCRouter, protectedProcedure } from '../../rpc/base';import { TRPCNotFoundError } from '../../rpc/errors';import { zReport } from './report.constants';+// Grid coordinates, so whole numbers inside the grid. A zero width or a+// height in the tens of thousands is a client bug, not a layout.+const GRID_MAX_COLUMNS = 12;+const GRID_MAX_ROWS = 1000;+const zGridSpan = z.number().int().min(1).max(GRID_MAX_COLUMNS);const zReportLayout = z.object({- x: z.number(),- y: z.number(),- w: z.number(),- h: z.number(),- minW: z.number().optional(),- minH: z.number().optional(),- maxW: z.number().optional(),- maxH: z.number().optional(),+ x: z.number().int().min(0).max(GRID_MAX_COLUMNS),+ y: z.number().int().min(0).max(GRID_MAX_ROWS),+ w: zGridSpan,+ h: z.number().int().min(1).max(GRID_MAX_ROWS),+ minW: zGridSpan.optional(),+ minH: z.number().int().min(1).max(GRID_MAX_ROWS).optional(),+ maxW: zGridSpan.optional(),+ maxH: z.number().int().min(1).max(GRID_MAX_ROWS).optional(),});export const reportRouter = createTRPCRouter({diff --git a/packages/core/src/modules/session/session.rpc.ts b/packages/core/src/modules/session/session.rpc.tsindex 33dae33a6..b457a52f2 100644--- a/packages/core/src/modules/session/session.rpc.ts+++ b/packages/core/src/modules/session/session.rpc.ts@@ -13,6 +13,8 @@ import {} from './session.service';const DEFAULT_LIST_TAKE = 50;+/** A list page, not an export. `/export/events` is the bulk path. */+const MAX_LIST_TAKE = 1000;export const sessionRouter = createTRPCRouter({list: protectedProcedure@@ -25,7 +27,12 @@ export const sessionRouter = createTRPCRouter({startDate: z.date().optional(),endDate: z.date().optional(),search: z.string().optional(),- take: z.number().default(DEFAULT_LIST_TAKE),+ take: z+ .number()+ .int()+ .min(1)+ .max(MAX_LIST_TAKE)+ .default(DEFAULT_LIST_TAKE),})).query(async ({ input, ctx }) => {