chore: remove deprecated apis and ENABLE_BROAD_ACTIVITY_ACCESS #24400

dpgaspar · 2023-06-14T14:57:20Z

SUMMARY

Removes old deprecated APIs:

/superset/recent_activity/...
/superset/fave_dashboards_by_username/...
/superset/fave_dashboards/...
/superset/created_dashboards/...
/superset/user_slices/...
/superset/created_slices/...
/superset/fave_slices/...
/superset/favstar/...

This PR also removes ENABLE_BROAD_ACTIVITY_ACCESS feature flag (was disabled by default), since by removing the above mentioned deprecated API's only one final API ( /api/v1/log/recent_activity/ ) was using it.
Also removes changed_by_url and created_by_url REST API response fields from datasets, dashboards and charts, since these fields function was to provide a link to other user's profiles.

Effort on removing deprecated APIs from /superset: #24332

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 · 2023-06-14T16:35:03Z

Codecov Report

Merging #24400 (a12e019) into master (19a9400) will decrease coverage by 0.05%.
The diff coverage is 91.48%.

❗ Current head a12e019 differs from pull request most recent head 63ea2bd. Consider uploading reports for the commit 63ea2bd to get more accurate results

@@            Coverage Diff             @@
##           master   #24400      +/-   ##
==========================================
- Coverage   68.95%   68.91%   -0.05%     
==========================================
  Files        1903     1904       +1     
  Lines       74070    73913     -157     
  Branches     8110     8118       +8     
==========================================
- Hits        51077    50939     -138     
+ Misses      20881    20864      -17     
+ Partials     2112     2110       -2

Flag	Coverage Δ
hive	`53.92% <68.75%> (+0.05%)`	⬆️
javascript	`55.65% <87.09%> (+0.02%)`	⬆️
mysql	`79.20% <100.00%> (-0.06%)`	⬇️
postgres	`79.29% <100.00%> (-0.05%)`	⬇️
presto	`53.85% <68.75%> (+0.05%)`	⬆️
python	`83.28% <100.00%> (-0.04%)`	⬇️
sqlite	`77.79% <100.00%> (-0.05%)`	⬇️
unit	`54.62% <68.75%> (+0.06%)`	⬆️

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

Impacted Files	Coverage Δ
...ackages/superset-ui-core/src/utils/featureFlags.ts	`100.00% <ø> (ø)`
...acy-preset-chart-deckgl/src/components/Tooltip.tsx	`0.00% <0.00%> (ø)`
...lugins/plugin-chart-table/src/utils/formatValue.ts	`66.66% <0.00%> (-3.93%)`	⬇️
superset-frontend/src/SqlLab/fixtures.ts	`100.00% <ø> (ø)`
...c/components/Chart/DrillDetail/DrillDetailPane.tsx	`75.32% <ø> (ø)`
...-frontend/src/components/TableCollection/index.tsx	`100.00% <ø> (ø)`
...mponents/DataTablesPane/components/SamplesPane.tsx	`97.67% <ø> (ø)`
...ataTablesPane/components/SingleQueryResultPane.tsx	`85.71% <ø> (ø)`
superset-frontend/src/pages/DatasetList/index.tsx	`57.76% <ø> (ø)`
...rset-frontend/src/profile/components/Favorites.tsx	`80.00% <ø> (ø)`
... and 22 more

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

john-bodley

Thanks for the cleanup. I left a couple of comments, but otherwise LGTM.

superset/views/core.py

john-bodley · 2023-06-15T00:03:53Z

