feat: Use SPA navigation from datasets list to Explore #20890

kgabryje · 2022-07-27T15:08:33Z

SUMMARY

This PR implements SPA navigation in Datasets list. By default, clicking on dataset's name opens Explore, but user can override it with some external URL. Default react-router Link component can't handle external URLs, so I implemented a GenericLink component, which check if URL is external - if it does, use HTML anchor element, else use react-router Link.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Screen.Recording.2022-07-29.at.14.20.16.mov

TESTING INSTRUCTIONS

Open datasets list
Click dataset's name, verify that Explore opens
Go back to datasets list, click "Edit" -> tab "Settings" -> set some external URL in "Default URL" field (like "https://google.com" or whatever) -> Save
Click dataset's name, verify that external URL opens

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 · 2022-07-27T16:28:05Z

Codecov Report

Merging #20890 (09db402) into master (77db065) will increase coverage by 0.06%.
The diff coverage is 84.61%.

@@            Coverage Diff             @@
##           master   #20890      +/-   ##
==========================================
+ Coverage   66.25%   66.31%   +0.06%     
==========================================
  Files        1758     1759       +1     
  Lines       67048    67009      -39     
  Branches     7118     7112       -6     
==========================================
+ Hits        44423    44440      +17     
+ Misses      20808    20745      -63     
- Partials     1817     1824       +7

Flag	Coverage Δ
javascript	`52.02% <84.61%> (+0.10%)`	⬆️

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

Impacted Files	Coverage Δ
superset-frontend/src/utils/urlUtils.ts	`50.90% <75.00%> (+4.10%)`	⬆️
...rontend/src/components/GenericLink/GenericLink.tsx	`100.00% <100.00%> (ø)`
...ontend/src/views/CRUD/data/dataset/DatasetList.tsx	`56.20% <100.00%> (ø)`
...rontend/src/components/ListView/Filters/Select.tsx	`52.38% <0.00%> (-2.62%)`	⬇️
superset-frontend/src/reports/actions/reports.js	`39.39% <0.00%> (ø)`
...et-frontend/src/components/TableSelector/index.tsx	`76.08% <0.00%> (ø)`
...et-frontend/src/dashboard/actions/sliceEntities.js	`74.28% <0.00%> (ø)`
...t-frontend/src/dashboard/components/SliceAdder.jsx	`62.66% <0.00%> (ø)`
...t-frontend/src/filters/components/GroupBy/types.ts	`100.00% <0.00%> (ø)`
...frontend/src/components/DatabaseSelector/index.tsx	`88.88% <0.00%> (ø)`
... and 9 more

Help us with your feedback. Take ten seconds to tell us how you rate us.

michael-s-molina

Thanks for the PR @kgabryje. I left some first-pass comments.

michael-s-molina · 2022-07-28T13:29:28Z

superset-frontend/src/components/GenericLink/GenericLink.tsx

+  innerRef,
+  children,
+  ...rest
+}: // css prop type check was failing, override with any


The type of Link properties is not LinkProps but React.PropsWithoutRef<LinkProps<S>> & React.RefAttributes<HTMLAnchorElement>.

To fix the Typescript error, you can define your component like:

export const GenericLink = <S,>({ to, component, replace, innerRef, children, ...rest }: React.PropsWithoutRef<LinkProps<S>> & React.RefAttributes<HTMLAnchorElement>) => { ... }

michael-s-molina · 2022-07-28T13:31:39Z

superset-frontend/src/components/GenericLink/GenericLink.tsx

