Load RTE component only when needed (#9804)

Use react lazy to load rte component
This commit is contained in:
Florian Duros 2022-12-20 15:59:18 +01:00 committed by GitHub
parent 26a01aba00
commit d6e447b934
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 92 additions and 28 deletions

View file

@ -0,0 +1,36 @@
/*
Copyright 2022 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import React, { ComponentProps, lazy, Suspense } from "react";
const SendComposer = lazy(() => import("./SendWysiwygComposer"));
const EditComposer = lazy(() => import("./EditWysiwygComposer"));
export function DynamicImportSendWysiwygComposer(props: ComponentProps<typeof SendComposer>) {
return (
<Suspense fallback={<div />}>
<SendComposer {...props} />
</Suspense>
);
}
export function DynamicImportEditWysiwygComposer(props: ComponentProps<typeof EditComposer>) {
return (
<Suspense fallback={<div />}>
<EditComposer {...props} />
</Suspense>
);
}

View file

@ -43,32 +43,35 @@ interface EditWysiwygComposerProps {
className?: string; className?: string;
} }
export function EditWysiwygComposer({ editorStateTransfer, className, ...props }: EditWysiwygComposerProps) { // Default needed for React.lazy
export default function EditWysiwygComposer({ editorStateTransfer, className, ...props }: EditWysiwygComposerProps) {
const initialContent = useInitialContent(editorStateTransfer); const initialContent = useInitialContent(editorStateTransfer);
const isReady = !editorStateTransfer || initialContent !== undefined; const isReady = !editorStateTransfer || initialContent !== undefined;
const { editMessage, endEditing, onChange, isSaveDisabled } = useEditing(editorStateTransfer, initialContent); const { editMessage, endEditing, onChange, isSaveDisabled } = useEditing(editorStateTransfer, initialContent);
if (!isReady) {
return null;
}
return ( return (
isReady && ( <WysiwygComposer
<WysiwygComposer className={classNames("mx_EditWysiwygComposer", className)}
className={classNames("mx_EditWysiwygComposer", className)} initialContent={initialContent}
initialContent={initialContent} onChange={onChange}
onChange={onChange} onSend={editMessage}
onSend={editMessage} {...props}
{...props} >
> {(ref) => (
{(ref) => ( <>
<> <Content disabled={props.disabled} ref={ref} />
<Content disabled={props.disabled} ref={ref} /> <EditionButtons
<EditionButtons onCancelClick={endEditing}
onCancelClick={endEditing} onSaveClick={editMessage}
onSaveClick={editMessage} isSaveDisabled={isSaveDisabled}
isSaveDisabled={isSaveDisabled} />
/> </>
</> )}
)} </WysiwygComposer>
</WysiwygComposer>
)
); );
} }

View file

@ -49,7 +49,8 @@ interface SendWysiwygComposerProps {
menuPosition: AboveLeftOf; menuPosition: AboveLeftOf;
} }
export function SendWysiwygComposer({ // Default needed for React.lazy
export default function SendWysiwygComposer({
isRichTextEnabled, isRichTextEnabled,
e2eStatus, e2eStatus,
menuPosition, menuPosition,

View file

@ -14,6 +14,8 @@ See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
*/ */
export { SendWysiwygComposer } from "./SendWysiwygComposer"; export {
export { EditWysiwygComposer } from "./EditWysiwygComposer"; DynamicImportSendWysiwygComposer as SendWysiwygComposer,
DynamicImportEditWysiwygComposer as EditWysiwygComposer,
} from "./DynamicImportWysiwygComposer";
export { sendMessage } from "./utils/message"; export { sendMessage } from "./utils/message";

View file

@ -64,13 +64,35 @@ describe("EditWysiwygComposer", () => {
); );
}; };
it("Should not render the component when not ready", async () => {
// When
const { rerender } = customRender(false);
await waitFor(() => expect(screen.getByRole("textbox")).toHaveAttribute("contentEditable", "true"), {
timeout: 2000,
});
rerender(
<MatrixClientContext.Provider value={mockClient}>
<RoomContext.Provider value={{ ...defaultRoomContext, room: undefined }}>
<EditWysiwygComposer disabled={false} editorStateTransfer={editorStateTransfer} />
</RoomContext.Provider>
</MatrixClientContext.Provider>,
);
// Then
await waitFor(() => expect(screen.queryByRole("textbox")).toBeNull());
});
describe("Initialize with content", () => { describe("Initialize with content", () => {
it("Should initialize useWysiwyg with html content", async () => { it("Should initialize useWysiwyg with html content", async () => {
// When // When
customRender(false, editorStateTransfer); customRender(false, editorStateTransfer);
await waitFor(() => expect(screen.getByRole("textbox")).toHaveAttribute("contentEditable", "true"));
// Then // Then
await waitFor(() => expect(screen.getByRole("textbox")).toHaveAttribute("contentEditable", "true"), {
timeout: 2000,
});
await waitFor(() => await waitFor(() =>
expect(screen.getByRole("textbox")).toContainHTML(mockEvent.getContent()["formatted_body"]), expect(screen.getByRole("textbox")).toContainHTML(mockEvent.getContent()["formatted_body"]),
); );

View file

@ -24,7 +24,7 @@ import defaultDispatcher from "../../../../../src/dispatcher/dispatcher";
import { Action } from "../../../../../src/dispatcher/actions"; import { Action } from "../../../../../src/dispatcher/actions";
import { IRoomState } from "../../../../../src/components/structures/RoomView"; import { IRoomState } from "../../../../../src/components/structures/RoomView";
import { createTestClient, flushPromises, getRoomContext, mkEvent, mkStubRoom } from "../../../../test-utils"; import { createTestClient, flushPromises, getRoomContext, mkEvent, mkStubRoom } from "../../../../test-utils";
import { SendWysiwygComposer } from "../../../../../src/components/views/rooms/wysiwyg_composer"; import { SendWysiwygComposer } from "../../../../../src/components/views/rooms/wysiwyg_composer/";
import { aboveLeftOf } from "../../../../../src/components/structures/ContextMenu"; import { aboveLeftOf } from "../../../../../src/components/structures/ContextMenu";
import { ComposerInsertPayload, ComposerType } from "../../../../../src/dispatcher/payloads/ComposerInsertPayload"; import { ComposerInsertPayload, ComposerType } from "../../../../../src/dispatcher/payloads/ComposerInsertPayload";
import { setSelection } from "../../../../../src/components/views/rooms/wysiwyg_composer/utils/selection"; import { setSelection } from "../../../../../src/components/views/rooms/wysiwyg_composer/utils/selection";
@ -101,12 +101,12 @@ describe("SendWysiwygComposer", () => {
); );
}; };
it("Should render WysiwygComposer when isRichTextEnabled is at true", () => { it("Should render WysiwygComposer when isRichTextEnabled is at true", async () => {
// When // When
customRender(jest.fn(), jest.fn(), false, true); customRender(jest.fn(), jest.fn(), false, true);
// Then // Then
expect(screen.getByTestId("WysiwygComposer")).toBeTruthy(); await waitFor(() => expect(screen.getByTestId("WysiwygComposer")).toBeTruthy());
}); });
it("Should render PlainTextComposer when isRichTextEnabled is at false", () => { it("Should render PlainTextComposer when isRichTextEnabled is at false", () => {