Conversation
Add a "What files do I need?" link in the upload section that opens a modal explaining the required files for each supported workflow: MaxQuant, DIA-NN, quantms, FragPipe, and mzIdentML.
…s-Dlmbv Clarify required files for proteomics workflow uploads
📝 WalkthroughWalkthroughThe change expands file guidance in the Upload step to include FragPipe workflows and introduces a new File Requirements modal providing detailed per-workflow file requirements. Modal lifecycle functions enable display and closure, with enhanced event handling for outside-click interactions across related modals. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@pmultiqc_service/templates/index.html`:
- Around line 1234-1239: The UI text inside the Tip block containing "The
workflow type is automatically detected..." currently hardcodes "max 10GB" and
must reflect actual runtime limits; update this template snippet to either
display the configured upload limit (read from the same environment/config
variable used by the server, e.g. MAX_FILE_SIZE or MAX_CONTENT_LENGTH) or change
the static copy to the correct values for each deployment (use "4GB" for the
docker-compose default and "500MB" for K8s), ensuring the visible string
replacing "max 10GB" is sourced from configuration or corrected per-deployment
so the message in the div with the Tip matches actual server/nginx limits.
🧹 Nitpick comments (1)
pmultiqc_service/templates/index.html (1)
1096-1126: Modal accessibility could be improved.The new File Requirements modal works correctly but lacks keyboard accessibility and ARIA attributes. While this is consistent with the existing Examples modal, consider these improvements for better accessibility:
- Add
role="dialog"andaria-modal="true"to the modal container- Add
aria-labelledbypointing to the header- Handle Escape key to close the modal
- Trap focus within the modal when open
♿ Optional: Add ARIA attributes for accessibility
<!-- File Requirements Modal --> - <div id="fileRequirementsModal" class="modal" style=" + <div id="fileRequirementsModal" class="modal" role="dialog" aria-modal="true" aria-labelledby="fileReqModalTitle" style=" display: none; ... "> <div class="modal-content" style="..."> <div style="display: flex; justify-content: space-between; align-items: center; margin-bottom: 20px;"> - <h3 style="margin: 0; color: `#333`;">📋 File Requirements by Workflow</h3> + <h3 id="fileReqModalTitle" style="margin: 0; color: `#333`;">📋 File Requirements by Workflow</h3>And add Escape key handling in the script:
document.addEventListener('keydown', function(event) { if (event.key === 'Escape') { closeExamples(); closeFileRequirements(); } });
| <div style="margin-top: 20px; padding: 15px; background: #e7f3ff; border-radius: 8px; border-left: 4px solid #007bff;"> | ||
| <p style="margin: 0; color: #004085; font-size: 0.9em;"> | ||
| <strong>Tip:</strong> The workflow type is automatically detected based on the files in your ZIP archive. | ||
| Make sure to include all required files in a single ZIP archive (max 10GB). | ||
| </p> | ||
| </div> |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Search for file size limit configuration in the codebase
rg -n -i "10.*gb|max.*size|upload.*limit|size.*limit" --type-add 'config:*.{py,yml,yaml,json,toml,ini,cfg,env}' --type configRepository: bigbio/pmultiqc
Length of output: 2474
Update the 10GB limit claim to match actual deployment configuration.
The template states a 10GB maximum file size, but the production docker-compose default (MAX_CONTENT_LENGTH) is set to 4GB. Additionally, K8s deployments have a 500MB nginx limit. Users will see 10GB in the UI but may be unable to upload files beyond the actual deployment limit, causing confusion. Either:
- Update the template to reflect the actual limit for each deployment (4GB for docker-compose, 500MB for K8s), or
- Document that the limit is configurable via
MAX_FILE_SIZEenvironment variable, or - Standardize the limits across all deployment configurations.
🤖 Prompt for AI Agents
In `@pmultiqc_service/templates/index.html` around lines 1234 - 1239, The UI text
inside the Tip block containing "The workflow type is automatically detected..."
currently hardcodes "max 10GB" and must reflect actual runtime limits; update
this template snippet to either display the configured upload limit (read from
the same environment/config variable used by the server, e.g. MAX_FILE_SIZE or
MAX_CONTENT_LENGTH) or change the static copy to the correct values for each
deployment (use "4GB" for the docker-compose default and "500MB" for K8s),
ensuring the visible string replacing "max 10GB" is sourced from configuration
or corrected per-deployment so the message in the div with the Tip matches
actual server/nginx limits.
2 participants
Pull Request
Description
Brief description of the changes made in this PR.
Type of Change
Summary by CodeRabbit
New Features
Improvements
✏️ Tip: You can customize this high-level summary in your review settings.