zhaoyongjie commented on code in PR #20728:
URL: https://github.com/apache/superset/pull/20728#discussion_r928485842
##########
superset-frontend/src/components/Chart/chartAction.js:
##########
@@ -603,8 +603,13 @@ export const getDatasourceSamples = async (
datasourceId,
force,
jsonPayload,
+ pagination,
) => {
- const endpoint =
`/datasource/samples?force=${force}&datasource_type=${datasourceType}&datasource_id=${datasourceId}`;
+ let endpoint =
`/datasource/samples?force=${force}&datasource_type=${datasourceType}&datasource_id=${datasourceId}`;
+ if (pagination) {
+ endpoint += `&page=${pagination.page}&per_page=${pagination.perPage}`;
+ }
+
try {
const response = await SupersetClient.post({ endpoint, jsonPayload });
Review Comment:
In order to keep 1) the interface consistent(API call is same as function
call), and 2) avoid join strings that are too long, we do a little refactoring.
```suggestion
perPage,
page,
) => {
try {
const searchParams = {
datasource_type: datasourceType,
datasource_id: datasourceId,
force,
};
if (isDefined(perPage) && isDefined(page)) {
searchParams.per_page = perPage;
searchParams.page = page;
}
const response = await SupersetClient.post({
endpoint: '/datasource/samples',
jsonPayload,
searchParams,
});
```
##########
superset-frontend/src/dashboard/components/DrillDetailPane/DrillDetailPane.tsx:
##########
@@ -0,0 +1,239 @@
+/**
+ * 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, {
+ useState,
+ useEffect,
+ useMemo,
+ useCallback,
+ useRef,
+} from 'react';
+import {
+ BinaryQueryObjectFilterClause,
+ css,
+ ensureIsArray,
+ GenericDataType,
+ t,
+ useTheme,
+} from '@superset-ui/core';
+import Loading from 'src/components/Loading';
+import { EmptyStateMedium } from 'src/components/EmptyState';
+import TableView, { EmptyWrapperType } from 'src/components/TableView';
+import { useTableColumns } from 'src/explore/components/DataTableControl';
+import { getDatasourceSamples } from 'src/components/Chart/chartAction';
+import TableControls from './TableControls';
+
+type ResultsPage = {
+ total: number;
+ data: Record<string, any>[];
+ colNames: string[];
+ colTypes: GenericDataType[];
+};
+
+const PAGE_SIZE = 50;
+const MAX_CACHED_PAGES = 5;
+
+export default function DrillDetailPane({
+ datasource,
+ initialFilters,
+}: {
+ datasource: string;
+ initialFilters?: BinaryQueryObjectFilterClause[];
+}) {
+ const theme = useTheme();
+ const [pageIndex, setPageIndex] = useState(0);
+ const lastPageIndex = useRef(pageIndex);
+ const [filters, setFilters] = useState(initialFilters || []);
+ const [isLoading, setIsLoading] = useState(false);
+ const [responseError, setResponseError] = useState('');
+ const [resultsPages, setResultsPages] = useState<Map<number, ResultsPage>>(
+ new Map(),
+ );
+
+ // Get string identifier for dataset
+ const [datasourceId, datasourceType] = useMemo(
+ () => datasource.split('__'),
+ [datasource],
+ );
+
+ // Get page of results
+ const resultsPage = useMemo(() => {
+ const nextResultsPage = resultsPages.get(pageIndex);
+ if (nextResultsPage) {
+ lastPageIndex.current = pageIndex;
+ return nextResultsPage;
+ }
+
+ return resultsPages.get(lastPageIndex.current);
+ }, [pageIndex, resultsPages]);
+
+ // Clear cache and reset page index if filters change
+ useEffect(() => {
+ setResultsPages(new Map());
+ setPageIndex(0);
+ }, [filters]);
+
+ // Update cache order if page in cache
+ useEffect(() => {
+ if (
+ resultsPages.has(pageIndex) &&
+ [...resultsPages.keys()].at(-1) !== pageIndex
+ ) {
+ const nextResultsPages = new Map(resultsPages);
+ nextResultsPages.delete(pageIndex);
+ setResultsPages(
+ nextResultsPages.set(
+ pageIndex,
+ resultsPages.get(pageIndex) as ResultsPage,
+ ),
+ );
+ }
+ }, [pageIndex, resultsPages]);
+
+ // Download page of results & trim cache if page not in cache
+ useEffect(() => {
+ if (!resultsPages.has(pageIndex)) {
+ setIsLoading(true);
+ getDatasourceSamples(
+ datasourceType,
+ datasourceId,
+ true,
+ filters.length ? { filters } : null,
+ { page: pageIndex + 1, perPage: PAGE_SIZE },
+ )
+ .then(response => {
+ setResultsPages(
+ new Map([
+ ...[...resultsPages.entries()].slice(-MAX_CACHED_PAGES + 1),
+ [
+ pageIndex,
+ {
+ total: response.total_count,
+ data: response.data,
+ colNames: ensureIsArray(response.colnames),
+ colTypes: ensureIsArray(response.coltypes),
+ },
+ ],
+ ]),
+ );
+ setResponseError('');
+ })
+ .catch(error => {
+ setResponseError(`${error.name}: ${error.message}`);
+ })
+ .finally(() => {
+ setIsLoading(false);
+ });
+ }
+ }, [datasourceId, datasourceType, filters, pageIndex, resultsPages]);
+
+ // this is to preserve the order of the columns, even if there are integer
values,
+ // while also only grabbing the first column's keys
+ const columns = useTableColumns(
+ resultsPage?.colNames,
+ resultsPage?.colTypes,
+ resultsPage?.data,
+ datasource,
+ );
+
+ const sortDisabledColumns = columns.map(column => ({
+ ...column,
+ disableSortBy: true,
+ }));
+
+ // Update page index on pagination click
+ const onServerPagination = useCallback(({ pageIndex }) => {
+ setPageIndex(pageIndex);
+ }, []);
+
+ // Clear cache on reload button click
+ const handleReload = useCallback(() => {
+ setResultsPages(new Map());
Review Comment:
free memory explicitly, don't rely on GC.
```suggestion
resultsPages.clear();
```
##########
superset-frontend/src/dashboard/components/DrillDetailPane/DrillDetailPane.tsx:
##########
@@ -0,0 +1,239 @@
+/**
+ * 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, {
+ useState,
+ useEffect,
+ useMemo,
+ useCallback,
+ useRef,
+} from 'react';
+import {
+ BinaryQueryObjectFilterClause,
+ css,
+ ensureIsArray,
+ GenericDataType,
+ t,
+ useTheme,
+} from '@superset-ui/core';
+import Loading from 'src/components/Loading';
+import { EmptyStateMedium } from 'src/components/EmptyState';
+import TableView, { EmptyWrapperType } from 'src/components/TableView';
+import { useTableColumns } from 'src/explore/components/DataTableControl';
+import { getDatasourceSamples } from 'src/components/Chart/chartAction';
+import TableControls from './TableControls';
+
+type ResultsPage = {
+ total: number;
+ data: Record<string, any>[];
+ colNames: string[];
+ colTypes: GenericDataType[];
+};
+
+const PAGE_SIZE = 50;
Review Comment:
```suggestion
const perPage = 50;
```
##########
superset-frontend/src/dashboard/components/DrillDetailPane/index.ts:
##########
@@ -0,0 +1,22 @@
+/**
+ * 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 DrillDetailPane from './DrillDetailPane';
+
+export default DrillDetailPane;
Review Comment:
```suggestion
export { default as DrillDetailPane } from './DrillDetailPane';
```
##########
superset-frontend/src/dashboard/components/DrillDetailPane/DrillDetailPane.tsx:
##########
@@ -0,0 +1,239 @@
+/**
+ * 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, {
+ useState,
+ useEffect,
+ useMemo,
+ useCallback,
+ useRef,
+} from 'react';
+import {
+ BinaryQueryObjectFilterClause,
+ css,
+ ensureIsArray,
+ GenericDataType,
+ t,
+ useTheme,
+} from '@superset-ui/core';
+import Loading from 'src/components/Loading';
+import { EmptyStateMedium } from 'src/components/EmptyState';
+import TableView, { EmptyWrapperType } from 'src/components/TableView';
+import { useTableColumns } from 'src/explore/components/DataTableControl';
+import { getDatasourceSamples } from 'src/components/Chart/chartAction';
+import TableControls from './TableControls';
+
+type ResultsPage = {
+ total: number;
+ data: Record<string, any>[];
+ colNames: string[];
+ colTypes: GenericDataType[];
+};
+
+const PAGE_SIZE = 50;
+const MAX_CACHED_PAGES = 5;
+
+export default function DrillDetailPane({
+ datasource,
+ initialFilters,
+}: {
+ datasource: string;
+ initialFilters?: BinaryQueryObjectFilterClause[];
+}) {
+ const theme = useTheme();
+ const [pageIndex, setPageIndex] = useState(0);
+ const lastPageIndex = useRef(pageIndex);
+ const [filters, setFilters] = useState(initialFilters || []);
+ const [isLoading, setIsLoading] = useState(false);
+ const [responseError, setResponseError] = useState('');
+ const [resultsPages, setResultsPages] = useState<Map<number, ResultsPage>>(
+ new Map(),
+ );
+
+ // Get string identifier for dataset
+ const [datasourceId, datasourceType] = useMemo(
+ () => datasource.split('__'),
+ [datasource],
+ );
+
+ // Get page of results
+ const resultsPage = useMemo(() => {
+ const nextResultsPage = resultsPages.get(pageIndex);
+ if (nextResultsPage) {
+ lastPageIndex.current = pageIndex;
+ return nextResultsPage;
+ }
+
+ return resultsPages.get(lastPageIndex.current);
+ }, [pageIndex, resultsPages]);
+
+ // Clear cache and reset page index if filters change
+ useEffect(() => {
+ setResultsPages(new Map());
+ setPageIndex(0);
+ }, [filters]);
+
+ // Update cache order if page in cache
+ useEffect(() => {
+ if (
+ resultsPages.has(pageIndex) &&
+ [...resultsPages.keys()].at(-1) !== pageIndex
+ ) {
+ const nextResultsPages = new Map(resultsPages);
+ nextResultsPages.delete(pageIndex);
+ setResultsPages(
+ nextResultsPages.set(
+ pageIndex,
+ resultsPages.get(pageIndex) as ResultsPage,
+ ),
+ );
+ }
+ }, [pageIndex, resultsPages]);
+
+ // Download page of results & trim cache if page not in cache
+ useEffect(() => {
+ if (!resultsPages.has(pageIndex)) {
+ setIsLoading(true);
+ getDatasourceSamples(
+ datasourceType,
+ datasourceId,
+ true,
+ filters.length ? { filters } : null,
+ { page: pageIndex + 1, perPage: PAGE_SIZE },
+ )
+ .then(response => {
+ setResultsPages(
+ new Map([
Review Comment:
let's use [LRU](https://github.com/apache/superset/pull/20842) to refactor
this.
##########
superset-frontend/src/dashboard/components/SliceHeaderControls/index.tsx:
##########
@@ -39,6 +45,8 @@ import ModalTrigger from 'src/components/ModalTrigger';
import Button from 'src/components/Button';
import ViewQueryModal from 'src/explore/components/controls/ViewQueryModal';
import { ResultsPaneOnDashboard } from 'src/explore/components/DataTablesPane';
+import Modal from 'src/components/Modal';
+import DrillDetailPane from 'src/dashboard/components/DrillDetailPane';
Review Comment:
```suggestion
import { DrillDetailPane } from 'src/dashboard/components/DrillDetailPane';
```
##########
superset-frontend/src/dashboard/components/DrillDetailPane/DrillDetailPane.tsx:
##########
@@ -0,0 +1,239 @@
+/**
+ * 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, {
+ useState,
+ useEffect,
+ useMemo,
+ useCallback,
+ useRef,
+} from 'react';
+import {
+ BinaryQueryObjectFilterClause,
+ css,
+ ensureIsArray,
+ GenericDataType,
+ t,
+ useTheme,
+} from '@superset-ui/core';
+import Loading from 'src/components/Loading';
+import { EmptyStateMedium } from 'src/components/EmptyState';
+import TableView, { EmptyWrapperType } from 'src/components/TableView';
+import { useTableColumns } from 'src/explore/components/DataTableControl';
+import { getDatasourceSamples } from 'src/components/Chart/chartAction';
+import TableControls from './TableControls';
+
+type ResultsPage = {
+ total: number;
+ data: Record<string, any>[];
+ colNames: string[];
+ colTypes: GenericDataType[];
+};
+
+const PAGE_SIZE = 50;
+const MAX_CACHED_PAGES = 5;
+
+export default function DrillDetailPane({
+ datasource,
+ initialFilters,
+}: {
+ datasource: string;
+ initialFilters?: BinaryQueryObjectFilterClause[];
+}) {
+ const theme = useTheme();
+ const [pageIndex, setPageIndex] = useState(0);
+ const lastPageIndex = useRef(pageIndex);
+ const [filters, setFilters] = useState(initialFilters || []);
+ const [isLoading, setIsLoading] = useState(false);
+ const [responseError, setResponseError] = useState('');
+ const [resultsPages, setResultsPages] = useState<Map<number, ResultsPage>>(
+ new Map(),
+ );
+
+ // Get string identifier for dataset
+ const [datasourceId, datasourceType] = useMemo(
+ () => datasource.split('__'),
+ [datasource],
+ );
+
+ // Get page of results
+ const resultsPage = useMemo(() => {
+ const nextResultsPage = resultsPages.get(pageIndex);
+ if (nextResultsPage) {
+ lastPageIndex.current = pageIndex;
+ return nextResultsPage;
+ }
+
+ return resultsPages.get(lastPageIndex.current);
+ }, [pageIndex, resultsPages]);
+
+ // Clear cache and reset page index if filters change
+ useEffect(() => {
+ setResultsPages(new Map());
+ setPageIndex(0);
+ }, [filters]);
+
+ // Update cache order if page in cache
+ useEffect(() => {
+ if (
+ resultsPages.has(pageIndex) &&
+ [...resultsPages.keys()].at(-1) !== pageIndex
+ ) {
+ const nextResultsPages = new Map(resultsPages);
+ nextResultsPages.delete(pageIndex);
+ setResultsPages(
+ nextResultsPages.set(
+ pageIndex,
+ resultsPages.get(pageIndex) as ResultsPage,
+ ),
+ );
+ }
+ }, [pageIndex, resultsPages]);
+
+ // Download page of results & trim cache if page not in cache
+ useEffect(() => {
+ if (!resultsPages.has(pageIndex)) {
+ setIsLoading(true);
+ getDatasourceSamples(
+ datasourceType,
+ datasourceId,
+ true,
+ filters.length ? { filters } : null,
+ { page: pageIndex + 1, perPage: PAGE_SIZE },
+ )
+ .then(response => {
+ setResultsPages(
+ new Map([
+ ...[...resultsPages.entries()].slice(-MAX_CACHED_PAGES + 1),
+ [
+ pageIndex,
+ {
+ total: response.total_count,
+ data: response.data,
+ colNames: ensureIsArray(response.colnames),
+ colTypes: ensureIsArray(response.coltypes),
+ },
+ ],
+ ]),
+ );
+ setResponseError('');
+ })
+ .catch(error => {
+ setResponseError(`${error.name}: ${error.message}`);
+ })
+ .finally(() => {
+ setIsLoading(false);
+ });
+ }
+ }, [datasourceId, datasourceType, filters, pageIndex, resultsPages]);
Review Comment:
the `id` and `type` was derived from datasource
```suggestion
}, [datasource, filters, pageIndex, resultsPages]);
```
##########
superset-frontend/src/dashboard/components/DrillDetailPane/DrillDetailPane.tsx:
##########
@@ -0,0 +1,239 @@
+/**
+ * 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, {
+ useState,
+ useEffect,
+ useMemo,
+ useCallback,
+ useRef,
+} from 'react';
+import {
+ BinaryQueryObjectFilterClause,
+ css,
+ ensureIsArray,
+ GenericDataType,
+ t,
+ useTheme,
+} from '@superset-ui/core';
+import Loading from 'src/components/Loading';
+import { EmptyStateMedium } from 'src/components/EmptyState';
+import TableView, { EmptyWrapperType } from 'src/components/TableView';
+import { useTableColumns } from 'src/explore/components/DataTableControl';
+import { getDatasourceSamples } from 'src/components/Chart/chartAction';
+import TableControls from './TableControls';
+
+type ResultsPage = {
+ total: number;
+ data: Record<string, any>[];
+ colNames: string[];
+ colTypes: GenericDataType[];
+};
+
+const PAGE_SIZE = 50;
+const MAX_CACHED_PAGES = 5;
+
+export default function DrillDetailPane({
+ datasource,
+ initialFilters,
+}: {
+ datasource: string;
+ initialFilters?: BinaryQueryObjectFilterClause[];
+}) {
+ const theme = useTheme();
+ const [pageIndex, setPageIndex] = useState(0);
Review Comment:
```
const [pageIndex, setPageIndex] = useState(1);
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
