NickAkhmetov/CAT-1533 Improve human readability of shared search links#3957
Merged
NickAkhmetov merged 2 commits intomainfrom Mar 17, 2026
Merged
Conversation
john-conroy
previously approved these changes
Mar 17, 2026
Collaborator
john-conroy
left a comment
john-conroy
left a comment
There was a problem hiding this comment.
The nested conditionals are a bit rough on the eyes, but seem mostly necessary.
|
|
||
| // Determine the facet type based on the field | ||
| // raw_dataset_type and mapped_status are HIERARCHICAL; others are TERM | ||
| if (field === 'raw_dataset_type' || field === 'mapped_status') { |
Collaborator
There was a problem hiding this comment.
Can we get the hierarchical fields from a constant defined somewhere?
NickAkhmetov
deleted the
nickakhmetov/cat-1533-search-state-enhancements
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adjusts the search parameter URL state mapping so that faceted data is human-readable, while maintaining the compressed URL approach for UUID-based search states and less important facets (e.g. sample category).
Existing links remain functional/compatible.
Additional mapped facets can be added by extending the
READABLE_PARAM_FIELDSconstant insearchParams.ts. The current implementation only took into account the main fields on the dataset search.Design Documentation/Original Tickets
https://hms-dbmi.atlassian.net/browse/CAT-1533
Testing
Screenshots/Video
Left lung RNAseq data:
Published left lung RNAseq data:
Checklist
CHANGELOG-your-feature-name-here.mdis present in the root directory, describing the change(s) in full sentences.Additional Notes
Selecting parent facets (e.g. "RNA-seq") adds all children to the url state; this was necessary to support handling cases where only a subset of the child facets are selected. Sharing a link with only the parent facet (e.g.
/search/datasets?dataset_type=RNAseq) automatically selects all of the child facets.