Skip to content

🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.

Enhance funnel functionality with filter integration (#80)

Bill Yang0f159e6794f5
diff --git a/client/src/api/analytics/useGetFunnel.ts b/client/src/api/analytics/useGetFunnel.ts
index 24dc87bd6..3bb2c7111 100644
--- a/client/src/api/analytics/useGetFunnel.ts
+++ b/client/src/api/analytics/useGetFunnel.ts
@@ -1,7 +1,7 @@
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
import { BACKEND_URL } from "../../lib/const";
import { authedFetch } from "../utils";
-import { useStore } from "../../lib/store";
+import { useStore, Filter } from "../../lib/store";
export type FunnelStep = {
value: string;
@@ -14,6 +14,7 @@ export type FunnelRequest = {
startDate: string | null;
endDate: string | null;
name?: string;
+ filters?: Filter[];
};
export type SaveFunnelRequest = {
@@ -22,6 +23,7 @@ export type SaveFunnelRequest = {
endDate: string;
name: string;
reportId?: number;
+ filters?: Filter[];
};
export type FunnelResponse = {
@@ -41,7 +43,6 @@ export function useGetFunnel(config?: FunnelRequest) {
return useQuery<{ data: FunnelResponse[] }, Error>({
queryKey: ["funnel", site, config],
queryFn: async () => {
- console.info(config);
if (!config) {
throw new Error("Funnel configuration is required");
}
diff --git a/client/src/api/analytics/useGetFunnels.ts b/client/src/api/analytics/useGetFunnels.ts
index 91627dd22..41b6ceb53 100644
--- a/client/src/api/analytics/useGetFunnels.ts
+++ b/client/src/api/analytics/useGetFunnels.ts
@@ -2,11 +2,13 @@ import { useQuery } from "@tanstack/react-query";
import { BACKEND_URL } from "../../lib/const";
import { authedFetch } from "../utils";
import { FunnelStep } from "./useGetFunnel";
+import { Filter } from "../../lib/store";
export interface SavedFunnel {
id: number;
name: string;
steps: FunnelStep[];
+ filters?: Filter[];
createdAt: string;
updatedAt: string;
conversionRate: number | null;
diff --git a/client/src/app/[site]/components/SubHeader/Filters/Filters.tsx b/client/src/app/[site]/components/SubHeader/Filters/Filters.tsx
index c6bc28672..f3343809b 100644
--- a/client/src/app/[site]/components/SubHeader/Filters/Filters.tsx
+++ b/client/src/app/[site]/components/SubHeader/Filters/Filters.tsx
@@ -10,80 +10,11 @@ import {
import { getCountryName } from "../../../../../lib/utils";
import { NewFilterButton } from "./NewFilterButton";
import { useGetRegionName } from "../../../../../lib/geo";
-
-function getParameterNameLabel(parameter: FilterParameter) {
- switch (parameter) {
- case "country":
- return "Country";
- case "device_type":
- return "Device Type";
- case "operating_system":
- return "OS";
- case "browser":
- return "Browser";
- case "referrer":
- return "Referrer";
- case "pathname":
- return "Path";
- case "page_title":
- return "Title";
- case "querystring":
- return "Query";
- case "language":
- return "Language";
- case "city":
- return "City";
- case "region":
- return "Region";
- case "iso_3166_2":
- return "Region";
- case "entry_page":
- return "Entry Page";
- case "exit_page":
- return "Exit Page";
- case "dimensions":
- return "Dimension";
- case "event_name":
- return "Event Name";
- default:
- return parameter;
- }
-}
-
-const filterTypeToLabel = (type: FilterType) => {
- switch (type) {
- case "equals":
- return "is";
- case "not_equals":
- return "is not";
- case "contains":
- return "contains";
- case "not_contains":
- return "not contains";
- }
-};
-
-function getParameterValueLabel(
- filter: Filter,
- getRegionName: (iso_3166_2: string) => string | undefined
-) {
- const formatValue = (value: string) => {
- if (filter.parameter === "country") {
- return getCountryName(value);
- }
- if (filter.parameter === "iso_3166_2") {
- return getRegionName(value);
- }
- return value;
- };
-
- if (filter.value.length === 1) {
- return formatValue(filter.value[0]);
- }
-
- // For multiple values, format them and join with commas
- return filter.value.map(formatValue).join(", ");
-}
+import {
+ filterTypeToLabel,
+ getParameterNameLabel,
+ getParameterValueLabel,
+} from "../../shared/Filters/utils";
export function Filters() {
const { filters } = useStore();
diff --git a/client/src/app/[site]/components/SubHeader/Filters/NewFilterButton.tsx b/client/src/app/[site]/components/SubHeader/Filters/NewFilterButton.tsx
index e7764d8d9..b1397f360 100644
--- a/client/src/app/[site]/components/SubHeader/Filters/NewFilterButton.tsx
+++ b/client/src/app/[site]/components/SubHeader/Filters/NewFilterButton.tsx
@@ -43,13 +43,13 @@ export function NewFilterButton() {
const onClose = async () => {
setOpen(false);
- setLocalFilters(filters);
await sleep(100);
};
return (
<DropdownMenu
onOpenChange={(isOpen) => {
+ setLocalFilters(filters);
if (!isOpen) {
onClose();
}
diff --git a/client/src/app/[site]/components/shared/Filters/utils.ts b/client/src/app/[site]/components/shared/Filters/utils.ts
new file mode 100644
index 000000000..693b5ea06
--- /dev/null
+++ b/client/src/app/[site]/components/shared/Filters/utils.ts
@@ -0,0 +1,78 @@
+import { Filter, FilterParameter, FilterType } from "../../../../../lib/store";
+import { getCountryName } from "../../../../../lib/utils";
+
+export function getParameterNameLabel(parameter: FilterParameter) {
+ switch (parameter) {
+ case "country":
+ return "Country";
+ case "device_type":
+ return "Device Type";
+ case "operating_system":
+ return "OS";
+ case "browser":
+ return "Browser";
+ case "referrer":
+ return "Referrer";
+ case "pathname":
+ return "Path";
+ case "page_title":
+ return "Title";
+ case "querystring":
+ return "Query";
+ case "language":
+ return "Language";
+ case "city":
+ return "City";
+ case "region":
+ return "Region";
+ case "iso_3166_2":
+ return "Region";
+ case "entry_page":
+ return "Entry Page";
+ case "exit_page":
+ return "Exit Page";
+ case "dimensions":
+ return "Dimension";
+ case "event_name":
+ return "Event Name";
+ default:
+ return parameter;
+ }
+}
+
+export const filterTypeToLabel = (type: FilterType) => {
+ switch (type) {
+ case "equals":
+ return "is";
+ case "not_equals":
+ return "is not";
+ case "contains":
+ return "contains";
+ case "not_contains":
+ return "not contains";
+ default:
+ return type;
+ }
+};
+
+export function getParameterValueLabel(
+ filter: Filter,
+ getRegionName: (iso_3166_2: string) => string | undefined
+) {
+ const formatValue = (value: string) => {
+ if (filter.parameter === "country") {
+ return getCountryName(value);
+ }
+ if (filter.parameter === "iso_3166_2") {
+ return getRegionName(value);
+ }
+ return value;
+ };
+
+ if (filter.value.length === 1) {
+ return formatValue(filter.value[0]);
+ }
+
+ // For multiple values, format them and join with commas
+ return filter.value.map(formatValue).join(", ");
+}
diff --git a/client/src/app/[site]/funnels/components/CreateFunnel.tsx b/client/src/app/[site]/funnels/components/CreateFunnel.tsx
index 9e7ea4007..9fee8ffd9 100644
--- a/client/src/app/[site]/funnels/components/CreateFunnel.tsx
+++ b/client/src/app/[site]/funnels/components/CreateFunnel.tsx
@@ -1,37 +1,26 @@
"use client";
-import { useState } from "react";
-import { Button } from "@/components/ui/button";
-import { Input } from "@/components/ui/input";
-import { Card, CardContent, CardHeader, CardTitle } from "@/components/ui/card";
import {
- Select,
- SelectContent,
- SelectItem,
- SelectTrigger,
- SelectValue,
-} from "@/components/ui/select";
-import { Plus, Trash2, Search, Save } from "lucide-react";
-import { Time } from "@/components/DateSelector/types";
-import { DateTime } from "luxon";
-import {
- useGetFunnel,
FunnelStep,
+ useGetFunnel,
useSaveFunnel,
} from "@/api/analytics/useGetFunnel";
-import { Funnel } from "./Funnel";
+import { Time } from "@/components/DateSelector/types";
+import { Button } from "@/components/ui/button";
import {
Dialog,
DialogContent,
DialogHeader,
DialogTitle,
DialogTrigger,
- DialogFooter,
} from "@/components/ui/dialog";
-import { useStore } from "@/lib/store";
+import { Plus } from "lucide-react";
+import { DateTime } from "luxon";
+import { useState } from "react";
import { toast } from "sonner";
import { getStartAndEndDate } from "../../../../api/utils";
-import { useDebounce } from "@uidotdev/usehooks";
+import { FunnelForm } from "./FunnelForm";
+import { Filter } from "../../../../lib/store";
export function CreateFunnelDialog() {
const [open, setOpen] = useState(false);
@@ -50,14 +39,13 @@ export function CreateFunnelDialog() {
{ type: "page", value: "", name: "" },
]);
- // Debounce steps and time changes
- const debouncedSteps = useDebounce(steps, 300);
- const debouncedTime = useDebounce(time, 300);
+ // Funnel filters state
+ const [filters, setFilters] = useState<Filter[]>([]);
// Funnel name
const [name, setName] = useState("New Funnel");
- const { startDate, endDate } = getStartAndEndDate(debouncedTime);
+ const { startDate, endDate } = getStartAndEndDate(time);
// Funnel analysis query
const {
@@ -66,12 +54,13 @@ export function CreateFunnelDialog() {
error,
isLoading: isPending,
} = useGetFunnel(
- debouncedSteps.some((step) => !step.value)
+ steps.some((step) => !step.value)
? undefined
: {
- steps: debouncedSteps,
+ steps,
startDate,
endDate,
+ filters,
}
);
@@ -82,37 +71,6 @@ export function CreateFunnelDialog() {
error: saveError,
} = useSaveFunnel();
- // Handle adding a new step
- const addStep = () => {
- setSteps([...steps, { type: "page", value: "", name: "" }]);
- };
-
- // Handle removing a step
- const removeStep = (index: number) => {
- if (steps.length <= 2) return; // Maintain at least 2 steps
- const newSteps = [...steps];
- newSteps.splice(index, 1);
- setSteps(newSteps);
- };
-
- // Handle step input changes
- const updateStep = (
- index: number,
- field: keyof FunnelStep,
- value: string
- ) => {
- const newSteps = [...steps];
- newSteps[index] = { ...newSteps[index], [field]: value };
- setSteps(newSteps);
- };
-
- // Handle step type changes
- const updateStepType = (index: number, type: "page" | "event") => {
- const newSteps = [...steps];
- newSteps[index] = { ...newSteps[index], type };
- setSteps(newSteps);
- };
-
// Query funnel without saving
const handleQueryFunnel = () => {
// Validate steps have values
@@ -179,6 +137,7 @@ export function CreateFunnelDialog() {
startDate,
endDate,
name,
+ filters: filters.length > 0 ? filters : undefined,
},
{
onSuccess: () => {
@@ -215,142 +174,26 @@ export function CreateFunnelDialog() {
<DialogTitle>Create Funnel</DialogTitle>
</DialogHeader>
- <div className="grid grid-cols-[600px_3fr] gap-6 my-4">
- {/* Left side: Funnel configuration form */}
- <div className="space-y-4">
- <div>
- <label className="text-sm font-medium mb-1 block">
- Funnel Name
- </label>
- <Input
- value={name}
- onChange={(e) => setName(e.target.value)}
- placeholder="Enter funnel name"
- />
- </div>
-
- {/* Funnel Steps in a boxed container */}
- <Card className="border border-neutral-200 dark:border-neutral-800">
- <CardHeader className="px-4 py-3">
- <CardTitle className="text-base">Funnel Steps</CardTitle>
- </CardHeader>
- <CardContent className="px-4 py-3 space-y-4">
- {steps.map((step, index) => (
- <div key={index} className="flex flex-col space-y-2">
- <div className="flex items-center gap-2">
- <div className="flex-shrink-0 w-6 h-6 rounded-full bg-neutral-800 flex items-center justify-center text-xs">
- {index + 1}
- </div>
- <Select
- value={step.type}
- onValueChange={(value) =>
- updateStepType(index, value as "page" | "event")
- }
- >
- <SelectTrigger className="w-[120px]">
- <SelectValue placeholder="Type" />
- </SelectTrigger>
- <SelectContent>
- <SelectItem value="page">Page Path</SelectItem>
- <SelectItem value="event">Event</SelectItem>
- </SelectContent>
- </Select>
-
- <div className="flex-grow flex gap-2">
- <Input
- placeholder={
- step.type === "page"
- ? "Path (e.g. /pricing)"
- : "Event name"
- }
- value={step.value}
- onChange={(e) =>
- updateStep(index, "value", e.target.value)
- }
- />
- <Input
- placeholder="Label (optional)"
- value={step.name || ""}
- onChange={(e) =>
- updateStep(index, "name", e.target.value)
- }
- />
- </div>
-
- <Button
- variant="ghost"
- size="sm"
- onClick={() => removeStep(index)}
- disabled={steps.length <= 2}
- >
- <Trash2 className="h-4 w-4" />
- </Button>
- </div>
- </div>
- ))}
-
- <Button variant="outline" onClick={addStep} className="w-full">
- <Plus className="mr-2 h-4 w-4" /> Add Step
- </Button>
- </CardContent>
- </Card>
-
- {/* Query Funnel button on the left side */}
- <Button
- onClick={handleQueryFunnel}
- disabled={isPending}
- className="w-full"
- variant="accent"
- >
- <Search className="mr-2 h-4 w-4" />
- {isPending ? "Querying..." : "Query Funnel"}
- </Button>
- </div>
-
- {/* Right side: Funnel visualization (if data exists) */}
- {data?.data && data.data.length > 0 ? (
- <Funnel
- data={data}
- isError={isError}
- error={error}
- isPending={isPending}
- time={time}
- setTime={setTime}
- />
- ) : (
- <div className="flex items-center justify-center bg-neutral-50 dark:bg-neutral-900 rounded-lg h-full">
- <div className="text-center p-6">
- <div className="text-lg font-medium mb-2">Funnel Preview</div>
- <p className="text-sm text-neutral-500">
- Configure your funnel steps and click "Query Funnel" to
- preview results
- </p>
- </div>
- </div>
- )}
- </div>
-
- <DialogFooter className="flex justify-between items-center">
- <div className="text-sm text-red-500">
- {(isError || saveError) &&
- (error instanceof Error || saveError instanceof Error
- ? (error || saveError)?.message
- : "An error occurred")}
- </div>
- <div className="flex gap-2">
- <Button variant="outline" onClick={() => setOpen(false)}>
- Cancel
- </Button>
- <Button
- onClick={handleSaveFunnel}
- disabled={isSaving}
- variant="success"
- >
- <Save className="mr-2 h-4 w-4" />
- {isSaving ? "Saving..." : "Save Funnel"}
- </Button>
- </div>
- </DialogFooter>
+ <FunnelForm
+ name={name}
+ setName={setName}
+ steps={steps}
+ setSteps={setSteps}
+ time={time}
+ setTime={setTime}
+ filters={filters}
+ setFilters={setFilters}
+ onSave={handleSaveFunnel}
+ onCancel={() => setOpen(false)}
+ onQuery={handleQueryFunnel}
+ saveButtonText="Save Funnel"
+ isSaving={isSaving}
+ isError={isError}
+ isPending={isPending}
+ error={error}
+ saveError={saveError}
+ funnelData={data}
+ />
</DialogContent>
</Dialog>
);
diff --git a/client/src/app/[site]/funnels/components/EditFunnel.tsx b/client/src/app/[site]/funnels/components/EditFunnel.tsx
index 75d1ad149..58fc4cd8c 100644
--- a/client/src/app/[site]/funnels/components/EditFunnel.tsx
+++ b/client/src/app/[site]/funnels/components/EditFunnel.tsx
@@ -1,17 +1,6 @@
"use client";
import { useState, useEffect } from "react";
-import { Button } from "@/components/ui/button";
-import { Input } from "@/components/ui/input";
-import { Card, CardContent, CardHeader, CardTitle } from "@/components/ui/card";
-import {
- Select,
- SelectContent,
- SelectItem,
- SelectTrigger,
- SelectValue,
-} from "@/components/ui/select";
-import { Plus, Trash2, Search, Save } from "lucide-react";
import { Time } from "@/components/DateSelector/types";
import { DateTime } from "luxon";
import {
@@ -20,18 +9,16 @@ import {
useSaveFunnel,
} from "@/api/analytics/useGetFunnel";
import { SavedFunnel } from "@/api/analytics/useGetFunnels";
-import { Funnel } from "./Funnel";
import {
Dialog,
DialogContent,
DialogHeader,
DialogTitle,
- DialogFooter,
} from "@/components/ui/dialog";
-import { useStore } from "@/lib/store";
import { toast } from "sonner";
import { getStartAndEndDate } from "../../../../api/utils";
-import { useDebounce } from "@uidotdev/usehooks";
+import { FunnelForm } from "./FunnelForm";
+import { Filter } from "../../../../lib/store";
interface EditFunnelDialogProps {
funnel: SavedFunnel;
@@ -55,14 +42,13 @@ export function EditFunnelDialog({
// Funnel steps state - initialized from funnel
const [steps, setSteps] = useState<FunnelStep[]>(funnel.steps);
- // Debounce steps and time changes
- const debouncedSteps = useDebounce(steps, 300);
- const debouncedTime = useDebounce(time, 300);
+ // Funnel filters state - initialized from funnel
+ const [filters, setFilters] = useState<Filter[]>(funnel.filters || []);
// Funnel name - initialized from funnel
const [name, setName] = useState(funnel.name);
- const { startDate, endDate } = getStartAndEndDate(debouncedTime);
+ const { startDate, endDate } = getStartAndEndDate(time);
// Funnel analysis query
const {
@@ -71,9 +57,10 @@ export function EditFunnelDialog({
error,
isLoading: isPending,
} = useGetFunnel({
- steps: debouncedSteps,
+ steps,
startDate,
endDate,
+ filters,
});
// Funnel save mutation
@@ -83,37 +70,6 @@ export function EditFunnelDialog({
error: saveError,
} = useSaveFunnel();
- // Handle adding a new step
- const addStep = () => {
- setSteps([...steps, { type: "page", value: "", name: "" }]);
- };
-
- // Handle removing a step
- const removeStep = (index: number) => {
- if (steps.length <= 2) return; // Maintain at least 2 steps
- const newSteps = [...steps];
- newSteps.splice(index, 1);
- setSteps(newSteps);
- };
-
- // Handle step input changes
- const updateStep = (
- index: number,
- field: keyof FunnelStep,
- value: string
- ) => {
- const newSteps = [...steps];
- newSteps[index] = { ...newSteps[index], [field]: value };
- setSteps(newSteps);
- };
-
- // Handle step type changes
- const updateStepType = (index: number, type: "page" | "event") => {
- const newSteps = [...steps];
- newSteps[index] = { ...newSteps[index], type };
- setSteps(newSteps);
- };
-
// Query funnel without saving
const handleQueryFunnel = () => {
// Validate steps have values
@@ -181,6 +137,7 @@ export function EditFunnelDialog({
endDate,
name,
reportId: funnel.id,
+ filters: filters.length > 0 ? filters : undefined,
},
{
onSuccess: () => {
@@ -210,142 +167,26 @@ export function EditFunnelDialog({
<DialogTitle>Edit Funnel</DialogTitle>
</DialogHeader>
- <div className="grid grid-cols-[600px_3fr] gap-6 my-4">
- {/* Left side: Funnel configuration form */}
- <div className="space-y-4">
- <div>
- <label className="text-sm font-medium mb-1 block">
- Funnel Name
- </label>
- <Input
- value={name}
- onChange={(e) => setName(e.target.value)}
- placeholder="Enter funnel name"
- />
- </div>
-
- {/* Funnel Steps in a boxed container */}
- <Card className="border border-neutral-200 dark:border-neutral-800">
- <CardHeader className="px-4 py-3">
- <CardTitle className="text-base">Funnel Steps</CardTitle>
- </CardHeader>
- <CardContent className="px-4 py-3 space-y-4">
- {steps.map((step, index) => (
- <div key={index} className="flex flex-col space-y-2">
- <div className="flex items-center gap-2">
- <div className="flex-shrink-0 w-6 h-6 rounded-full bg-neutral-800 flex items-center justify-center text-xs">
- {index + 1}
- </div>
- <Select
- value={step.type}
- onValueChange={(value) =>
- updateStepType(index, value as "page" | "event")
- }
- >
- <SelectTrigger className="w-[120px]">
- <SelectValue placeholder="Type" />
- </SelectTrigger>
- <SelectContent>
- <SelectItem value="page">Page Path</SelectItem>
- <SelectItem value="event">Event</SelectItem>
- </SelectContent>
- </Select>
-
- <div className="flex-grow flex gap-2">
- <Input
- placeholder={
- step.type === "page"
- ? "Path (e.g. /pricing)"
- : "Event name"
- }
- value={step.value}
- onChange={(e) =>
- updateStep(index, "value", e.target.value)
- }
- />
- <Input
- placeholder="Label (optional)"
- value={step.name || ""}
- onChange={(e) =>
- updateStep(index, "name", e.target.value)
- }
- />
- </div>
-
- <Button
- variant="ghost"
- size="sm"
- onClick={() => removeStep(index)}
- disabled={steps.length <= 2}
- >
- <Trash2 className="h-4 w-4" />
- </Button>
- </div>
- </div>
- ))}
-
- <Button variant="outline" onClick={addStep} className="w-full">
- <Plus className="mr-2 h-4 w-4" /> Add Step
- </Button>
- </CardContent>
- </Card>
-
- {/* Query Funnel button on the left side */}
- <Button
- onClick={handleQueryFunnel}
- disabled={isPending}
- className="w-full"
- variant="accent"
- >
- <Search className="mr-2 h-4 w-4" />
- {isPending ? "Querying..." : "Query Funnel"}
- </Button>
- </div>
-
- {/* Right side: Funnel visualization (if data exists) */}
- {data?.data && data.data.length > 0 ? (
- <Funnel
- data={data}
- isError={isError}
- error={error}
- isPending={isPending}
- time={time}
- setTime={setTime}
- />
- ) : (
- <div className="flex items-center justify-center bg-neutral-50 dark:bg-neutral-900 rounded-lg h-full">
- <div className="text-center p-6">
- <div className="text-lg font-medium mb-2">Funnel Preview</div>
- <p className="text-sm text-neutral-500">
- Configure your funnel steps and click "Query Funnel" to
- preview results
- </p>
- </div>
- </div>
- )}
- </div>
-
- <DialogFooter className="flex justify-between items-center">
- <div className="text-sm text-red-500">
- {(isError || saveError) &&
- (error instanceof Error || saveError instanceof Error
- ? (error || saveError)?.message
- : "An error occurred")}
- </div>
- <div className="flex gap-2">
- <Button variant="outline" onClick={onClose}>
- Cancel
- </Button>
- <Button
- onClick={handleUpdateFunnel}
- disabled={isSaving}
- variant="success"
- >
- <Save className="mr-2 h-4 w-4" />
- {isSaving ? "Saving..." : "Update Funnel"}
- </Button>
- </div>
- </DialogFooter>
+ <FunnelForm
+ name={name}
+ setName={setName}
+ steps={steps}
+ setSteps={setSteps}
+ time={time}
+ setTime={setTime}
+ filters={filters}
+ setFilters={setFilters}
+ onSave={handleUpdateFunnel}
+ onCancel={onClose}
+ onQuery={handleQueryFunnel}
+ saveButtonText="Update Funnel"
+ isSaving={isSaving}
+ isError={isError}
+ isPending={isPending}
+ error={error}
+ saveError={saveError}
+ funnelData={data}
+ />
</DialogContent>
</Dialog>
);
diff --git a/client/src/app/[site]/funnels/components/FunnelForm.tsx b/client/src/app/[site]/funnels/components/FunnelForm.tsx
new file mode 100644
index 000000000..996e92253
--- /dev/null
+++ b/client/src/app/[site]/funnels/components/FunnelForm.tsx
@@ -0,0 +1,316 @@
+import { useState } from "react";
+import { Button } from "@/components/ui/button";
+import { Input } from "@/components/ui/input";
+import { Card, CardContent, CardHeader, CardTitle } from "@/components/ui/card";
+import {
+ Select,
+ SelectContent,
+ SelectItem,
+ SelectTrigger,
+ SelectValue,
+} from "@/components/ui/select";
+import { Plus, Trash2, Search, Save, ListFilterPlus } from "lucide-react";
+import { Time } from "@/components/DateSelector/types";
+import { DateTime } from "luxon";
+import { FunnelStep, useGetFunnel } from "@/api/analytics/useGetFunnel";
+import { Funnel } from "./Funnel";
+import { useDebounce } from "@uidotdev/usehooks";
+import { getStartAndEndDate } from "../../../../api/utils";
+import { ReactNode } from "react";
+import { Filter } from "../../../../lib/store";
+import { FilterComponent } from "../../components/shared/Filters/FilterComponent";
+
+interface FunnelFormProps {
+ name: string;
+ setName: (name: string) => void;
+ steps: FunnelStep[];
+ setSteps: (steps: FunnelStep[]) => void;
+ time: Time;
+ setTime: (time: Time) => void;
+ filters: Filter[];
+ setFilters: (filters: Filter[]) => void;
+ onSave: () => void;
+ onCancel: () => void;
+ onQuery: () => void;
+ saveButtonText: string;
+ isSaving: boolean;
+ isError: boolean;
+ isPending: boolean;
+ error: unknown;
+ saveError: unknown;
+ funnelData: any;
+}
+
+export function FunnelForm({
+ name,
+ setName,
+ steps,
+ setSteps,
+ time,
+ setTime,
+ filters,
+ setFilters,
+ onSave,
+ onCancel,
+ onQuery,
+ saveButtonText,
+ isSaving,
+ isError,
+ isPending,
+ error,
+ saveError,
+ funnelData,
+}: FunnelFormProps) {
+ // Debounce steps and time changes
+ const debouncedSteps = useDebounce(steps, 300);
+ const debouncedTime = useDebounce(time, 300);
+ const [showFilters, setShowFilters] = useState(filters.length > 0);
+
+ const { startDate, endDate } = getStartAndEndDate(debouncedTime);
+
+ // Get error message as string
+ const getErrorMessage = (err: unknown): string => {
+ if (err instanceof Error) return err.message;
+ if (typeof err === "string") return err;
+ return "An error occurred";
+ };
+
+ // Handle adding a new step
+ const addStep = () => {
+ setSteps([...steps, { type: "page", value: "", name: "" }]);
+ };
+
+ // Handle removing a step
+ const removeStep = (index: number) => {
+ if (steps.length <= 2) return; // Maintain at least 2 steps
+ const newSteps = [...steps];
+ newSteps.splice(index, 1);
+ setSteps(newSteps);
+ };
+
+ // Handle step input changes
+ const updateStep = (
+ index: number,
+ field: keyof FunnelStep,
+ value: string
+ ) => {
+ const newSteps = [...steps];
+ newSteps[index] = { ...newSteps[index], [field]: value };
+ setSteps(newSteps);
+ };
+
+ // Handle step type changes
+ const updateStepType = (index: number, type: "page" | "event") => {
+ const newSteps = [...steps];
+ newSteps[index] = { ...newSteps[index], type };
+ setSteps(newSteps);
+ };
+
+ // Handle filter operations
+ const updateFilter = (filter: Filter | null, index: number) => {
+ if (filter === null) {
+ const newFilters = [...filters];
+ newFilters.splice(index, 1);
+ setFilters(newFilters);
+ return;
+ }
+ const newFilters = [...filters];
+ newFilters[index] = filter;
+ setFilters(newFilters);
+ };
+
+ const addFilter = () => {
+ setFilters([
+ ...filters,
+ {
+ parameter: "pathname",
+ type: "equals",
+ value: [],
+ },
+ ]);
+ setShowFilters(true);
+ };
+
+ return (
+ <>
+ <div className="grid grid-cols-[600px_3fr] gap-6 my-4">
+ {/* Left side: Funnel configuration form */}
+ <div className="space-y-4">
+ <div>
+ <label className="text-sm font-medium mb-1 block">
+ Funnel Name
+ </label>
+ <Input
+ value={name}
+ onChange={(e) => setName(e.target.value)}
+ placeholder="Enter funnel name"
+ />
+ </div>
+
+ {/* Funnel Steps in a boxed container */}
+ <Card className="border border-neutral-200 dark:border-neutral-800">
+ <CardHeader className="px-4 py-3">
+ <CardTitle className="text-base">Funnel Steps</CardTitle>
+ </CardHeader>
+ <CardContent className="px-4 py-3 space-y-4">
+ {steps.map((step, index) => (
+ <div key={index} className="flex flex-col space-y-2">
+ <div className="flex items-center gap-2">
+ <div className="flex-shrink-0 w-6 h-6 rounded-full bg-neutral-800 flex items-center justify-center text-xs">
+ {index + 1}
+ </div>
+ <Select
+ value={step.type}
+ onValueChange={(value) =>
+ updateStepType(index, value as "page" | "event")
+ }
+ >
+ <SelectTrigger className="w-[120px]">
+ <SelectValue placeholder="Type" />
+ </SelectTrigger>
+ <SelectContent>
+ <SelectItem value="page">Page Path</SelectItem>
+ <SelectItem value="event">Event</SelectItem>
+ </SelectContent>
+ </Select>
+
+ <div className="flex-grow flex gap-2">
+ <Input
+ placeholder={
+ step.type === "page"
+ ? "Path (e.g. /pricing)"
+ : "Event name"
+ }
+ value={step.value}
+ onChange={(e) =>
+ updateStep(index, "value", e.target.value)
+ }
+ />
+ <Input
+ placeholder="Label (optional)"
+ value={step.name || ""}
+ onChange={(e) =>
+ updateStep(index, "name", e.target.value)
+ }
+ />
+ </div>
+
+ <Button
+ variant="ghost"
+ size="sm"
+ onClick={() => removeStep(index)}
+ disabled={steps.length <= 2}
+ >
+ <Trash2 className="h-4 w-4" />
+ </Button>
+ </div>
+ </div>
+ ))}
+
+ <Button variant="outline" onClick={addStep} className="w-full">
+ <Plus className="mr-2 h-4 w-4" /> Add Step
+ </Button>
+ </CardContent>
+ </Card>
+
+ {/* Filters Section */}
+ <Card className="border border-neutral-200 dark:border-neutral-800">
+ <CardHeader className="px-4 py-3 flex flex-row justify-between items-center">
+ <CardTitle className="text-base">Funnel Filters</CardTitle>
+ {!showFilters && (
+ <Button variant="outline" size="sm" onClick={addFilter}>
+ <ListFilterPlus className="mr-2 h-4 w-4" />
+ Add Filters
+ </Button>
+ )}
+ </CardHeader>
+ {showFilters && (
+ <CardContent className="px-4 py-3 space-y-4">
+ <div className="flex flex-col gap-2">
+ {filters.map((filter, index) => (
+ <FilterComponent
+ key={index}
+ filter={filter}
+ index={index}
+ updateFilter={updateFilter}
+ />
+ ))}
+ </div>
+ <div className="flex justify-between">
+ <Button
+ variant="ghost"
+ size="sm"
+ onClick={addFilter}
+ className="gap-1"
+ >
+ <Plus className="w-3 h-3" />
+ Add Filter
+ </Button>
+ </div>
+ </CardContent>
+ )}
+ </Card>
+
+ {/* Query Funnel button on the left side */}
+ <Button
+ onClick={onQuery}
+ disabled={isPending}
+ className="w-full"
+ variant="accent"
+ >
+ <Search className="mr-2 h-4 w-4" />
+ {isPending ? "Querying..." : "Query Funnel"}
+ </Button>
+ </div>
+
+ {/* Right side: Funnel visualization (if data exists) */}
+ {funnelData?.data && funnelData.data.length > 0 ? (
+ <Funnel
+ data={funnelData}
+ isError={isError}
+ error={error}
+ isPending={isPending}
+ time={time}
+ setTime={setTime}
+ />
+ ) : (
+ <div className="flex items-center justify-center bg-neutral-50 dark:bg-neutral-900 rounded-lg h-full">
+ <div className="text-center p-6">
+ <div className="text-lg font-medium mb-2">Funnel Preview</div>
+ <p className="text-sm text-neutral-500">
+ Configure your funnel steps and click "Query Funnel" to preview
+ results
+ </p>
+ </div>
+ </div>
+ )}
+ </div>
+
+ <div className="flex justify-between items-center">
+ <div className="text-sm text-red-500">
+ {(() => {
+ if (isError) {
+ return error instanceof Error
+ ? error.message
+ : "An error occurred";
+ } else if (saveError) {
+ return saveError instanceof Error
+ ? saveError.message
+ : "An error occurred while saving";
+ }
+ return null;
+ })()}
+ </div>
+ <div className="flex gap-2">
+ <Button variant="outline" onClick={onCancel}>
+ Cancel
+ </Button>
+ <Button onClick={onSave} disabled={isSaving} variant="success">
+ <Save className="mr-2 h-4 w-4" />
+ {isSaving ? "Saving..." : saveButtonText}
+ </Button>
+ </div>
+ </div>
+ </>
+ );
+}
diff --git a/client/src/app/[site]/funnels/components/FunnelRow.tsx b/client/src/app/[site]/funnels/components/FunnelRow.tsx
index fed72e234..6e3ba30da 100644
--- a/client/src/app/[site]/funnels/components/FunnelRow.tsx
+++ b/client/src/app/[site]/funnels/components/FunnelRow.tsx
@@ -8,30 +8,35 @@ import { DateRangeMode, Time } from "@/components/DateSelector/types";
import { Button } from "@/components/ui/button";
import { Card } from "@/components/ui/card";
import {
- BarChart2,
- Calendar,
+ Tooltip,
+ TooltipContent,
+ TooltipProvider,
+ TooltipTrigger,
+} from "@/components/ui/tooltip";
+import { useDebounce } from "@uidotdev/usehooks";
+import {
+ ArrowRight,
ChevronDown,
ChevronUp,
Edit,
+ FilterIcon,
FunnelIcon,
- Trash2,
Globe,
+ Trash2,
ZapIcon,
- ArrowRight,
} from "lucide-react";
import { DateTime } from "luxon";
import { useState } from "react";
import { toast } from "sonner";
import { getStartAndEndDate } from "../../../../api/utils";
+import { useGetRegionName } from "../../../../lib/geo";
+import {
+ filterTypeToLabel,
+ getParameterNameLabel,
+ getParameterValueLabel,
+} from "../../components/shared/Filters/utils";
import { EditFunnelDialog } from "./EditFunnel";
import { Funnel } from "./Funnel";
-import { useDebounce } from "@uidotdev/usehooks";
-import {
- Tooltip,
- TooltipContent,
- TooltipProvider,
- TooltipTrigger,
-} from "@/components/ui/tooltip";
interface FunnelRowProps {
funnel: SavedFunnel;
@@ -41,6 +46,7 @@ export function FunnelRow({ funnel }: FunnelRowProps) {
const [expanded, setExpanded] = useState(false);
const [isDeleteModalOpen, setIsDeleteModalOpen] = useState(false);
const [isEditModalOpen, setIsEditModalOpen] = useState(false);
+ const { getRegionName } = useGetRegionName();
// Time state for funnel visualization - default to last 7 days
const [time, setTime] = useState<Time>({
@@ -67,6 +73,7 @@ export function FunnelRow({ funnel }: FunnelRowProps) {
steps: funnel.steps,
startDate,
endDate,
+ filters: funnel.filters,
}
: undefined
);
@@ -79,19 +86,6 @@ export function FunnelRow({ funnel }: FunnelRowProps) {
setExpanded(!expanded);
};
- // Format date string
- const formatDate = (dateString: string) => {
- try {
- return new Date(dateString).toLocaleDateString(undefined, {
- year: "numeric",
- month: "short",
- day: "numeric",
- });
- } catch (e) {
- return "Unknown date";
- }
- };
-
// Handle funnel deletion
const handleDeleteFunnel = async () => {
try {
@@ -103,6 +97,9 @@ export function FunnelRow({ funnel }: FunnelRowProps) {
}
};
+ // Check if funnel has filters
+ const hasFilters = funnel.filters && funnel.filters.length > 0;
+
return (
<Card className="mb-4 overflow-hidden">
{/* Header row (always visible) */}
@@ -114,17 +111,10 @@ export function FunnelRow({ funnel }: FunnelRowProps) {
<div className="bg-neutral-100 dark:bg-neutral-800 p-2 rounded-md">
<FunnelIcon className="h-5 w-5 text-neutral-500" />
</div>
- <div>
+ <div className="flex-grow">
<h3 className="font-medium">{funnel.name}</h3>
- {/* <div className="text-sm text-neutral-500 flex items-center gap-2">
- <span>{funnel.steps.length} steps</span>
- <span>•</span>
- <div className="flex items-center">
- <Calendar className="h-3 w-3 mr-1" />
- {formatDate(funnel.createdAt)}
- </div>
- </div> */}
- <div className="mt-1 text-xs text-neutral-400 flex items-center">
+ <div className="mt-1 text-xs text-neutral-400 flex flex-col gap-1">
+ {/* Steps visualization */}
<div className="flex flex-wrap gap-1 max-w-[500px]">
{funnel.steps.map((step, index) => (
<div key={index} className="flex items-center">
@@ -164,18 +154,45 @@ export function FunnelRow({ funnel }: FunnelRowProps) {
</div>
))}
</div>
+
+ {/* Filters visualization */}
+ {hasFilters && (
+ <div className="flex items-center gap-1">
+ <FilterIcon className="h-3 w-3 text-neutral-400" />
+ <div className="flex flex-wrap gap-1">
+ {funnel.filters?.map((filter, index) => (
+ <span
+ key={index}
+ className="rounded bg-neutral-100 dark:bg-neutral-800 px-1.5 py-0.5 whitespace-nowrap overflow-hidden text-ellipsis flex items-center cursor-default"
+ >
+ <span className="text-neutral-300">
+ {getParameterNameLabel(filter.parameter)}
+ </span>
+ <span
+ className={`mx-1 ${
+ filter.type === "not_equals" ||
+ filter.type === "not_contains"
+ ? "text-red-400"
+ : "text-emerald-400"
+ }`}
+ >
+ {filterTypeToLabel(filter.type)}
+ </span>
+ <span className="text-neutral-100 max-w-[100px] overflow-hidden text-ellipsis inline-block">
+ {filter.value.length > 0
+ ? getParameterValueLabel(filter, getRegionName)
+ : "empty"}
+ </span>
+ </span>
+ ))}
+ </div>
+ </div>
+ )}
</div>
</div>
</div>
<div className="flex items-center gap-4">
- {/* <div className="text-right">
- <div className="text-sm text-neutral-500">Conversion</div>
- <div className="font-semibold">
- {(funnel.conversionRate || 0).toFixed(1)}%
- </div>
- </div> */}
-
<div className="flex">
{/* Edit button */}
<Button
diff --git a/server/src/api/createFunnel.ts b/server/src/api/createFunnel.ts
index b7ce75dca..ac0dd1a3c 100644
--- a/server/src/api/createFunnel.ts
+++ b/server/src/api/createFunnel.ts
@@ -10,10 +10,17 @@ type FunnelStep = {
type: "page" | "event";
};
+type Filter = {
+ parameter: string;
+ type: string;
+ value: string[];
+};
+
type Funnel = {
steps: FunnelStep[];
name: string;
reportId?: number; // Optional report ID for updates
+ filters?: Filter[]; // Optional filters for the funnel
};
export async function createFunnel(
@@ -25,7 +32,7 @@ export async function createFunnel(
}>,
reply: FastifyReply
) {
- const { steps, name, reportId } = request.body;
+ const { steps, name, reportId, filters } = request.body;
const { site } = request.params;
const userId = request.user?.id;
@@ -72,6 +79,7 @@ export async function createFunnel(
data: {
name,
steps,
+ filters,
},
updatedAt: new Date().toISOString(),
})
@@ -92,6 +100,7 @@ export async function createFunnel(
data: {
name,
steps,
+ filters,
},
})
.returning({ reportId: reports.reportId });
diff --git a/server/src/api/getFunnel.ts b/server/src/api/getFunnel.ts
index dae3e1b7f..74d722443 100644
--- a/server/src/api/getFunnel.ts
+++ b/server/src/api/getFunnel.ts
@@ -1,7 +1,11 @@
import { FastifyRequest } from "fastify";
import { FastifyReply } from "fastify";
import clickhouse from "../db/clickhouse/clickhouse.js";
-import { getTimeStatement, processResults } from "./utils.js";
+import {
+ getTimeStatement,
+ processResults,
+ getFilterStatement,
+} from "./utils.js";
import { getUserHasAccessToSite } from "../lib/auth-utils.js";
type FunnelStep = {
@@ -10,11 +14,18 @@ type FunnelStep = {
type: "page" | "event";
};
+type Filter = {
+ parameter: string;
+ type: string;
+ value: string[];
+};
+
type Funnel = {
steps: FunnelStep[];
startDate: string;
endDate: string;
timezone: string;
+ filters?: Filter[];
};
type FunnelResponse = {
@@ -34,7 +45,7 @@ export async function getFunnel(
}>,
reply: FastifyReply
) {
- const { steps, startDate, endDate, timezone } = request.body;
+ const { steps, startDate, endDate, timezone, filters } = request.body;
const { site } = request.params;
// Validate request
@@ -57,6 +68,12 @@ export async function getFunnel(
date: { startDate, endDate, timezone },
});
+ // Get filter conditions using the existing utility function
+ const filterConditions =
+ filters && filters.length > 0
+ ? getFilterStatement(JSON.stringify(filters))
+ : "";
+
// Build conditional statements for each step
const stepConditions = steps.map((step) => {
if (step.type === "page") {
@@ -81,6 +98,7 @@ export async function getFunnel(
WHERE
site_id = ${site}
${timeStatement}
+ ${filterConditions}
AND user_id != ''
),
-- Initial step (all users who completed step 1)
@@ -148,8 +166,6 @@ export async function getFunnel(
ORDER BY s1.step_number
`;
- console.info(query);
-
// Execute the query
const result = await clickhouse.query({
query,
diff --git a/server/src/api/getFunnels.ts b/server/src/api/getFunnels.ts
index 3583bcd93..f911be592 100644
--- a/server/src/api/getFunnels.ts
+++ b/server/src/api/getFunnels.ts
@@ -37,6 +37,7 @@ export async function getFunnels(
id: report.reportId,
name: data.name || "Unnamed Funnel",
steps: data.steps || [],
+ filters: data.filters || [],
configuration: data.configuration || {},
createdAt: report.createdAt,
updatedAt: report.updatedAt,
diff --git a/server/src/api/sites/addFunnel.ts b/server/src/api/sites/addFunnel.ts
deleted file mode 100644
index b695898ca..000000000
--- a/server/src/api/sites/addFunnel.ts
+++ /dev/null
@@ -1,12 +0,0 @@
-import { FastifyReply } from "fastify";
-
-import { FastifyRequest } from "fastify";
-
-export function addFunnel(
- request: FastifyRequest<{
- Body: { domain: string; name: string; organizationId: string };
- }>,
- reply: FastifyReply
-) {
- const { domain, name, organizationId } = request.body;
-}