Enhance Form Submission Export Functionality #657
Conversation
WalkthroughThe pull request introduces changes to the form submission export functionality across multiple files. The modifications allow for more dynamic control over exported data by enabling users to specify which columns should be included in the CSV export. The changes involve updating the Changes
Sequence DiagramsequenceDiagram
participant Client as Form Submissions Component
participant API as Export Controller
participant Database as Form Data Storage
Client->>API: POST /submissions/export
API->>Database: Retrieve Form Submissions
API-->>Client: CSV with Selected Columns
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
api/app/Http/Controllers/Forms/FormSubmissionController.php (1)
64-75: Dynamic column export logic looks solid.
Filtering and mapping columns to$filteredDatabased on$displayColumnsis a neat approach. However, consider validating the existence of$columnkeys in your$formattedDatato avoid edge cases if the request or data changes.client/components/open/forms/components/FormSubmissions.vue (1)
336-342: POST request with column data fosters flexibility but requires server validation.
The new body parameter enhances dynamic exports. Ensure the backend enforces security checks and handles empty or largecolumnsarrays gracefully.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
api/app/Http/Controllers/Forms/FormSubmissionController.php(2 hunks)api/routes/api.php(1 hunks)client/components/open/forms/components/FormSubmissions.vue(2 hunks)
🔇 Additional comments (7)
api/app/Http/Controllers/Forms/FormSubmissionController.php (5)
17-17: Good addition of the Request import for improved handling of input data.
This import is essential for the enhanced export functionality.
50-50: Method signature update is aligned with the POST approach.
The change frompublic function export(string $id)topublic function export(Request $request, string $id)allows dynamic input parameters.
56-56: Security check: Validate$request->columnsbefore usage.
Ensure the request contains the expected data type (array) and handle any malformed input to prevent errors or potential injection.
81-81: Filename customization is clear and consistent with this approach.
Appending-submission-data.csvis straightforward and improves clarity.
88-89: Check for consistency in file paths.
The dynamic file path is carefully constructed. Ensure consistency with the rest of your file downloads to avoid confusion around leading/trailing slashes.client/components/open/forms/components/FormSubmissions.vue (1)
216-216: Removing the leading slash is correct for consistent routing.
Make sure your other API calls also follow the same pattern if needed.api/routes/api.php (1)
164-164: Switching from GET to POST aligns with sending request payload.
This ensures that large or sensitive data can be provided without URL length constraints and is more secure.
| @@ -46,38 +47,46 @@ public function update(AnswerFormRequest $request, $id, $submissionId) | |||
| ]); | |||
| } | |||
|
|
|||
| public function export(string $id) | |||
| public function export(Request $request, string $id) | |||
There was a problem hiding this comment.
Need to validate the new param you added
| { | ||
| $form = Form::findOrFail((int) $id); | ||
| $this->authorize('view', $form); | ||
|
|
||
| $allRows = []; | ||
| $displayColumns = collect($request->columns)->filter(fn ($value, $key) => $value === true)->toArray(); |
There was a problem hiding this comment.
need to ensure the column exist in the form
Summary by CodeRabbit
New Features
Changes
Improvements