forked from apache/superset
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add ChartClient
- Loading branch information
Showing
12 changed files
with
422 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,138 @@ | ||
import { isDefined } from '@superset-ui/core'; | ||
import { | ||
SupersetClient, | ||
RequestConfig, | ||
SupersetClientClass, | ||
SupersetClientResponse, | ||
Json, | ||
} from '@superset-ui/connection'; | ||
import getChartBuildQueryRegistry from '../registries/ChartBuildQueryRegistrySingleton'; | ||
import { FormData, AnnotationLayerMetadata } from '../query/FormData'; | ||
|
||
interface SliceIdAndOrFormData { | ||
sliceId?: number; | ||
formData?: FormData; | ||
} | ||
|
||
interface AnnotationData { | ||
[key: string]: object; | ||
} | ||
|
||
interface ChartData { | ||
annotationData: AnnotationData; | ||
datasource: object; | ||
formData: FormData; | ||
queryData: object; | ||
} | ||
|
||
export interface ChartClientConfig { | ||
client?: SupersetClientClass; | ||
} | ||
|
||
export class ChartClient { | ||
readonly client: { | ||
get: (config: RequestConfig) => Promise<SupersetClientResponse>; | ||
post: (config: RequestConfig) => Promise<SupersetClientResponse>; | ||
}; | ||
|
||
constructor(config: ChartClientConfig = {}) { | ||
const { client = SupersetClient } = config; | ||
this.client = client; | ||
} | ||
|
||
loadFormData(input: SliceIdAndOrFormData, options?: RequestConfig): Promise<FormData> { | ||
/* If sliceId is provided, use it to fetch stored formData from API */ | ||
if (input.sliceId) { | ||
const promise = this.client | ||
.get({ | ||
endpoint: `/api/v1/formData/?slice_id=${input.sliceId}`, | ||
...options, | ||
} as RequestConfig) | ||
.then(response => response.json as Json) | ||
.then(json => json.form_data); | ||
|
||
/* | ||
* If formData is also specified, override API result | ||
* with user-specified formData | ||
*/ | ||
return input.formData | ||
? promise.then( | ||
(dbFormData: object) => | ||
({ | ||
...dbFormData, | ||
...input.formData, | ||
} as FormData), | ||
) | ||
: promise.then((dbFormData: object) => dbFormData as FormData); | ||
} | ||
|
||
/* If sliceId is not provided, returned formData wrapped in a Promise */ | ||
return input.formData | ||
? Promise.resolve(input.formData) | ||
: Promise.reject(new Error('At least one of sliceId or formData must be specified')); | ||
} | ||
|
||
loadQueryData(formData: FormData, options?: RequestConfig): Promise<object> { | ||
const buildQuery = getChartBuildQueryRegistry().get(formData.viz_type); | ||
if (buildQuery) { | ||
return this.client | ||
.post({ | ||
endpoint: '/api/v1/query/', | ||
postPayload: { query_context: buildQuery(formData) }, | ||
...options, | ||
} as RequestConfig) | ||
.then(response => response.json as Json); | ||
} | ||
|
||
return Promise.reject(new Error(`Unknown chart type: ${formData.viz_type}`)); | ||
} | ||
|
||
loadDatasource(datasourceKey: string, options?: RequestConfig): Promise<object> { | ||
return this.client | ||
.get({ | ||
endpoint: `/superset/fetch_datasource_metadata?datasourceKey=${datasourceKey}`, | ||
...options, | ||
} as RequestConfig) | ||
.then(response => response.json as Json); | ||
} | ||
|
||
loadAnnotation(annotationLayer: AnnotationLayerMetadata): Promise<object> { | ||
/* When annotation does not require query */ | ||
if (!isDefined(annotationLayer.sourceType)) { | ||
return Promise.resolve({}); | ||
} | ||
|
||
// TODO: Implement | ||
return Promise.reject(new Error('This feature is not implemented yet.')); | ||
} | ||
|
||
loadAnnotations(annotationLayers?: Array<AnnotationLayerMetadata>): Promise<AnnotationData> { | ||
if (Array.isArray(annotationLayers) && annotationLayers.length > 0) { | ||
return Promise.all(annotationLayers.map(layer => this.loadAnnotation(layer))).then(results => | ||
annotationLayers.reduce((prev, layer, i) => { | ||
const output: AnnotationData = prev; | ||
output[layer.name] = results[i]; | ||
|
||
return output; | ||
}, {}), | ||
); | ||
} | ||
|
||
return Promise.resolve({}); | ||
} | ||
|
||
loadChartData(input: SliceIdAndOrFormData): Promise<ChartData> { | ||
return this.loadFormData(input).then(formData => | ||
Promise.all([ | ||
this.loadAnnotations(formData.annotation_layers), | ||
this.loadDatasource(formData.datasource), | ||
this.loadQueryData(formData), | ||
]).then(([annotationData, datasource, queryData]) => ({ | ||
annotationData, | ||
datasource, | ||
formData, | ||
queryData, | ||
})), | ||
); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.