superset2/superset-frontend/src/SqlLab/hooks/useQueryEditor/index.ts

/**
 * 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 { pick } from 'lodash';
import { useMemo } from 'react';
import { shallowEqual, useSelector } from 'react-redux';
import { SqlLabRootState, QueryEditor } from 'src/SqlLab/types';

export const EMPTY_STATE_QE_ID = 'tmp_qe_id';

export default function useQueryEditor<T extends keyof QueryEditor>(
  sqlEditorId: string,
  attributes: ReadonlyArray<T>,
) {
  const queryEditors = useSelector<SqlLabRootState, QueryEditor[]>(
    ({ sqlLab: { queryEditors } }) => queryEditors,
    shallowEqual,
  );
  const queryEditorsById = useMemo(
    () =>
      Object.fromEntries(
        queryEditors.map((editor, index) => [editor.id, index]),
      ),
    [queryEditors.map(({ id }) => id).join(',')],
  );

  return useSelector<SqlLabRootState, Pick<QueryEditor, T | 'id'>>(
    ({ sqlLab: { unsavedQueryEditor } }) =>
      pick(
        {
          ...queryEditors[queryEditorsById[sqlEditorId]],
          ...(sqlEditorId === unsavedQueryEditor?.id && unsavedQueryEditor),
          ...(sqlEditorId === EMPTY_STATE_QE_ID && { id: sqlEditorId }),
        },
        ['id'].concat(attributes),
      ) as Pick<QueryEditor, T | 'id'>,
    shallowEqual,
  );
}