Skip to content

Latest commit

 

History

History
346 lines (277 loc) · 19.6 KB

CHANGELOG.md

File metadata and controls

346 lines (277 loc) · 19.6 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[UNRELEASED] - YYYY-MM-DD

Fixed

  • #655 - Regression fix: Show filters in TablePlotter when using lock argument.

Changed

  • #648 - Allow blob: in script-src CSP in order to enable web worker usage in Dash components.
  • #652 - Enabled support for LaTeX math/equations in markdown.
  • #653 - Reduce time for running webviz --help by lazy importing top level entrypoints.
  • #656 - Further reduce startup time by only loading plugin entrypoints used in the application.

Added

  • #644 - Added option to download tables in DataTable and PivotTable.
  • #658 - Added plotly_theme to options in configuration file, allowing user to modify theming of plotly plots without creating a completely new theme. Examples are formatting of axes like gridlines, ticks, color palettes and number formatting.

[0.5.0] - 2022-10-10

Changed

  • #634 - Disable automatic worker restart in gunicorn configuration.
  • #602 - Changed the file and plugin names from ExampleContentWrapper to ExampleWlfPlugin.
  • #543 - Improved spacing around images and image captions.
  • #618 - Initialized common_cache.CACHE directly with 3600 sec timeout and deprecated CACHE.TIMEOUT.
  • #619 - Adjusted the WLF example plugin to the best practice, added slots there and introduced new callback_typecheck decorator. Moreover, added a StrEnum class for IDs and settings.

Added

  • #635 - Added option to interactively set axis ranges in TablePlotter
  • #594 - Added early testing of graphical user interface (GUI) for editing and creating Webviz configuration files. Run webviz editor to start the GUI.
  • #599 - Implemented new Webviz Layout Framework (WLF).
  • #631 - Added homepage option to menu options in config file to define which page should be shown first when opening a Webviz app.

[0.4.0] - 2022-06-22

Fixed

  • #588 - Added compatibility with upstream dependency bleach >= 5.

[0.3.9] - 2022-02-09

Added

  • #572 - Added title_position for the BannerImage plugin, allowing the user to place the text at the top or at the bottom of the image.

[0.3.8] - 2022-01-06

Changed

  • #562 - Added global WebvizInstanceInfo accessible through WEBVIZ_INSTANCE_INFO

[0.3.7] - 2021-12-09

Fixed

  • #558 - Added documentation on SSH deploy keys, and fix permission on ssh_identity files in Dockerfile.
  • #555 - Fix issue where clientside callbacks were not getting whitelisted
  • #539 - Support using OAuth behind proxy. If silent refresh of OAuth token fails, fall back to loud refresh of token instead of raising internal server error.
  • #550 - Change user data directory on Windows from Application Data to AppData (both work on Windows 10, but only the latter works on Windows 11).
  • #546 - Replaced cp with copyfiles in package.json's postinstall script and added note to README.
  • #552 - Fix Windows problem when calling gh api in Radix deploy.

[0.3.6] - 2021-11-08

Added

  • #528 - Implemented initiallyCollapsed setting for groups in menu.

[0.3.5] - 2021-10-08

Changed

Fixed

  • #498 - Explicitly use UTC when comparing time zones in the OAuth implementation.
  • #476 - Use Azure SDK Python packages instead of wrapping Azure CLI.
  • #521 - Improved performance on deployment workflow for Webviz applications with large data sets. Also allow for empty commits (i.e. redeployment of same application triggering new build).
  • #532 - Fixed syntax highlighting of code blocks in markdown.

Added

  • #503 - Added __main__.py. This will allow users to do python -m webviz_config [...] in addition to webviz [...].
  • #510 - Added command line option --debug which enables selected underlying Dash development features.

[0.3.4] - 2021-08-30

Fixed

  • #482 - Reverted the assumption made in #419 that all argument section in init-docstrings are lists of argument descriptions, and separated deprecated plugins and arguments in doc sidebar.
  • #489 - Use Docker user on numerical format (in order for Radix/Kubernetes to correctly infer non-root user). Also changed to use new Radix supported blob mount driver.

[0.3.3] - 2021-07-13

Changed

  • #474 - Remove 62.5% CSS IE workaround.
  • #470 - Improve VSCode YAML schema installation documentation.

[0.3.2] - 2021-06-06

