Skip to content

Papermark is the open-source DocSend alternative and secure data rooms with built-in analytics and custom domains.

feat: show visitor location/user-agent on video and dataroom views

Ashish Viradiyaaff8263ba264
diff --git a/components/visitors/video-visitor-useragent.tsx b/components/visitors/video-visitor-useragent.tsx
new file mode 100644
index 00000000..821a5d60
--- /dev/null
+++ b/components/visitors/video-visitor-useragent.tsx
@@ -0,0 +1,17 @@
+import { useVideoVisitorUserAgent } from "@/lib/swr/use-stats";
+
+import VisitorUserAgentBase from "./visitor-useragent-base";
+
+export default function VideoVisitorUserAgent({ viewId }: { viewId: string }) {
+ const { userAgent, error } = useVideoVisitorUserAgent(viewId);
+
+ if (error) {
+ return null;
+ }
+
+ if (!userAgent) {
+ return <div className="pb-0.5 pl-1.5 md:pb-1 md:pl-2">Loading...</div>;
+ }
+
+ return <VisitorUserAgentBase userAgent={userAgent} />;
+}
diff --git a/components/visitors/visitors-table.tsx b/components/visitors/visitors-table.tsx
index 85768b22..3bce73e7 100644
--- a/components/visitors/visitors-table.tsx
+++ b/components/visitors/visitors-table.tsx
@@ -53,6 +53,7 @@ import {
DropdownMenuSeparator,
DropdownMenuTrigger,
} from "../ui/dropdown-menu";
+import VideoVisitorUserAgent from "./video-visitor-useragent";
import { VisitorAvatar } from "./visitor-avatar";
import VisitorChart from "./visitor-chart";
import VisitorClicks from "./visitor-clicks";
@@ -412,7 +413,11 @@ export default function VisitorsTable({
/>
)}
{!isFreePlan ? (
- <VisitorUserAgent viewId={view.id} />
+ isVideo ? (
+ <VideoVisitorUserAgent viewId={view.id} />
+ ) : (
+ <VisitorUserAgent viewId={view.id} />
+ )
) : (
<VisitorUserAgentPlaceholder />
)}
diff --git a/lib/swr/use-stats.ts b/lib/swr/use-stats.ts
index 79402c41..44e0d702 100644
--- a/lib/swr/use-stats.ts
+++ b/lib/swr/use-stats.ts
@@ -108,3 +108,31 @@ export function useVisitorUserAgent(viewId: string) {
error,
};
}
+
+export function useVideoVisitorUserAgent(viewId: string) {
+ const router = useRouter();
+ const teamInfo = useTeam();
+
+ const { id: documentId } = router.query as {
+ id: string;
+ };
+
+ const { data: userAgent, error } = useSWRImmutable<{
+ country: string;
+ city: string;
+ os: string;
+ browser: string;
+ device: string;
+ }>(
+ documentId &&
+ viewId &&
+ `/api/teams/${teamInfo?.currentTeam?.id}/documents/${documentId}/views/${viewId}/video-user-agent`,
+ fetcher,
+ );
+
+ return {
+ userAgent,
+ loading: !error && !userAgent,
+ error,
+ };
+}
diff --git a/lib/tinybird/endpoints/get_dataroom_useragent_per_view.pipe b/lib/tinybird/endpoints/get_dataroom_useragent_per_view.pipe
new file mode 100644
index 00000000..44d8d2f5
--- /dev/null
+++ b/lib/tinybird/endpoints/get_dataroom_useragent_per_view.pipe
@@ -0,0 +1,20 @@
+VERSION 1
+
+NODE endpoint
+SQL >
+ %
+ SELECT
+ country,
+ city,
+ browser,
+ os,
+ device
+ FROM
+ pm_click_events__v1
+ WHERE
+ view_id = {{ String(viewId, required=True) }}
+ AND dataroom_id IS NOT NULL
+ AND timestamp >= {{ Int64(since, required=True) }}
+ ORDER BY
+ timestamp ASC
+ LIMIT 1
\ No newline at end of file
diff --git a/lib/tinybird/endpoints/get_video_useragent_per_view.pipe b/lib/tinybird/endpoints/get_video_useragent_per_view.pipe
new file mode 100644
index 00000000..a515f450
--- /dev/null
+++ b/lib/tinybird/endpoints/get_video_useragent_per_view.pipe
@@ -0,0 +1,19 @@
+VERSION 1
+
+NODE endpoint
+SQL >
+ %
+ SELECT
+ country,
+ city,
+ browser,
+ os,
+ device
+ FROM
+ video_views__v1
+ WHERE
+ view_id = {{ String(viewId, required=True) }}
+ AND timestamp >= {{ Int64(since, required=True) }}
+ ORDER BY
+ view_id, timestamp ASC
+ LIMIT 1
\ No newline at end of file
diff --git a/lib/tinybird/pipes.ts b/lib/tinybird/pipes.ts
index 92973ede..5a7bdd1f 100644
--- a/lib/tinybird/pipes.ts
+++ b/lib/tinybird/pipes.ts
@@ -92,6 +92,36 @@ export const getViewUserAgent = tb.buildPipe({
}),
});
+export const getDataroomViewUserAgent = tb.buildPipe({
+ pipe: "get_dataroom_useragent_per_view__v1",
+ parameters: z.object({
+ viewId: z.string(),
+ since: z.number(),
+ }),
+ data: z.object({
+ country: z.string(),
+ city: z.string(),
+ browser: z.string(),
+ os: z.string(),
+ device: z.string(),
+ }),
+});
+
+export const getVideoViewUserAgent = tb.buildPipe({
+ pipe: "get_video_useragent_per_view__v1",
+ parameters: z.object({
+ viewId: z.string(),
+ since: z.number(),
+ }),
+ data: z.object({
+ country: z.string(),
+ city: z.string(),
+ browser: z.string(),
+ os: z.string(),
+ device: z.string(),
+ }),
+});
+
export const getTotalDataroomDuration = tb.buildPipe({
pipe: "get_total_dataroom_duration__v1",
parameters: z.object({
diff --git a/pages/api/teams/[teamId]/datarooms/[id]/views/[viewId]/user-agent.ts b/pages/api/teams/[teamId]/datarooms/[id]/views/[viewId]/user-agent.ts
index bd3ffe42..a1e88789 100644
--- a/pages/api/teams/[teamId]/datarooms/[id]/views/[viewId]/user-agent.ts
+++ b/pages/api/teams/[teamId]/datarooms/[id]/views/[viewId]/user-agent.ts
@@ -5,7 +5,7 @@ import { getServerSession } from "next-auth/next";
import { errorhandler } from "@/lib/errorHandler";
import prisma from "@/lib/prisma";
-import { getViewUserAgent } from "@/lib/tinybird";
+import { getDataroomViewUserAgent } from "@/lib/tinybird";
import { CustomUser } from "@/lib/types";
export default async function handle(
@@ -54,30 +54,17 @@ export default async function handle(
if (team.plan.includes("free")) {
return res.status(403).end("Forbidden");
}
-
- const view = await prisma.view.findMany({
- where: {
- dataroomId: dataroomId,
- dataroomViewId: viewId,
- },
- select: {
- id: true,
- documentId: true,
- },
- take: 1,
- });
-
- if (!view || !view[0].documentId) {
- return res.status(404).end("Not Found");
- }
-
- const userAgent = await getViewUserAgent({
- documentId: view[0].documentId,
- viewId: view[0].id,
+ const userAgent = await getDataroomViewUserAgent({
+ viewId: viewId,
since: 0,
});
const userAgentData = userAgent.data[0];
+
+ if (!userAgentData) {
+ return res.status(404).end("No user agent data found");
+ }
+
// Include country and city for business and datarooms plans
if (team.plan.includes("business") || team.plan.includes("datarooms")) {
return res.status(200).json(userAgentData);
@@ -90,7 +77,7 @@ export default async function handle(
errorhandler(error, res);
}
} else {
- // We only allow GET and POST requests
+ // We only allow GET requests
res.setHeader("Allow", ["GET"]);
return res.status(405).end(`Method ${req.method} Not Allowed`);
}
diff --git a/pages/api/teams/[teamId]/documents/[id]/views/[viewId]/video-user-agent.ts b/pages/api/teams/[teamId]/documents/[id]/views/[viewId]/video-user-agent.ts
new file mode 100644
index 00000000..a11e6ec9
--- /dev/null
+++ b/pages/api/teams/[teamId]/documents/[id]/views/[viewId]/video-user-agent.ts
@@ -0,0 +1,81 @@
+import { NextApiRequest, NextApiResponse } from "next";
+
+import { authOptions } from "@/pages/api/auth/[...nextauth]";
+import { getServerSession } from "next-auth/next";
+
+import { errorhandler } from "@/lib/errorHandler";
+import prisma from "@/lib/prisma";
+import { getVideoViewUserAgent } from "@/lib/tinybird";
+import { CustomUser } from "@/lib/types";
+
+export default async function handle(
+ req: NextApiRequest,
+ res: NextApiResponse,
+) {
+ if (req.method === "GET") {
+ const session = await getServerSession(req, res, authOptions);
+ if (!session) {
+ return res.status(401).end("Unauthorized");
+ }
+
+ const {
+ teamId,
+ id: docId,
+ viewId,
+ } = req.query as {
+ teamId: string;
+ id: string;
+ viewId: string;
+ };
+
+ const userId = (session.user as CustomUser).id;
+
+ try {
+ const team = await prisma.team.findUnique({
+ where: {
+ id: teamId,
+ users: {
+ some: {
+ userId: userId,
+ },
+ },
+ },
+ select: {
+ id: true,
+ plan: true,
+ },
+ });
+
+ if (!team) {
+ return res.status(401).end("Unauthorized");
+ }
+
+ if (team.plan.includes("free")) {
+ return res.status(403).end("Forbidden");
+ }
+
+ const userAgent = await getVideoViewUserAgent({
+ viewId: viewId,
+ since: 0,
+ });
+
+ const userAgentData = userAgent.data[0];
+
+ if (!userAgentData) {
+ return res.status(404).end("No video user agent data found");
+ }
+
+ if (team.plan.includes("business") || team.plan.includes("datarooms")) {
+ return res.status(200).json(userAgentData);
+ } else {
+ const { country, city, ...remainingResponse } = userAgentData;
+ return res.status(200).json(remainingResponse);
+ }
+ } catch (error) {
+ errorhandler(error, res);
+ }
+ } else {
+ res.setHeader("Allow", ["GET"]);
+ return res.status(405).end(`Method ${req.method} Not Allowed`);
+ }
+}
\ No newline at end of file