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

catalog search handle from file edge case and implement max sources #3337

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

gibsongreen
Copy link
Contributor

@gibsongreen gibsongreen commented Dec 5, 2024

Description

This pull request is to address an edge case when there is only one source in a catalog search from file. It also implements the max_sources traitlet for all catalogs.

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)?

@github-actions github-actions bot added imviz plugin Label for plugins common to multiple configurations labels Dec 5, 2024
@gibsongreen gibsongreen added bug Something isn't working and removed imviz labels Dec 5, 2024
@gibsongreen gibsongreen added this to the 4.1 milestone Dec 5, 2024
@gibsongreen gibsongreen force-pushed the fix-catalog-from-file-bug branch from 6e00ce6 to bfb83ef Compare December 5, 2024 06:21
@gibsongreen gibsongreen changed the title handle from file edge case and implement max sources catalog search handle from file edge case and implement max sources Dec 5, 2024
Copy link

codecov bot commented Dec 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.87%. Comparing base (300e5f3) to head (bc94e61).
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3337      +/-   ##
==========================================
+ Coverage   88.80%   88.87%   +0.06%     
==========================================
  Files         125      125              
  Lines       19132    19152      +20     
==========================================
+ Hits        16990    17021      +31     
+ Misses       2142     2131      -11     

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

@gibsongreen gibsongreen marked this pull request as ready for review December 5, 2024 14:10
@gibsongreen gibsongreen force-pushed the fix-catalog-from-file-bug branch from 6654e2b to 12af427 Compare December 5, 2024 18:18
Copy link
Member

@kecnry kecnry left a comment

Choose a reason for hiding this comment

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

It looks like the entire GAIA search logic is uncovered - is it easy to add coverage here or if its out of scope, can you create a follow-up please?

Otherwise code looks good - thanks!

Comment on lines +162 to +163
if len(query_region_result) > self.max_sources:
query_region_result = query_region_result[:self.max_sources]
Copy link
Member

Choose a reason for hiding this comment

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

can we have a warning for this (maybe in-UI)?

Copy link
Contributor Author

@gibsongreen gibsongreen Dec 6, 2024

Choose a reason for hiding this comment

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

I added a snackbar message instead of a warning since the user manually enters the max_sources themselves. Also added it for the Gaia (and SDSS) catalog with the custom logic for this.

@gibsongreen
Copy link
Contributor Author

gibsongreen commented Dec 6, 2024

It looks like the entire GAIA search logic is uncovered - is it easy to add coverage here or if its out of scope, can you create a follow-up please?

A follow up ticket has been created and pulled into the sprint to add test coverage for Gaia and SDSS.
Update: There ended up being sources from Gaia for the existing test data that SDSS was using so I added the coverage in this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working imviz 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.

2 participants