perf(sqllab): Rendering perf improvement using immutable state (#20877)

* perf(sqllab): Rendering perf improvement using immutable state

- keep queryEditors immutable during active state
- add unsavedQueryEditor to store all active changes
- refactor each component to subscribe the related unsaved editor state only

* revert ISaveableDatasource type cast

* missing trigger prop

* a default of an empty object and optional operator

superset-frontend/src/SqlLab/components/RunQueryActionButton/RunQueryActionButton.test.jsx

@@ -1,53 +0,0 @@
-/**
- * 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.
- */
-import React from 'react';
-import { mount } from 'enzyme';
-import { supersetTheme, ThemeProvider } from '@superset-ui/core';
-import RunQueryActionButton from 'src/SqlLab/components/RunQueryActionButton';
-import Button from 'src/components/Button';
-
-describe('RunQueryActionButton', () => {
-  let wrapper;
-  const defaultProps = {
-    allowAsync: false,
-    dbId: 1,
-    queryState: 'pending',
-    runQuery: () => {}, // eslint-disable-line
-    selectedText: null,
-    stopQuery: () => {}, // eslint-disable-line
-    sql: '',
-  };
-
-  beforeEach(() => {
-    wrapper = mount(<RunQueryActionButton {...defaultProps} />, {
-      wrappingComponent: ThemeProvider,
-      wrappingComponentProps: { theme: supersetTheme },
-    });
-  });
-
-  it('is a valid react element', () => {
-    expect(
-      React.isValidElement(<RunQueryActionButton {...defaultProps} />),
-    ).toBe(true);
-  });
-
-  it('renders a single Button', () => {
-    expect(wrapper.find(Button)).toExist();
-  });
-});

superset-frontend/src/SqlLab/components/RunQueryActionButton/RunQueryActionButton.test.tsx

@@ -0,0 +1,151 @@
+/**
+ * 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.
+ */
+import React from 'react';
+import configureStore from 'redux-mock-store';
+import thunk from 'redux-thunk';
+import { Store } from 'redux';
+
+import { render, fireEvent, waitFor } from 'spec/helpers/testing-library';
+import { initialState, defaultQueryEditor } from 'src/SqlLab/fixtures';
+import RunQueryActionButton, {
+  Props,
+} from 'src/SqlLab/components/RunQueryActionButton';
+
+const middlewares = [thunk];
+const mockStore = configureStore(middlewares);
+
+jest.mock('src/components/Select', () => () => (
+  <div data-test="mock-deprecated-select" />
+));
+jest.mock('src/components/Select/Select', () => () => (
+  <div data-test="mock-deprecated-select-select" />
+));
+jest.mock('src/components/Select/AsyncSelect', () => () => (
+  <div data-test="mock-deprecated-async-select" />
+));
+
+const defaultProps = {
+  queryEditor: defaultQueryEditor,
+  allowAsync: false,
+  dbId: 1,
+  queryState: 'ready',
+  runQuery: jest.fn(),
+  selectedText: null,
+  stopQuery: jest.fn(),
+  overlayCreateAsMenu: null,
+};
+
+const setup = (props?: Partial<Props>, store?: Store) =>
+  render(<RunQueryActionButton {...defaultProps} {...props} />, {
+    useRedux: true,
+    ...(store && { store }),
+  });
+
+describe('RunQueryActionButton', () => {
+  beforeEach(() => {
+    defaultProps.runQuery.mockReset();
+    defaultProps.stopQuery.mockReset();
+  });
+
+  it('renders a single Button', () => {
+    const { getByRole } = setup({}, mockStore(initialState));
+    expect(getByRole('button')).toBeInTheDocument();
+  });
+
+  it('renders a label for Run Query', () => {
+    const { getByText } = setup({}, mockStore(initialState));
+    expect(getByText('Run')).toBeInTheDocument();
+  });
+
+  it('renders a label for Selected Query', () => {
+    const { getByText } = setup(
+      {},
+      mockStore({
+        ...initialState,
+        sqlLab: {
+          ...initialState.sqlLab,
+          unsavedQueryEditor: {
+            id: defaultQueryEditor.id,
+            selectedText: 'FROM',
+          },
+        },
+      }),
+    );
+    expect(getByText('Run selection')).toBeInTheDocument();
+  });
+
+  it('disable button when sql from unsaved changes is empty', () => {
+    const { getByRole } = setup(
+      {},
+      mockStore({
+        ...initialState,
+        sqlLab: {
+          ...initialState.sqlLab,
+          unsavedQueryEditor: {
+            id: defaultQueryEditor.id,
+            sql: '',
+          },
+        },
+      }),
+    );
+    const button = getByRole('button');
+    expect(button).toBeDisabled();
+  });
+
+  it('enable default button for unrelated unsaved changes', () => {
+    const { getByRole } = setup(
+      {},
+      mockStore({
+        ...initialState,
+        sqlLab: {
+          ...initialState.sqlLab,
+          unsavedQueryEditor: {
+            id: `${defaultQueryEditor.id}-other`,
+            sql: '',
+          },
+        },
+      }),
+    );
+    const button = getByRole('button');
+    expect(button).toBeEnabled();
+  });
+
+  it('dispatch runQuery on click', async () => {
+    const { getByRole } = setup({}, mockStore(initialState));
+    const button = getByRole('button');
+    expect(defaultProps.runQuery).toHaveBeenCalledTimes(0);
+    fireEvent.click(button);
+    await waitFor(() => expect(defaultProps.runQuery).toHaveBeenCalledTimes(1));
+  });
+
+  describe('on running state', () => {
+    it('dispatch stopQuery on click', async () => {
+      const { getByRole } = setup(
+        { queryState: 'running' },
+        mockStore(initialState),
+      );
+      const button = getByRole('button');
+      expect(defaultProps.stopQuery).toHaveBeenCalledTimes(0);
+      fireEvent.click(button);
+      await waitFor(() =>
+        expect(defaultProps.stopQuery).toHaveBeenCalledTimes(1),
+      );
+    });
+  });
+});

superset-frontend/src/SqlLab/components/RunQueryActionButton/index.tsx

@@ -24,15 +24,20 @@ import Button from 'src/components/Button';
 import Icons from 'src/components/Icons';
 import { DropdownButton } from 'src/components/DropdownButton';
 import { detectOS } from 'src/utils/common';
-import { QueryButtonProps } from 'src/SqlLab/types';
+import { shallowEqual, useSelector } from 'react-redux';
+import {
+  QueryEditor,
+  SqlLabRootState,
+  QueryButtonProps,
+} from 'src/SqlLab/types';
+import { getUpToDateQuery } from 'src/SqlLab/actions/sqlLab';
 
-interface Props {
+export interface Props {
+  queryEditor: QueryEditor;
   allowAsync: boolean;
   queryState?: string;
   runQuery: (c?: boolean) => void;
-  selectedText?: string;
   stopQuery: () => void;
-  sql: string;
   overlayCreateAsMenu: typeof Menu | null;
 }
 
@@ -83,16 +88,27 @@ const StyledButton = styled.span`
 
 const RunQueryActionButton = ({
   allowAsync = false,
+  queryEditor,
   queryState,
-  selectedText,
-  sql = '',
   overlayCreateAsMenu,
   runQuery,
   stopQuery,
 }: Props) => {
   const theme = useTheme();
-
   const userOS = detectOS();
+  const { selectedText, sql } = useSelector<
+    SqlLabRootState,
+    Pick<QueryEditor, 'selectedText' | 'sql'>
+  >(rootState => {
+    const currentQueryEditor = getUpToDateQuery(
+      rootState,
+      queryEditor,
+    ) as unknown as QueryEditor;
+    return {
+      selectedText: currentQueryEditor.selectedText,
+      sql: currentQueryEditor.sql,
+    };
+  }, shallowEqual);
 
   const shouldShowStopBtn =
     !!queryState && ['running', 'pending'].indexOf(queryState) > -1;
@@ -101,7 +117,7 @@ const RunQueryActionButton = ({
     ? (DropdownButton as React.FC)
     : Button;
 
-  const isDisabled = !sql.trim();
+  const isDisabled = !sql || !sql.trim();
 
   const stopButtonTooltipText = useMemo(
     () =>