chore: deprecate /superset/slice_json/<int:slice_id> and /superset/an…

…notation_json/<int:layer_id> (#22496)
apache · Jan 27, 2023 · bed10a0 · bed10a0
1 parent 8226110
commit bed10a0
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 73 deletions.
diff --git a/superset-frontend/src/components/Chart/chartAction.js b/superset-frontend/src/components/Chart/chartAction.js
@@ -30,10 +30,7 @@ import {
   shouldUseLegacyApi,
   getChartDataUri,
 } from 'src/explore/exploreUtils';
-import {
-  requiresQuery,
-  ANNOTATION_SOURCE_TYPES,
-} from 'src/modules/AnnotationTypes';
+import { requiresQuery } from 'src/modules/AnnotationTypes';
 
 import { addDangerToast } from 'src/components/MessageToasts/actions';
 import { logEvent } from 'src/logger/actions';
@@ -290,26 +287,35 @@ export function runAnnotationQuery({
         : undefined;
     }
 
-    const isNative = annotation.sourceType === ANNOTATION_SOURCE_TYPES.NATIVE;
-    const url = getAnnotationJsonUrl(
-      annotation.value,
-      sliceFormData,
-      isNative,
-      force,
-    );
+    const url = getAnnotationJsonUrl(annotation.value, force);
     const controller = new AbortController();
     const { signal } = controller;
 
     dispatch(annotationQueryStarted(annotation, controller, sliceKey));
 
-    return SupersetClient.get({
+    const annotationIndex = fd?.annotation_layers?.findIndex(
+      it => it.name === annotation.name,
+    );
+    if (annotationIndex >= 0) {
+      fd.annotation_layers[annotationIndex].overrides = sliceFormData;
+    }
+
+    return SupersetClient.post({
       url,
       signal,
       timeout: timeout * 1000,
+      headers: { 'Content-Type': 'application/json' },
+      jsonPayload: buildV1ChartDataPayload({
+        formData: fd,
+        force,
+        resultFormat: 'json',
+        resultType: 'full',
+      }),
     })
-      .then(({ json }) =>
-        dispatch(annotationQuerySuccess(annotation, json, sliceKey)),
-      )
+      .then(({ json }) => {
+        const data = json?.result?.[0]?.annotation_data?.[annotation.name];
+        return dispatch(annotationQuerySuccess(annotation, { data }, sliceKey));
+      })
       .catch(response =>
         getClientErrorObject(response).then(err => {
           if (err.statusText === 'timeout') {

diff --git a/superset-frontend/src/explore/components/controls/AnnotationLayerControl/index.jsx b/superset-frontend/src/explore/components/controls/AnnotationLayerControl/index.jsx
@@ -71,7 +71,7 @@ class AnnotationLayerControl extends React.PureComponent {
   }
 
   componentDidMount() {
-    // preload the AnotationLayer component and dependent libraries i.e. mathjs
+    // preload the AnnotationLayer component and dependent libraries i.e. mathjs
     AnnotationLayer.preload();
   }
 

diff --git a/superset-frontend/src/explore/exploreUtils/getAnnotationJsonUrl.test.ts b/superset-frontend/src/explore/exploreUtils/getAnnotationJsonUrl.test.ts
diff --git a/superset-frontend/src/explore/exploreUtils/index.js b/superset-frontend/src/explore/exploreUtils/index.js
@@ -61,18 +61,16 @@ export function getHostName(allowDomainSharding = false) {
   return availableDomains[currentIndex];
 }
 
-export function getAnnotationJsonUrl(slice_id, form_data, isNative, force) {
+export function getAnnotationJsonUrl(slice_id, force) {
   if (slice_id === null || slice_id === undefined) {
     return null;
   }
+
   const uri = URI(window.location.search);
-  const endpoint = isNative ? 'annotation_json' : 'slice_json';
   return uri
-    .pathname(`/superset/${endpoint}/${slice_id}`)
+    .pathname('/api/v1/chart/data')
     .search({
-      form_data: safeStringify(form_data, (key, value) =>
-        value === null ? undefined : value,
-      ),
+      form_data: safeStringify({ slice_id }),
       force,
     })
     .toString();

diff --git a/superset/common/query_context_processor.py b/superset/common/query_context_processor.py
@@ -576,6 +576,7 @@ def get_viz_annotation_data(
         if not chart.datasource:
             raise QueryObjectValidationError(_("The chart datasource does not exist"))
         form_data = chart.form_data.copy()
+        form_data.update(annotation_layer.get("overrides", {}))
         try:
             viz_obj = get_viz(
                 datasource_type=chart.datasource.type,

diff --git a/superset/views/core.py b/superset/views/core.py
@@ -505,6 +505,7 @@ def generate_json(
     @expose("/slice_json/<int:slice_id>")
     @etag_cache()
     @check_resource_permissions(check_slice_perms)
+    @deprecated()
     def slice_json(self, slice_id: int) -> FlaskResponse:
         form_data, slc = get_form_data(slice_id, use_slice_data=True)
         if not slc:
@@ -528,6 +529,7 @@ def slice_json(self, slice_id: int) -> FlaskResponse:
     @has_access_api
     @event_logger.log_this
     @expose("/annotation_json/<int:layer_id>")
+    @deprecated()
     def annotation_json(  # pylint: disable=no-self-use
         self, layer_id: int
     ) -> FlaskResponse: