Make Kedro-Viz shareable via a hosted URL #1487

tynandebold · 2023-08-15T10:28:58Z

Description

Development notes

This PR enables Viz to be published and hosted on AWS S3.

For the frontend, most changes exist in shareable-url-modal.js. On the deployed version, we show a timestamp for context, which comes from the shareable-url-metadata.js file.

A new feature hint for the Sharable URLs button is added in feature-hints-content.js. I've also updated feature-hints.js to remove that feature hint from the deployed version, since it doesn't make sense for the user to see it there.

QA notes

Important

You don't need to review any Python files in this PR (nothing inside /package)!!! That review will be done in #1498.

To get setup to test this locally:

Install fsspec version 2023.9.0 or greater.
Ensure you're running kedro version 18.2.0 or greater.
You'll need access to an AWS S3 bucket and know the following information:
- Access key
- Secret access key
- Bucket region
- Bucket name
Enable static website hosting on your S3 bucket and then make the objects public so you'll be able to view Viz when it's deployed
Set your access keys in your terminal, and then run make run.
Then run the frontend with npm start.
The deploy button is in the lower-left, between the theme toggle and settings icon.

Checklist

Read the contributing guidelines
Opened this PR as a 'Draft Pull Request' if it is work-in-progress
Updated the documentation to reflect the code changes
Added new entries to the RELEASE.md file
Added tests to cover my changes

Signed-off-by: Rashida Kanchwala <[email protected]>

…dro-viz into kedro-viz-save-load Signed-off-by: Rashida Kanchwala <[email protected]>

Signed-off-by: Rashida Kanchwala <[email protected]>

Signed-off-by: Tynan DeBold <[email protected]>

…ature/shareable-urls Signed-off-by: Tynan DeBold <[email protected]>

Signed-off-by: Tynan DeBold <[email protected]>

…ove WS/subscription code Signed-off-by: Tynan DeBold <[email protected]>

Signed-off-by: Tynan DeBold <[email protected]>

…reable-viz-backend

Signed-off-by: Tynan DeBold <[email protected]>

…/kedro-viz into feature/shareable-urls Signed-off-by: Tynan DeBold <[email protected]>

…ature/shareable-urls Signed-off-by: Tynan DeBold <[email protected]>

…kedro-viz into feature/shareable-urls Signed-off-by: Tynan DeBold <[email protected]>

Signed-off-by: Tynan DeBold <[email protected]>

…/kedro-viz into feature/shareable-urls Signed-off-by: Tynan DeBold <[email protected]>

ravi-kumar-pilla

I have made few suggestions, none of them is a blocking change. Looks great !

RELEASE.md

package/kedro_viz/api/rest/router.py

src/components/shareable-url-modal/shareable-url-metadata.js

src/config.js

* fix telemetry for sharaeable viz Signed-off-by: ravi-kumar-pilla <[email protected]> * fix lint issue Signed-off-by: ravi-kumar-pilla <[email protected]> --------- Signed-off-by: ravi-kumar-pilla <[email protected]> Signed-off-by: Tynan DeBold <[email protected]> Co-authored-by: Tynan DeBold <[email protected]>

rashidakanchwala · 2023-10-04T20:59:33Z

src/apollo/subscriptions.js

