Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Load all settings from federated extensions at startup #1220

Merged
merged 23 commits into from Oct 20, 2023

Conversation

jtpio
Copy link
Member

@jtpio jtpio commented Oct 19, 2023

References

JupyterLab 4 seems to now be expecting all settings (including the ones from federated extensions) to be returned in one go on the first call to /api/settings.

This is likely related to the change in jupyterlab/jupyterlab#14195 and/or other upstream PRs as well.

Fixes #1213

Code changes

  • Aggregate settings from federated extensions in a all_federated.json file by adding a step in the federated_extensions addon post_build
  • UI test to check the "Launch Notebook File Browser" item is available when the notebook package is installed in the build environment
  • Handle redirects to /doc/tree
  • UI test to check going from Notebook to Lab with the toolbar button
  • Mention installing the notebook package in the docs to get the UI elements

An alternative could have been to create an all.json file with all the settings for a federated extension, in each federated extension directory. And query this file for each extension. However many extensions don't provide settings, so these queries would lead to many 404s.

User-facing changes

End users should be able to see menu entries or toolbar items defined in third-party extensions via the settings system.

image

notebook-lab-switch.mp4

Backwards-incompatible changes

None

@jtpio jtpio added the bug Something isn't working label Oct 19, 2023
@jtpio jtpio added this to the 0.2.0 milestone Oct 19, 2023
@github-actions
Copy link
Contributor

lite-badge 👈 Try it on ReadTheDocs

@jtpio jtpio marked this pull request as ready for review October 19, 2023 14:42
@jtpio
Copy link
Member Author

jtpio commented Oct 19, 2023

Thanks @bollwyvl for the review, I pushed a couple more commits to address the suggestions 👍

@jtpio
Copy link
Member Author

jtpio commented Oct 20, 2023

Getting this one in and following up with a new release.

@jtpio jtpio merged commit 38c6fb1 into jupyterlite:main Oct 20, 2023
20 checks passed
@jtpio jtpio deleted the federated-settings branch October 20, 2023 05:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Issue when loading settings from federated extensions
2 participants