fix: remove standalone #18157

AAfghahi · 2022-01-25T02:17:13Z

SUMMARY

Having standalone 3 in the url prevented tabbed dashboards from showing in a report.

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

tests/integration_tests/reports/commands_tests.py

codecov · 2022-01-25T04:05:26Z

Codecov Report

Merging #18157 (e667c12) into master (fa104fe) will decrease coverage by 0.07%.
The diff coverage is 85.09%.

❗ Current head e667c12 differs from pull request most recent head 8c7e2f8. Consider uploading reports for the commit 8c7e2f8 to get more accurate results

@@            Coverage Diff             @@
##           master   #18157      +/-   ##
==========================================
- Coverage   65.95%   65.87%   -0.08%     
==========================================
  Files        1584     1591       +7     
  Lines       62063    62409     +346     
  Branches     6273     6283      +10     
==========================================
+ Hits        40934    41114     +180     
- Misses      19508    19674     +166     
  Partials     1621     1621

Flag	Coverage Δ
hive	`?`
mysql	`81.28% <92.21%> (+0.09%)`	⬆️
postgres	`81.32% <92.21%> (+0.09%)`	⬆️
presto	`?`
python	`81.41% <92.21%> (-0.26%)`	⬇️
sqlite	`81.02% <92.21%> (+0.10%)`	⬆️

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

Impacted Files	Coverage Δ
.../superset-ui-core/src/connection/SupersetClient.ts	`100.00% <ø> (ø)`
...ackages/superset-ui-core/src/utils/featureFlags.ts	`100.00% <ø> (ø)`
superset-frontend/src/embedded/index.tsx	`0.00% <0.00%> (ø)`
...rc/explore/components/controls/TextAreaControl.jsx	`80.00% <0.00%> (-4.22%)`	⬇️
superset-frontend/src/preamble.ts	`0.00% <ø> (ø)`
superset-frontend/src/setup/setupClient.ts	`0.00% <0.00%> (ø)`
superset-frontend/src/views/App.tsx	`0.00% <0.00%> (ø)`
...perset-frontend/src/views/RootContextProviders.tsx	`0.00% <0.00%> (ø)`
superset/views/core.py	`77.74% <0.00%> (ø)`
superset/views/dashboard/views.py	`65.16% <46.15%> (-4.07%)`	⬇️
... and 38 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fa104fe...8c7e2f8. Read the comment docs.

AAfghahi · 2022-01-25T15:32:10Z

/testenv up FEATURE_ALERT_REPORTS=True

github-actions · 2022-01-25T15:45:19Z

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

betodealmeida

Looks good! The signature of the function has incorrect types (there should be no Optional), but I also thought of a way of making the function more generic which might be good.

betodealmeida · 2022-01-25T22:50:16Z

superset/utils/urls.py

@@ -33,3 +33,12 @@ def headless_url(path: str, user_friendly: bool = False) -> str:
 def get_url_path(view: str, user_friendly: bool = False, **kwargs: Any) -> str:
    with current_app.test_request_context():
        return headless_url(url_for(view, **kwargs), user_friendly=user_friendly)
+
+
+def get_screenshot_explorelink(url: Optional[str]) -> Optional[str]:


Can you add a docstring to the function explaining what it does? As for types, it's better to have the signature be (url: str) -> str:, otherwise you need to handle the case where url is None.

One thing I was thinking is that since this function is currently very specific we could make it a bit more generic, so it has utility outside of your use case. Eg:

def modify_url_query(url: str, **kwargs: Any) -> str: """ Replace or add parameters to a URL. """ parts = list(urllib.parse.urlsplit(url)) params = urllib.parse.parse_qs(parts[3]) for k, v in kwargs.items(): if not isinstance(v, list): v = [v] params[k] = v parts[3] = "&".join(f"{k}={urllib.parse.quote(v[0])}" for k, v in params.items()) return urllib.parse.urlunsplit(parts)

Then you can call it for your use case as:

url = modify_url_query(self._content.url, standalone='0')

ok I think that is a cool generic function, thank you! When I had (url: string) -> string I got a type error, and since i was rushing against the cherry deadline I made it optional, will change back and think it through. Thank you!

If you had an error with (url: str) -> str it means that in some place the function was potentially being called with a non-string value (probably None, since you fixed it by adding Optional). Since your original function did not handle the case when the argument was not a string, this means that at some point the code would break.

In other words, if your function has a signature (url: Optional[str]) it should be able to handle being passed url=None. But more importantly, the types in the signature should make sense — would we ever want to pass None as a URL to a function that changes parameters in the URL?