+  ...rest
+}: // css prop type check was failing, override with any
+LinkProps & { css?: any }) => {
+  if (typeof to === 'string' && /^https?:\/\//.test(to)) {


I think we need to improve the algorithm to detect internal and external URLs. If we type www.google.com without the https then it breaks. I'm not sure if we already have something similar in the codebase or if we need to find an npm package for this.

True. Found some more complex regex, I'll use that one instead + some unit tests

Actually that's not really a valid concern in this case. URL passed to <a> must have a protocol prefix, otherwise it's appended to current pathname. In such case it doesn't matter if we use <a> or <Link>.

You can design the component with the protocol restriction, but then we need to handle the problem elsewhere because it will be really common to have users type the URL without the protocol. In this case, when they click on the dataset nothing happens.

Yeah I see your point. However, I'm wondering if that should be considered a separate bug. Currently, if you type "www.google.com" in default url field, the link would redirect you to http://localhost:9000/tablemodelview/list/www.google.com.
This PR, even with more foolproof external url detection, wouldn't change that behaviour - we'd still get an <a> element linking to http://localhost:9000/tablemodelview/list/www.google.com.
I'd propose adding external URL detection in this PR (even though it wouldn't really do anything) and handling external links without protocol in a separate PR

This PR, even with more foolproof external url detection, wouldn't change that behaviour - we'd still get an element linking to http://localhost:9000/tablemodelview/list/www.google.com.

I was thinking that upon detecting www.google.com as an external link without a protocol, then the component would add the protocol automatically, setting the <a> tag to http://www.google.com. Of course, we can implement this outside of the component but in that case we would need to always call the helper function before using the component.

Done :)

Screen.Recording.2022-07-29.at.14.20.16.mov

michael-s-molina

Thank you so much for addressing the comments. The added tests are great!

michael-s-molina · 2022-07-29T18:24:39Z

superset-frontend/src/components/GenericLink/GenericLink.tsx

    return (
-      <a data-test="external-link" href={to} {...rest}>
+      <a data-test="external-link" href={parseUrl(to)} {...rest}>


Small suggestion for a follow-up: You could return the parsed value when it's valid and undefined or another thing when it's invalid. That way you would only need to apply the regex once by combining isUrlExternal with parseUrl.

Good point! I'll do that in a separate PR

EugeneTorap · 2022-08-02T06:34:52Z

Hi @kgabryje. Dataset links don't work in SPA in Dataset column on Charts page

EugeneTorap · 2022-08-02T06:56:01Z

Also in Dashboard

EugeneTorap · 2022-08-02T06:56:37Z

@michael-s-molina @kgabryje I will create a new PR for this fix

feat: Use SPA navigation from datasets list to Explore

779f7db

kgabryje requested review from zhaoyongjie, geido and michael-s-molina July 27, 2022 15:08

pull-request-size bot added the size/M label Jul 27, 2022

fix lint

cbabb4f

Fix lint

15051b1

pull-request-size bot added size/L and removed size/M labels Jul 27, 2022

michael-s-molina reviewed Jul 28, 2022

View reviewed changes

kgabryje added 3 commits July 28, 2022 15:58

Fix type

8581f26

Make external links work without protocols

ab26012

add comment

09db402

michael-s-molina approved these changes Jul 29, 2022

View reviewed changes

michael-s-molina reviewed Jul 29, 2022

View reviewed changes

kgabryje merged commit 6ec164e into apache:master Aug 1, 2022

EugeneTorap mentioned this pull request Aug 2, 2022

fix: Use SPA Dataset link in Chart and Dashboard #20941

Merged

9 tasks

mistercrunch added the 🚢 2.1.3 label Feb 18, 2024

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Use SPA navigation from datasets list to Explore #20890

feat: Use SPA navigation from datasets list to Explore #20890

kgabryje commented Jul 27, 2022 •

edited

codecov bot commented Jul 27, 2022 •

edited

michael-s-molina left a comment

michael-s-molina Jul 28, 2022

kgabryje Jul 28, 2022

michael-s-molina Jul 28, 2022

kgabryje Jul 28, 2022

kgabryje Jul 28, 2022

michael-s-molina Jul 28, 2022

kgabryje Jul 28, 2022

michael-s-molina Jul 28, 2022

kgabryje Jul 29, 2022

michael-s-molina left a comment

michael-s-molina Jul 29, 2022

kgabryje Aug 1, 2022

EugeneTorap commented Aug 2, 2022

EugeneTorap commented Aug 2, 2022

EugeneTorap commented Aug 2, 2022

feat: Use SPA navigation from datasets list to Explore #20890

feat: Use SPA navigation from datasets list to Explore #20890

Conversation

kgabryje commented Jul 27, 2022 • edited

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

codecov bot commented Jul 27, 2022 • edited

Codecov Report

michael-s-molina left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michael-s-molina left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

EugeneTorap commented Aug 2, 2022

EugeneTorap commented Aug 2, 2022

EugeneTorap commented Aug 2, 2022

kgabryje commented Jul 27, 2022 •

edited

codecov bot commented Jul 27, 2022 •

edited