From 2c6fd0abb8e3ebc7d6e3a1d74f8586e007150f7b Mon Sep 17 00:00:00 2001 From: David Aaron Suddjian Date: Mon, 22 Feb 2021 16:29:57 -0800 Subject: [PATCH] better names --- .../src/common/hooks/apiResources/apiResources.ts | 9 +++++---- .../src/common/hooks/apiResources/charts.ts | 4 ++-- superset-frontend/src/common/hooks/apiResources/index.ts | 4 ++-- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/superset-frontend/src/common/hooks/apiResources/apiResources.ts b/superset-frontend/src/common/hooks/apiResources/apiResources.ts index 7643b088a5..99504c7f31 100644 --- a/superset-frontend/src/common/hooks/apiResources/apiResources.ts +++ b/superset-frontend/src/common/hooks/apiResources/apiResources.ts @@ -144,7 +144,7 @@ export function useApiResourceFullBody( * @param transformFn a callback that transforms the result object into the shape you want. * Make sure to use a persistent function for this so it doesn't constantly recalculate! */ -export function useResourceTransform( +export function useTransformedResource( resource: Resource, transformFn: (result: IN) => OUT, ): Resource { @@ -161,7 +161,8 @@ export function useResourceTransform( } // returns the "result" field from a fetched API v1 endpoint -const innerResult = (responseBody: { result: T }) => responseBody.result; +const extractInnerResult = (responseBody: { result: T }) => + responseBody.result; /** * A general-purpose hook to fetch a Superset resource from a v1 API endpoint. @@ -173,8 +174,8 @@ const innerResult = (responseBody: { result: T }) => responseBody.result; * @param endpoint The url where the resource is located. */ export function useApiV1Resource(endpoint: string): Resource { - return useResourceTransform( + return useTransformedResource( useApiResourceFullBody<{ result: RESULT }>(endpoint), - innerResult, + extractInnerResult, ); } diff --git a/superset-frontend/src/common/hooks/apiResources/charts.ts b/superset-frontend/src/common/hooks/apiResources/charts.ts index f7525d8eec..8b5f109183 100644 --- a/superset-frontend/src/common/hooks/apiResources/charts.ts +++ b/superset-frontend/src/common/hooks/apiResources/charts.ts @@ -19,7 +19,7 @@ import rison from 'rison'; import Chart from 'src/types/Chart'; -import { useApiV1Resource, useResourceTransform } from './apiResources'; +import { useApiV1Resource, useTransformedResource } from './apiResources'; function extractOwnerNames({ owners }: Chart) { if (!owners) return null; @@ -32,7 +32,7 @@ const ownerNamesQuery = rison.encode({ }); export function useChartOwnerNames(chartId: string) { - return useResourceTransform( + return useTransformedResource( useApiV1Resource(`/api/v1/chart/${chartId}?q=${ownerNamesQuery}`), extractOwnerNames, ); diff --git a/superset-frontend/src/common/hooks/apiResources/index.ts b/superset-frontend/src/common/hooks/apiResources/index.ts index 6451f57c60..8befc73735 100644 --- a/superset-frontend/src/common/hooks/apiResources/index.ts +++ b/superset-frontend/src/common/hooks/apiResources/index.ts @@ -20,10 +20,10 @@ export { useApiResourceFullBody, useApiV1Resource, - useResourceTransform, + useTransformedResource, } from './apiResources'; -// A central catalog of API hooks. +// A central catalog of API Resource hooks. // Add new API hooks here, organized under // different files for different resource types. export { useChartOwnerNames } from './charts';