Nextflow Samplesheet - Pagination

[ChrisHuynh333]

What does this PR do and why?

This PR is for story STRY0016721.

This is a complete refactor on how the nextflow samplesheet samples table handles its data, to improve performance and responsiveness of the dialog when large sample numbers are selected by utilization of pagination and elimination of excess DOM elements.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other pull requests.

How to set up and validate locally

Because this PR entirely changes how the functionality of the samplesheet is handled, all previous samplesheet testing should be redone:

1. Verify all the steps in PR879 still behave as described. Note: Error handling is now simply a text box above the table that lists the samples with an error
2. Create and submit a workflow execution with edited parameters (project_name, assembler, random_seed), and verify after submission that the workflow contains the edited parameters and not the default values.
3. Create an automated workflow execution as described in PR585 and verify it still works/behaves as expected
4. Edit an automated workflow execution as described in PR594 and verify it still works/behaves as expected

Test Pagination:

1. Navigate to a Group with many samples (over 20).
2. For at least two samples, add paired end attachments to one, and a single end attachment to the other (note these sample IDs).
3. Select a large number of the group samples (use a total sample count that is not divisible by 5). Note how many samples there are and divide by 5 (and round up) for number of pages
4. Start a workflow
5. Verify on the pagination just below the samples table that the Previous button is disabled, and click the page number and check that the dropdown selection goes down to the expected page number
6. Test the dropdown page selection, previous and next buttons and ensure the expected pagination behaviour.
7. Navigate to the last page and verify the next button becomes disabled.
8. Verify on the last page that the correct number of 'remaining' samples was rendered. (If you selected 23 samples, you would expect 3 samples to render on page 5).
9. To the samples that you uploaded attachments to, find those samples and select the uploaded attachments for the respective sample.
10. Change pages and then return to the page containing those samples, and verify that the sample attachment listing is still the same as your selection (did not revert back to the initial file selection).
11. Launch the workflow
12. Verify on the workflow's samplesheet that the changed attachments are listed on the respective samples.
13. Navigate back to any project/group with samples.
14. Select less than 5 samples
15. Start a workflow and verify that pagination does not render as there is only 1 page.

PR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

• I have evaluated the PR acceptance checklist for this PR.

[joshsadam]

Styling issue if there is only one page.  Maybe just hide the pagination if just one page.

[ChrisHuynh333]

Styling issue if there is only one page.  Maybe just hide the pagination if just one page.

Fixed in dde84a3

[joshsadam]

This is a lot of really good work.  I would like to see a lot less JavaScript dependency, but that is beyond the scope of this PR.  I have one request.

[github-actions]

Code Metrics Report

Coverage	Test Execution Time
92.7%	10m19s

Code coverage of files in pull request scope (91.3%)

Files	Coverage
app/components/nextflow/samplesheet/header_component.html.erb	100.0%
app/components/nextflow/samplesheet/header_component.rb	100.0%
app/components/nextflow/samplesheet_component.html.erb	100.0%
app/components/nextflow/samplesheet_component.rb	96.6%
app/components/nextflow_component.html.erb	95.5%
app/components/nextflow_component.rb	100.0%
app/controllers/workflow_executions/file_selector_controller.rb	94.8%
app/controllers/workflow_executions/metadata_controller.rb	0.0%
app/models/concerns/file_selector.rb	90.6%
app/views/projects/automated_workflow_executions/_edit_dialog.html.erb	88.8%
app/views/projects/automated_workflow_executions/_new_automated_workflow_execution_modal.html.erb	100.0%
app/views/workflow_executions/file_selector/_file_selector_dialog.html.erb	100.0%
app/views/workflow_executions/file_selector/create.turbo_stream.erb	100.0%
app/views/workflow_executions/submissions/_pipeline_selection_dialog.html.erb	100.0%

---

Reported by octocov

[joshsadam]

This works exactly as it is supposed. This PR was a lot of work and you did a really great job on it.

[ericenns]

Thanks for implementing this! It works as I expect and looks great!

[deepsidhu85]

This looks great!