Skip to content

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

Encode user IDs in URLs to ensure proper handling of special characters. Fixes issues with user ids that have "|" in them for example. (#787)

Chris Rimmer2ee3bd3a84ed
diff --git a/client/src/api/analytics/endpoints/users.ts b/client/src/api/analytics/endpoints/users.ts
index 181751c9e..372c908f9 100644
--- a/client/src/api/analytics/endpoints/users.ts
+++ b/client/src/api/analytics/endpoints/users.ts
@@ -120,6 +120,6 @@ export async function fetchUserSessionCount(
* GET /api/users/:userId/:site
*/
export async function fetchUserInfo(site: string | number, userId: string): Promise<UserInfo> {
- const response = await authedFetch<{ data: UserInfo }>(`/users/${userId}/${site}`);
+ const response = await authedFetch<{ data: UserInfo }>(`/users/${encodeURIComponent(userId)}/${site}`);
return response.data;
}
diff --git a/client/src/app/[site]/errors/components/ErrorDetails.tsx b/client/src/app/[site]/errors/components/ErrorDetails.tsx
index b03b22ebe..f3c1fe75a 100644
--- a/client/src/app/[site]/errors/components/ErrorDetails.tsx
+++ b/client/src/app/[site]/errors/components/ErrorDetails.tsx
@@ -139,7 +139,7 @@ function ErrorEventItem({ errorEvent }: { errorEvent: ErrorEvent }) {
{errorEvent.user_id && (
<Tooltip>
<TooltipTrigger asChild>
- <Link href={`/${site}/user/${errorEvent.user_id}`}>
+ <Link href={`/${site}/user/${encodeURIComponent(errorEvent.user_id)}`}>
<Badge variant="outline" className="text-xs">
<User className="w-3 h-3 mr-1" />
{errorEvent.user_id.substring(0, 12)}
diff --git a/client/src/app/[site]/events/components/EventLogItem.tsx b/client/src/app/[site]/events/components/EventLogItem.tsx
index f636e4ddf..96cdb59bd 100644
--- a/client/src/app/[site]/events/components/EventLogItem.tsx
+++ b/client/src/app/[site]/events/components/EventLogItem.tsx
@@ -143,7 +143,7 @@ export function EventLogItem({ event }: EventLogItemProps) {
</div>
{/* User ID */}
- <Link href={`/${site}/user/${event.user_id}`} className="shrink-0">
+ <Link href={`/${site}/user/${encodeURIComponent(event.user_id)}`} className="shrink-0">
<Tooltip>
<TooltipTrigger asChild>
<span className="text-sm font-mono text-neutral-500 dark:text-neutral-400 hover:text-neutral-700 dark:hover:text-neutral-300">
diff --git a/client/src/app/[site]/user/[userId]/components/UserTopPages.tsx b/client/src/app/[site]/user/[userId]/components/UserTopPages.tsx
index dd18542aa..7886cc20a 100644
--- a/client/src/app/[site]/user/[userId]/components/UserTopPages.tsx
+++ b/client/src/app/[site]/user/[userId]/components/UserTopPages.tsx
@@ -1,4 +1,3 @@
-import { useParams } from "next/navigation";
import { useState } from "react";
import { useGetSite } from "../../../../../api/admin/hooks/useSites";
import { TabsContent, TabsList, TabsTrigger } from "../../../../../components/ui/basic-tabs";
@@ -9,8 +8,7 @@ import { StandardSection } from "../../../components/shared/StandardSection/Stan
type Tab = "pages" | "events";
-export function UserTopPages() {
- const { userId } = useParams();
+export function UserTopPages({ userId }: { userId: string }) {
const [tab, setTab] = useState<Tab>("pages");
const { data: siteMetadata } = useGetSite();
@@ -37,7 +35,7 @@ export function UserTopPages() {
getLink={e => `https://${siteMetadata?.domain}${e.value}`}
expanded={false}
close={close}
- customFilters={[{ parameter: "user_id", value: [userId as string], type: "equals" }]}
+ customFilters={[{ parameter: "user_id", value: [userId], type: "equals" }]}
customTime={{
mode: "all-time",
wellKnown: "all-time",
@@ -54,7 +52,7 @@ export function UserTopPages() {
getLink={e => `https://${siteMetadata?.domain}${e.value}`}
expanded={false}
close={close}
- customFilters={[{ parameter: "user_id", value: [userId as string], type: "equals" }]}
+ customFilters={[{ parameter: "user_id", value: [userId], type: "equals" }]}
customTime={{
mode: "all-time",
wellKnown: "all-time",
diff --git a/client/src/app/[site]/user/[userId]/page.tsx b/client/src/app/[site]/user/[userId]/page.tsx
index 58a1f1fa5..eb5279514 100644
--- a/client/src/app/[site]/user/[userId]/page.tsx
+++ b/client/src/app/[site]/user/[userId]/page.tsx
@@ -29,13 +29,22 @@ const LIMIT = 25;
export default function UserPage() {
useSetPageTitle("Rybbit · User");
- const { userId, site } = useParams();
+ const { userId: rawUserId, site } = useParams();
+ const userId = (() => {
+ const value = Array.isArray(rawUserId) ? rawUserId[0] : rawUserId;
+ if (!value) return "";
+ try {
+ return decodeURIComponent(value);
+ } catch {
+ return value;
+ }
+ })();
const [page, setPage] = useState(1);
- const { data, isLoading } = useUserInfo(Number(site), userId as string);
- const { data: sessionCount } = useGetUserSessionCount(userId as string);
+ const { data, isLoading } = useUserInfo(Number(site), userId);
+ const { data: sessionCount } = useGetUserSessionCount(userId);
const { data: sessionsData, isLoading: isLoadingSessions } = useGetSessions({
- userId: userId as string,
+ userId,
page: page,
limit: LIMIT + 1,
});
@@ -52,7 +61,7 @@ export default function UserPage() {
const traitsEmail = data?.traits?.email as string | undefined;
const isIdentified = !!data?.identified_user_id;
const displayName =
- traitsUsername || traitsName || (isIdentified ? (userId as string) : generateName(userId as string));
+ traitsUsername || traitsName || (isIdentified ? userId : generateName(userId));
return (
<div className="p-2 md:p-4 max-w-[1200px] mx-auto">
@@ -75,7 +84,7 @@ export default function UserPage() {
</div>
<div className="flex items-center gap-4 mb-4">
- <Avatar size={64} id={userId as string} />
+ <Avatar size={64} id={userId} />
<div className="mt-3 w-full flex gap-2">
<div>
<div className="font-semibold text-lg flex items-center gap-2">
@@ -114,7 +123,7 @@ export default function UserPage() {
{/* Right Content - Sessions */}
<div className="flex-1 min-w-0 space-y-4">
- <UserTopPages />
+ <UserTopPages userId={userId} />
<SessionsList
sessions={sessions}
isLoading={isLoadingSessions}
@@ -122,7 +131,7 @@ export default function UserPage() {
onPageChange={setPage}
hasNextPage={hasNextPage}
hasPrevPage={hasPrevPage}
- userId={userId as string}
+ userId={userId}
/>
</div>
</div>
diff --git a/client/src/app/[site]/users/page.tsx b/client/src/app/[site]/users/page.tsx
index 09084b4ec..b6eab1047 100644
--- a/client/src/app/[site]/users/page.tsx
+++ b/client/src/app/[site]/users/page.tsx
@@ -113,11 +113,12 @@ export default function UsersPage() {
const isIdentified = !!info.row.original.identified_user_id;
// For links: use identified_user_id for identified users, device ID for anonymous
const linkId = isIdentified ? identifiedUserId : info.getValue();
+ const encodedLinkId = encodeURIComponent(linkId);
const displayName = getUserDisplayName(info.row.original);
const lastSeen = DateTime.fromSQL(info.row.original.last_seen, { zone: "utc" });
return (
- <Link href={`/${site}/user/${linkId}`} className="flex items-center gap-2">
+ <Link href={`/${site}/user/${encodedLinkId}`} className="flex items-center gap-2">
<Avatar size={20} id={linkId as string} lastActiveTime={lastSeen} />
<span className="max-w-32 truncate hover:underline" title={displayName}>
{displayName}
@@ -346,7 +347,7 @@ export default function UsersPage() {
table.getRowModel().rows.map(row => {
// Use identified_user_id for identified users, device ID (user_id) for anonymous
const linkId = row.original.identified_user_id || row.original.user_id;
- const href = `/${site}/user/${linkId}`;
+ const href = `/${site}/user/${encodeURIComponent(linkId)}`;
return (
<tr key={row.id} className="border-b border-neutral-100 dark:border-neutral-800 group">
diff --git a/client/src/components/Sessions/SessionDetails.tsx b/client/src/components/Sessions/SessionDetails.tsx
index 9a146c2ee..1d45bdd86 100644
--- a/client/src/components/Sessions/SessionDetails.tsx
+++ b/client/src/components/Sessions/SessionDetails.tsx
@@ -322,7 +322,11 @@ export function SessionDetails({ session, userId }: SessionDetailsProps) {
<TabsTrigger value="info">Session Info</TabsTrigger>
</TabsList>
{!userId && (
- <Link href={`/${site}/user/${isIdentified ? session.identified_user_id : session.user_id}`}>
+ <Link
+ href={`/${site}/user/${encodeURIComponent(
+ isIdentified ? session.identified_user_id : session.user_id
+ )}`}
+ >
<Button size={"sm"} variant={"success"}>
View User <ArrowRight className="w-4 h-4" />
</Button>
diff --git a/client/src/components/replay/ReplayBreadcrumbs.tsx b/client/src/components/replay/ReplayBreadcrumbs.tsx
index ec9979028..5ade42542 100644
--- a/client/src/components/replay/ReplayBreadcrumbs.tsx
+++ b/client/src/components/replay/ReplayBreadcrumbs.tsx
@@ -258,8 +258,8 @@ export function ReplayBreadcrumbs() {
// Calculate display name based on identification status
const isIdentified = !!data.metadata.identified_user_id;
const userLink = isIdentified
- ? `/${siteId}/user/${data.metadata.identified_user_id}`
- : `/${siteId}/user/${data.metadata.user_id}`;
+ ? `/${siteId}/user/${encodeURIComponent(data.metadata.identified_user_id)}`
+ : `/${siteId}/user/${encodeURIComponent(data.metadata.user_id)}`;
return (
<div className="flex flex-col gap-2 h-full">