Skip to content

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

feat: improve error handling and status report

Marc Seitz35f8f1f24737
diff --git a/components/documents/process-status-bar.tsx b/components/documents/process-status-bar.tsx
index 85791c64..26d8bffb 100644
--- a/components/documents/process-status-bar.tsx
+++ b/components/documents/process-status-bar.tsx
@@ -3,6 +3,7 @@ import ErrorPage from "next/error";
import { useDocumentProcessingStatus } from "@/lib/swr/use-document";
import { useEffect, useState } from "react";
import { cn } from "@/lib/utils";
+import { useEventRunStatuses } from "@trigger.dev/react";
export default function ProcessStatusBar({
documentVersionId,
@@ -11,40 +12,64 @@ export default function ProcessStatusBar({
documentVersionId: string;
className?: string;
}) {
- const { status, loading, error } =
- useDocumentProcessingStatus(documentVersionId);
-
- const [progress, setProgress] = useState<number>(0);
- const [text, setText] = useState<string>("");
-
- useEffect(() => {
- if (status) {
- const progress = (status.currentPageCount / status.totalPages) * 100;
- setProgress(progress);
- if (progress === 100) {
- setText("Processing complete");
- } else {
- setText(
- `${status.currentPageCount} / ${status.totalPages} pages processed`,
- );
- }
- }
- }, [status]);
-
- if (error && error.status === 404) {
- return <ErrorPage statusCode={404} />;
- }
+ const { fetchStatus, error, statuses, run } =
+ useEventRunStatuses(documentVersionId);
+
+ // const { status, loading, error: DocError } =
+ // useDocumentProcessingStatus(documentVersionId);
+
+ // const [progress, setProgress] = useState<number>(0);
+ // const [text, setText] = useState<string>("");
- if (loading) {
+ // useEffect(() => {
+ // if (status) {
+ // const progress = (status.currentPageCount / status.totalPages) * 100;
+ // setProgress(progress);
+ // if (progress === 100) {
+ // setText("Processing complete");
+ // } else {
+ // setText(
+ // `${status.currentPageCount} / ${status.totalPages} pages processed`,
+ // );
+ // }
+ // }
+ // }, [status]);
+
+ // if (error && error.status === 404) {
+ // return <ErrorPage statusCode={404} />;
+ // }
+
+ if (fetchStatus === "loading") {
return (
<Progress value={0} className={cn("w-full rounded-none", className)} />
);
}
- if (status && status.hasPages) {
+ if (fetchStatus === "error") {
+ return (
+ <Progress
+ value={0}
+ text={error.message}
+ className={cn("w-full rounded-none", className)}
+ />
+ );
+ }
+
+ if (run.status === "SUCCESS") {
return null;
}
+ console.log("statuses", statuses);
+
+ console.log(
+ "status",
+ statuses[0].key,
+ statuses[0].data?.progress,
+ statuses[0].data?.text,
+ );
+ const progress = Number(statuses[0].data?.progress) * 100 || 0;
+ const text = String(statuses[0].data?.text) || "";
+
return (
<Progress
value={progress}
diff --git a/components/providers/trigger-provider.tsx b/components/providers/trigger-provider.tsx
new file mode 100644
index 00000000..c5fa802a
--- /dev/null
+++ b/components/providers/trigger-provider.tsx
@@ -0,0 +1,19 @@
+import { TriggerProvider } from "@trigger.dev/react";
+
+export const TriggerCustomProvider = ({
+ children,
+}: {
+ children: React.ReactNode;
+}) => {
+ if (!process.env.NEXT_PUBLIC_TRIGGER_PUBLIC_API_KEY) {
+ return <>{children}</>;
+ }
+
+ return (
+ <TriggerProvider
+ publicApiKey={process.env.NEXT_PUBLIC_TRIGGER_PUBLIC_API_KEY}
+ >
+ {children}
+ </TriggerProvider>
+ );
+};
diff --git a/jobs/convert-pdf-to-image.ts b/jobs/convert-pdf-to-image.ts
index 741f7708..b6d76e4f 100644
--- a/jobs/convert-pdf-to-image.ts
+++ b/jobs/convert-pdf-to-image.ts
@@ -3,7 +3,6 @@ import { eventTrigger, retry } from "@trigger.dev/sdk";
import { z } from "zod";
import prisma from "@/lib/prisma";
import { getFile } from "@/lib/files/get-file";
-import { error } from "console";
client.defineJob({
id: "convert-pdf-to-image",
@@ -21,6 +20,24 @@ client.defineJob({
run: async (payload, io, ctx) => {
const { documentVersionId } = payload;
+ // STATUS: initialized status
+ const processingDocumentStatus = await io.createStatus(
+ "processing-document",
+ {
+ //the label is compulsory on this first call
+ label: "Processing document",
+ //state is optional
+ state: "loading",
+ //data is an optional object. the values can be any type that is JSON serializable
+ data: {
+ text: "Processing document...",
+ progress: 0,
+ currentPage: 0,
+ numPages: undefined,
+ },
+ },
+ );
+
// 1. get file url from document version
const documentUrl = await io.runTask("get-document-url", async () => {
return prisma.documentVersion.findUnique({
@@ -38,6 +55,16 @@ client.defineJob({
// if documentUrl is null, log error and return
if (!documentUrl) {
await io.logger.error("File not found", { payload });
+ await processingDocumentStatus.update("error", {
+ //set data, this overrides the previous value
+ state: "failure",
+ data: {
+ text: "Document not found",
+ progress: 0,
+ currentPage: 0,
+ numPages: 0,
+ },
+ });
return;
}
@@ -51,6 +78,16 @@ client.defineJob({
if (!signedUrl) {
await io.logger.error("Failed to get signed url", { payload });
+ await processingDocumentStatus.update("error-signed-url", {
+ //set data, this overrides the previous value
+ state: "failure",
+ data: {
+ text: "Failed to retrieve document",
+ progress: 0,
+ currentPage: 0,
+ numPages: 0,
+ },
+ });
return;
}
@@ -88,10 +125,12 @@ client.defineJob({
let currentPage = 0;
let conversionWithoutError = true;
for (var i = 0; i < numPages; ++i) {
- currentPage = i + 1;
if (!conversionWithoutError) {
break;
}
+
+ // increment currentPage
+ currentPage = i + 1;
await io.runTask(
`upload-page-${currentPage}`,
async () => {
@@ -114,8 +153,20 @@ client.defineJob({
);
if (!response.ok) {
- await io.logger.error("Failed to upload page", { payload });
- return;
+ await processingDocumentStatus.update(
+ `error-processing-page-${currentPage}`,
+ {
+ //set data, this overrides the previous value
+ state: "failure",
+ data: {
+ text: `Error processing page ${currentPage} of ${numPages}`,
+ progress: currentPage / numPages,
+ currentPage: currentPage,
+ numPages: numPages,
+ },
+ },
+ );
+ throw new Error("Failed to convert page");
}
const { documentPageId } = (await response.json()) as {
@@ -137,11 +188,33 @@ client.defineJob({
return { error: error as Error };
},
);
+
+ // STATUS: retrieved-url
+ await processingDocumentStatus.update(`processing-page-${currentPage}`, {
+ //set data, this overrides the previous value
+ data: {
+ text: `${currentPage} / ${numPages} pages processed`,
+ progress: currentPage / numPages,
+ currentPage: currentPage,
+ numPages: numPages,
+ },
+ });
}
if (!conversionWithoutError) {
await io.logger.error("Failed to process pages", { payload });
- return { success: false, message: "Failed to process pages" };
+ // STATUS: error with processing document
+ await processingDocumentStatus.update("error-processing-pages", {
+ //set data, this overrides the previous value
+ state: "failure",
+ data: {
+ text: `Error processing page ${currentPage} of ${numPages}`,
+ progress: currentPage / numPages,
+ currentPage: currentPage,
+ numPages: numPages,
+ },
+ });
+ return;
}
// 5. after all pages are uploaded, update document version to hasPages = true
@@ -162,6 +235,16 @@ client.defineJob({
});
});
+ // STATUS: enabled-pages
+ await processingDocumentStatus.update("enabled-pages", {
+ //set data, this overrides the previous value
+ state: "loading",
+ data: {
+ text: "Enabling pages...",
+ progress: 1,
+ },
+ });
+
if (payload.versionNumber) {
const { versionNumber, documentId } = payload;
// after all pages are uploaded, update all other versions to be not primary
@@ -186,6 +269,14 @@ client.defineJob({
});
}
+ // STATUS: success
+ await processingDocumentStatus.update("success", {
+ state: "success",
+ data: {
+ text: "Processing complete",
+ },
+ });
+
return {
success: true,
message: "Successfully converted PDF to images",
diff --git a/next.config.js b/next.config.js
index 1ae99e19..9753e1c0 100644
--- a/next.config.js
+++ b/next.config.js
@@ -62,6 +62,7 @@ const nextConfig = {
},
],
},
+ transpilePackages: ["@trigger.dev/react"],
async rewrites() {
return [
{
diff --git a/pages/_app.tsx b/pages/_app.tsx
index 8cfc4d58..7f898e8d 100644
--- a/pages/_app.tsx
+++ b/pages/_app.tsx
@@ -12,6 +12,7 @@ import { TeamProvider } from "@/context/team-context";
import { TooltipProvider } from "@/components/ui/tooltip";
import { PostHogCustomProvider } from "@/components/providers/posthog-provider";
import { EXCLUDED_PATHS } from "@/lib/constants";
+import { TriggerCustomProvider } from "@/components/providers/trigger-provider";
const inter = Inter({ subsets: ["latin"] });
@@ -76,7 +77,9 @@ export default function App({
<Component {...pageProps} />
) : (
<TeamProvider>
- <Component {...pageProps} />
+ <TriggerCustomProvider>
+ <Component {...pageProps} />
+ </TriggerCustomProvider>
</TeamProvider>
)}
</TooltipProvider>
diff --git a/pages/api/teams/[teamId]/documents/index.ts b/pages/api/teams/[teamId]/documents/index.ts
index c14b3022..10ecbb6b 100644
--- a/pages/api/teams/[teamId]/documents/index.ts
+++ b/pages/api/teams/[teamId]/documents/index.ts
@@ -135,6 +135,7 @@ export default async function handle(
if (type !== "notion") {
// trigger document uploaded event to trigger convert-pdf-to-image job
await client.sendEvent({
+ id: document.versions[0].id, // unique eventId for the run
name: "document.uploaded",
payload: {
documentVersionId: document.versions[0].id,