Skip to content

Change default plotly version used to display plots#287

Merged
backmari merged 4 commits intonextfrom
ewm15056_plotly_version_with_cleanup
Feb 19, 2026
Merged

Change default plotly version used to display plots#287
backmari merged 4 commits intonextfrom
ewm15056_plotly_version_with_cleanup

Conversation

@backmari
Copy link
Collaborator

@backmari backmari commented Feb 19, 2026

Description of the changes

Background: A CIS reported that a plot was showing up as empty. It had been created with plotly 6 (compatible with Plotly.JS 3.) but was missing the plotly version tag injected by plot_publisher. Since Mantid is using plotly 6 now, new plots are more likely to be compatible with Plotly.JS 3., which should also be backwards compatible with plots created using an older version.

Check all that apply:

  • updated documentation
  • Source added/refactored
  • Added unit tests
  • Added integration tests
  • (If applicable) Verified that manual tests requiring the /SNS and /HFIR filesystems pass without fail

References:

⚠️ Manual test for the reviewer

(Instructions for testing here)

There is a manual test to verify that a plot created without a version tag is displayed using Plotly.JS 3.0.1.

  1. First, ensure that the data resources (/SNS/VULCAN/shared/autoreduce/reduce_VULCAN.py) are updated:
make clean
make all
# ensure the images and containers are rebuilt, e.g. using:
docker system prune -f -a --volumes
  1. Build the images and stand up the containers:
make localdev/up
# wait for all containers to start
pixi run systemtests  # this will add the VULCAN instrument to the database
  1. Open http://localhost/dasmon and log in as InstrumentScientist.
  2. Open http://localhost/report/vulcan/12345/.
  3. Submit for reduction by clicking "reduction".
  4. Verify that the reduction completes and the plot is displayed using Plotly.JS 3.0.1. (There should also be a console log about the plotly version tag missing.)
webmon plotly version

Check list for the reviewer

  • best software practices
    • clearly named variables (better to be verbose in variable names)
    • code comments explaining the intent of code blocks
  • All the tests are passing
  • The documentation is up to date
  • code comments added when explaining intent

@codecov-commenter
Copy link

codecov-commenter commented Feb 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.69%. Comparing base (dd8bdf1) to head (1f62713).
⚠️ Report is 12 commits behind head on next.

Additional details and impacted files
@@            Coverage Diff             @@
##             next     #287      +/-   ##
==========================================
+ Coverage   82.67%   82.69%   +0.02%     
==========================================
  Files          60       60              
  Lines        4434     4393      -41     
==========================================
- Hits         3666     3633      -33     
+ Misses        768      760       -8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

@darshdinger darshdinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two hopefully simple comments to address. Otherwise, looks great!

Copy link
Contributor

@darshdinger darshdinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@backmari backmari merged commit e955167 into next Feb 19, 2026
4 checks passed
@backmari backmari deleted the ewm15056_plotly_version_with_cleanup branch February 19, 2026 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants