Skip to content

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

feat: update tinybird pipe to exclude specific links and views

Marc Seitz014c7070dfd1
diff --git a/lib/swr/use-stats.ts b/lib/swr/use-stats.ts
index d08507f3..45964fd2 100644
--- a/lib/swr/use-stats.ts
+++ b/lib/swr/use-stats.ts
@@ -4,20 +4,14 @@ import { fetcher } from "@/lib/utils";
import { View } from "@prisma/client";
import { useTeam } from "@/context/team-context";
-interface GroupedView {
- viewerEmail: string;
- _count: { id: number };
-}
-
-interface StatsData {
+export type TStatsData = {
views: View[];
- groupedViews: GroupedView[];
groupedReactions: { type: string; _count: { type: number } }[];
duration: {
data: { versionNumber: number; pageNumber: string; avg_duration: number }[];
};
total_duration: number;
-}
+};
export function useStats() {
// this gets the data for a document's graph of all views
@@ -28,7 +22,7 @@ export function useStats() {
id: string;
};
- const { data: stats, error } = useSWR<StatsData>(
+ const { data: stats, error } = useSWR<TStatsData>(
id &&
`/api/teams/${teamInfo?.currentTeam?.id}/documents/${encodeURIComponent(
id,
diff --git a/lib/tinybird/endpoints/get_total_average_page_duration.pipe b/lib/tinybird/endpoints/get_total_average_page_duration.pipe
index 6cbd0e2a..ff439a1c 100644
--- a/lib/tinybird/endpoints/get_total_average_page_duration.pipe
+++ b/lib/tinybird/endpoints/get_total_average_page_duration.pipe
@@ -1,18 +1,20 @@
-VERSION 2
+VERSION 3
NODE endpoint
SQL >
%
- SELECT
- versionNumber,
- pageNumber,
- AVG(duration) AS avg_duration
- FROM
- page_views__v2
- WHERE
- documentId = {{ String(documentId, required=True) }}
- AND time >= {{ Int64(since, required=True) }}
- GROUP BY
- versionNumber, pageNumber
- ORDER BY
- versionNumber ASC, pageNumber ASC
+ WITH
+ DistinctDurations AS (
+ SELECT versionNumber, pageNumber, viewId, SUM(duration) AS distinct_duration
+ FROM page_views__v2
+ WHERE
+ documentId = {{ String(documentId, required=true) }}
+ AND time >= {{ Int64(since, required=true) }}
+ AND linkId NOT IN {{ Array(excludedLinkIds, String) }}
+ AND viewId NOT IN {{ Array(excludedViewIds, String) }}
+ GROUP BY versionNumber, pageNumber, viewId
+ )
+ SELECT versionNumber, pageNumber, AVG(distinct_duration) AS avg_duration
+ FROM DistinctDurations
+ GROUP BY versionNumber, pageNumber
+ ORDER BY versionNumber ASC, pageNumber ASC
diff --git a/lib/tinybird/pipes.ts b/lib/tinybird/pipes.ts
index 111d4555..8e7d5459 100644
--- a/lib/tinybird/pipes.ts
+++ b/lib/tinybird/pipes.ts
@@ -5,9 +5,11 @@ import { Tinybird } from "@chronark/zod-bird";
const tb = new Tinybird({ token: process.env.TINYBIRD_TOKEN! });
export const getTotalAvgPageDuration = tb.buildPipe({
- pipe: "get_total_average_page_duration__v2",
+ pipe: "get_total_average_page_duration__v3",
parameters: z.object({
documentId: z.string(),
+ excludedLinkIds: z.array(z.string()),
+ excludedViewIds: z.array(z.string()),
since: z.number(),
}),
data: z.object({
diff --git a/pages/api/teams/[teamId]/documents/[id]/stats.ts b/pages/api/teams/[teamId]/documents/[id]/stats.ts
index c2652c00..f1d68950 100644
--- a/pages/api/teams/[teamId]/documents/[id]/stats.ts
+++ b/pages/api/teams/[teamId]/documents/[id]/stats.ts
@@ -6,6 +6,7 @@ import { getTotalAvgPageDuration } from "@/lib/tinybird";
import { CustomUser } from "@/lib/types";
import { getTeamWithUsersAndDocument } from "@/lib/team/helper";
import { errorhandler } from "@/lib/errorHandler";
+import { View } from "@prisma/client";
export default async function handle(
req: NextApiRequest,
@@ -35,22 +36,56 @@ export default async function handle(
},
});
+ const users = await prisma.user.findMany({
+ where: {
+ teams: {
+ some: {
+ teamId: teamId,
+ },
+ },
+ },
+ select: {
+ email: true,
+ },
+ });
+
const views = document?.views;
- const groupedViews = await prisma.view.groupBy({
- by: ["viewerEmail"],
- where: { documentId: docId },
- _count: { id: true },
- });
+ // if there are no views, return an empty array
+ if (!views) {
+ return res.status(200).json({
+ views: [],
+ duration: { data: [] },
+ total_duration: 0,
+ groupedReactions: [],
+ });
+ }
+
+ // exclude views from the team's members
+ let excludedViews: View[] = [];
+ excludedViews = views.filter((view) => {
+ return users.some((user) => user.email === view.viewerEmail);
+ });
+
+ const filteredViews = views.filter(
+ (view) => !excludedViews.map((view) => view.id).includes(view.id),
+ );
const groupedReactions = await prisma.reaction.groupBy({
by: ["type"],
- where: { view: { documentId: docId } },
+ where: {
+ view: {
+ documentId: docId,
+ id: { notIn: excludedViews.map((view) => view.id) },
+ },
+ },
_count: { type: true },
});
const duration = await getTotalAvgPageDuration({
documentId: docId,
+ excludedLinkIds: [],
+ excludedViewIds: excludedViews.map((view) => view.id),
since: 0,
});
@@ -60,8 +95,7 @@ export default async function handle(
);
const stats = {
- views,
- groupedViews,
+ views: filteredViews,
duration,
total_duration,
groupedReactions,
diff --git a/pages/api/teams/[teamId]/documents/[id]/views/[viewId]/stats.ts b/pages/api/teams/[teamId]/documents/[id]/views/[viewId]/stats.ts
index 75de58a1..63afc0fd 100644
--- a/pages/api/teams/[teamId]/documents/[id]/views/[viewId]/stats.ts
+++ b/pages/api/teams/[teamId]/documents/[id]/views/[viewId]/stats.ts
@@ -9,7 +9,7 @@ import { errorhandler } from "@/lib/errorHandler";
export default async function handle(
req: NextApiRequest,
- res: NextApiResponse
+ res: NextApiResponse,
) {
if (req.method === "GET") {
// GET /api/teams/:teamId/documents/:id/views/:viewId/stats
@@ -52,7 +52,7 @@ export default async function handle(
const total_duration = duration.data.reduce(
(totalDuration, data) => totalDuration + data.sum_duration,
- 0
+ 0,
);
const stats = { duration, total_duration };