perf: Lazy load React Ace (#29796)

This commit is contained in:
Kamil Gabryjelski 2024-08-01 15:14:58 +02:00 committed by GitHub
parent 249f5ec31a
commit d143b24232
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 61 additions and 11 deletions

View File

@ -0,0 +1,20 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
declare module 'ace-builds/src-min-noconflict/mode-sql';

View File

@ -16,12 +16,12 @@
* specific language governing permissions and limitations * specific language governing permissions and limitations
* under the License. * under the License.
*/ */
import { useEffect, useState } from 'react';
import { Popover } from 'antd'; import { Popover } from 'antd';
import type ReactAce from 'react-ace';
import type { PopoverProps } from 'antd/lib/popover'; import type { PopoverProps } from 'antd/lib/popover';
import AceEditor from 'react-ace';
import { CalculatorOutlined } from '@ant-design/icons'; import { CalculatorOutlined } from '@ant-design/icons';
import { css, styled, useTheme, t } from '@superset-ui/core'; import { css, styled, useTheme, t } from '@superset-ui/core';
import 'ace-builds/src-noconflict/mode-sql';
const StyledCalculatorIcon = styled(CalculatorOutlined)` const StyledCalculatorIcon = styled(CalculatorOutlined)`
${({ theme }) => css` ${({ theme }) => css`
@ -36,6 +36,19 @@ const StyledCalculatorIcon = styled(CalculatorOutlined)`
export const SQLPopover = (props: PopoverProps & { sqlExpression: string }) => { export const SQLPopover = (props: PopoverProps & { sqlExpression: string }) => {
const theme = useTheme(); const theme = useTheme();
const [AceEditor, setAceEditor] = useState<typeof ReactAce | null>(null);
useEffect(() => {
Promise.all([
import('react-ace'),
import('ace-builds/src-min-noconflict/mode-sql'),
]).then(([reactAceModule]) => {
setAceEditor(() => reactAceModule.default);
});
}, []);
if (!AceEditor) {
return null;
}
return ( return (
<Popover <Popover
content={ content={

View File

@ -18,27 +18,24 @@
*/ */
import { forwardRef, useEffect, ComponentType } from 'react'; import { forwardRef, useEffect, ComponentType } from 'react';
import { import type {
Editor as OrigEditor, Editor as OrigEditor,
IEditSession, IEditSession,
Position, Position,
TextMode as OrigTextMode, TextMode as OrigTextMode,
} from 'brace'; } from 'brace';
import AceEditor, { IAceEditorProps } from 'react-ace'; import type AceEditor from 'react-ace';
import { config } from 'ace-builds'; import type { IAceEditorProps } from 'react-ace';
import { acequire } from 'ace-builds/src-noconflict/ace';
import AsyncEsmComponent, { import AsyncEsmComponent, {
PlaceholderProps, PlaceholderProps,
} from 'src/components/AsyncEsmComponent'; } from 'src/components/AsyncEsmComponent';
import useEffectEvent from 'src/hooks/useEffectEvent'; import useEffectEvent from 'src/hooks/useEffectEvent';
import cssWorkerUrl from 'ace-builds/src-noconflict/worker-css';
import { useTheme, css } from '@superset-ui/core'; import { useTheme, css } from '@superset-ui/core';
import { Global } from '@emotion/react'; import { Global } from '@emotion/react';
export { getTooltipHTML } from './Tooltip'; export { getTooltipHTML } from './Tooltip';
config.setModuleUrl('ace/mode/css_worker', cssWorkerUrl);
export interface AceCompleterKeywordData { export interface AceCompleterKeywordData {
name: string; name: string;
value: string; value: string;
@ -116,7 +113,26 @@ export default function AsyncAceEditor(
}: AsyncAceEditorOptions = {}, }: AsyncAceEditorOptions = {},
) { ) {
return AsyncEsmComponent(async () => { return AsyncEsmComponent(async () => {
const { default: ReactAceEditor } = await import('react-ace'); const reactAcePromise = import('react-ace');
const aceBuildsConfigPromise = import('ace-builds');
const cssWorkerUrlPromise = import(
'ace-builds/src-min-noconflict/worker-css'
);
const acequirePromise = import('ace-builds/src-min-noconflict/ace');
const [
{ default: ReactAceEditor },
{ config },
{ default: cssWorkerUrl },
{ acequire },
] = await Promise.all([
reactAcePromise,
aceBuildsConfigPromise,
cssWorkerUrlPromise,
acequirePromise,
]);
config.setModuleUrl('ace/mode/css_worker', cssWorkerUrl);
await Promise.all(aceModules.map(x => aceModuleLoaders[x]())); await Promise.all(aceModules.map(x => aceModuleLoaders[x]()));

View File

@ -16,4 +16,5 @@
* specific language governing permissions and limitations * specific language governing permissions and limitations
* under the License. * under the License.
*/ */
declare module 'ace-builds/src-noconflict/worker-css'; declare module 'ace-builds/src-min-noconflict/worker-css';
declare module 'ace-builds/src-min-noconflict/ace';