base

plane-src/apps/live/src/utils/broadcast-error.ts

@@ -0,0 +1,44 @@
+/**
+ * Copyright (c) 2023-present Plane Software, Inc. and contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * See the LICENSE file for details.
+ */
+
+import type { Hocuspocus } from "@hocuspocus/server";
+import { createRealtimeEvent } from "@plane/editor";
+import { logger } from "@plane/logger";
+import type { HocusPocusServerContext } from "@/types";
+import { broadcastMessageToPage } from "./broadcast-message";
+
+// Helper to broadcast error to frontend
+export const broadcastError = async (
+  hocuspocusServerInstance: Hocuspocus,
+  pageId: string,
+  errorMessage: string,
+  errorType: "fetch" | "store",
+  context: HocusPocusServerContext,
+  errorCode?: "content_too_large" | "page_locked" | "page_archived",
+  shouldDisconnect?: boolean
+) => {
+  try {
+    const errorEvent = createRealtimeEvent({
+      action: "error",
+      page_id: pageId,
+      parent_id: undefined,
+      descendants_ids: [],
+      data: {
+        error_message: errorMessage,
+        error_type: errorType,
+        error_code: errorCode,
+        should_disconnect: shouldDisconnect,
+        user_id: context.userId || "",
+      },
+      workspace_slug: context.workspaceSlug || "",
+      user_id: context.userId || "",
+    });
+
+    await broadcastMessageToPage(hocuspocusServerInstance, pageId, errorEvent);
+  } catch (broadcastError) {
+    logger.error("Error broadcasting error message to frontend:", broadcastError);
+  }
+};

plane-src/apps/live/src/utils/broadcast-message.ts

@@ -0,0 +1,40 @@
+/**
+ * Copyright (c) 2023-present Plane Software, Inc. and contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * See the LICENSE file for details.
+ */
+
+import type { Hocuspocus } from "@hocuspocus/server";
+import type { BroadcastedEvent } from "@plane/editor";
+import { logger } from "@plane/logger";
+import { Redis } from "@/extensions/redis";
+import { AppError } from "@/lib/errors";
+
+export const broadcastMessageToPage = async (
+  hocuspocusServerInstance: Hocuspocus,
+  documentName: string,
+  eventData: BroadcastedEvent
+): Promise<boolean> => {
+  if (!hocuspocusServerInstance || !hocuspocusServerInstance.documents) {
+    const appError = new AppError("HocusPocus server not available or initialized", {
+      context: { operation: "broadcastMessageToPage", documentName },
+    });
+    logger.error("Error while broadcasting message:", appError);
+    return false;
+  }
+
+  const redisExtension = hocuspocusServerInstance.configuration.extensions.find((ext) => ext instanceof Redis);
+
+  if (!redisExtension) {
+    logger.error("BROADCAST_MESSAGE_TO_PAGE: Redis extension not found");
+    return false;
+  }
+
+  try {
+    await redisExtension.broadcastToDocument(documentName, eventData);
+    return true;
+  } catch (error) {
+    logger.error(`BROADCAST_MESSAGE_TO_PAGE: Error broadcasting to ${documentName}:`, error);
+    return false;
+  }
+};