-import gql from 'graphql-tag';
-
-/** subscribe to receive new runs */
-export const NEW_RUN_SUBSCRIPTION = gql`


@tynandebold - Since we are removing this subscription feature from Experiment Tracking I think it should have it's own PR. So in the future, incase we want to add it back or we want to explore this again, there's history. Especially because based on this subscription feature we were planning other features like auto-reload on Collab Experiment Tracking and so on.

Right now because it's part of Shareable-viz -- it is not obvious.

Fair enough.

Please review this today, if you can: #1554

src/components/feature-hints/feature-hint-dot.js

src/components/shareable-url-modal/shareable-url-modal.js

src/components/flowchart-wrapper/flowchart-wrapper.js

src/components/shareable-url-modal/shareable-url-modal.js

rashidakanchwala

I have gone through the code and suggested some changes.

Signed-off-by: Tynan DeBold <[email protected]>

…/kedro-viz into feature/shareable-urls Signed-off-by: Tynan DeBold <[email protected]>

Signed-off-by: Tynan DeBold <[email protected]>

rashidakanchwala · 2023-10-05T13:09:22Z

src/components/feature-hints/feature-hints.js

@@ -15,7 +16,10 @@ import './feature-hints.scss';

 const localStorageKeyShowHints = 'showFeatureHints';
 export const localStorageKeyFeatureHintsStep = 'featureHintStep';
-const numFeatureHints = featureHintsContent.length;
+const updatedFeatureHintsContent = isRunningLocally()


This is not a blocker but just for clarity-- from what I understand 'Publish and share Kedro-viz' feature hint shouldn't show in the deployed version and hence we have to write this code.

But this feature hint only gets shown when the user hovers over the 'deploy button' and there won't be any deploy button in the hosted version, so why do we still need to have this check here?

Because even if the indicator dot isn't there the content in the card would still exist.

rashidakanchwala

Thanks for this!

…ature/shareable-urls Signed-off-by: Tynan DeBold <[email protected]>

Signed-off-by: Tynan DeBold <[email protected]>

rashidakanchwala and others added 30 commits February 17, 2023 12:45

nodes working

5af4d9f

Signed-off-by: Rashida Kanchwala <[email protected]>

added pipeline

283a4f5

Signed-off-by: Rashida Kanchwala <[email protected]>

Merge branch 'kedro-viz-save-load' of https://github.com/kedro-org/ke…

96bb1d2

…dro-viz into kedro-viz-save-load Signed-off-by: Rashida Kanchwala <[email protected]>

fix path

7de3f65

Signed-off-by: Rashida Kanchwala <[email protected]>

fix bug and lint

3a023f9

Signed-off-by: Rashida Kanchwala <[email protected]>

fix lint

3c2b625

Signed-off-by: Rashida Kanchwala <[email protected]>

Add deploy button, modal, and form fields

71de836

Signed-off-by: Tynan DeBold <[email protected]>

Fix failing tests

a98a17d

Signed-off-by: Tynan DeBold <[email protected]>

Fix failing tests

15d095c

Signed-off-by: Tynan DeBold <[email protected]>

Update single file to S3 via file input

462f447

Signed-off-by: Tynan DeBold <[email protected]>

Update test case

319a7a8

Signed-off-by: Tynan DeBold <[email protected]>

Merge branch 'main' of https://github.com/kedro-org/kedro-viz into fe…

dd2041f

…ature/shareable-urls Signed-off-by: Tynan DeBold <[email protected]>

Remove package lock changes

616cbdf

Signed-off-by: Tynan DeBold <[email protected]>

Hide exp tracking and deploy button when not running Viz locally; rem…

f46032d

…ove WS/subscription code Signed-off-by: Tynan DeBold <[email protected]>

Add the beginnings of a /deploy REST endpoint

67371b7

Signed-off-by: Tynan DeBold <[email protected]>

Trying to send credentials to the backend

5f25491

Signed-off-by: Tynan DeBold <[email protected]>

Merge remote-tracking branch 'origin' into kedro-viz-save-load

5da7410

update responses

4762c2f

test

4bc45e5

Merge branch 'main' into feature/shareable-urls

d2e28a5

Merge remote-tracking branch 'origin/feature/shareable-urls' into sha…

b2a22d1

…reable-viz-backend

Update UI to remove unneeded fields

a2456da

Signed-off-by: Tynan DeBold <[email protected]>

Fix failing text

3a883e9

Signed-off-by: Tynan DeBold <[email protected]>

Merge branch 'feature/shareable-urls' of https://github.com/kedro-org…

d911a26

…/kedro-viz into feature/shareable-urls Signed-off-by: Tynan DeBold <[email protected]>

Workable Prototype

6ba6a04

fix rebase

6081e85

fixing stuff

d044bd1

Merge branch 'main' of https://github.com/kedro-org/kedro-viz into fe…

5c27954

…ature/shareable-urls Signed-off-by: Tynan DeBold <[email protected]>

Merge branch 'shareable-viz-backend' of https://github.com/kedro-org/…

258de8d

…kedro-viz into feature/shareable-urls Signed-off-by: Tynan DeBold <[email protected]>

Successfully returning a 200 from /api/deploy endpoint

028e220

Signed-off-by: Tynan DeBold <[email protected]>

tynandebold and others added 4 commits October 3, 2023 13:17

Add tracking to create_api_app_from_file

d322ddc

Signed-off-by: Tynan DeBold <[email protected]>

fix e2e tests

8ed3d95

Revert changes to create_api_app_from_file function

1f79c1f

Signed-off-by: Tynan DeBold <[email protected]>

Merge branch 'feature/shareable-urls' of https://github.com/kedro-org…

6ab25be

…/kedro-viz into feature/shareable-urls Signed-off-by: Tynan DeBold <[email protected]>

ravi-kumar-pilla reviewed Oct 4, 2023

View reviewed changes

RELEASE.md Outdated Show resolved Hide resolved

package/kedro_viz/api/rest/router.py Show resolved Hide resolved

src/components/shareable-url-modal/shareable-url-metadata.js Outdated Show resolved Hide resolved

src/config.js Show resolved Hide resolved

rashidakanchwala reviewed Oct 4, 2023

View reviewed changes

src/components/feature-hints/feature-hint-dot.js Show resolved Hide resolved

rashidakanchwala reviewed Oct 5, 2023

View reviewed changes

src/components/shareable-url-modal/shareable-url-modal.js Show resolved Hide resolved

rashidakanchwala reviewed Oct 5, 2023

View reviewed changes

src/components/flowchart-wrapper/flowchart-wrapper.js Outdated Show resolved Hide resolved

rashidakanchwala reviewed Oct 5, 2023

View reviewed changes

src/components/shareable-url-modal/shareable-url-modal.js Outdated Show resolved Hide resolved

rashidakanchwala requested changes Oct 5, 2023

View reviewed changes

tynandebold added 4 commits October 5, 2023 12:09

Design QA changes

01965e6

Signed-off-by: Tynan DeBold <[email protected]>

Merge branch 'feature/shareable-urls' of https://github.com/kedro-org…

1657183

…/kedro-viz into feature/shareable-urls Signed-off-by: Tynan DeBold <[email protected]>

Update release file

d441207

Signed-off-by: Tynan DeBold <[email protected]>

PR review fixes

922dd72

Signed-off-by: Tynan DeBold <[email protected]>

tynandebold requested review from ravi-kumar-pilla and rashidakanchwala October 5, 2023 12:00

Add back graphql subscription (removal moved to another PR)

2926f7f

Signed-off-by: Tynan DeBold <[email protected]>

stephkaiser approved these changes Oct 5, 2023

View reviewed changes

rashidakanchwala reviewed Oct 5, 2023

View reviewed changes

rashidakanchwala approved these changes Oct 5, 2023

View reviewed changes

Merge branch 'main' of https://github.com/kedro-org/kedro-viz into fe…

0ef2fe5

…ature/shareable-urls Signed-off-by: Tynan DeBold <[email protected]>

ravi-kumar-pilla approved these changes Oct 5, 2023

View reviewed changes

tynandebold added 2 commits October 6, 2023 09:40

Update cypress test

1d42332

Signed-off-by: Tynan DeBold <[email protected]>

Merge branch 'main' into feature/shareable-urls

c82fa36

tynandebold merged commit a185d5a into main Oct 10, 2023
1 check passed

tynandebold deleted the feature/shareable-urls branch October 10, 2023 11:09

tynandebold mentioned this pull request Oct 10, 2023

Release v6.6.0 #1566

Merged

5 tasks

vladimir-mck mentioned this pull request Oct 27, 2023

Add tooltip to shareable urls copy button #1614

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make Kedro-Viz shareable via a hosted URL #1487

Make Kedro-Viz shareable via a hosted URL #1487

tynandebold commented Aug 15, 2023 •

edited

Loading

ravi-kumar-pilla left a comment

rashidakanchwala Oct 4, 2023

tynandebold Oct 5, 2023

rashidakanchwala left a comment

rashidakanchwala Oct 5, 2023 •

edited

Loading

tynandebold Oct 5, 2023

rashidakanchwala left a comment

Make Kedro-Viz shareable via a hosted URL #1487

Make Kedro-Viz shareable via a hosted URL #1487

Conversation

tynandebold commented Aug 15, 2023 • edited Loading

Description

Development notes

QA notes

Checklist

ravi-kumar-pilla left a comment

Choose a reason for hiding this comment

rashidakanchwala Oct 4, 2023

Choose a reason for hiding this comment

tynandebold Oct 5, 2023

Choose a reason for hiding this comment

rashidakanchwala left a comment

Choose a reason for hiding this comment

rashidakanchwala Oct 5, 2023 • edited Loading

Choose a reason for hiding this comment

tynandebold Oct 5, 2023

Choose a reason for hiding this comment

rashidakanchwala left a comment

Choose a reason for hiding this comment

tynandebold commented Aug 15, 2023 •

edited

Loading

rashidakanchwala Oct 5, 2023 •

edited

Loading