fix: error handling editor

This commit is contained in:
Palanikannan1437 2024-04-24 13:39:14 +05:30
parent a4e5138d1c
commit 69034187be
6 changed files with 81 additions and 27 deletions

View File

@ -56,6 +56,8 @@ export const useEditor = ({
mentionHandler, mentionHandler,
placeholder, placeholder,
}: CustomEditorProps) => { }: CustomEditorProps) => {
const [error, setError] = useState<string | null>(null);
const editor = useCustomEditor({ const editor = useCustomEditor({
editorProps: { editorProps: {
...CoreEditorProps(editorClassName), ...CoreEditorProps(editorClassName),
@ -86,6 +88,10 @@ export const useEditor = ({
setSavedSelection(editor.state.selection); setSavedSelection(editor.state.selection);
}, },
onUpdate: async ({ editor }) => { onUpdate: async ({ editor }) => {
const shouldError = Math.random() < 0.05; // 10% chance to generate an error
if (shouldError) {
setError("Randomly generated error for testing purposes.");
}
onChange?.(editor.getJSON(), getTrimmedHTML(editor.getHTML())); onChange?.(editor.getJSON(), getTrimmedHTML(editor.getHTML()));
}, },
onDestroy: async () => { onDestroy: async () => {
@ -203,6 +209,11 @@ export const useEditor = ({
[editorRef, savedSelection, uploadFile] [editorRef, savedSelection, uploadFile]
); );
if (error) {
console.log("threw error from core");
throw new Error(error);
}
if (!editor) { if (!editor) {
return null; return null;
} }

View File

@ -49,7 +49,6 @@ const RichTextEditor = (props: IRichTextEditor) => {
containerClassName, containerClassName,
editorClassName = "", editorClassName = "",
forwardedRef, forwardedRef,
// rerenderOnPropsChange,
id = "", id = "",
placeholder, placeholder,
tabIndex, tabIndex,
@ -58,8 +57,6 @@ const RichTextEditor = (props: IRichTextEditor) => {
const [hideDragHandleOnMouseLeave, setHideDragHandleOnMouseLeave] = React.useState<() => void>(() => {}); const [hideDragHandleOnMouseLeave, setHideDragHandleOnMouseLeave] = React.useState<() => void>(() => {});
// this essentially sets the hideDragHandle function from the DragAndDrop extension as the Plugin
// loads such that we can invoke it from react when the cursor leaves the container
const setHideDragHandleFunction = (hideDragHandlerFromDragDrop: () => void) => { const setHideDragHandleFunction = (hideDragHandlerFromDragDrop: () => void) => {
setHideDragHandleOnMouseLeave(() => hideDragHandlerFromDragDrop); setHideDragHandleOnMouseLeave(() => hideDragHandlerFromDragDrop);
}; };
@ -75,7 +72,6 @@ const RichTextEditor = (props: IRichTextEditor) => {
initialValue, initialValue,
value, value,
forwardedRef, forwardedRef,
// rerenderOnPropsChange,
extensions: RichTextEditorExtensions({ extensions: RichTextEditorExtensions({
uploadFile: fileHandler.upload, uploadFile: fileHandler.upload,
dragDropEnabled, dragDropEnabled,

View File

@ -1,4 +1,4 @@
import React, { forwardRef } from "react"; import { forwardRef } from "react";
// editor // editor
import { EditorRefApi, IRichTextEditor, RichTextEditorWithRef } from "@plane/rich-text-editor"; import { EditorRefApi, IRichTextEditor, RichTextEditorWithRef } from "@plane/rich-text-editor";
// types // types
@ -9,6 +9,7 @@ import { cn } from "@/helpers/common.helper";
import { useMember, useMention, useUser } from "@/hooks/store"; import { useMember, useMention, useUser } from "@/hooks/store";
// services // services
import { FileService } from "@/services/file.service"; import { FileService } from "@/services/file.service";
import ErrorBoundaryWithFallback from "./rich-text-fallback";
interface RichTextEditorWrapperProps extends Omit<IRichTextEditor, "fileHandler" | "mentionHandler"> { interface RichTextEditorWrapperProps extends Omit<IRichTextEditor, "fileHandler" | "mentionHandler"> {
workspaceSlug: string; workspaceSlug: string;
@ -20,6 +21,7 @@ const fileService = new FileService();
export const RichTextEditor = forwardRef<EditorRefApi, RichTextEditorWrapperProps>((props, ref) => { export const RichTextEditor = forwardRef<EditorRefApi, RichTextEditorWrapperProps>((props, ref) => {
const { containerClassName, workspaceSlug, workspaceId, projectId, ...rest } = props; const { containerClassName, workspaceSlug, workspaceId, projectId, ...rest } = props;
console.log("eeeeeeee", rest.value);
// store hooks // store hooks
const { currentUser } = useUser(); const { currentUser } = useUser();
const { const {
@ -38,21 +40,23 @@ export const RichTextEditor = forwardRef<EditorRefApi, RichTextEditorWrapperProp
}); });
return ( return (
<RichTextEditorWithRef <ErrorBoundaryWithFallback>
ref={ref} <RichTextEditorWithRef
fileHandler={{ ref={ref}
upload: fileService.getUploadFileFunction(workspaceSlug), fileHandler={{
delete: fileService.getDeleteImageFunction(workspaceId), upload: fileService.getUploadFileFunction(workspaceSlug),
restore: fileService.getRestoreImageFunction(workspaceId), delete: fileService.getDeleteImageFunction(workspaceId),
cancel: fileService.cancelUpload, restore: fileService.getRestoreImageFunction(workspaceId),
}} cancel: fileService.cancelUpload,
mentionHandler={{ }}
highlights: mentionHighlights, mentionHandler={{
suggestions: mentionSuggestions, highlights: mentionHighlights,
}} suggestions: mentionSuggestions,
{...rest} }}
containerClassName={cn(containerClassName, "relative min-h-[150px] border border-custom-border-200 p-3")} {...rest}
/> containerClassName={cn(containerClassName, "relative min-h-[150px] border border-custom-border-200 p-3")}
/>
</ErrorBoundaryWithFallback>
); );
}); });

View File

@ -0,0 +1,41 @@
import React, { useEffect } from "react";
import { ErrorBoundary } from "react-error-boundary";
interface FallbackProps {
error: Error;
resetErrorBoundary: () => void;
}
const Fallback: React.FC<FallbackProps> = ({ error, resetErrorBoundary }) => {
useEffect(() => {
const timer = setTimeout(() => {
resetErrorBoundary();
}, 1000);
return () => clearTimeout(timer);
}, [resetErrorBoundary]);
return (
<div role="alert">
<p>Something went wrong:</p>
<pre style={{ color: "red" }}>{error.message}</pre>
</div>
);
};
interface ErrorBoundaryWithFallbackProps {
children: React.ReactNode;
}
const ErrorBoundaryWithFallback: React.FC<ErrorBoundaryWithFallbackProps> = ({ children }) => {
return (
<ErrorBoundary
FallbackComponent={Fallback}
onError={(error, errorInfo) => console.log("Error occurred:", error, errorInfo)}
>
{children}
</ErrorBoundary>
);
};
export default ErrorBoundaryWithFallback;

View File

@ -54,13 +54,13 @@
"react-day-picker": "^8.10.0", "react-day-picker": "^8.10.0",
"react-dom": "18.2.0", "react-dom": "18.2.0",
"react-dropzone": "^14.2.3", "react-dropzone": "^14.2.3",
"react-error-boundary": "^4.0.13",
"react-hook-form": "^7.38.0", "react-hook-form": "^7.38.0",
"react-markdown": "^8.0.7", "react-markdown": "^8.0.7",
"react-popper": "^2.3.0", "react-popper": "^2.3.0",
"sharp": "^0.32.1", "sharp": "^0.32.1",
"swr": "^2.1.3", "swr": "^2.1.3",
"tailwind-merge": "^2.0.0", "tailwind-merge": "^2.0.0",
"use-debounce": "^9.0.4",
"uuid": "^9.0.0" "uuid": "^9.0.0"
}, },
"devDependencies": { "devDependencies": {

View File

@ -2755,7 +2755,7 @@
dependencies: dependencies:
"@types/react" "*" "@types/react" "*"
"@types/react@*", "@types/react@18.2.42", "@types/react@^18.2.42": "@types/react@*", "@types/react@^18.2.42":
version "18.2.42" version "18.2.42"
resolved "https://registry.yarnpkg.com/@types/react/-/react-18.2.42.tgz#6f6b11a904f6d96dda3c2920328a97011a00aba7" resolved "https://registry.yarnpkg.com/@types/react/-/react-18.2.42.tgz#6f6b11a904f6d96dda3c2920328a97011a00aba7"
integrity sha512-c1zEr96MjakLYus/wPnuWDo1/zErfdU9rNsIGmE+NV71nx88FG9Ttgo5dqorXTu/LImX2f63WBP986gJkMPNbA== integrity sha512-c1zEr96MjakLYus/wPnuWDo1/zErfdU9rNsIGmE+NV71nx88FG9Ttgo5dqorXTu/LImX2f63WBP986gJkMPNbA==
@ -7194,6 +7194,13 @@ react-dropzone@^14.2.3:
file-selector "^0.6.0" file-selector "^0.6.0"
prop-types "^15.8.1" prop-types "^15.8.1"
react-error-boundary@^4.0.13:
version "4.0.13"
resolved "https://registry.yarnpkg.com/react-error-boundary/-/react-error-boundary-4.0.13.tgz#80386b7b27b1131c5fbb7368b8c0d983354c7947"
integrity sha512-b6PwbdSv8XeOSYvjt8LpgpKrZ0yGdtZokYwkwV2wlcZbxgopHX/hgPl5VgpnoVOWd868n1hktM8Qm4b+02MiLQ==
dependencies:
"@babel/runtime" "^7.12.5"
react-fast-compare@^3.0.1: react-fast-compare@^3.0.1:
version "3.2.2" version "3.2.2"
resolved "https://registry.yarnpkg.com/react-fast-compare/-/react-fast-compare-3.2.2.tgz#929a97a532304ce9fee4bcae44234f1ce2c21d49" resolved "https://registry.yarnpkg.com/react-fast-compare/-/react-fast-compare-3.2.2.tgz#929a97a532304ce9fee4bcae44234f1ce2c21d49"
@ -8628,11 +8635,6 @@ use-callback-ref@^1.3.0:
dependencies: dependencies:
tslib "^2.0.0" tslib "^2.0.0"
use-debounce@^9.0.4:
version "9.0.4"
resolved "https://registry.yarnpkg.com/use-debounce/-/use-debounce-9.0.4.tgz#51d25d856fbdfeb537553972ce3943b897f1ac85"
integrity sha512-6X8H/mikbrt0XE8e+JXRtZ8yYVvKkdYRfmIhWZYsP8rcNs9hk3APV8Ua2mFkKRLcJKVdnX2/Vwrmg2GWKUQEaQ==
use-memo-one@^1.1.3: use-memo-one@^1.1.3:
version "1.1.3" version "1.1.3"
resolved "https://registry.yarnpkg.com/use-memo-one/-/use-memo-one-1.1.3.tgz#2fd2e43a2169eabc7496960ace8c79efef975e99" resolved "https://registry.yarnpkg.com/use-memo-one/-/use-memo-one-1.1.3.tgz#2fd2e43a2169eabc7496960ace8c79efef975e99"