Skip to content

The Open Source DocuSign Alternative.

feat: add sequential document view logs (#1871)

David Nguyen0cc729e9bd0f
diff --git a/apps/remix/app/components/general/document/document-history-sheet-changes.tsx b/apps/remix/app/components/general/document/document-history-sheet-changes.tsx
deleted file mode 100644
index 577dbc473..000000000
--- a/apps/remix/app/components/general/document/document-history-sheet-changes.tsx
+++ /dev/null
@@ -1,26 +0,0 @@
-import React from 'react';
-
-import { Badge } from '@documenso/ui/primitives/badge';
-
-export type DocumentHistorySheetChangesProps = {
- values: {
- key: string | React.ReactNode;
- value: string | React.ReactNode;
- }[];
-};
-
-export const DocumentHistorySheetChanges = ({ values }: DocumentHistorySheetChangesProps) => {
- return (
- <Badge
- className="text-muted-foreground mt-3 block w-full space-y-0.5 text-xs"
- variant="neutral"
- >
- {values.map(({ key, value }, i) => (
- <p key={typeof key === 'string' ? key : i}>
- <span>{key}: </span>
- <span className="font-normal">{value}</span>
- </p>
- ))}
- </Badge>
- );
-};
diff --git a/apps/remix/app/components/general/document/document-history-sheet.tsx b/apps/remix/app/components/general/document/document-history-sheet.tsx
deleted file mode 100644
index f7c70bc84..000000000
--- a/apps/remix/app/components/general/document/document-history-sheet.tsx
+++ /dev/null
@@ -1,410 +0,0 @@
-import { useMemo, useState } from 'react';
-
-import { useLingui } from '@lingui/react';
-import { Trans } from '@lingui/react/macro';
-import { ArrowRightIcon, Loader } from 'lucide-react';
-import { DateTime } from 'luxon';
-import { match } from 'ts-pattern';
-import { UAParser } from 'ua-parser-js';
-
-import { DOCUMENT_AUDIT_LOG_EMAIL_FORMAT } from '@documenso/lib/constants/document-audit-logs';
-import { DOCUMENT_AUTH_TYPES } from '@documenso/lib/constants/document-auth';
-import { DOCUMENT_AUDIT_LOG_TYPE } from '@documenso/lib/types/document-audit-logs';
-import { formatDocumentAuditLogAction } from '@documenso/lib/utils/document-audit-logs';
-import { trpc } from '@documenso/trpc/react';
-import { cn } from '@documenso/ui/lib/utils';
-import { Avatar, AvatarFallback } from '@documenso/ui/primitives/avatar';
-import { Badge } from '@documenso/ui/primitives/badge';
-import { Button } from '@documenso/ui/primitives/button';
-import { Sheet, SheetContent, SheetTrigger } from '@documenso/ui/primitives/sheet';
-
-import { DocumentHistorySheetChanges } from './document-history-sheet-changes';
-
-export type DocumentHistorySheetProps = {
- documentId: number;
- userId: number;
- isMenuOpen?: boolean;
- onMenuOpenChange?: (_value: boolean) => void;
- children?: React.ReactNode;
-};
-
-export const DocumentHistorySheet = ({
- documentId,
- userId,
- isMenuOpen,
- onMenuOpenChange,
- children,
-}: DocumentHistorySheetProps) => {
- const { _, i18n } = useLingui();
-
- const [isUserDetailsVisible, setIsUserDetailsVisible] = useState(false);
-
- const {
- data,
- isLoading,
- isLoadingError,
- refetch,
- hasNextPage,
- fetchNextPage,
- isFetchingNextPage,
- } = trpc.document.findDocumentAuditLogs.useInfiniteQuery(
- {
- documentId,
- },
- {
- getNextPageParam: (lastPage) => lastPage.nextCursor,
- placeholderData: (previousData) => previousData,
- },
- );
-
- const documentAuditLogs = useMemo(() => (data?.pages ?? []).flatMap((page) => page.data), [data]);
-
- const extractBrowser = (userAgent?: string | null) => {
- if (!userAgent) {
- return 'Unknown';
- }
-
- const parser = new UAParser(userAgent);
-
- parser.setUA(userAgent);
-
- const result = parser.getResult();
-
- return result.browser.name;
- };
-
- /**
- * Applies the following formatting for a given text:
- * - Uppercase first lower, lowercase rest
- * - Replace _ with spaces
- *
- * @param text The text to format
- * @returns The formatted text
- */
- const formatGenericText = (text?: string | string[] | null): string => {
- if (!text) {
- return '';
- }
-
- if (Array.isArray(text)) {
- return text.map((t) => formatGenericText(t)).join(', ');
- }
-
- return (text.charAt(0).toUpperCase() + text.slice(1).toLowerCase()).replaceAll('_', ' ');
- };
-
- return (
- <Sheet open={isMenuOpen} onOpenChange={onMenuOpenChange}>
- {children && <SheetTrigger asChild>{children}</SheetTrigger>}
-
- <SheetContent
- sheetClass="backdrop-blur-none"
- className="flex w-full max-w-[500px] flex-col overflow-y-auto p-0"
- >
- <div className="text-foreground px-6 pt-6">
- <h1 className="text-lg font-medium">
- <Trans>Document history</Trans>
- </h1>
- <button
- className="text-muted-foreground text-sm"
- onClick={() => setIsUserDetailsVisible(!isUserDetailsVisible)}
- >
- {isUserDetailsVisible ? (
- <Trans>Hide additional information</Trans>
- ) : (
- <Trans>Show additional information</Trans>
- )}
- </button>
- </div>
-
- {isLoading && (
- <div className="flex h-full items-center justify-center">
- <Loader className="text-muted-foreground h-6 w-6 animate-spin" />
- </div>
- )}
-
- {isLoadingError && (
- <div className="flex h-full flex-col items-center justify-center">
- <p className="text-foreground/80 text-sm">
- <Trans>Unable to load document history</Trans>
- </p>
- <button
- onClick={async () => refetch()}
- className="text-foreground/70 hover:text-muted-foreground mt-2 text-sm"
- >
- <Trans>Click here to retry</Trans>
- </button>
- </div>
- )}
-
- {data && (
- <ul
- className={cn('divide-y border-t', {
- 'mb-4 border-b': !hasNextPage,
- })}
- >
- {documentAuditLogs.map((auditLog) => (
- <li className="px-4 py-2.5" key={auditLog.id}>
- <div className="flex flex-row items-center">
- <Avatar className="mr-2 h-9 w-9">
- <AvatarFallback className="text-xs text-gray-400">
- {(auditLog?.email ?? auditLog?.name ?? '?').slice(0, 1).toUpperCase()}
- </AvatarFallback>
- </Avatar>
-
- <div>
- <p className="text-foreground text-xs font-bold">
- {formatDocumentAuditLogAction(_, auditLog, userId).description}
- </p>
- <p className="text-foreground/50 text-xs">
- {DateTime.fromJSDate(auditLog.createdAt)
- .setLocale(i18n.locales?.[0] || i18n.locale)
- .toFormat('d MMM, yyyy HH:MM a')}
- </p>
- </div>
- </div>
-
- {match(auditLog)
- .with(
- { type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_CREATED },
- { type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_COMPLETED },
- { type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_DELETED },
- { type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_OPENED },
- { type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RECIPIENT_COMPLETED },
- { type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RECIPIENT_REJECTED },
- { type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_SENT },
- { type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_MOVED_TO_TEAM },
- () => null,
- )
- .with(
- { type: DOCUMENT_AUDIT_LOG_TYPE.RECIPIENT_CREATED },
- { type: DOCUMENT_AUDIT_LOG_TYPE.RECIPIENT_DELETED },
- ({ data }) => {
- const values = [
- {
- key: 'Email',
- value: data.recipientEmail,
- },
- {
- key: 'Role',
- value: formatGenericText(data.recipientRole),
- },
- ];
-
- // Insert the name to the start of the array if available.
- if (data.recipientName) {
- values.unshift({
- key: 'Name',
- value: data.recipientName,
- });
- }
-
- return <DocumentHistorySheetChanges values={values} />;
- },
- )
- .with({ type: DOCUMENT_AUDIT_LOG_TYPE.RECIPIENT_UPDATED }, ({ data }) => {
- if (data.changes.length === 0) {
- return null;
- }
-
- return (
- <DocumentHistorySheetChanges
- values={data.changes.map(({ type, from, to }) => ({
- key: formatGenericText(type),
- value: (
- <span className="inline-flex flex-row items-center">
- <span>{type === 'ROLE' ? formatGenericText(from) : from}</span>
- <ArrowRightIcon className="h-4 w-4" />
- <span>{type === 'ROLE' ? formatGenericText(to) : to}</span>
- </span>
- ),
- }))}
- />
- );
- })
- .with(
- { type: DOCUMENT_AUDIT_LOG_TYPE.FIELD_CREATED },
- { type: DOCUMENT_AUDIT_LOG_TYPE.FIELD_DELETED },
- { type: DOCUMENT_AUDIT_LOG_TYPE.FIELD_UPDATED },
- ({ data }) => (
- <DocumentHistorySheetChanges
- values={[
- {
- key: 'Field',
- value: formatGenericText(data.fieldType),
- },
- {
- key: 'Recipient',
- value: formatGenericText(data.fieldRecipientEmail),
- },
- ]}
- />
- ),
- )
- .with(
- { type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_GLOBAL_AUTH_ACCESS_UPDATED },
- { type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_GLOBAL_AUTH_ACTION_UPDATED },
- ({ data }) => (
- <DocumentHistorySheetChanges
- values={[
- {
- key: 'Old',
- value: Array.isArray(data.from)
- ? data.from
- .map((f) => DOCUMENT_AUTH_TYPES[f]?.value || 'None')
- .join(', ')
- : DOCUMENT_AUTH_TYPES[data.from || '']?.value || 'None',
- },
- {
- key: 'New',
- value: Array.isArray(data.to)
- ? data.to
- .map((f) => DOCUMENT_AUTH_TYPES[f]?.value || 'None')
- .join(', ')
- : DOCUMENT_AUTH_TYPES[data.to || '']?.value || 'None',
- },
- ]}
- />
- ),
- )
- .with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_META_UPDATED }, ({ data }) => {
- if (data.changes.length === 0) {
- return null;
- }
-
- return (
- <DocumentHistorySheetChanges
- values={data.changes.map((change) => ({
- key: formatGenericText(change.type),
- value: change.type === 'PASSWORD' ? '*********' : change.to,
- }))}
- />
- );
- })
- .with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_TITLE_UPDATED }, ({ data }) => (
- <DocumentHistorySheetChanges
- values={[
- {
- key: 'Old',
- value: data.from,
- },
- {
- key: 'New',
- value: data.to,
- },
- ]}
- />
- ))
- .with(
- { type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_EXTERNAL_ID_UPDATED },
- ({ data }) => (
- <DocumentHistorySheetChanges
- values={[
- {
- key: 'Old',
- value: data.from,
- },
- {
- key: 'New',
- value: data.to,
- },
- ]}
- />
- ),
- )
- .with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_FIELD_INSERTED }, ({ data }) => (
- <DocumentHistorySheetChanges
- values={[
- {
- key: 'Field inserted',
- value: formatGenericText(data.field.type),
- },
- ]}
- />
- ))
- .with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_FIELD_UNINSERTED }, ({ data }) => (
- <DocumentHistorySheetChanges
- values={[
- {
- key: 'Field uninserted',
- value: formatGenericText(data.field),
- },
- ]}
- />
- ))
- .with({ type: DOCUMENT_AUDIT_LOG_TYPE.EMAIL_SENT }, ({ data }) => (
- <DocumentHistorySheetChanges
- values={[
- {
- key: 'Type',
- value: DOCUMENT_AUDIT_LOG_EMAIL_FORMAT[data.emailType].description,
- },
- {
- key: 'Sent to',
- value: data.recipientEmail,
- },
- ]}
- />
- ))
- .with(
- { type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_VISIBILITY_UPDATED },
- ({ data }) => (
- <DocumentHistorySheetChanges
- values={[
- {
- key: 'Old',
- value: data.from,
- },
- {
- key: 'New',
- value: data.to,
- },
- ]}
- />
- ),
- )
- .with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_FIELD_PREFILLED }, ({ data }) => (
- <DocumentHistorySheetChanges
- values={[
- {
- key: 'Field prefilled',
- value: formatGenericText(data.field.type),
- },
- ]}
- />
- ))
- .exhaustive()}
-
- {isUserDetailsVisible && (
- <>
- <div className="mb-1 mt-2 flex flex-row space-x-2">
- <Badge variant="neutral" className="text-muted-foreground">
- IP: {auditLog.ipAddress ?? 'Unknown'}
- </Badge>
-
- <Badge variant="neutral" className="text-muted-foreground">
- Browser: {extractBrowser(auditLog.userAgent)}
- </Badge>
- </div>
- </>
- )}
- </li>
- ))}
-
- {hasNextPage && (
- <div className="flex items-center justify-center py-4">
- <Button
- variant="outline"
- loading={isFetchingNextPage}
- onClick={async () => fetchNextPage()}
- >
- Show more
- </Button>
- </div>
- )}
- </ul>
- )}
- </SheetContent>
- </Sheet>
- );
-};
diff --git a/apps/remix/app/routes/_authenticated+/t.$teamUrl+/documents.$id._index.tsx b/apps/remix/app/routes/_authenticated+/t.$teamUrl+/documents.$id._index.tsx
index 6513bddc0..99c2bd243 100644
--- a/apps/remix/app/routes/_authenticated+/t.$teamUrl+/documents.$id._index.tsx
+++ b/apps/remix/app/routes/_authenticated+/t.$teamUrl+/documents.$id._index.tsx
@@ -1,7 +1,7 @@
import { useLingui } from '@lingui/react';
import { Plural, Trans } from '@lingui/react/macro';
import { DocumentStatus, TeamMemberRole } from '@prisma/client';
-import { ChevronLeft, Clock9, Users2 } from 'lucide-react';
+import { ChevronLeft, Users2 } from 'lucide-react';
import { Link, redirect } from 'react-router';
import { match } from 'ts-pattern';
@@ -13,11 +13,9 @@ import { DocumentVisibility } from '@documenso/lib/types/document-visibility';
import { formatDocumentsPath } from '@documenso/lib/utils/teams';
import { DocumentReadOnlyFields } from '@documenso/ui/components/document/document-read-only-fields';
import { Badge } from '@documenso/ui/primitives/badge';
-import { Button } from '@documenso/ui/primitives/button';
import { Card, CardContent } from '@documenso/ui/primitives/card';
import { PDFViewer } from '@documenso/ui/primitives/pdf-viewer';
-import { DocumentHistorySheet } from '~/components/general/document/document-history-sheet';
import { DocumentPageViewButton } from '~/components/general/document/document-page-view-button';
import { DocumentPageViewDropdown } from '~/components/general/document/document-page-view-dropdown';
import { DocumentPageViewInformation } from '~/components/general/document/document-page-view-information';
@@ -101,9 +99,6 @@ export default function DocumentPage() {
const { recipients, documentData, documentMeta } = document;
- // This was a feature flag. Leave to false since it's not ready.
- const isDocumentHistoryEnabled = false;
-
return (
<div className="mx-auto -mt-4 w-full max-w-screen-xl px-4 md:px-8">
{document.status === DocumentStatus.PENDING && (
@@ -154,17 +149,6 @@ export default function DocumentPage() {
)}
</div>
</div>
-
- {isDocumentHistoryEnabled && (
- <div className="self-end">
- <DocumentHistorySheet documentId={document.id} userId={user.id}>
- <Button variant="outline">
- <Clock9 className="mr-1.5 h-4 w-4" />
- <Trans>Document history</Trans>
- </Button>
- </DocumentHistorySheet>
- </div>
- )}
</div>
<div className="mt-6 grid w-full grid-cols-12 gap-8">
diff --git a/packages/lib/server-only/document/viewed-document.ts b/packages/lib/server-only/document/viewed-document.ts
index fbc0aaa2d..a9faf992a 100644
--- a/packages/lib/server-only/document/viewed-document.ts
+++ b/packages/lib/server-only/document/viewed-document.ts
@@ -27,7 +27,6 @@ export const viewedDocument = async ({
const recipient = await prisma.recipient.findFirst({
where: {
token,
- readStatus: ReadStatus.NOT_OPENED,
},
});
@@ -37,6 +36,30 @@ export const viewedDocument = async ({
const { documentId } = recipient;
+ await prisma.documentAuditLog.create({
+ data: createDocumentAuditLogData({
+ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_VIEWED,
+ documentId,
+ user: {
+ name: recipient.name,
+ email: recipient.email,
+ },
+ requestMetadata,
+ data: {
+ recipientEmail: recipient.email,
+ recipientId: recipient.id,
+ recipientName: recipient.name,
+ recipientRole: recipient.role,
+ accessAuth: recipientAccessAuth ?? [],
+ },
+ }),
+ });
+
+ // Early return if already opened.
+ if (recipient.readStatus === ReadStatus.OPENED) {
+ return;
+ }
+
await prisma.$transaction(async (tx) => {
await tx.recipient.update({
where: {
diff --git a/packages/lib/types/document-audit-logs.ts b/packages/lib/types/document-audit-logs.ts
index 25679287a..5c3f5bd86 100644
--- a/packages/lib/types/document-audit-logs.ts
+++ b/packages/lib/types/document-audit-logs.ts
@@ -33,6 +33,7 @@ export const ZDocumentAuditLogTypeSchema = z.enum([
'DOCUMENT_GLOBAL_AUTH_ACTION_UPDATED', // When the global action authentication is updated.
'DOCUMENT_META_UPDATED', // When the document meta data is updated.
'DOCUMENT_OPENED', // When the document is opened by a recipient.
+ 'DOCUMENT_VIEWED', // When the document is viewed by a recipient.
'DOCUMENT_RECIPIENT_REJECTED', // When a recipient rejects the document.
'DOCUMENT_RECIPIENT_COMPLETED', // When a recipient completes all their required tasks for the document.
'DOCUMENT_SENT', // When the document transitions from DRAFT to PENDING.
@@ -438,6 +439,22 @@ export const ZDocumentAuditLogEventDocumentOpenedSchema = z.object({
}),
});
+/**
+ * Event: Document viewed.
+ */
+export const ZDocumentAuditLogEventDocumentViewedSchema = z.object({
+ type: z.literal(DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_VIEWED),
+ data: ZBaseRecipientDataSchema.extend({
+ accessAuth: z.preprocess((unknownValue) => {
+ if (!unknownValue) {
+ return [];
+ }
+
+ return Array.isArray(unknownValue) ? unknownValue : [unknownValue];
+ }, z.array(ZRecipientAccessAuthTypesSchema)),
+ }),
+});
+
/**
* Event: Document recipient completed the document (the recipient has fully actioned and completed their required steps for the document).
*/
@@ -601,6 +618,7 @@ export const ZDocumentAuditLogSchema = ZDocumentAuditLogBaseSchema.and(
ZDocumentAuditLogEventDocumentGlobalAuthActionUpdatedSchema,
ZDocumentAuditLogEventDocumentMetaUpdatedSchema,
ZDocumentAuditLogEventDocumentOpenedSchema,
+ ZDocumentAuditLogEventDocumentViewedSchema,
ZDocumentAuditLogEventDocumentRecipientCompleteSchema,
ZDocumentAuditLogEventDocumentRecipientRejectedSchema,
ZDocumentAuditLogEventDocumentSentSchema,
diff --git a/packages/lib/utils/document-audit-logs.ts b/packages/lib/utils/document-audit-logs.ts
index 287d4a823..58797510f 100644
--- a/packages/lib/utils/document-audit-logs.ts
+++ b/packages/lib/utils/document-audit-logs.ts
@@ -338,6 +338,10 @@ export const formatDocumentAuditLogAction = (
anonymous: msg`Document opened`,
identified: msg`${prefix} opened the document`,
}))
+ .with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_VIEWED }, () => ({
+ anonymous: msg`Document viewed`,
+ identified: msg`${prefix} viewed the document`,
+ }))
.with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_TITLE_UPDATED }, () => ({
anonymous: msg`Document title updated`,
identified: msg`${prefix} updated the document title`,