Skip to content

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

time/tracking

Ashish Viradiyae2ea19a6e962
diff --git a/components/view/viewer/advanced-excel-viewer.tsx b/components/view/viewer/advanced-excel-viewer.tsx
index 02af2246..a7f9bbc3 100644
--- a/components/view/viewer/advanced-excel-viewer.tsx
+++ b/components/view/viewer/advanced-excel-viewer.tsx
@@ -1,28 +1,8 @@
import { useEffect, useRef } from "react";
-import Nav, { TNavData } from "../nav";
-
-const trackPageView = async (data: {
- linkId: string;
- documentId: string;
- viewId?: string;
- duration: number;
- pageNumber: number;
- versionNumber: number;
- dataroomId?: string;
- isPreview?: boolean;
-}) => {
- // If the view is a preview, do not track the view
- if (data.isPreview) return;
+import { useSafePageViewTracker } from "@/lib/tracking/safe-page-view-tracker";
- await fetch("/api/record_view", {
- method: "POST",
- body: JSON.stringify(data),
- headers: {
- "Content-Type": "application/json",
- },
- });
-};
+import Nav, { TNavData } from "../nav";
export default function AdvancedExcelViewer({
file,
@@ -39,16 +19,40 @@ export default function AdvancedExcelViewer({
const startTimeRef = useRef(Date.now());
const visibilityRef = useRef<boolean>(true);
+ const { trackPageViewSafely, resetTrackingState } = useSafePageViewTracker();
+
useEffect(() => {
const handleVisibilityChange = () => {
if (document.visibilityState === "visible") {
visibilityRef.current = true;
startTimeRef.current = Date.now(); // Reset start time when page becomes visible
+ resetTrackingState();
} else {
visibilityRef.current = false;
const duration = Date.now() - startTimeRef.current;
if (duration > 0) {
- trackPageView({
+ trackPageViewSafely(
+ {
+ linkId,
+ documentId,
+ viewId,
+ duration,
+ pageNumber,
+ versionNumber,
+ dataroomId,
+ isPreview,
+ },
+ true,
+ );
+ }
+ }
+ };
+
+ const handleBeforeUnload = () => {
+ const duration = Date.now() - startTimeRef.current;
+ if (duration > 0) {
+ trackPageViewSafely(
+ {
linkId,
documentId,
viewId,
@@ -57,28 +61,18 @@ export default function AdvancedExcelViewer({
versionNumber,
dataroomId,
isPreview,
- });
- }
+ },
+ true,
+ );
}
};
document.addEventListener("visibilitychange", handleVisibilityChange);
+ window.addEventListener("beforeunload", handleBeforeUnload);
return () => {
- if (visibilityRef.current) {
- const duration = Date.now() - startTimeRef.current;
- trackPageView({
- linkId,
- documentId,
- viewId,
- duration,
- pageNumber,
- versionNumber,
- dataroomId,
- isPreview,
- }); // Also capture duration if component unmounts while visible
- }
document.removeEventListener("visibilitychange", handleVisibilityChange);
+ window.removeEventListener("beforeunload", handleBeforeUnload);
};
}, []);
diff --git a/components/view/viewer/download-only-viewer.tsx b/components/view/viewer/download-only-viewer.tsx
index 3461ad19..7664c100 100644
--- a/components/view/viewer/download-only-viewer.tsx
+++ b/components/view/viewer/download-only-viewer.tsx
@@ -6,33 +6,13 @@ import { Brand, DataroomBrand } from "@prisma/client";
import { Download } from "lucide-react";
import { toast } from "sonner";
+import { useSafePageViewTracker } from "@/lib/tracking/safe-page-view-tracker";
+
import { Button } from "@/components/ui/button";
import { TDocumentData } from "../dataroom/dataroom-view";
import Nav, { TNavData } from "../nav";
-const trackPageView = async (data: {
- linkId: string;
- documentId: string;
- viewId?: string;
- duration: number;
- pageNumber: number;
- versionNumber: number;
- dataroomId?: string;
- isPreview?: boolean;
-}) => {
- // If the view is a preview, do not track the view
- if (data.isPreview) return;
-
- await fetch("/api/record_view", {
- method: "POST",
- body: JSON.stringify(data),
- headers: {
- "Content-Type": "application/json",
- },
- });
-};
-
export default function DownloadOnlyViewer({
versionNumber,
documentName,
@@ -45,6 +25,7 @@ export default function DownloadOnlyViewer({
const router = useRouter();
const startTimeRef = useRef(Date.now());
const visibilityRef = useRef<boolean>(true);
+ const { trackPageViewSafely, resetTrackingState } = useSafePageViewTracker();
const { linkId, documentId, viewId, isPreview, allowDownload, dataroomId } =
navData;
@@ -76,19 +57,23 @@ export default function DownloadOnlyViewer({
if (document.visibilityState === "visible") {
visibilityRef.current = true;
startTimeRef.current = Date.now();
+ resetTrackingState();
} else {
visibilityRef.current = false;
const duration = Date.now() - startTimeRef.current;
- trackPageView({
- linkId,
- documentId,
- viewId,
- duration,
- pageNumber: 1,
- versionNumber,
- dataroomId,
- isPreview,
- });
+ trackPageViewSafely(
+ {
+ linkId,
+ documentId,
+ viewId,
+ duration,
+ pageNumber: 1,
+ versionNumber,
+ dataroomId,
+ isPreview,
+ },
+ true,
+ );
}
};
@@ -102,16 +87,19 @@ export default function DownloadOnlyViewer({
useEffect(() => {
const handleBeforeUnload = () => {
const duration = Date.now() - startTimeRef.current;
- trackPageView({
- linkId,
- documentId,
- viewId,
- duration,
- pageNumber: 1,
- versionNumber,
- dataroomId,
- isPreview,
- });
+ trackPageViewSafely(
+ {
+ linkId,
+ documentId,
+ viewId,
+ duration,
+ pageNumber: 1,
+ versionNumber,
+ dataroomId,
+ isPreview,
+ },
+ true,
+ );
};
window.addEventListener("beforeunload", handleBeforeUnload);
diff --git a/components/view/viewer/excel-viewer.tsx b/components/view/viewer/excel-viewer.tsx
index 409657b3..f3ee56dd 100644
--- a/components/view/viewer/excel-viewer.tsx
+++ b/components/view/viewer/excel-viewer.tsx
@@ -4,6 +4,7 @@ import React from "react";
import "@/public/vendor/handsontable/handsontable.full.min.css";
import { Brand, DataroomBrand } from "@prisma/client";
+import { useSafePageViewTracker } from "@/lib/tracking/safe-page-view-tracker";
import { cn } from "@/lib/utils";
import { Button } from "@/components/ui/button";
@@ -20,27 +21,7 @@ type SheetData = {
rowData: RowData[];
};
-const trackPageView = async (data: {
- linkId: string;
- documentId: string;
- viewId?: string;
- duration: number;
- pageNumber: number;
- versionNumber: number;
- dataroomId?: string;
- isPreview?: boolean;
-}) => {
- // If the view is a preview, do not track the view
- if (data.isPreview) return;
-
- await fetch("/api/record_view", {
- method: "POST",
- body: JSON.stringify(data),
- headers: {
- "Content-Type": "application/json",
- },
- });
-};
+
export default function ExcelViewer({
versionNumber,
@@ -62,6 +43,11 @@ export default function ExcelViewer({
const { linkId, documentId, viewId, isPreview, dataroomId } = navData;
+ const startTimeRef = useRef(Date.now());
+ const visibilityRef = useRef<boolean>(true);
+
+ const { trackPageViewSafely, resetTrackingState } = useSafePageViewTracker();
+
useEffect(() => {
const script = document.createElement("script");
script.src =
@@ -85,8 +71,6 @@ export default function ExcelViewer({
const containerRef = useRef<HTMLDivElement>(null);
// @ts-ignore - Handsontable import has not types
const hotInstanceRef = useRef<Handsontable | null>(null);
- const startTimeRef = useRef(Date.now());
- const visibilityRef = useRef<boolean>(true);
const calculateSize = () => {
if (containerRef.current) {
@@ -128,19 +112,23 @@ export default function ExcelViewer({
if (document.visibilityState === "visible") {
visibilityRef.current = true;
startTimeRef.current = Date.now(); // Reset start time when page becomes visible
+ resetTrackingState();
} else {
visibilityRef.current = false;
const duration = Date.now() - startTimeRef.current;
- trackPageView({
- linkId,
- documentId,
- viewId,
- duration,
- pageNumber: selectedSheetIndex + 1,
- versionNumber,
- dataroomId,
- isPreview,
- });
+ trackPageViewSafely(
+ {
+ linkId,
+ documentId,
+ viewId,
+ duration,
+ pageNumber: selectedSheetIndex + 1,
+ versionNumber,
+ dataroomId,
+ isPreview,
+ },
+ true,
+ );
}
};
@@ -149,16 +137,19 @@ export default function ExcelViewer({
return () => {
if (visibilityRef.current) {
const duration = Date.now() - startTimeRef.current;
- trackPageView({
- linkId,
- documentId,
- viewId,
- duration,
- pageNumber: selectedSheetIndex + 1,
- versionNumber,
- dataroomId,
- isPreview,
- }); // Also capture duration if component unmounts while visible
+ trackPageViewSafely(
+ {
+ linkId,
+ documentId,
+ viewId,
+ duration,
+ pageNumber: selectedSheetIndex + 1,
+ versionNumber,
+ dataroomId,
+ isPreview,
+ },
+ true,
+ ); // Also capture duration if component unmounts while visible
startTimeRef.current = Date.now();
}
document.removeEventListener("visibilitychange", handleVisibilityChange);
@@ -169,17 +160,21 @@ export default function ExcelViewer({
const handleBeforeUnload = () => {
if (!visibilityRef.current) return;
+ // Only track if we haven't already tracked an unload event
const duration = Date.now() - startTimeRef.current;
- trackPageView({
- linkId,
- documentId,
- viewId,
- duration,
- pageNumber: selectedSheetIndex + 1,
- versionNumber,
- dataroomId,
- isPreview,
- });
+ trackPageViewSafely(
+ {
+ linkId,
+ documentId,
+ viewId,
+ duration,
+ pageNumber: selectedSheetIndex + 1,
+ versionNumber,
+ dataroomId,
+ isPreview,
+ },
+ true,
+ );
};
window.addEventListener("beforeunload", handleBeforeUnload);
diff --git a/components/view/viewer/image-viewer.tsx b/components/view/viewer/image-viewer.tsx
index 9a660539..0f36494e 100644
--- a/components/view/viewer/image-viewer.tsx
+++ b/components/view/viewer/image-viewer.tsx
@@ -3,6 +3,7 @@ import { useRouter } from "next/router";
import { useEffect, useRef, useState } from "react";
import React from "react";
+import { useSafePageViewTracker } from "@/lib/tracking/safe-page-view-tracker";
import { WatermarkConfig } from "@/lib/types";
import { cn } from "@/lib/utils";
@@ -13,28 +14,6 @@ import { SVGWatermark } from "../watermark-svg";
import "@/styles/custom-viewer-styles.css";
-const trackPageView = async (data: {
- linkId: string;
- documentId: string;
- viewId?: string;
- duration: number;
- pageNumber: number;
- versionNumber: number;
- dataroomId?: string;
- isPreview?: boolean;
-}) => {
- // If the view is a preview, do not track the view
- if (data.isPreview) return;
-
- await fetch("/api/record_view", {
- method: "POST",
- body: JSON.stringify(data),
- headers: {
- "Content-Type": "application/json",
- },
- });
-};
-
export default function ImageViewer({
file,
screenshotProtectionEnabled,
@@ -61,8 +40,7 @@ export default function ImageViewer({
const { isPreview, linkId, documentId, viewId, dataroomId } = navData;
const numPages = 1;
-
- const [pageNumber, setPageNumber] = useState<number>(1); // start on first page
+ const pageNumber = 1;
const [scale, setScale] = useState<number>(1);
const [isWindowFocused, setIsWindowFocused] = useState(true);
@@ -72,6 +50,8 @@ export default function ImageViewer({
const containerRef = useRef<HTMLDivElement>(null);
const imageRefs = useRef<HTMLImageElement | null>(null);
+ const { trackPageViewSafely, resetTrackingState } = useSafePageViewTracker();
+
const [imageDimensions, setImageDimensions] = useState<{
width: number;
height: number;
@@ -126,20 +106,19 @@ export default function ImageViewer({
return () => {
window.removeEventListener("resize", updateImageDimensions);
};
- }, [pageNumber]);
+ }, []);
useEffect(() => {
const handleVisibilityChange = () => {
- if (pageNumber > numPages) return;
-
if (document.visibilityState === "visible") {
visibilityRef.current = true;
startTimeRef.current = Date.now(); // Reset start time when the page becomes visible again
+ resetTrackingState();
} else {
visibilityRef.current = false;
- if (pageNumber <= numPages) {
- const duration = Date.now() - startTimeRef.current;
- trackPageView({
+ const duration = Date.now() - startTimeRef.current;
+ trackPageViewSafely(
+ {
linkId,
documentId,
viewId,
@@ -148,8 +127,9 @@ export default function ImageViewer({
versionNumber,
dataroomId,
isPreview,
- });
- }
+ },
+ true,
+ );
}
};
@@ -158,31 +138,35 @@ export default function ImageViewer({
return () => {
document.removeEventListener("visibilitychange", handleVisibilityChange);
};
- }, [pageNumber, numPages]);
+ }, []);
useEffect(() => {
startTimeRef.current = Date.now();
- if (visibilityRef.current && pageNumber <= numPages) {
+ if (visibilityRef.current) {
const duration = Date.now() - startTimeRef.current;
- trackPageView({
- linkId,
- documentId,
- viewId,
- duration,
- pageNumber: pageNumber,
- versionNumber,
- dataroomId,
- isPreview,
- });
+ trackPageViewSafely(
+ {
+ linkId,
+ documentId,
+ viewId,
+ duration,
+ pageNumber: pageNumber,
+ versionNumber,
+ dataroomId,
+ isPreview,
+ },
+ false,
+ );
}
- }, [pageNumber, numPages]);
+ }, []);
useEffect(() => {
const handleBeforeUnload = () => {
- if (pageNumber <= numPages) {
- const duration = Date.now() - startTimeRef.current;
- trackPageView({
+ // Only track if we haven't already tracked an unload event
+ const duration = Date.now() - startTimeRef.current;
+ trackPageViewSafely(
+ {
linkId,
documentId,
viewId,
@@ -191,8 +175,9 @@ export default function ImageViewer({
versionNumber,
dataroomId,
isPreview,
- });
- }
+ },
+ true,
+ );
};
window.addEventListener("beforeunload", handleBeforeUnload);
@@ -200,7 +185,7 @@ export default function ImageViewer({
return () => {
window.removeEventListener("beforeunload", handleBeforeUnload);
};
- }, [pageNumber, numPages]);
+ }, []);
// Add this effect near your other useEffect hooks
useEffect(() => {
diff --git a/components/view/viewer/notion-page.tsx b/components/view/viewer/notion-page.tsx
index 341ae638..73096ae1 100644
--- a/components/view/viewer/notion-page.tsx
+++ b/components/view/viewer/notion-page.tsx
@@ -10,6 +10,7 @@ import { NotionRenderer } from "react-notion-x";
// core styles shared by all of react-notion-x (required)
import "react-notion-x/src/styles.css";
+import { useSafePageViewTracker } from "@/lib/tracking/safe-page-view-tracker";
import { NotionTheme } from "@/lib/types";
import { cn } from "@/lib/utils";
import { determineTextColor } from "@/lib/utils/determine-text-color";
@@ -47,9 +48,8 @@ export const NotionPage = ({
screenshotProtectionEnabled: boolean;
navData: TNavData;
}) => {
- const { isPreview, linkId, documentId, viewId, brand, dataroomId } = navData;
+ const { isPreview, linkId, documentId, viewId, brand } = navData;
const [pageNumber, setPageNumber] = useState<number>(1); // start on first page
- const [maxScrollPercentage, setMaxScrollPercentage] = useState<number>(0);
const [loading, setLoading] = useState<boolean>(false);
const [subPageId, setSubPageId] = useQueryState("pageid", {
history: "push",
@@ -69,28 +69,35 @@ export const NotionPage = ({
const startTimeRef = useRef(Date.now());
const pageNumberRef = useRef<number>(pageNumber);
const visibilityRef = useRef<boolean>(true);
+ const { trackPageViewSafely, resetTrackingState } = useSafePageViewTracker();
useEffect(() => {
const handleVisibilityChange = () => {
if (document.visibilityState === "visible") {
visibilityRef.current = true;
startTimeRef.current = Date.now(); // Reset start time when page becomes visible
+ resetTrackingState();
} else {
visibilityRef.current = false;
const duration = Date.now() - startTimeRef.current;
- if (duration > 0) {
- trackPageView(duration);
- }
+ trackPageViewSafely(
+ {
+ linkId: linkId,
+ documentId: documentId,
+ viewId: viewId,
+ duration: duration,
+ pageNumber: pageNumberRef.current,
+ versionNumber: versionNumber,
+ isPreview: isPreview,
+ },
+ true,
+ );
}
};
document.addEventListener("visibilitychange", handleVisibilityChange);
return () => {
- if (visibilityRef.current) {
- const duration = Date.now() - startTimeRef.current;
- trackPageView(duration); // Also capture duration if component unmounts while visible
- }
document.removeEventListener("visibilitychange", handleVisibilityChange);
};
}, []);
@@ -175,7 +182,18 @@ export const NotionPage = ({
useEffect(() => {
const handleBeforeUnload = () => {
const duration = Date.now() - startTimeRef.current;
- trackPageView(duration);
+ trackPageViewSafely(
+ {
+ linkId: linkId,
+ documentId: documentId,
+ viewId: viewId,
+ duration: duration,
+ pageNumber: pageNumberRef.current,
+ versionNumber: versionNumber,
+ isPreview: isPreview,
+ },
+ true,
+ );
};
window.addEventListener("beforeunload", handleBeforeUnload);
@@ -185,25 +203,6 @@ export const NotionPage = ({
};
}, [subPageId]);
- async function trackPageView(duration: number = 0) {
- if (isPreview) return;
-
- await fetch("/api/record_view", {
- method: "POST",
- body: JSON.stringify({
- linkId: linkId,
- documentId: documentId,
- viewId: viewId,
- duration: duration,
- pageNumber: pageNumberRef.current,
- versionNumber: versionNumber,
- }),
- headers: {
- "Content-Type": "application/json",
- },
- });
- }
-
// // Function to calculate scroll percentage
// const calculateScrollPercentage = () => {
// const scrollableHeight =
diff --git a/components/view/viewer/pages-horizontal-viewer.tsx b/components/view/viewer/pages-horizontal-viewer.tsx
index 788c745e..31fe2953 100644
--- a/components/view/viewer/pages-horizontal-viewer.tsx
+++ b/components/view/viewer/pages-horizontal-viewer.tsx
@@ -6,6 +6,7 @@ import React from "react";
import { ChevronLeftIcon, ChevronRightIcon } from "lucide-react";
import { useSession } from "next-auth/react";
+import { useSafePageViewTracker } from "@/lib/tracking/safe-page-view-tracker";
import { WatermarkConfig } from "@/lib/types";
import { cn } from "@/lib/utils";
@@ -21,39 +22,6 @@ import "@/styles/custom-viewer-styles.css";
const DEFAULT_PRELOADED_IMAGES_NUM = 5;
-const trackPageView = async (data: {
- linkId: string;
- documentId: string;
- viewId?: string;
- duration: number;
- pageNumber: number;
- versionNumber: number;
- dataroomId?: string;
- setViewedPages?: React.Dispatch<
- React.SetStateAction<{ pageNumber: number; duration: number }[]>
- >;
- isPreview?: boolean;
-}) => {
- data.setViewedPages &&
- data.setViewedPages((prevViewedPages) =>
- prevViewedPages.map((page) =>
- page.pageNumber === data.pageNumber
- ? { ...page, duration: page.duration + data.duration }
- : page,
- ),
- );
-
- // If the view is a preview, do not track the view
- if (data.isPreview) return;
-
- await fetch("/api/record_view", {
- method: "POST",
- body: JSON.stringify(data),
- headers: {
- "Content-Type": "application/json",
- },
- });
-};
export default function PagesHorizontalViewer({
pages,
@@ -140,7 +108,6 @@ export default function PagesHorizontalViewer({
const pageNumberRef = useRef<number>(pageNumber);
const visibilityRef = useRef<boolean>(true);
const containerRef = useRef<HTMLDivElement>(null);
- const scrollActionRef = useRef<boolean>(false);
const hasTrackedDownRef = useRef<boolean>(false);
const hasTrackedUpRef = useRef<boolean>(false);
const imageRefs = useRef<(HTMLImageElement | null)[]>([]);
@@ -148,6 +115,7 @@ export default function PagesHorizontalViewer({
const [imageDimensions, setImageDimensions] = useState<
Record<number, { width: number; height: number }>
>({});
+ const { trackPageViewSafely, resetTrackingState } = useSafePageViewTracker();
const scaleCoordinates = (coords: string, scaleFactor: number) => {
return coords
@@ -212,21 +180,25 @@ export default function PagesHorizontalViewer({
if (document.visibilityState === "visible") {
visibilityRef.current = true;
startTimeRef.current = Date.now(); // Reset start time when the page becomes visible again
+ resetTrackingState();
} else {
visibilityRef.current = false;
if (pageNumber <= numPages) {
const duration = Date.now() - startTimeRef.current;
- trackPageView({
- linkId,
- documentId,
- viewId,
- duration,
- pageNumber: pageNumber,
- versionNumber,
- dataroomId,
- setViewedPages,
- isPreview,
- });
+ trackPageViewSafely(
+ {
+ linkId,
+ documentId,
+ viewId,
+ duration,
+ pageNumber: pageNumber,
+ versionNumber,
+ dataroomId,
+ setViewedPages,
+ isPreview,
+ },
+ true,
+ );
}
}
};
@@ -243,7 +215,7 @@ export default function PagesHorizontalViewer({
if (visibilityRef.current && pageNumber <= numPages) {
const duration = Date.now() - startTimeRef.current;
- trackPageView({
+ trackPageViewSafely({
linkId,
documentId,
viewId,
@@ -261,17 +233,20 @@ export default function PagesHorizontalViewer({
const handleBeforeUnload = () => {
if (pageNumber <= numPages) {
const duration = Date.now() - startTimeRef.current;
- trackPageView({
- linkId,
- documentId,
- viewId,
- duration,
- pageNumber: pageNumber,
- versionNumber,
- dataroomId,
- setViewedPages,
- isPreview,
- });
+ trackPageViewSafely(
+ {
+ linkId,
+ documentId,
+ viewId,
+ duration,
+ pageNumber: pageNumber,
+ versionNumber,
+ dataroomId,
+ setViewedPages,
+ isPreview,
+ },
+ true,
+ );
}
};
@@ -355,7 +330,7 @@ export default function PagesHorizontalViewer({
preloadImage(pageNumber - 4);
const duration = Date.now() - startTimeRef.current;
- trackPageView({
+ trackPageViewSafely({
linkId,
documentId,
viewId,
@@ -385,7 +360,7 @@ export default function PagesHorizontalViewer({
preloadImage(pageNumber + 2);
const duration = Date.now() - startTimeRef.current;
- trackPageView({
+ trackPageViewSafely({
linkId,
documentId,
viewId,
@@ -428,7 +403,7 @@ export default function PagesHorizontalViewer({
if (targetPage >= 1 && targetPage <= numPages) {
// Track the current page before jumping
const duration = Date.now() - startTimeRef.current;
- trackPageView({
+ trackPageViewSafely({
linkId,
documentId,
viewId,
@@ -781,4 +756,4 @@ export default function PagesHorizontalViewer({
</div>
</>
);
-}
+}
\ No newline at end of file
diff --git a/components/view/viewer/pages-vertical-viewer.tsx b/components/view/viewer/pages-vertical-viewer.tsx
index 943b0bef..3e1afd35 100644
--- a/components/view/viewer/pages-vertical-viewer.tsx
+++ b/components/view/viewer/pages-vertical-viewer.tsx
@@ -5,6 +5,7 @@ import React from "react";
import { ChevronDownIcon, ChevronUpIcon } from "lucide-react";
+import { useSafePageViewTracker } from "@/lib/tracking/safe-page-view-tracker";
import { WatermarkConfig } from "@/lib/types";
import { cn } from "@/lib/utils";
import { useMediaQuery } from "@/lib/utils/use-media-query";
@@ -47,40 +48,6 @@ const calculateOptimalWidth = (
return isMobile ? containerWidth : minWidth;
};
-const trackPageView = async (data: {
- linkId: string;
- documentId: string;
- viewId?: string;
- duration: number;
- pageNumber: number;
- versionNumber: number;
- dataroomId?: string;
- setViewedPages?: React.Dispatch<
- React.SetStateAction<{ pageNumber: number; duration: number }[]>
- >;
- isPreview?: boolean;
-}) => {
- data.setViewedPages &&
- data.setViewedPages((prevViewedPages) =>
- prevViewedPages.map((page) =>
- page.pageNumber === data.pageNumber
- ? { ...page, duration: page.duration + data.duration }
- : page,
- ),
- );
-
- // If the view is a preview, do not track the view
- if (data.isPreview) return;
-
- await fetch("/api/record_view", {
- method: "POST",
- body: JSON.stringify(data),
- headers: {
- "Content-Type": "application/json",
- },
- });
-};
-
export default function PagesVerticalViewer({
pages,
feedbackEnabled,
@@ -222,6 +189,8 @@ export default function PagesVerticalViewer({
hasTrackedUpRef.current = false; // Reset tracking status on page number change
}, [pageNumber]);
+ const { trackPageViewSafely, resetTrackingState } = useSafePageViewTracker();
+
useEffect(() => {
const handleVisibilityChange = () => {
if (pageNumber > numPages) return;
@@ -229,21 +198,25 @@ export default function PagesVerticalViewer({
if (document.visibilityState === "visible") {
visibilityRef.current = true;
startTimeRef.current = Date.now(); // Reset start time when the page becomes visible again
+ resetTrackingState();
} else {
visibilityRef.current = false;
if (pageNumber <= numPages) {
const duration = Date.now() - startTimeRef.current;
- trackPageView({
- linkId,
- documentId,
- viewId,
- duration,
- pageNumber: pageNumber,
- versionNumber,
- dataroomId,
- setViewedPages,
- isPreview,
- });
+ trackPageViewSafely(
+ {
+ linkId,
+ documentId,
+ viewId,
+ duration,
+ pageNumber: pageNumber,
+ versionNumber,
+ dataroomId,
+ setViewedPages,
+ isPreview,
+ },
+ true,
+ );
}
}
};
@@ -260,7 +233,7 @@ export default function PagesVerticalViewer({
if (visibilityRef.current && pageNumber <= numPages) {
const duration = Date.now() - startTimeRef.current;
- trackPageView({
+ trackPageViewSafely({
linkId,
documentId,
viewId,
@@ -277,18 +250,22 @@ export default function PagesVerticalViewer({
useEffect(() => {
const handleBeforeUnload = () => {
if (pageNumber <= numPages) {
+ // Only track if we haven't already tracked an unload event
const duration = Date.now() - startTimeRef.current;
- trackPageView({
- linkId,
- documentId,
- viewId,
- duration,
- pageNumber: pageNumber,
- versionNumber,
- dataroomId,
- setViewedPages,
- isPreview,
- });
+ trackPageViewSafely(
+ {
+ linkId,
+ documentId,
+ viewId,
+ duration,
+ pageNumber: pageNumber,
+ versionNumber,
+ dataroomId,
+ setViewedPages,
+ isPreview,
+ },
+ true,
+ );
}
};
@@ -402,7 +379,7 @@ export default function PagesVerticalViewer({
if (maxVisiblePage !== pageNumber) {
if (pageNumber <= numPages) {
const duration = Date.now() - startTimeRef.current;
- trackPageView({
+ trackPageViewSafely({
linkId,
documentId,
viewId,
@@ -456,7 +433,7 @@ export default function PagesVerticalViewer({
preloadImage(pageNumber - 4);
const duration = Date.now() - startTimeRef.current;
- trackPageView({
+ trackPageViewSafely({
linkId,
documentId,
viewId,
@@ -503,7 +480,7 @@ export default function PagesVerticalViewer({
preloadImage(pageNumber + 2);
const duration = Date.now() - startTimeRef.current;
- trackPageView({
+ trackPageViewSafely({
linkId,
documentId,
viewId,
@@ -559,7 +536,7 @@ export default function PagesVerticalViewer({
if (targetPage >= 1 && targetPage <= numPages) {
// Track the current page before jumping
const duration = Date.now() - startTimeRef.current;
- trackPageView({
+ trackPageViewSafely({
linkId,
documentId,
viewId,
diff --git a/components/view/viewer/pdf-default-viewer.tsx b/components/view/viewer/pdf-default-viewer.tsx
index 83abb807..0d0aaa92 100644
--- a/components/view/viewer/pdf-default-viewer.tsx
+++ b/components/view/viewer/pdf-default-viewer.tsx
@@ -1,11 +1,23 @@
import { useEffect, useRef, useState } from "react";
+
+
import { useTeam } from "@/context/team-context";
import { ChevronLeftIcon, ChevronRightIcon } from "lucide-react";
import { Document, Page, pdfjs } from "react-pdf";
+
+
+import { useSafePageViewTracker } from "@/lib/tracking/safe-page-view-tracker";
+
+
+
import Nav from "@/components/view/nav";
+
+
+
+
pdfjs.GlobalWorkerOptions.workerSrc = `//cdnjs.cloudflare.com/ajax/libs/pdf.js/${pdfjs.version}/pdf.worker.min.js`;
export default function PDFViewer(props: any) {
@@ -18,7 +30,9 @@ export default function PDFViewer(props: any) {
const startTimeRef = useRef(Date.now());
const pageNumberRef = useRef<number>(pageNumber);
+ const visibilityRef = useRef<boolean>(true);
const teamInfo = useTeam();
+ const { trackPageViewSafely, resetTrackingState } = useSafePageViewTracker();
// Update the previous page number after the effect hook has run
useEffect(() => {
@@ -30,12 +44,53 @@ export default function PDFViewer(props: any) {
// when component unmounts, calculate duration and track page view
return () => {
- const endTime = Date.now();
- const duration = Math.round(endTime - startTimeRef.current);
- trackPageView(duration);
+ const duration = Math.round(Date.now() - startTimeRef.current);
+ trackPageViewSafely(
+ {
+ linkId: linkId,
+ documentId: documentId,
+ viewId: viewId,
+ duration: duration,
+ pageNumber: pageNumberRef.current,
+ versionNumber: props.versionNumber,
+ isPreview: isPreview,
+ },
+ false,
+ );
};
}, [pageNumber]); // monitor pageNumber for changes
+ useEffect(() => {
+ const handleVisibilityChange = () => {
+ if (document.visibilityState === "visible") {
+ visibilityRef.current = true;
+ startTimeRef.current = Date.now();
+ resetTrackingState();
+ } else {
+ visibilityRef.current = false;
+ const duration = Date.now() - startTimeRef.current;
+ trackPageViewSafely(
+ {
+ linkId: linkId,
+ documentId: documentId,
+ viewId: viewId,
+ duration: duration,
+ pageNumber: pageNumberRef.current,
+ versionNumber: props.versionNumber,
+ isPreview: isPreview,
+ },
+ true,
+ );
+ }
+ };
+
+ document.addEventListener("visibilitychange", handleVisibilityChange);
+
+ return () => {
+ document.removeEventListener("visibilitychange", handleVisibilityChange);
+ };
+ }, [pageNumber]);
+
useEffect(() => {
if (numPages > 0) {
updateNumPages(numPages);
@@ -54,9 +109,19 @@ export default function PDFViewer(props: any) {
// duration is measured in milliseconds
useEffect(() => {
const handleBeforeUnload = () => {
- const endTime = Date.now();
- const duration = Math.round(endTime - startTimeRef.current);
- trackPageView(duration);
+ const duration = Math.round(Date.now() - startTimeRef.current);
+ trackPageViewSafely(
+ {
+ linkId: linkId,
+ documentId: documentId,
+ viewId: viewId,
+ duration: duration,
+ pageNumber: pageNumberRef.current,
+ versionNumber: props.versionNumber,
+ isPreview: isPreview,
+ },
+ true,
+ );
};
window.addEventListener("beforeunload", handleBeforeUnload);
@@ -132,24 +197,6 @@ export default function PDFViewer(props: any) {
}
}
- async function trackPageView(duration: number = 0) {
- await fetch("/api/record_view", {
- method: "POST",
- body: JSON.stringify({
- linkId: linkId,
- documentId: documentId,
- viewId: viewId,
- duration: duration,
- pageNumber: pageNumberRef.current,
- versionNumber: props.versionNumber,
- isPreview: isPreview,
- }),
- headers: {
- "Content-Type": "application/json",
- },
- });
- }
-
async function updateNumPages(numPages: number) {
await fetch(`/api/teams/${teamInfo?.currentTeam?.id}/documents/update`, {
method: "POST",
@@ -219,4 +266,4 @@ export default function PDFViewer(props: any) {
</div>
</>
);
-}
+}
\ No newline at end of file
diff --git a/lib/tracking/safe-page-view-tracker.ts b/lib/tracking/safe-page-view-tracker.ts
new file mode 100644
index 00000000..38df60e8
--- /dev/null
+++ b/lib/tracking/safe-page-view-tracker.ts
@@ -0,0 +1,84 @@
+import { useRef } from "react";
+import { trackPageViewReliably } from "../utils/reliable-tracking";
+
+interface TrackingData {
+ linkId: string;
+ documentId: string;
+ viewId?: string;
+ duration: number;
+ pageNumber: number;
+ versionNumber: number;
+ dataroomId?: string;
+ isPreview?: boolean;
+ setViewedPages?: React.Dispatch<
+ React.SetStateAction<{ pageNumber: number; duration: number }[]>
+ >;
+}
+
+export function useSafePageViewTracker() {
+ const hasTrackedUnloadRef = useRef<boolean>(false);
+ const isTrackingRef = useRef<boolean>(false);
+
+ const trackPageViewSafely = async (
+ data: TrackingData,
+ useBeacon: boolean = false,
+ ): Promise<void> => {
+ // Prevent concurrent tracking calls
+ if (isTrackingRef.current) return;
+
+ // Prevent duplicate unload tracking
+ if (useBeacon && hasTrackedUnloadRef.current) return;
+
+ isTrackingRef.current = true;
+
+ if (useBeacon) {
+ hasTrackedUnloadRef.current = true;
+ }
+
+ try {
+ // Update viewed pages if setter is provided
+ if (data.setViewedPages) {
+ data.setViewedPages((prevViewedPages) =>
+ prevViewedPages.map((page) =>
+ page.pageNumber === data.pageNumber
+ ? { ...page, duration: page.duration + data.duration }
+ : page,
+ ),
+ );
+ }
+
+ // Track the page view
+ await trackPageViewReliably(
+ {
+ linkId: data.linkId,
+ documentId: data.documentId,
+ viewId: data.viewId,
+ duration: data.duration,
+ pageNumber: data.pageNumber,
+ versionNumber: data.versionNumber,
+ dataroomId: data.dataroomId,
+ isPreview: data.isPreview,
+ },
+ useBeacon,
+ );
+ } finally {
+ isTrackingRef.current = false;
+ }
+ };
+
+ const resetTrackingState = () => {
+ hasTrackedUnloadRef.current = false;
+ isTrackingRef.current = false;
+ };
+
+ const getTrackingState = () => ({
+ hasTrackedUnload: hasTrackedUnloadRef.current,
+ isTracking: isTrackingRef.current,
+ });
+
+ return {
+ trackPageViewSafely,
+ resetTrackingState,
+ getTrackingState,
+ };
+}
\ No newline at end of file
diff --git a/lib/utils/reliable-tracking.ts b/lib/utils/reliable-tracking.ts
new file mode 100644
index 00000000..ef1b2339
--- /dev/null
+++ b/lib/utils/reliable-tracking.ts
@@ -0,0 +1,122 @@
+interface TrackingData {
+ linkId: string;
+ documentId: string;
+ viewId?: string;
+ duration: number;
+ pageNumber: number;
+ versionNumber: number;
+ dataroomId?: string;
+ isPreview?: boolean;
+}
+
+interface TrackingOptions {
+ useBeacon?: boolean;
+ retryAttempts?: number;
+ retryDelay?: number;
+}
+
+export async function trackPageViewReliably(
+ data: TrackingData,
+ useBeacon: boolean = false,
+ options: TrackingOptions = {}
+): Promise<void> {
+ // If the view is a preview, do not track the view
+ if (data.isPreview) return;
+
+ const {
+ retryAttempts = 3,
+ retryDelay = 1000
+ } = options;
+ const payload = JSON.stringify(data);
+ const url = "/api/record_view";
+
+ // 1: Use sendBeacon for maximum reliability during page unload
+ if (useBeacon && navigator.sendBeacon) {
+ try {
+ const blob = new Blob([payload], { type: "application/json" });
+ const success = navigator.sendBeacon(url, blob);
+
+ if (success) {
+ return;
+ }
+ } catch (error) {
+ console.warn("sendBeacon failed:", error);
+ }
+ }
+
+ // 2: Use fetch with keepalive for better reliability
+ try {
+ const response = await fetch(url, {
+ method: "POST",
+ body: payload,
+ headers: {
+ "Content-Type": "application/json",
+ },
+ keepalive: true, // Critical for page unload scenarios
+ });
+
+ if (response.ok) {
+ return;
+ }
+ } catch (error) {
+ console.warn("Fetch with keepalive failed:", error);
+ }
+
+ // 3: Fallback to sendBeacon if fetch failed
+ if (!useBeacon && navigator.sendBeacon) {
+ try {
+ const blob = new Blob([payload], { type: "application/json" });
+ const success = navigator.sendBeacon(url, blob);
+
+ if (success) {
+ return;
+ }
+ } catch (error) {
+ console.warn("Fallback sendBeacon failed:", error);
+ }
+ }
+
+ // 4: Retry with exponential backoff (only if not during page unload)
+ if (!useBeacon && retryAttempts > 0) {
+ for (let attempt = 1; attempt <= retryAttempts; attempt++) {
+ try {
+ await new Promise(resolve => setTimeout(resolve, retryDelay * attempt));
+
+ const response = await fetch(url, {
+ method: "POST",
+ body: payload,
+ headers: {
+ "Content-Type": "application/json",
+ },
+ keepalive: true,
+ });
+
+ if (response.ok) {
+ return;
+ }
+ } catch (error) {
+ console.warn(`Retry attempt ${attempt} failed:`, error);
+ }
+ }
+ }
+
+ // 5: Last resort - Image beacon (limited payload size)
+ if (payload.length < 2000) { // URL length limit
+ try {
+ const img = new Image();
+ const params = new URLSearchParams({ data: payload });
+ img.src = `${url}?${params.toString()}`;
+
+ // Don't wait for image to load, just fire and forget
+ return;
+ } catch (error) {
+ console.warn("Image beacon fallback failed:", error);
+ }
+ }
+
+ console.error("All tracking strategies failed - data may be lost");
+}
+
+export async function trackPageView(data: TrackingData): Promise<void> {
+ return trackPageViewReliably(data, false);
+}
\ No newline at end of file