chore: deprecate /superset/slice_json/<int:slice_id> and /superset/annotation_json/<int:layer_id>

[diegomedina248]

SUMMARY

Continuing the effort on deprecating all /superset/ REST API endpoints
Deprecates /superset/slice_json/<int:layer_id>
Deprecates /superset/annotation_json/<int:layer_id>

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

• Has associated issue:
• Required feature flags:
• Changes UI
• Includes DB Migration (follow approval process in SIP-59)
  • Migration is atomic, supports rollback & is backwards-compatible
  • Confirm DB migration upgrade and downgrade tested
  • Runtime estimates and downtime expectations provided
• Introduces new feature or API
• Removes existing feature or API

[codecov]

Codecov Report

Merging #22496 (065b288) into master (02a3c0d) will decrease coverage by 0.01%.
The diff coverage is 18.18%.

@@            Coverage Diff             @@
##           master   #22496      +/-   ##
==========================================
- Coverage   67.28%   67.27%   -0.01%     
==========================================
  Files        1877     1877              
  Lines       72023    72028       +5     
  Branches     7897     7897              
==========================================
- Hits        48461    48459       -2     
- Misses      21534    21541       +7     
  Partials     2028     2028              

Flag	Coverage Δ
hive	52.60% <66.66%> (+<0.01%)	⬆️
javascript	53.84% <0.00%> (-0.02%)	⬇️
mysql	78.56% <66.66%> (-0.01%)	⬇️
postgres	78.63% <66.66%> (-0.01%)	⬇️
presto	52.49% <66.66%> (+<0.01%)	⬆️
python	81.89% <66.66%> (-0.01%)	⬇️
sqlite	76.99% <66.66%> (-0.01%)	⬇️
unit	51.55% <66.66%> (+<0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...erset-frontend/src/components/Chart/chartAction.js	55.34% <0.00%> (-1.43%)	⬇️
...mponents/controls/AnnotationLayerControl/index.jsx	9.67% <ø> (ø)
...uperset-frontend/src/explore/exploreUtils/index.js	78.76% <ø> (-2.11%)	⬇️
superset/common/query_context_processor.py	88.28% <0.00%> (-0.38%)	⬇️
superset/views/core.py	75.07% <100.00%> (+0.03%)	⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[dpgaspar]

Looks good, but I don't have a lot of context here

[EugeneTorap]

LGTM!
We should try to deprecate /superset/explore_json/ API in superset-frontend/packages/superset-ui-core/src/chart/clients/ChartClient.ts:112 and use only /api/v1/chart/data for all viz of chart.

[villebro]

Wow! While we're at it, I think we should try to burn the following code, as it's mostly just neeeded for annotation layers, as the table viz migrated to v1 chart data endpoint a long time ago:

superset/superset/viz.py

Lines 690 to 838 in d479009

	class TableViz(BaseViz):
	"""A basic html table that is sortable and searchable"""
	viz_type = "table"
	verbose_name = _("Table View")
	credits = 'a <a href="https://github.com/airbnb/superset">Superset</a> original'
	is_timeseries = False
	enforce_numerical_metrics = False
	def process_metrics(self) -> None:
	"""Process form data and store parsed column configs.
	1. Determine query mode based on form_data params.
	- Use `query_mode` if it has a valid value
	- Set as RAW mode if `all_columns` is set
	- Otherwise defaults to AGG mode
	2. Determine output columns based on query mode.
	"""
	# Verify form data first: if not specifying query mode, then cannot have both
	# GROUP BY and RAW COLUMNS.
	if (
	not self.form_data.get("query_mode")
	and self.form_data.get("all_columns")
	and (
	self.form_data.get("groupby")
	or self.form_data.get("metrics")
	or self.form_data.get("percent_metrics")
	)
	):
	raise QueryObjectValidationError(
	_(
	"You cannot use [Columns] in combination with "
	"[Group By]/[Metrics]/[Percentage Metrics]. "
	"Please choose one or the other."
	)
	)
	super().process_metrics()
	self.query_mode: QueryMode = QueryMode.get(
	self.form_data.get("query_mode")
	) or (
	# infer query mode from the presence of other fields
	QueryMode.RAW
	if len(self.form_data.get("all_columns") or []) > 0
	else QueryMode.AGGREGATE
	)
	columns: List[str] # output columns sans time and percent_metric column
	percent_columns: List[str] = [] # percent columns that needs extra computation
	if self.query_mode == QueryMode.RAW:
	columns = get_metric_names(self.form_data.get("all_columns"))
	else:
	columns = get_column_names(self.groupby) + get_metric_names(
	self.form_data.get("metrics")
	)
	percent_columns = get_metric_names(
	self.form_data.get("percent_metrics") or []
	)
	self.columns = columns
	self.percent_columns = percent_columns
	self.is_timeseries = self.should_be_timeseries()
	def should_be_timeseries(self) -> bool:
	# TODO handle datasource-type-specific code in datasource
	conditions_met = (
	self.form_data.get("granularity")
	and self.form_data.get("granularity") != "all"
	) or (
	self.form_data.get("granularity_sqla")
	and self.form_data.get("time_grain_sqla")
	)
	if self.form_data.get("include_time") and not conditions_met:
	raise QueryObjectValidationError(
	_("Pick a granularity in the Time section or " "uncheck 'Include Time'")
	)
	return bool(self.form_data.get("include_time"))
	def query_obj(self) -> QueryObjectDict:
	query_obj = super().query_obj()
	if self.query_mode == QueryMode.RAW:
	query_obj["columns"] = self.form_data.get("all_columns")
	order_by_cols = self.form_data.get("order_by_cols") or []
	query_obj["orderby"] = [json.loads(t) for t in order_by_cols]
	# must disable groupby and metrics in raw mode
	query_obj["groupby"] = []
	query_obj["metrics"] = []
	# raw mode does not support timeseries queries
	query_obj["timeseries_limit_metric"] = None
	query_obj["timeseries_limit"] = None
	query_obj["is_timeseries"] = None
	else:
	sort_by = self.form_data.get("timeseries_limit_metric")
	if sort_by:
	sort_by_label = utils.get_metric_name(sort_by)
	if sort_by_label not in utils.get_metric_names(query_obj["metrics"]):
	query_obj["metrics"].append(sort_by)
	query_obj["orderby"] = [
	(sort_by, not self.form_data.get("order_desc", True))
	]
	elif query_obj["metrics"]:
	# Legacy behavior of sorting by first metric by default
	first_metric = query_obj["metrics"][0]
	query_obj["orderby"] = [
	(first_metric, not self.form_data.get("order_desc", True))
	]
	return query_obj
	def get_data(self, df: pd.DataFrame) -> VizData:
	"""
	Transform the query result to the table representation.
	:param df: The interim dataframe
	:returns: The table visualization data
	The interim dataframe comprises of the group-by and non-group-by columns and
	the union of the metrics representing the non-percent and percent metrics. Note
	the percent metrics have yet to be transformed.
	"""
	# Transform the data frame to adhere to the UI ordering of the columns and
	# metrics whilst simultaneously computing the percentages (via normalization)
	# for the percent metrics.
	if df.empty:
	return None
	columns, percent_columns = self.columns, self.percent_columns
	if DTTM_ALIAS in df and self.is_timeseries:
	columns = [DTTM_ALIAS] + columns
	df = pd.concat(
	[
	df[columns],
	(df[percent_columns].div(df[percent_columns].sum()).add_prefix("%")),
	],
	axis=1,
	)
	return self.handle_js_int_overflow(
	dict(records=df.to_dict(orient="records"), columns=list(df.columns))
	)
	@staticmethod
	def json_dumps(query_obj: Any, sort_keys: bool = False) -> str:
	return json.dumps(
	query_obj,
	default=utils.json_iso_dttm_ser,
	sort_keys=sort_keys,
	ignore_nan=True,
	)

I think you need to do a few changes here, but it should be fairly straight forward:

superset/superset/common/query_context_processor.py

Lines 569 to 589 in d479009

	@staticmethod
	def get_viz_annotation_data(
	annotation_layer: Dict[str, Any], force: bool
	) -> Dict[str, Any]:
	chart = ChartDAO.find_by_id(annotation_layer["value"])
	if not chart:
	raise QueryObjectValidationError(_("The chart does not exist"))
	if not chart.datasource:
	raise QueryObjectValidationError(_("The chart datasource does not exist"))
	form_data = chart.form_data.copy()
	try:
	viz_obj = get_viz(
	datasource_type=chart.datasource.type,
	datasource_id=chart.datasource.id,
	form_data=form_data,
	force=force,
	)
	payload = viz_obj.get_payload()
	return payload["data"]
	except SupersetException as ex:
	raise QueryObjectValidationError(error_msg_from_exception(ex)) from ex

Please ping me on Slack if you need help. If we go this extra mile, we'll be killing a HUGE amount of tech debt in one go! 🚀

[villebro]

Actually, come to think of it, my proposed changes are breaking, so we need to hold off on them until we cut the 3.0 release. So LGTM!

[geido]

/testenv up

[github-actions]

@geido Ephemeral environment spinning up at http://35.86.158.208:8080. Credentials are admin/admin. Please allow several minutes for bootstrapping and startup.

[geido]

LGTM!

[github-actions]

Ephemeral environment shutdown and build artifacts deleted.