Added

  • #456 - Extended error message when configuration file is invalid with suggestion to run webviz docs.
  • #426 - Added centralized factory registry exposed through WEBVIZ_FACTORY_REGISTRY for sharing factories between plugins.
  • #443 - Added --logconfig command line argument to allow detailed control of logging output in webviz.
  • #447 - Plugin project dependencies (indirect and direct) are now included in PLUGIN_PROJECT_METADATA. This enables the generated Docker setup, when portable apps are built, to have the same dependency versions compared to what the user had installed when creating the portable app.
  • #445 - Added report feedback button to WebvizPluginABC.

Fixed

  • #463 - Reflect external change. Repository name for standard OAuth2 Docker containers is changed from quay.io/pusher/oauth2_proxy to quay.io/oauth2-proxy/oauth2-proxy.
  • #440 - Fixed setting of global log level for webviz application.
  • #457 - Use non-root redis Docker image in generated Radix setup.

[0.3.1] - 2021-04-29

Fixed

  • #429 - Moved FutureWarnings from deprecated_decorators.py to _config_parser.py. Simplified deprecation warnings.
  • #432 - Replaced WebvizPluginABC type in deprecated_plugin decorator with Type[WebvizPluginABC].
  • #433 - Removed short message from deprecated_plugin decorator.
  • #435 - Support only specifying source_url in setup.py when building Dockerfile.

[0.3.0] - 2021-04-27

Added

  • #419 - Plugins and their arguments can now be marked as deprecated by using the newly implemented deprecation framework that, in addition to console FutureWarnings, automatically shows deprecation messages to the end user in the app and in the documentation. Adjusted contributing guide accordingly.
  • #318 - webviz-config now facilitates automatically including necessary plugin projects as dependencies in generated Docker setup. Private repositories are also supported, however the Docker build process would then need to be given deploy keys as environment variable secrets. First iteration of automatically creating a corresponding Radix config and deploying a Radix application is also added.
  • #423 - Added class name webviz-config-markdown to the output from the webviz-config Markdown plugin output, such that Webviz themes can optionally reduce CSS scope to the output from the Markdown plugin.

Changed

  • #419 - Changed plugin_metadata and plugin_project_metadata in webviz_config.plugins to uppercase.
  • #409 - Relax Python test dependency constraints.
  • #318 - Ad-hoc plugins not supported anymore (i.e. plugins not being part of a Python project with setup.py). This enables us to reserve the configuration file syntax prefix.PluginName to later. Requiring a formal Python project also enables useful features in the framework (see e.g. the Added section for this PR).

Fixed

  • #415 - Reduce height of main sidebar to prevent overflow.
  • #422 - Remove deprecated 'plugin-types' CSP directive.

[0.2.9] - 2021-02-23

Changed

  • #395 - Update npm dependencies. See also #392 (docsify-copy-code update) and #393 (katex update).

[0.2.8] - 2021-01-26

Added

  • #345 - Added Oauth2 Authorization Code flow support for Azure AD applications.

Changed

  • #374 - Removed Webviz SSL certificate generation and forcing of HTTPS connections.
  • #388 - Firefox preferred as default browser over Chrome/Chromium to ease the transition on localhost after #374. Browser defined with webviz preferences --browser somebrowser is still used instead of the new default (Firefox).

Fixed

  • #380 - Don't write warning for multiple versions of same plugin if the metadata is equal.

[0.2.7] - 2021-01-14

Changed

  • #368 - Made Webviz global settings available to plugin implementations through special webviz_settings argument. This argument is an instance of the WebvizSettings class and currently contains both the shared_settings and theme properties.

Deprecated

  • #368 - Access to webviz_settings as an attribute on the Dash application instance object (currently being passed to the plugins as the special app argument) has been deprecated.

[0.2.6] - 2021-01-07

Fixed

  • #373 - Fix for import of TypedDict in Python versions older than 3.8. Check against Python version instead of using try-except.

[0.2.5] - 2020-12-19

Changed

  • #367 - Made type information available to package consumers by indicating support for typing as specified in PEP 561.

[0.2.4] - 2020-12-08

Changed

  • #362 - Bumped pandas requirement to pandas>=1.0, as pandas==0.24.2 is no longer needed in internal deployment.

Fixed

  • #351 - Fixed bug in automatically generated docs when having a defaulted input argument of type pathlib.Path in plugin arguments.
  • #354 - Fixed bug in automatically generated docs when having type hinted return value of plugin __init__ functions.

