From a3db5844f00c6dd1a34a73de7099f9c5c84fba11 Mon Sep 17 00:00:00 2001 From: John Bodley <4567245+john-bodley@users.noreply.github.com> Date: Thu, 13 Jul 2023 09:18:15 -0700 Subject: [PATCH] chore: remove fetch explore json (#24669) --- .../src/query/api/legacy/fetchExploreJson.ts | 49 ----------- .../src/query/api/legacy/index.ts | 1 - .../query/api/legacy/fetchExploreJson.test.ts | 81 ------------------- 3 files changed, 131 deletions(-) delete mode 100644 superset-frontend/packages/superset-ui-core/src/query/api/legacy/fetchExploreJson.ts delete mode 100644 superset-frontend/packages/superset-ui-core/test/query/api/legacy/fetchExploreJson.test.ts diff --git a/superset-frontend/packages/superset-ui-core/src/query/api/legacy/fetchExploreJson.ts b/superset-frontend/packages/superset-ui-core/src/query/api/legacy/fetchExploreJson.ts deleted file mode 100644 index b018205d7..000000000 --- a/superset-frontend/packages/superset-ui-core/src/query/api/legacy/fetchExploreJson.ts +++ /dev/null @@ -1,49 +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 { SupersetClient, Method, Endpoint } from '../../../connection'; -import { QueryFormData } from '../../types/QueryFormData'; -import { LegacyChartDataResponse } from './types'; -import { BaseParams } from '../types'; - -export interface Params extends BaseParams { - method?: Method; - endpoint?: Endpoint; - formData: QueryFormData; -} - -export default async function fetchExploreJson({ - client = SupersetClient, - method = 'POST', - requestConfig, - endpoint = '/superset/explore_json/', - formData, -}: Params) { - const { json } = await client.request({ - ...requestConfig, - method, - endpoint, - searchParams: - method === 'GET' - ? new URLSearchParams({ form_data: JSON.stringify(formData) }) - : undefined, - postPayload: method === 'POST' ? { form_data: formData } : undefined, - }); - return json as LegacyChartDataResponse; -} diff --git a/superset-frontend/packages/superset-ui-core/src/query/api/legacy/index.ts b/superset-frontend/packages/superset-ui-core/src/query/api/legacy/index.ts index 907b134c5..683955531 100644 --- a/superset-frontend/packages/superset-ui-core/src/query/api/legacy/index.ts +++ b/superset-frontend/packages/superset-ui-core/src/query/api/legacy/index.ts @@ -17,7 +17,6 @@ * under the License. */ -export { default as fetchExploreJson } from './fetchExploreJson'; export { default as getFormData } from './getFormData'; export { default as getDatasourceMetadata } from './getDatasourceMetadata'; diff --git a/superset-frontend/packages/superset-ui-core/test/query/api/legacy/fetchExploreJson.test.ts b/superset-frontend/packages/superset-ui-core/test/query/api/legacy/fetchExploreJson.test.ts deleted file mode 100644 index 40203c824..000000000 --- a/superset-frontend/packages/superset-ui-core/test/query/api/legacy/fetchExploreJson.test.ts +++ /dev/null @@ -1,81 +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 fetchMock from 'fetch-mock'; -import { fetchExploreJson } from '../../../../src/query/api/legacy'; -import setupClientForTest from '../setupClientForTest'; - -describe('fetchExploreJson()', () => { - beforeAll(setupClientForTest); - - afterEach(fetchMock.restore); - - it('returns a promise of LegacyChartDataResponse', () => { - fetchMock.post('glob:*/superset/explore_json/', { - field1: 'abc', - field2: 'def', - }); - - return expect( - fetchExploreJson({ - formData: { - granularity: 'minute', - viz_type: 'word_cloud', - datasource: '1__table', - }, - }), - ).resolves.toEqual({ - field1: 'abc', - field2: 'def', - }); - }); - it('uses GET when specified', async () => { - expect.assertions(4); - const mockUrl = 'glob:*/superset/explore_json/*'; - - fetchMock.get(mockUrl, { - field1: 'abc', - field2: 'def', - }); - - const result = await fetchExploreJson({ - method: 'GET', - formData: { - granularity: 'minute', - viz_type: 'word_cloud', - datasource: '1__table', - }, - }); - - expect(result).toEqual({ - field1: 'abc', - field2: 'def', - }); - const mockCalls = fetchMock.calls(mockUrl); - expect(mockCalls).toHaveLength(1); - expect(mockCalls[0][0]).toEqual( - 'http://localhost/superset/explore_json/?form_data=%7B%22granularity%22%3A%22minute%22%2C%22viz_type%22%3A%22word_cloud%22%2C%22datasource%22%3A%221__table%22%7D', - ); - expect(mockCalls[0][1]).toEqual( - expect.objectContaining({ - method: 'GET', - body: undefined, - }), - ); - }); -});