Skip to content

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

feat: add dataroom uploading notificatons per uploader

Marc Seitz015d08793494
diff --git a/app/(ee)/api/links/[id]/upload/route.ts b/app/(ee)/api/links/[id]/upload/route.ts
index bbc51a26..44d1eec8 100644
--- a/app/(ee)/api/links/[id]/upload/route.ts
+++ b/app/(ee)/api/links/[id]/upload/route.ts
@@ -333,6 +333,8 @@ export async function POST(
}
// 5. Notify other dataroom visitors about the new upload (each visitor gets their own email)
+ // Uses cancel-and-retrigger as a debounce: the delayed task queries
+ // DocumentUpload at runtime to batch all recent uploads into one notification.
if (link.dataroom?.enableVisitorUploadChangeNotifications) {
try {
const changeNotifTag = `dataroom_${dataroomId}`;
@@ -340,7 +342,7 @@ export async function POST(
taskIdentifier: ["send-dataroom-change-notification"],
tag: [changeNotifTag, `visitor_upload_${viewerId}`],
status: ["DELAYED", "QUEUED"],
- period: "10m",
+ period: "15m",
});
const matchingChangeRuns = existingChangeRuns.data.filter(
@@ -355,20 +357,19 @@ export async function POST(
sendDataroomChangeNotificationTask.trigger(
{
dataroomId,
- dataroomDocumentId: newDataroomDocument.id,
+ uploaderViewerId: viewerId,
senderUserId: null,
teamId: link.teamId,
excludeViewerId: viewerId,
},
{
- idempotencyKey: `visitor-change-notification-${link.teamId}-${dataroomId}-${newDataroomDocument.id}`,
+ idempotencyKey: `visitor-change-notification-${link.teamId}-${dataroomId}-${viewerId}-${Date.now()}`,
tags: [
`team_${link.teamId}`,
changeNotifTag,
- `document_${newDataroomDocument.id}`,
`visitor_upload_${viewerId}`,
],
- delay: new Date(Date.now() + 10 * 60 * 1000), // 10 minute delay (same as admin)
+ delay: new Date(Date.now() + 10 * 60 * 1000),
},
),
);
diff --git a/components/emails/dataroom-digest-notification.tsx b/components/emails/dataroom-digest-notification.tsx
index b82f49d6..51338d99 100644
--- a/components/emails/dataroom-digest-notification.tsx
+++ b/components/emails/dataroom-digest-notification.tsx
@@ -34,10 +34,15 @@ export default function DataroomDigestNotification({
senderEmail: string | null;
url: string;
preferencesUrl: string;
- frequency: "daily" | "weekly";
+ frequency: "daily" | "weekly" | "instant";
}) {
const count = documents.length;
- const periodLabel = frequency === "daily" ? "today" : "this week";
+ const periodLabel =
+ frequency === "instant"
+ ? "recently"
+ : frequency === "daily"
+ ? "today"
+ : "this week";
return (
<Html>
@@ -91,7 +96,8 @@ export default function DataroomDigestNotification({
reserved.
</Text>
<Text className="text-xs">
- You received this {frequency} digest{" "}
+ You received this{" "}
+ {frequency !== "instant" ? `${frequency} digest ` : "notification "}
{senderEmail ? (
<>
from{" "}
diff --git a/lib/emails/send-dataroom-digest-notification.ts b/lib/emails/send-dataroom-digest-notification.ts
index 30096499..265afc92 100644
--- a/lib/emails/send-dataroom-digest-notification.ts
+++ b/lib/emails/send-dataroom-digest-notification.ts
@@ -17,10 +17,15 @@ export const sendDataroomDigestNotification = async ({
to: string;
url: string;
preferencesUrl: string;
- frequency: "daily" | "weekly";
+ frequency: "daily" | "weekly" | "instant";
}) => {
const count = documents.length;
- const periodLabel = frequency === "daily" ? "today" : "this week";
+ const periodLabel =
+ frequency === "instant"
+ ? "recently"
+ : frequency === "daily"
+ ? "today"
+ : "this week";
try {
await sendEmail({
diff --git a/lib/trigger/dataroom-change-notification.ts b/lib/trigger/dataroom-change-notification.ts
index b35b114d..3d7a08d6 100644
--- a/lib/trigger/dataroom-change-notification.ts
+++ b/lib/trigger/dataroom-change-notification.ts
@@ -1,30 +1,62 @@
-import { logger, task } from "@trigger.dev/sdk";
+import { logger, schemaTask } from "@trigger.dev/sdk";
+import { z } from "zod";
import prisma from "@/lib/prisma";
import { queueNotification } from "@/lib/redis/dataroom-notification-queue";
import { ZViewerNotificationPreferencesSchema } from "@/lib/zod/schemas/notifications";
-type NotificationPayload = {
- dataroomId: string;
- dataroomDocumentId: string;
- senderUserId: string | null;
- teamId: string;
- excludeViewerId?: string;
-};
+const NotificationPayloadSchema = z.object({
+ dataroomId: z.string().cuid(),
+ dataroomDocumentId: z.string().cuid().optional(),
+ uploaderViewerId: z.string().cuid().optional(),
+ senderUserId: z.string().cuid().nullable(),
+ teamId: z.string().cuid(),
+ excludeViewerId: z.string().cuid().optional(),
+});
-export const sendDataroomChangeNotificationTask = task({
+export const sendDataroomChangeNotificationTask = schemaTask({
id: "send-dataroom-change-notification",
+ schema: NotificationPayloadSchema,
retry: { maxAttempts: 3 },
- run: async (payload: NotificationPayload) => {
- const dataroomDocument = await prisma.dataroomDocument.findUnique({
- where: { id: payload.dataroomDocumentId },
+ run: async (payload) => {
+ // --- Resolve document IDs ---
+ let dataroomDocumentIds: string[];
+
+ if (payload.uploaderViewerId) {
+ const fifteenMinutesAgo = new Date(Date.now() - 15 * 60 * 1000);
+ const recentUploads = await prisma.documentUpload.findMany({
+ where: {
+ dataroomId: payload.dataroomId,
+ viewerId: payload.uploaderViewerId,
+ uploadedAt: { gte: fifteenMinutesAgo },
+ },
+ select: { dataroomDocumentId: true },
+ orderBy: { uploadedAt: "desc" },
+ });
+ dataroomDocumentIds = recentUploads
+ .map((u) => u.dataroomDocumentId)
+ .filter((id): id is string => id !== null);
+ } else if (payload.dataroomDocumentId) {
+ dataroomDocumentIds = [payload.dataroomDocumentId];
+ } else {
+ logger.error("Either dataroomDocumentId or uploaderViewerId is required");
+ return;
+ }
+
+ if (dataroomDocumentIds.length === 0) {
+ logger.info("No documents to notify about", {
+ dataroomId: payload.dataroomId,
+ });
+ return;
+ }
+
+ const dataroomDocuments = await prisma.dataroomDocument.findMany({
+ where: { id: { in: dataroomDocumentIds } },
select: { id: true, folderId: true },
});
- if (!dataroomDocument) {
- logger.error("Dataroom document not found", {
- dataroomDocumentId: payload.dataroomDocumentId,
- });
+ if (dataroomDocuments.length === 0) {
+ logger.error("Dataroom documents not found", { dataroomDocumentIds });
return;
}
@@ -80,28 +112,23 @@ export const sendDataroomChangeNotificationTask = task({
return;
}
- // Cache folder-access results per group to avoid duplicate queries
const folderAccessCache = new Map<string, boolean>();
const canViewFolder = async (
groupId: string | null | undefined,
permissionGroupId: string | null | undefined,
+ folderId: string | null,
): Promise<boolean> => {
- // No group restriction → unrestricted access
if (!groupId && !permissionGroupId) {
return true;
}
- // Document is in the root (no folder) → always notify
- if (!dataroomDocument.folderId) {
+ if (!folderId) {
return true;
}
- const folderId = dataroomDocument.folderId;
-
- // groupId
if (groupId) {
- const cacheKey = `viewer-group:${groupId}`;
+ const cacheKey = `viewer-group:${groupId}:${folderId}`;
if (folderAccessCache.has(cacheKey)) {
return folderAccessCache.get(cacheKey)!;
}
@@ -116,9 +143,8 @@ export const sendDataroomChangeNotificationTask = task({
return result;
}
- // permissionGroupId
if (permissionGroupId) {
- const cacheKey = `permission-group:${permissionGroupId}`;
+ const cacheKey = `permission-group:${permissionGroupId}:${folderId}`;
if (folderAccessCache.has(cacheKey)) {
return folderAccessCache.get(cacheKey)!;
}
@@ -138,6 +164,13 @@ export const sendDataroomChangeNotificationTask = task({
const viewerResults = await Promise.all(
viewers.map(async (viewer) => {
+ // TODO: KNOWN LIMITATION: Only the most recent view (views[0]) is checked for
+ // folder access. A viewer with multiple verified links may be
+ // incorrectly skipped if views[0]'s link lacks access but another
+ // link in viewer.views does grant it via canViewFolder(). The fix is
+ // to iterate over all viewer.views and pick any link where
+ // canViewFolder(link.groupId, link.permissionGroupId) returns true
+ // for dataroomDocument.folderId before deciding to skip.
const view = viewer.views[0];
const link = view?.link;
@@ -149,23 +182,29 @@ export const sendDataroomChangeNotificationTask = task({
return null;
}
- const hasAccess = await canViewFolder(
- link.groupId,
- link.permissionGroupId,
- );
-
- if (!hasAccess) {
- logger.info(
- "Skipping viewer notification: link group does not have access to the document folder",
- {
- viewerId: viewer.id,
- linkId: link.id,
- groupId: link.groupId,
- permissionGroupId: link.permissionGroupId,
- folderId: dataroomDocument.folderId,
- dataroomDocumentId: payload.dataroomDocumentId,
- },
+ const accessibleDocIds: string[] = [];
+ for (const doc of dataroomDocuments) {
+ const hasAccess = await canViewFolder(
+ link.groupId,
+ link.permissionGroupId,
+ doc.folderId,
);
+ if (hasAccess) {
+ accessibleDocIds.push(doc.id);
+ } else {
+ logger.info(
+ "Skipping document for viewer: link group lacks folder access",
+ {
+ viewerId: viewer.id,
+ linkId: link.id,
+ dataroomDocumentId: doc.id,
+ folderId: doc.folderId,
+ },
+ );
+ }
+ }
+
+ if (accessibleDocIds.length === 0) {
return null;
}
@@ -197,6 +236,7 @@ export const sendDataroomChangeNotificationTask = task({
id: viewer.id,
linkUrl,
frequency,
+ accessibleDocIds,
};
}),
);
@@ -208,28 +248,33 @@ export const sendDataroomChangeNotificationTask = task({
id: string;
linkUrl: string;
frequency: "instant" | "daily" | "weekly";
+ accessibleDocIds: string[];
} => viewer !== null,
);
logger.info("Processed viewer links", {
viewerCount: viewersWithLinks.length,
+ documentCount: dataroomDocuments.length,
});
for (const viewer of viewersWithLinks) {
try {
if (viewer.frequency === "daily" || viewer.frequency === "weekly") {
- await queueNotification({
- frequency: viewer.frequency,
- viewerId: viewer.id,
- dataroomId: payload.dataroomId,
- teamId: payload.teamId,
- dataroomDocumentId: payload.dataroomDocumentId,
- senderUserId: payload.senderUserId,
- });
+ for (const docId of viewer.accessibleDocIds) {
+ await queueNotification({
+ frequency: viewer.frequency,
+ viewerId: viewer.id,
+ dataroomId: payload.dataroomId,
+ teamId: payload.teamId,
+ dataroomDocumentId: docId,
+ senderUserId: payload.senderUserId,
+ });
+ }
- logger.info("Queued notification for digest", {
+ logger.info("Queued notifications for digest", {
viewerId: viewer.id,
frequency: viewer.frequency,
+ documentCount: viewer.accessibleDocIds.length,
});
continue;
}
@@ -241,7 +286,7 @@ export const sendDataroomChangeNotificationTask = task({
body: JSON.stringify({
dataroomId: payload.dataroomId,
linkUrl: viewer.linkUrl,
- dataroomDocumentId: payload.dataroomDocumentId,
+ dataroomDocumentIds: viewer.accessibleDocIds,
viewerId: viewer.id,
senderUserId: payload.senderUserId,
teamId: payload.teamId,
@@ -266,6 +311,7 @@ export const sendDataroomChangeNotificationTask = task({
logger.info("Notification sent successfully", {
viewerId: viewer.id,
message,
+ documentCount: viewer.accessibleDocIds.length,
});
} catch (error) {
logger.error("Error sending notification", {
@@ -278,6 +324,7 @@ export const sendDataroomChangeNotificationTask = task({
logger.info("Completed sending notifications", {
dataroomId: payload.dataroomId,
viewerCount: viewers.length,
+ documentCount: dataroomDocuments.length,
});
return;
},
diff --git a/pages/api/jobs/send-dataroom-new-document-notification.ts b/pages/api/jobs/send-dataroom-new-document-notification.ts
index 7bb0a9c9..b86e0223 100644
--- a/pages/api/jobs/send-dataroom-new-document-notification.ts
+++ b/pages/api/jobs/send-dataroom-new-document-notification.ts
@@ -1,5 +1,6 @@
import { NextApiRequest, NextApiResponse } from "next";
+import { sendDataroomDigestNotification } from "@/lib/emails/send-dataroom-digest-notification";
import { sendDataroomNotification } from "@/lib/emails/send-dataroom-notification";
import prisma from "@/lib/prisma";
import { log } from "@/lib/utils";
@@ -13,17 +14,14 @@ export default async function handle(
req: NextApiRequest,
res: NextApiResponse,
) {
- // We only allow POST requests
if (req.method !== "POST") {
res.status(405).json({ message: "Method Not Allowed" });
return;
}
- // Extract the API Key from the Authorization header
const authHeader = req.headers.authorization;
- const token = authHeader?.split(" ")[1]; // Assuming the format is "Bearer [token]"
+ const token = authHeader?.split(" ")[1];
- // Check if the API Key matches
if (token !== process.env.INTERNAL_API_KEY) {
res.status(401).json({ message: "Unauthorized" });
return;
@@ -33,22 +31,32 @@ export default async function handle(
linkUrl,
dataroomId,
dataroomDocumentId,
+ dataroomDocumentIds,
viewerId,
senderUserId,
teamId,
} = req.body as {
linkUrl: string;
dataroomId: string;
- dataroomDocumentId: string;
+ dataroomDocumentId?: string;
+ dataroomDocumentIds?: string[];
viewerId: string;
senderUserId: string | null;
teamId: string;
};
+ const docIds =
+ dataroomDocumentIds ??
+ (dataroomDocumentId ? [dataroomDocumentId] : []);
+
+ if (docIds.length === 0) {
+ res.status(400).json({ message: "No document IDs provided" });
+ return;
+ }
+
let viewer: { email: string } | null = null;
try {
- // Fetch the link to verify the settings
viewer = await prisma.viewer.findUnique({
where: {
id: viewerId,
@@ -73,12 +81,10 @@ export default async function handle(
return;
}
- // POST /api/jobs/send-datarooom-notification
try {
- // Fetch the document to verify the settings
- const document = await prisma.dataroomDocument.findUnique({
+ const documents = await prisma.dataroomDocument.findMany({
where: {
- id: dataroomDocumentId,
+ id: { in: docIds },
dataroomId: dataroomId,
},
select: {
@@ -95,6 +101,11 @@ export default async function handle(
},
});
+ if (documents.length === 0) {
+ res.status(404).json({ message: "No documents found." });
+ return;
+ }
+
let senderEmail: string | null = null;
if (senderUserId) {
const user = await prisma.user.findUnique({
@@ -115,23 +126,40 @@ export default async function handle(
teamId,
});
- await sendDataroomNotification({
- dataroomName: document?.dataroom?.name || "",
- documentName: document?.document?.name || "",
- senderEmail,
- to: viewer.email!,
- url: linkUrl,
- unsubscribeUrl,
- });
+ const dataroomName = documents[0]?.dataroom?.name || "";
+
+ if (documents.length === 1) {
+ await sendDataroomNotification({
+ dataroomName,
+ documentName: documents[0]?.document?.name || "",
+ senderEmail,
+ to: viewer.email!,
+ url: linkUrl,
+ unsubscribeUrl,
+ });
+ } else {
+ await sendDataroomDigestNotification({
+ dataroomName,
+ documents: documents.map((doc) => ({
+ documentName: doc.document?.name || "Untitled",
+ })),
+ senderEmail,
+ to: viewer.email!,
+ url: linkUrl,
+ preferencesUrl: unsubscribeUrl,
+ frequency: "instant",
+ });
+ }
res.status(200).json({
message: "Successfully sent dataroom change notification",
viewerId,
+ documentCount: documents.length,
});
return;
} catch (error) {
log({
- message: `Failed to send invite email for dataroom ${dataroomId} to viewer: ${viewerId}. \n\n Error: ${error} \n\n*Metadata*: \`{dataroomId: ${dataroomId}, viewerId: ${viewerId}}\``,
+ message: `Failed to send notification for dataroom ${dataroomId} to viewer: ${viewerId}. \n\n Error: ${error} \n\n*Metadata*: \`{dataroomId: ${dataroomId}, viewerId: ${viewerId}, docCount: ${docIds.length}}\``,
type: "error",
mention: true,
});