[0.2.3] - 2020-11-26

Added

  • #337 - New generic plugin to generate a Pivot table based on Dash Pivottable.
  • #333 - Warning is now raised if more than one plugin project provides a plugin with the same name.

[0.2.2] - 2020-11-16

Fixed

  • #339 - After #230 generated app started using Dash dcc.Location and dcc.Link instead of tabs for multi-page apps. This enabled URL routing. At the same time, the root url / special case was set to show "Front page", however, users did not from before necessarily have a page called "Front page", as the "Front page" shown earlier was simply the first page in the list. Changed back to behavior prior to #230 - i.e. show first page in config as "Front page" and not rely on page title.

[0.2.1] - 2020-10-29

Changed

  • #324 - Now also webviz-config shipped plugins install themselves through the webviz_config_plugins entrypoints group.
  • #325 - Removed support for ad-hoc plugins as this is costly to maintain. Also, the module.PluginName notation in configuration files can then in future be used fo distinguish between multiple plugin packages using the same plugin name.
  • #330 - Pie chart plot type now available in table plotter.

Fixed

  • #325 - Support plugin projects that use different name for top level package and distribution name.

[0.2.0] - 2020-10-06

Changed

  • #230 - Instead of using dcc.Tabs to give the impression of a "multipage app", webviz now uses dcc.Link and dcc.Location. This has two main advantages: Big applications can have significantly faster loading time, as only callbacks on selected "page" fire initially. In addition, the user can navigate with forward/backward buttons in browser, as well as getting an URL they can share with others in order to point them to the correct "page". Plugin authors should check that persistence is set to session on Dash components they use if they want user selections to remain across "page" changes. In order to get more easily typed URLs, runtime generated page IDs now use - instead of _ for spaces.

Fixed

  • #321 - Allowed for blob: in img-src CSP such that plotly.js "Download to png" works properly.

[0.1.4] - 2020-09-24

Added

  • #311 - Automatically add a comment in generated application regarding which Python executable (sys.executable) was used when building a portable application.
  • #310 - Added RuntimeWarning which appears if @webvizstore decorated functions are given argument values of type pandas.DataFrame or pandas.Series (Which are known to not have __repr__ functions useful for hashing).

Fixed

  • #313 - Added min-width to menu CSS such that it does not collapse on wide content. In addition, make sure menu width is only specified on screen widths wide enough to be above the Dash Tabs provided breakpoint at 800px.

[0.1.3] - 2020-09-22

Added

  • #283 - Auto-generated Webviz plugin documentation now has search functionality (using docsify full text search).
  • #278 - Plugin authors can now use Dash inline callbacks (i.e. app.clientside_callback(...)) without being in conflict with the strict CSP rules enforced by webviz-config (inline script hashes are added automatically).

Changed

  • #294 - Plugin authors can now define file type to download (including specifying MIME type). Before only .zip archives were supported.
  • #281 - Now uses importlib instead of pkg_resources for detecting plugin entry points and package versions.
  • #306 - Now runs WEBVIZ_ASSETS.make_portable before WEBVIZ_STORE.build_store when building portables, as it usually takes shorter time, and therefore will give feedback quicker if something is wrong.

Fixed

  • #308 - Fixed UnclosedFile and Resource warnings, which would appear if developer enabled e.g. export PYTHONWARNINGS=default. Also, Webviz now gracefully exits on CTRL+C (KeyboardInterrupt) instead of giving (unnecessary) traceback to the user.
  • #295 - Menu width is now specified. This both ensures the menu does not collapse if plugin content is wide, as well as not too wide itself if page titles are long (instead page titles in the menu are wrapped). Also added <meta name="viewport" content="width=device-width, initial-scale=1"> for better experience on mobiles.

[0.1.2] - 2020-09-09

Added

  • #279 - Added scrollbar to menu (when larger than screen size).

[0.1.1] - 2020-09-02

Added

  • #269 - Added an optional argument screenshot_filename to WebvizPluginABC. Can be used to let plugin authors specify filename used when screenshots of the plugin are saved.
  • #275 - Indented docstrings are now supported by webviz docs.

[0.1.0] - 2020-08-24

Added

  • #265 - Added support to automatically create JSON/YAML schema based on installed plugins to be used in e.g. VSCode with the Red Hat YAML extension for VSCode. Create a schema by running webviz schema.