Skip to content

Commit

Permalink
fix(sqllab): missing column meta on autocomplete (#24611)
Browse files Browse the repository at this point in the history
Co-authored-by: Justin Park <justinpark@apache.org>
(cherry picked from commit ca8c8d2)
  • Loading branch information
justinpark authored and michael-s-molina committed Jul 12, 2023
1 parent d8bf955 commit 79a42c6
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 18 deletions.
48 changes: 32 additions & 16 deletions superset-frontend/src/SqlLab/components/AceEditorWrapper/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* under the License.
*/
import React, { useState, useEffect, useRef, useMemo } from 'react';
import { useDispatch } from 'react-redux';
import { shallowEqual, useDispatch, useSelector } from 'react-redux';
import { css, styled, usePrevious, t } from '@superset-ui/core';

import { areArraysShallowEqual } from 'src/reduxUtils';
Expand All @@ -39,8 +39,14 @@ import {
FullSQLEditor as AceEditor,
} from 'src/components/AsyncAceEditor';
import useQueryEditor from 'src/SqlLab/hooks/useQueryEditor';
import { useSchemas, useTables } from 'src/hooks/apiResources';
import {
useSchemas,
useTables,
tableEndpoints,
skipToken,
} from 'src/hooks/apiResources';
import { useDatabaseFunctionsQuery } from 'src/hooks/apiResources/databaseFunctions';
import { RootState } from 'src/views/store';
import { useAnnotations } from './useAnnotations';

type HotKey = {
Expand All @@ -55,7 +61,6 @@ type AceEditorWrapperProps = {
onBlur: (sql: string) => void;
onChange: (sql: string) => void;
queryEditorId: string;
extendedTables?: Array<{ name: string; columns: any[] }>;
height: string;
hotkeys: HotKey[];
};
Expand Down Expand Up @@ -85,12 +90,10 @@ const AceEditorWrapper = ({
onBlur = () => {},
onChange = () => {},
queryEditorId,
extendedTables = [],
height,
hotkeys,
}: AceEditorWrapperProps) => {
const dispatch = useDispatch();

const queryEditor = useQueryEditor(queryEditorId, [
'id',
'dbId',
Expand Down Expand Up @@ -138,6 +141,26 @@ const AceEditorWrapper = ({
);
const tables = tableData?.options ?? [];

const columns = useSelector<RootState, string[]>(state => {
const columns = new Set<string>();
tables.forEach(({ value }) => {
tableEndpoints.tableMetadata
.select(
queryEditor.dbId && queryEditor.schema
? {
dbId: queryEditor.dbId,
schema: queryEditor.schema,
table: value,
}
: skipToken,
)(state)
.data?.columns?.forEach(({ name }) => {
columns.add(name);
});
});
return [...columns];
}, shallowEqual);

const [sql, setSql] = useState(currentSql);
const [words, setWords] = useState<AceCompleterKeyword[]>([]);

Expand All @@ -155,18 +178,18 @@ const AceEditorWrapper = ({

const prevTables = usePrevious(tables) ?? [];
const prevSchemas = usePrevious(schemas) ?? [];
const prevExtendedTables = usePrevious(extendedTables) ?? [];
const prevColumns = usePrevious(columns) ?? [];
const prevSql = usePrevious(currentSql);

useEffect(() => {
if (
!areArraysShallowEqual(tables, prevTables) ||
!areArraysShallowEqual(schemas, prevSchemas) ||
!areArraysShallowEqual(extendedTables, prevExtendedTables)
!areArraysShallowEqual(columns, prevColumns)
) {
setAutoCompleter();
}
}, [tables, schemas, extendedTables]);
}, [tables, schemas, columns]);

useEffect(() => {
if (currentSql !== prevSql) {
Expand Down Expand Up @@ -221,15 +244,8 @@ const AceEditorWrapper = ({
};

function setAutoCompleter() {
const columns = {};

const tableWords = tables.map(t => {
const tableName = t.value;
const extendedTable = extendedTables.find(et => et.name === tableName);
const cols = extendedTable?.columns || [];
cols.forEach(col => {
columns[col.name] = null; // using an object as a unique set
});

return {
name: t.label,
Expand All @@ -239,7 +255,7 @@ const AceEditorWrapper = ({
};
});

const columnWords = Object.keys(columns).map(col => ({
const columnWords = columns.map(col => ({
name: col,
value: col,
score: COLUMN_AUTOCOMPLETE_SCORE,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -666,7 +666,6 @@ const SqlEditor = ({
onBlur={setQueryEditorAndSaveSql}
onChange={onSqlChanged}
queryEditorId={queryEditor.id}
extendedTables={tables}
height={`${aceEditorHeight}px`}
hotkeys={hotkeys}
/>
Expand Down
2 changes: 1 addition & 1 deletion superset-frontend/src/hooks/apiResources/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/

export { skipToken } from '@reduxjs/toolkit/query/react';
export {
useApiResourceFullBody,
useApiV1Resource,
Expand Down
1 change: 1 addition & 0 deletions superset-frontend/src/hooks/apiResources/tables.ts
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ export const {
useTablesQuery,
useTableMetadataQuery,
useTableExtendedMetadataQuery,
endpoints: tableEndpoints,
} = tableApi;

export function useTables(options: Params) {
Expand Down
1 change: 1 addition & 0 deletions superset-frontend/src/views/store.ts
Original file line number Diff line number Diff line change
Expand Up @@ -161,3 +161,4 @@ export function setupStore({
}

export const store: Store = setupStore();
export type RootState = ReturnType<typeof store.getState>;

0 comments on commit 79a42c6

Please sign in to comment.