superset/views/core.py

        payload = {
-            "user": bootstrap_user_data(user, include_perms=True),
+            "user": bootstrap_user_data(g.user, include_perms=True),


@dpgaspar what happens if the user is a guest user? Is g.user guaranteed to exist and be non-None.

Good point, it should be AnonymousUser from flask-login or GuestUser, but added some safe guard, and we're returning 404 now

superset/views/log/api.py

villebro

LGTM

villebro · 2023-06-15T12:43:15Z

superset/views/core.py

-    @expose("/profile/<username>/")
-    def profile(self, username: str) -> FlaskResponse:
+    @expose("/profile/")
+    def profile(self) -> FlaskResponse:


villebro · 2023-06-15T12:45:25Z

superset/views/core.py

-        if error_obj := self.get_user_activity_access_error(user_id):
-            return error_obj
-
+        user = g.user if hasattr(g, "user") and g.user else None


I think this snippet or a variation of it appears in LOTS of places. We should replace all of these with a single util to DRY this up and add tests for all expected cases. I can do it if needed (I think this PR is big enough already, so it should not be obfuscated with more chores).

totally agree! would be great also to make anonymous users and guest user's more clear to check, use and test

@villebro having a get_user method here—which get_user_id and get_username would call—would be useful. I did a pass previously in #20492 which ensured facets of this was normalized.

john-bodley

LGTM

john-bodley · 2023-06-15T19:01:46Z

superset/views/core.py

-        if error_obj := self.get_user_activity_access_error(user_id):
-            return error_obj
-
+        user = g.user if hasattr(g, "user") and g.user else None


@villebro having a get_user method here—which get_user_id and get_username would call—would be useful. I did a pass previously in #20492 which ensured facets of this was normalized.

chore: remove deprecated apis on superset

dfee0fc

pull-request-size bot added the size/XL label Jun 14, 2023

dpgaspar changed the title ~~chore: remove deprecated apis on superset~~ chore: remove deprecated apis on superset Jun 14, 2023

fix lint and tests

4bcfb35

eschutho added the risk:breaking-change Issues or PRs that will introduce breaking changes label Jun 14, 2023

dpgaspar added 3 commits June 14, 2023 22:06

fix test

548e416

Merge branch 'master' into chore/remove-deprecated-apis-11

f90fe74

remove ENABLE_BROAD_ACTIVITY_ACCESS

3e21fed

dpgaspar changed the title ~~chore: remove deprecated apis on superset~~ chore: remove deprecated apis and ENABLE_BROAD_ACTIVITY_ACCESS Jun 14, 2023

more removal

e50b6db

dpgaspar requested review from michael-s-molina, geido, villebro, john-bodley and eschutho June 14, 2023 23:26

john-bodley reviewed Jun 15, 2023

View reviewed changes

address comments, add anonymous and guest cases on profile

fbd8ddb

dpgaspar requested a review from john-bodley June 15, 2023 01:18

dpgaspar added 2 commits June 15, 2023 02:27

fix lint

7c824aa

remove created_by_url

63ea2bd

villebro approved these changes Jun 15, 2023

View reviewed changes

john-bodley approved these changes Jun 15, 2023

View reviewed changes

dpgaspar merged commit 23bb1c4 into apache:master Jun 15, 2023
31 checks passed

dpgaspar deleted the chore/remove-deprecated-apis-11 branch June 15, 2023 21:11

iamzoltan mentioned this pull request Jun 16, 2023

/api/v1/log/recent_activity/1/?q=(page_size:6) does not return recent activity #24414

Closed

3 tasks

dpgaspar mentioned this pull request Jun 16, 2023

fix: FE call to changed recent_activity endpoint #24420

Merged

9 tasks

mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 3.0.0 labels Mar 8, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: remove deprecated apis and ENABLE_BROAD_ACTIVITY_ACCESS #24400

chore: remove deprecated apis and ENABLE_BROAD_ACTIVITY_ACCESS #24400

dpgaspar commented Jun 14, 2023 •

edited

Loading

codecov bot commented Jun 14, 2023 •

edited

Loading

john-bodley left a comment

john-bodley Jun 15, 2023

dpgaspar Jun 15, 2023

villebro left a comment

villebro Jun 15, 2023

villebro Jun 15, 2023

dpgaspar Jun 15, 2023

john-bodley Jun 15, 2023 •

edited

Loading

john-bodley left a comment

john-bodley Jun 15, 2023 •

edited

Loading

chore: remove deprecated apis and ENABLE_BROAD_ACTIVITY_ACCESS #24400

chore: remove deprecated apis and ENABLE_BROAD_ACTIVITY_ACCESS #24400

Conversation

dpgaspar commented Jun 14, 2023 • edited Loading

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

codecov bot commented Jun 14, 2023 • edited Loading

Codecov Report

john-bodley left a comment

Choose a reason for hiding this comment

john-bodley Jun 15, 2023

Choose a reason for hiding this comment

dpgaspar Jun 15, 2023

Choose a reason for hiding this comment

villebro left a comment

Choose a reason for hiding this comment

villebro Jun 15, 2023

Choose a reason for hiding this comment

villebro Jun 15, 2023

Choose a reason for hiding this comment

dpgaspar Jun 15, 2023

Choose a reason for hiding this comment

john-bodley Jun 15, 2023 • edited Loading

Choose a reason for hiding this comment

john-bodley left a comment

Choose a reason for hiding this comment

john-bodley Jun 15, 2023 • edited Loading

Choose a reason for hiding this comment

dpgaspar commented Jun 14, 2023 •

edited

Loading

codecov bot commented Jun 14, 2023 •

edited

Loading

john-bodley Jun 15, 2023 •

edited

Loading

john-bodley Jun 15, 2023 •

edited

Loading