Add disable preview toggle in settings panel

[SajidAlamQB]

Description

Related to: #1921

This feature enables users to control data previews for all nodes from the settings panel of Kedro-Viz when running kedro viz locally.

After running Kedro-Viz locally, dataset previews for all nodes will be enabled by default. However, users will have the ability to enable or disable this feature from the Kedro-Viz settings panel.

Development Notes

Backend Changes:

• Introduced a new API endpoint /api/preferences to handle user preferences updates.
• Created a UserPreference model to define the preference schema.
• Implemented a new function in router.py to update the showDatasetPreviews preference and set the class variable accordingly.
• Adjusted the logic in responses.py to use the new preference for determining dataset preview settings.

Frontend Changes:

• Added a new showDatasetPreviews toggle in the Redux state to manage the setting.
• Updated the SettingsModal component to include the showDatasetPreviews toggle.

How to Test:

• Run kedro viz locally via
• Open the Kedro-Viz settings panel.
• Toggle the Dataset Previews setting on and off.
• Verify that the dataset previews for all nodes are enabled/disabled based on the setting.
• Check the network tab to confirm that Preferences API is called and that the preferences are correctly updated on the backend. (Might need to toggle preserve logs to view it as saving in the settings menu refreshes the page and clears network logs)

New dataset preview toggle:

New API endpoint:

QA notes

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

[Huongg]

hey @SajidAlamQB what's the best way to test your branch locally? I run kedro viz run in demo-project but I guess it won't reflect any changes from the FE

[SajidAlamQB]

hey @SajidAlamQB what's the best way to test your branch locally? I run kedro viz run in demo-project but I guess it won't reflect any changes from the FE

Hi, I'm making some changes at the moment, but I've been using make build and make run to test the changes locally.

[Huongg]

hey @SajidAlamQB what's the best way to test your branch locally? I run kedro viz run in demo-project but I guess it won't reflect any changes from the FE

Hi, I'm making some changes at the moment, but I've been using make build and make run to test the changes locally.

oh i see, maybe i got it wrong but from the description it says when you run "kedro viz run". So i expect if i run "kedro viz run" the behaviour will be different from if i run "kedro viz build" etc. Is it the case?

[SajidAlamQB]

oh i see, maybe i got it wrong but from the description it says when you run "kedro viz run". So i expect if i run "kedro viz run" the behaviour will be different from if i run "kedro viz build" etc. Is it the case?

It should be the same behaviour, I've made quite a few changes and updated the description might be worth testing again.

[stephkaiser]

Thanks Sajid! some very minor design QA comments:

• could we make it so that 'Previews" has a lowercase p - so "Dataset previews"
• and can we change the description to "Display preview data for all datasets."

[Huongg]

thank you @SajidAlamQB. I've left a few comments. Let me know if you have any questions about them

[jitu5]

LGTM! Thanks @SajidAlamQB

[ravi-kumar-pilla]

Thank you for addressing all the PR comments @SajidAlamQB . LGTM and works well 💯