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

data-menu: handle viewer rename properly #3383

Merged
merged 2 commits into from
Jan 10, 2025

Conversation

kecnry
Copy link
Member

@kecnry kecnry commented Jan 8, 2025

Description

This pull request fixes tracebacks caused by the new data-menu when renaming a viewer (currently only used by downstream lcviz - this fixes broken tests in spacetelescope/lcviz#158 when run locally).

Change log entry

  • Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts,
    list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer
    should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
  • Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
  • Do the proposed changes follow the STScI Style Guides?
  • Are tests added/updated as required? If so, do they follow the STScI Style Guides?
  • Are docs added/updated as required? If so, do they follow the STScI Style Guides?
  • Did the CI pass? If not, are the failures related?
  • Is a milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone. Bugfix milestone also needs an accompanying backport label.
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

@kecnry kecnry added the backport-v4.1.x on-merge: backport to v4.1.x label Jan 8, 2025
@kecnry kecnry added this to the 4.1.1 milestone Jan 8, 2025
@github-actions github-actions bot added the plugin Label for plugins common to multiple configurations label Jan 8, 2025
Copy link

codecov bot commented Jan 8, 2025

Codecov Report

Attention: Patch coverage is 57.14286% with 6 lines in your changes missing coverage. Please review.

Project coverage is 88.00%. Comparing base (19ddfac) to head (260af52).
Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
jdaviz/core/template_mixin.py 50.00% 4 Missing ⚠️
...viz/configs/default/plugins/data_menu/data_menu.py 66.66% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3383      +/-   ##
==========================================
- Coverage   88.02%   88.00%   -0.02%     
==========================================
  Files         127      127              
  Lines       19717    19730      +13     
==========================================
+ Hits        17356    17364       +8     
- Misses       2361     2366       +5     

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

@kecnry kecnry marked this pull request as ready for review January 8, 2025 19:50
if viewer == msg.old_viewer_ref:
self.viewer[i] = msg.new_viewer_ref
elif self.viewer == msg.old_viewer_ref:
self.viewer = msg.new_viewer_ref
Copy link
Contributor

Choose a reason for hiding this comment

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

does this need to set viewer id as well like in data_menu?

Copy link
Member Author

Choose a reason for hiding this comment

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

no, this only tracks the reference so doesn't need to worry about whether the id has changed or not

@kecnry kecnry merged commit d019ae4 into spacetelescope:main Jan 10, 2025
25 of 27 checks passed

This comment was marked as resolved.

@kecnry kecnry deleted the dm-viewer-rename branch January 10, 2025 13:56
kecnry added a commit to kecnry/jdaviz that referenced this pull request Jan 10, 2025
* data-menu: handle viewer rename properly
kecnry added a commit that referenced this pull request Jan 10, 2025
* data-menu: handle viewer rename properly
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-v4.1.x on-merge: backport to v4.1.x plugin Label for plugins common to multiple configurations Ready for final review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants