task/WP-304: Fixed the placeholder text for search to be more accurately represented

[tjgrafft]

Overview

The search bar's placeholder text, specifically in Data Files, was not accurately represented based on navigation and possible search results.

1. Open Data Files.
2. Initially the search placeholder text might say "Search My Data(Frontera)".
3. After navigating into folders inside My Data(Frontera), the placeholder text remains the same regardless of file depth/navigation.
4. The user could mistake the search path for wrong one. For example:

• If I've navigated to the following file hierarchy: My Data(Frontera) > archive > jobs > 2023-11-20, the current search bar text placeholder would say "Search My Data(Frontera)".
• But if I try and search with the keyword "archive", I'll get no results.
• However, if I navigated back to My Data(Frontera) and tried to search the same keyword "archive", I'd get the folder result.

In other words, having the placeholder be the system name the entire time implies I can search the whole system for folders/files regardless of depth/hierarchy--which isn't the case.

To fix this, I've made the placeholder text more accurate.

Related

• WP-304

Changes

• Added code to check if the current path is homeDir. If user is in the homeDir, the search bar's text placeholder will use the appropriate system name. If the user is not in the homeDir, the current directory name will be displayed for the text placeholder.

Testing

1. Go to cep.test (make sure your search index is properly set up)
2. Navigate to 'Data Files'
3. Select 'My Data(Frontera)' as your system
4. The initial text placeholder should say 'Search My Data(Frontera)'.
5. Try searching for a folder or file name you know is inside this system.
6. Navigate to a folder inside My Data(Frontera) and confirm that the placeholder text is the current directory of the folder you're in.
7. Try searching for a folder/file that's higher in the hierarchy. It shouldn't return those results since you're deeper in the file tree.
8. See my examples below in the screenshots to compare.
9. When testing, make sure that the other Search bar's placeholder text and functionality still work. Site-wide search bar (cep.test/search) and Search bar for job history in "History" tab, for example.

UI

Searching for 'jobs' keyword from My Data(Frontera) directory

Notes

[codecov]

Codecov Report

Merging #905 (871198d) into main (fc00451) will increase coverage by 0.02%.
The diff coverage is 100.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #905      +/-   ##
==========================================
+ Coverage   63.47%   63.49%   +0.02%     
==========================================
  Files         431      431              
  Lines       12404    12412       +8     
  Branches     2585     2588       +3     
==========================================
+ Hits         7873     7881       +8     
  Misses       4315     4315              
  Partials      216      216              

Flag	Coverage Δ
javascript	69.79% <100.00%> (+0.03%)	⬆️
unittests	57.07% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
...ts/DataFiles/DataFilesListing/DataFilesListing.jsx	90.47% <100.00%> (+2.24%)	⬆️

[chandra-tacc]

LGTM and also tested. Thanks for adding this feature.

Would it be possible to update DataFilesListing.test.js to add tests to check scenarios related to home dir or not, current dir updates and so on?

[chandra-tacc]

Thanks for adding tests.

[edmondsgarrett]

Looks good, nice work!