Skip to content

OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.

fix(dashboard): project exclude filters are saved and applied to ingest

Carl-Gerhard Lindesvärd19a102b50f27
diff --git a/apps/start/src/components/settings/edit-project-filters.tsx b/apps/start/src/components/settings/edit-project-filters.tsx
index 8bba2cc01..08179ac04 100644
--- a/apps/start/src/components/settings/edit-project-filters.tsx
+++ b/apps/start/src/components/settings/edit-project-filters.tsx
@@ -11,7 +11,7 @@ import type {
IChartEventFilterValue,
} from '@openpanel/core/modules/report/report.constants';
import { shortId } from '@openpanel/shared';
-import { useMutation } from '@tanstack/react-query';
+import { useMutation, useQueryClient } from '@tanstack/react-query';
import { PlusIcon, SaveIcon, Trash2Icon } from 'lucide-react';
import { Controller, useForm } from 'react-hook-form';
import { toast } from 'sonner';
@@ -27,9 +27,9 @@ import { useEventNames } from '@/hooks/use-event-names';
import { handleError, useTRPC } from '@/integrations/trpc/react';
import type { RouterOutputs } from '@/trpc/client';
-type Props = {
+interface Props {
project: NonNullable<RouterOutputs['project']['getProjectWithClients']>;
-};
+}
const validator = z.object({
ips: z.array(z.string()),
@@ -120,22 +120,18 @@ function EventRuleItem({
</Button>
</div>
- {rule.filters.length > 0 && (
- <>
- {rule.filters.map((filter) => (
- <PureFilterItem
- className="border-t border-l-2 border-l-emerald-500 p-2 px-4"
- eventName={rule.name}
- filter={filter}
- immediateInput
- key={filter.id}
- onChangeOperator={changeFilterOperator}
- onChangeValue={changeFilterValue}
- onRemove={removeFilter}
- />
- ))}
- </>
- )}
+ {rule.filters.map((filter) => (
+ <PureFilterItem
+ className="border-t border-l-2 border-l-emerald-500 p-2 px-4"
+ eventName={rule.name}
+ filter={filter}
+ immediateInput
+ key={filter.id}
+ onChangeOperator={changeFilterOperator}
+ onChangeValue={changeFilterValue}
+ onRemove={removeFilter}
+ />
+ ))}
<div className="border-t p-4">
<PropertiesCombobox categories={['event']} onSelect={addFilter}>
{(setOpen) => (
@@ -179,11 +175,17 @@ export default function EditProjectFilters({ project }: Props) {
});
const trpc = useTRPC();
+ const queryClient = useQueryClient();
const mutation = useMutation(
trpc.project.update.mutationOptions({
onError: handleError,
onSuccess: () => {
toast.success('Project filters updated');
+ queryClient.invalidateQueries(
+ trpc.project.getProjectWithClients.queryFilter({
+ projectId: project.id,
+ })
+ );
},
})
);
@@ -238,15 +240,9 @@ export default function EditProjectFilters({ project }: Props) {
</p>
</WidgetHead>
<WidgetBody>
- <form
- className="space-y-4"
- onKeyDown={(e) => {
- if (e.key === 'Enter' && e.target instanceof HTMLInputElement) {
- e.preventDefault();
- }
- }}
- onSubmit={form.handleSubmit(onSubmit)}
- >
+ {/* Not a <form>: Enter in a tag or filter input adds a value, so the
+ page must never submit implicitly. */}
+ <div className="space-y-4">
<Controller
control={form.control}
name="ips"
@@ -309,11 +305,12 @@ export default function EditProjectFilters({ project }: Props) {
className="self-end"
icon={SaveIcon}
loading={mutation.isPending}
- type="submit"
+ onClick={form.handleSubmit(onSubmit)}
+ type="button"
>
Save
</Button>
- </form>
+ </div>
</WidgetBody>
</Widget>
);
diff --git a/packages/core/src/modules/project/project.rpc.test.ts b/packages/core/src/modules/project/project.rpc.test.ts
index 42573611a..7a087bde8 100644
--- a/packages/core/src/modules/project/project.rpc.test.ts
+++ b/packages/core/src/modules/project/project.rpc.test.ts
@@ -1,12 +1,13 @@
-// Only the "is anyone logged in" boundary is exercised here — no database.
-// The access-check + mutation bodies ride on @openpanel/db (lazy-loaded
-// through ./src/access and project.service.ts); wiring this router
-// end-to-end against a real Postgres is P6's (protectedProcedure) job, not
-// this one's — see project.rpc.ts's header.
+// No database: the anonymous tests stop at the login boundary, and the update
+// tests stub `ctx.services` to assert what the procedure hands the service.
import { expect, test } from 'bun:test';
-import { stubHttpCtx } from '../../../test/rpc-fixtures';
+import {
+ servicesWithProjectAccess,
+ stubHttpCtx,
+} from '../../../test/rpc-fixtures';
import { makeTrpcContext } from '../../rpc/base';
+import type { Services } from '../../services';
import type { CookieOptions } from '../../shared/cookie';
import { projectRouter } from './project.rpc';
@@ -86,3 +87,44 @@ test('cancelDeletion rejects an unauthenticated caller', async () => {
caller.cancelDeletion({ projectId: 'proj_1' })
).rejects.toMatchObject({ code: 'UNAUTHORIZED' });
});
+
+async function updateCallerRecordingInput() {
+ const updates: unknown[] = [];
+ const services = {
+ ...servicesWithProjectAccess(),
+ project: {
+ getProjectById: () =>
+ Promise.resolve({ id: 'proj_1', organizationId: 'org_1' }),
+ updateProjectForOrganization: (
+ _id: string,
+ _organizationId: string,
+ input: unknown
+ ) => {
+ updates.push(input);
+ return Promise.resolve(null);
+ },
+ },
+ } as unknown as Services;
+ const { ctx } = stubHttpCtx({ services });
+ const trpcCtx = await makeTrpcContext(ctx, new Headers(), {
+ cookieOptions: COOKIE_OPTIONS,
+ });
+ return { caller: projectRouter.createCaller(trpcCtx), updates };
+}
+
+test('update passes exclude filters through to the service', async () => {
+ const { caller, updates } = await updateCallerRecordingInput();
+ const filters = [{ type: 'ip' as const, ip: '203.0.113.7' }];
+
+ await caller.update({ id: 'proj_1', filters });
+
+ expect(updates).toEqual([expect.objectContaining({ filters })]);
+});
+
+test('update leaves filters undefined when the caller omits them', async () => {
+ const { caller, updates } = await updateCallerRecordingInput();
+
+ await caller.update({ id: 'proj_1', name: 'Renamed' });
+
+ expect(updates).toEqual([expect.objectContaining({ filters: undefined })]);
+});
diff --git a/packages/core/src/modules/project/project.rpc.ts b/packages/core/src/modules/project/project.rpc.ts
index 36a6b3883..d85f8cbef 100644
--- a/packages/core/src/modules/project/project.rpc.ts
+++ b/packages/core/src/modules/project/project.rpc.ts
@@ -80,6 +80,7 @@ export const projectRouter = createTRPCRouter({
cors: input.cors,
crossDomain: input.crossDomain,
allowUnsafeRevenueTracking: input.allowUnsafeRevenueTracking,
+ filters: input.filters,
}
);
}),
diff --git a/packages/core/src/modules/project/project.service.test.ts b/packages/core/src/modules/project/project.service.test.ts
index c24c12597..1b17ae247 100644
--- a/packages/core/src/modules/project/project.service.test.ts
+++ b/packages/core/src/modules/project/project.service.test.ts
@@ -262,6 +262,35 @@ test('updateProjectForOrganization strips trailing slashes from domain and cors'
expect(result?.cors).toEqual(['https://a.com', 'https://b.com']);
});
+test('updateProjectForOrganization persists exclude filters', async () => {
+ projectStore.set('p1', makeProject({ id: 'p1', organizationId: 'org_1' }));
+ const filters = [
+ { type: 'ip' as const, ip: '203.0.113.7' },
+ { type: 'profile_id' as const, profileId: 'usr_1' },
+ ];
+
+ const result = await subject.updateProjectForOrganization('p1', 'org_1', {
+ filters,
+ });
+
+ expect(result?.filters).toEqual(filters);
+ expect(projectStore.get('p1')?.filters).toEqual(filters);
+});
+
+test('updateProjectForOrganization leaves filters unchanged when omitted', async () => {
+ const filters = [{ type: 'ip', ip: '203.0.113.7' }];
+ projectStore.set(
+ 'p1',
+ makeProject({ id: 'p1', organizationId: 'org_1', filters })
+ );
+
+ await subject.updateProjectForOrganization('p1', 'org_1', {
+ name: 'Renamed',
+ });
+
+ expect(projectStore.get('p1')?.filters).toEqual(filters);
+});
+
test('deleteProjectForOrganization schedules a 24h grace period, scoped to the org', async () => {
projectStore.set('p1', makeProject({ id: 'p1', organizationId: 'org_1' }));
diff --git a/packages/core/src/modules/project/project.service.ts b/packages/core/src/modules/project/project.service.ts
index 4d8cd4d13..b05c0f84e 100644
--- a/packages/core/src/modules/project/project.service.ts
+++ b/packages/core/src/modules/project/project.service.ts
@@ -19,6 +19,7 @@ import { TABLE_NAMES } from '../../shared/ch-tables';
import { hashClientSecret } from '../../shared/client-secret';
import { getId } from '../../slug-id';
import { getClientByIdCached } from '../client/client.service';
+import type { IProjectFilters } from './project.constants';
// The `sql` tag is a value import of `@openpanel/db` and stays one: it is a
// compile-time template tag holding no client (see ch-query.ts).
@@ -391,6 +392,7 @@ export function createProjectService(
cors?: string[];
crossDomain?: boolean;
allowUnsafeRevenueTracking?: boolean;
+ filters?: IProjectFilters[];
}
): Promise<IServiceProject | null> {
const existing = await deps.db.project.findFirst({
@@ -420,6 +422,9 @@ export function createProjectService(
if (input.allowUnsafeRevenueTracking !== undefined) {
updateData.allowUnsafeRevenueTracking = input.allowUnsafeRevenueTracking;
}
+ if (input.filters !== undefined) {
+ updateData.filters = input.filters;
+ }
const project = await deps.db.project.update({
where: { id },