The proper way to fix the type checking is not relaxing the signature, but adding guards to the code:

if url is not None: explore_url = get_screenshot_explorelink(url)

I was thinking of adding an exception into the modify_url_query function, but this feels like it would look better in the email.

Since we do end up using the URL in the email body later I was thinking that we could do this:

url = "" if self._content.url is not None: url = modify_url_query(self._content.url, standalone="0")

The code before was using self._content.url into the email. so if we were invoking None, would it be the same as invoking an empty string?

betodealmeida

Awesome!

superset/reports/notifications/email.py

Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>

github-actions · 2022-01-26T18:04:48Z

Ephemeral environment shutdown and build artifacts deleted.

* removed standalone * Update tests/integration_tests/reports/commands_tests.py * changed standalone * added tests * made function more generic * Update superset/reports/notifications/email.py Co-authored-by: Beto Dealmeida <roberto@dealmeida.net> Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>

pull-request-size bot added the size/XS label Jan 25, 2022

AAfghahi force-pushed the ch35037_reportUrl branch from a24bfbc to fc41151 Compare January 25, 2022 02:25

removed standalone

e83a9b8

AAfghahi force-pushed the ch35037_reportUrl branch from fc41151 to e83a9b8 Compare January 25, 2022 03:25

AAfghahi commented Jan 25, 2022

View reviewed changes

tests/integration_tests/reports/commands_tests.py Outdated Show resolved Hide resolved

Update tests/integration_tests/reports/commands_tests.py

3e75c14

AAfghahi added 2 commits January 25, 2022 12:41

changed standalone

ca2b881

changed standalone

602ebba

pull-request-size bot added size/M and removed size/XS labels Jan 25, 2022

AAfghahi force-pushed the ch35037_reportUrl branch 4 times, most recently from b702980 to 43b26ce Compare January 25, 2022 22:11

added tests

565e2c1

AAfghahi force-pushed the ch35037_reportUrl branch from 43b26ce to 565e2c1 Compare January 25, 2022 22:16

betodealmeida self-requested a review January 25, 2022 22:26

betodealmeida requested changes Jan 25, 2022

View reviewed changes

AAfghahi force-pushed the ch35037_reportUrl branch 2 times, most recently from 2760891 to f0b74be Compare January 26, 2022 16:52

made function more generic

89d7e58

AAfghahi force-pushed the ch35037_reportUrl branch from f0b74be to 89d7e58 Compare January 26, 2022 17:29

betodealmeida approved these changes Jan 26, 2022

View reviewed changes

superset/reports/notifications/email.py Outdated Show resolved Hide resolved

Update superset/reports/notifications/email.py

8c7e2f8

Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>

AAfghahi force-pushed the ch35037_reportUrl branch from 705b344 to 8c7e2f8 Compare January 26, 2022 17:42

AAfghahi merged commit fa11a97 into apache:master Jan 26, 2022

hughhhh mentioned this pull request Feb 16, 2022

fix: update standalone url for slack reports #18756

Merged

9 tasks

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: remove standalone #18157

fix: remove standalone #18157

AAfghahi commented Jan 25, 2022

codecov bot commented Jan 25, 2022 •

edited

AAfghahi commented Jan 25, 2022

github-actions bot commented Jan 25, 2022

betodealmeida left a comment

betodealmeida Jan 25, 2022

AAfghahi Jan 26, 2022

betodealmeida Jan 26, 2022

AAfghahi Jan 26, 2022

AAfghahi Jan 26, 2022 •

edited

betodealmeida left a comment

github-actions bot commented Jan 26, 2022

fix: remove standalone #18157

fix: remove standalone #18157

Conversation

AAfghahi commented Jan 25, 2022

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

codecov bot commented Jan 25, 2022 • edited

Codecov Report

AAfghahi commented Jan 25, 2022

github-actions bot commented Jan 25, 2022

betodealmeida left a comment

Choose a reason for hiding this comment

betodealmeida Jan 25, 2022

Choose a reason for hiding this comment

AAfghahi Jan 26, 2022

Choose a reason for hiding this comment

betodealmeida Jan 26, 2022

Choose a reason for hiding this comment

AAfghahi Jan 26, 2022

Choose a reason for hiding this comment

AAfghahi Jan 26, 2022 • edited

Choose a reason for hiding this comment

betodealmeida left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 26, 2022

codecov bot commented Jan 25, 2022 •

edited

AAfghahi Jan 26, 2022 •

edited