Skip to content

Beautiful Open-Source Form Builder

Enhance form submission export functionality to support selected submission IDs

Julien Nahum7ca82464ee44
diff --git a/api/app/Http/Controllers/Forms/FormSubmissionController.php b/api/app/Http/Controllers/Forms/FormSubmissionController.php
index 5c7221922..04e14e0b3 100644
--- a/api/app/Http/Controllers/Forms/FormSubmissionController.php
+++ b/api/app/Http/Controllers/Forms/FormSubmissionController.php
@@ -95,14 +95,16 @@ class FormSubmissionController extends Controller
$this->authorize('view', $form);
$displayColumns = collect($request->columns)->filter(fn ($value, $key) => $value === true)->toArray();
+ $submissionIds = $request->input('submissionIds', []);
+ $submissionCount = !empty($submissionIds) ? count($submissionIds) : null;
// Check if we should process asynchronously
- if ($exportService->shouldExportAsync($form)) {
- return $this->startAsyncExport($form, $displayColumns, $exportService);
+ if ($exportService->shouldExportAsync($form, $submissionCount)) {
+ return $this->startAsyncExport($form, $displayColumns, $submissionIds, $exportService);
}
// Process synchronously for small exports
- return $this->processSyncExport($form, $displayColumns, $exportService);
+ return $this->processSyncExport($form, $displayColumns, $submissionIds, $exportService);
}
public function exportStatus(Form $form, string $jobId, FormExportService $exportService)
@@ -124,11 +126,11 @@ class FormSubmissionController extends Controller
return new ExportJobStatusResource($jobData);
}
- private function startAsyncExport(Form $form, array $displayColumns, FormExportService $exportService)
+ private function startAsyncExport(Form $form, array $displayColumns, array $submissionIds, FormExportService $exportService)
{
$jobId = $exportService->initializeAsyncExport($form, Auth::id());
- ExportFormSubmissionsJob::dispatch($form, $displayColumns, $jobId, Auth::id());
+ ExportFormSubmissionsJob::dispatch($form, $displayColumns, $submissionIds, $jobId, Auth::id());
return $this->success([
'message' => 'Export started. Large export will be processed in the background.',
@@ -137,11 +139,16 @@ class FormSubmissionController extends Controller
]);
}
- private function processSyncExport(Form $form, array $displayColumns, FormExportService $exportService)
+ private function processSyncExport(Form $form, array $displayColumns, array $submissionIds, FormExportService $exportService)
{
$allRows = [];
// Use query builder with orderBy for consistency with async export
- foreach ($form->submissions()->orderByDesc('created_at')->get() as $submission) {
+ $submissionQuery = $form->submissions()->orderByDesc('created_at');
+ if (!empty($submissionIds)) {
+ $submissionQuery->whereIn('id', $submissionIds);
+ }
+
+ foreach ($submissionQuery->get() as $submission) {
$allRows[] = $exportService->formatSubmissionForExport($form, $submission, $displayColumns);
}
diff --git a/api/app/Http/Requests/FormSubmissionExportRequest.php b/api/app/Http/Requests/FormSubmissionExportRequest.php
index 13a02e7b6..90ea8da55 100644
--- a/api/app/Http/Requests/FormSubmissionExportRequest.php
+++ b/api/app/Http/Requests/FormSubmissionExportRequest.php
@@ -5,6 +5,7 @@ namespace App\Http\Requests;
use App\Models\Forms\Form;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Http\Request;
+use Illuminate\Validation\Rule;
class FormSubmissionExportRequest extends FormRequest
{
@@ -33,6 +34,11 @@ class FormSubmissionExportRequest extends FormRequest
$fail('The columns contain invalid values: ' . implode(', ', $invalidColumns));
}
}],
+ 'submissionIds' => 'nullable|array',
+ 'submissionIds.*' => [
+ 'integer',
+ Rule::exists('form_submissions', 'id')->where('form_id', $this->form->id),
+ ],
];
}
}
diff --git a/api/app/Jobs/Form/ExportFormSubmissionsJob.php b/api/app/Jobs/Form/ExportFormSubmissionsJob.php
index 80153f340..dd6e2694c 100644
--- a/api/app/Jobs/Form/ExportFormSubmissionsJob.php
+++ b/api/app/Jobs/Form/ExportFormSubmissionsJob.php
@@ -25,6 +25,7 @@ class ExportFormSubmissionsJob implements ShouldQueue
public function __construct(
public Form $form,
public array $columns,
+ public array $submissionIds,
public string $jobId,
public int $userId
) {
@@ -35,8 +36,13 @@ class ExportFormSubmissionsJob implements ShouldQueue
// Initialize job status in cache
$this->updateJobStatus('processing', 0);
+ $submissionQuery = $this->form->submissions()->orderBy('created_at', 'desc');
+ if (!empty($this->submissionIds)) {
+ $submissionQuery->whereIn('id', $this->submissionIds);
+ }
+
// Get total submission count
- $totalSubmissions = $this->form->submissions()->count();
+ $totalSubmissions = (clone $submissionQuery)->count();
if ($totalSubmissions === 0) {
$this->updateJobStatus('failed', 0, 'No submissions to export');
@@ -48,23 +54,21 @@ class ExportFormSubmissionsJob implements ShouldQueue
$processedCount = 0;
$allRows = [];
- $this->form->submissions()
- ->orderBy('created_at', 'desc')
- ->chunk($chunkSize, function ($submissions) use (&$processedCount, &$allRows, $totalSubmissions, $exportService) {
- foreach ($submissions as $submission) {
- $formattedRow = $exportService->formatSubmissionForExport(
- $this->form,
- $submission,
- $this->columns
- );
- $allRows[] = $formattedRow;
- $processedCount++;
- }
-
- // Update progress
- $progress = min(90, ($processedCount / $totalSubmissions) * 90); // Reserve 10% for file generation
- $this->updateJobStatus('processing', $progress, null, $processedCount, $totalSubmissions);
- });
+ $submissionQuery->chunk($chunkSize, function ($submissions) use (&$processedCount, &$allRows, $totalSubmissions, $exportService) {
+ foreach ($submissions as $submission) {
+ $formattedRow = $exportService->formatSubmissionForExport(
+ $this->form,
+ $submission,
+ $this->columns
+ );
+ $allRows[] = $formattedRow;
+ $processedCount++;
+ }
+
+ // Update progress
+ $progress = min(90, ($processedCount / $totalSubmissions) * 90); // Reserve 10% for file generation
+ $this->updateJobStatus('processing', $progress, null, $processedCount, $totalSubmissions);
+ });
// Generate and upload file to S3
$this->updateJobStatus('processing', 95, 'Generating export file...');
diff --git a/api/app/Service/Forms/FormExportService.php b/api/app/Service/Forms/FormExportService.php
index 7cc64a152..a5b56335e 100644
--- a/api/app/Service/Forms/FormExportService.php
+++ b/api/app/Service/Forms/FormExportService.php
@@ -18,9 +18,11 @@ class FormExportService
/**
* Determine if export should be processed synchronously or asynchronously
*/
- public function shouldExportAsync(Form $form): bool
+ public function shouldExportAsync(Form $form, ?int $submissionCount = null): bool
{
- return $form->submissions()->count() > self::SYNC_EXPORT_THRESHOLD;
+ $count = $submissionCount ?? $form->submissions()->count();
+
+ return $count > self::SYNC_EXPORT_THRESHOLD;
}
/**
diff --git a/api/tests/Feature/Forms/FormSubmissionExportTest.php b/api/tests/Feature/Forms/FormSubmissionExportTest.php
index e74811f0f..e8dd42d68 100644
--- a/api/tests/Feature/Forms/FormSubmissionExportTest.php
+++ b/api/tests/Feature/Forms/FormSubmissionExportTest.php
@@ -48,6 +48,77 @@ it('can export form submissions with selected columns', function () {
->assertHeader('content-disposition', 'attachment; filename=' . $form->slug . '-submission-data.csv');
});
+it('exports only the selected submission ids', function () {
+ $user = $this->actingAsProUser();
+ $workspace = $this->createUserWorkspace($user);
+ $form = $this->createForm($user, $workspace);
+
+ $textField = collect($form->properties)->firstWhere('type', 'text');
+
+ $firstSubmissionData = $this->generateFormSubmissionData($form, [
+ $textField['id'] => 'John Selected',
+ ]);
+ $this->postJson(route('forms.answer', $form->slug), $firstSubmissionData)
+ ->assertSuccessful();
+
+ $firstSubmissionId = $form->refresh()->submissions()->orderByDesc('id')->first()->id;
+
+ $secondSubmissionData = $this->generateFormSubmissionData($form, [
+ $textField['id'] => 'Jane Not Selected',
+ ]);
+ $this->postJson(route('forms.answer', $form->slug), $secondSubmissionData)
+ ->assertSuccessful();
+
+ $secondSubmissionId = $form->refresh()->submissions()->orderByDesc('id')->first()->id;
+
+ $response = $this->postJson(route('open.forms.submissions.export', [
+ 'form' => $form,
+ ]), [
+ 'columns' => [
+ $textField['id'] => true,
+ ],
+ 'submissionIds' => [$firstSubmissionId],
+ ]);
+
+ $response->assertSuccessful();
+
+ ob_start();
+ $response->sendContent();
+ $content = ob_get_clean();
+
+ expect(str_contains($content, 'John Selected'))->toBeTrue();
+ expect(str_contains($content, 'Jane Not Selected'))->toBeFalse();
+ expect(str_contains($content, (string) $secondSubmissionId))->toBeFalse();
+});
+
+it('rejects submission ids that do not belong to the form', function () {
+ $user = $this->actingAsProUser();
+ $workspace = $this->createUserWorkspace($user);
+ $form = $this->createForm($user, $workspace);
+ $otherForm = $this->createForm($user, $workspace);
+
+ $textField = collect($otherForm->properties)->firstWhere('type', 'text');
+ $submissionData = $this->generateFormSubmissionData($otherForm, [
+ $textField['id'] => 'Other Form Submission',
+ ]);
+ $this->postJson(route('forms.answer', $otherForm->slug), $submissionData)
+ ->assertSuccessful();
+
+ $otherSubmissionId = $otherForm->refresh()->submissions()->orderByDesc('id')->first()->id;
+
+ $response = $this->postJson(route('open.forms.submissions.export', [
+ 'form' => $form,
+ ]), [
+ 'columns' => [
+ $textField['id'] => true,
+ ],
+ 'submissionIds' => [$otherSubmissionId],
+ ]);
+
+ $response->assertStatus(422)
+ ->assertJsonValidationErrors(['submissionIds.0']);
+});
+
it('cannot export form submissions with invalid columns', function () {
$user = $this->actingAsProUser();
$workspace = $this->createUserWorkspace($user);
diff --git a/client/components/open/forms/FormExportModal.vue b/client/components/open/forms/FormExportModal.vue
index 6ec251d88..d2878abac 100644
--- a/client/components/open/forms/FormExportModal.vue
+++ b/client/components/open/forms/FormExportModal.vue
@@ -109,6 +109,10 @@ const props = defineProps({
columns: {
type: Object,
required: true
+ },
+ selectedIds: {
+ type: Array,
+ default: () => []
}
})
@@ -140,9 +144,15 @@ const startExport = () => {
lastApiCall.value = null
progressStartTime.value = Date.now()
- formsApi.submissions.export(props.form.id, {
+ const payload = {
columns: props.columns
- }).then(response => {
+ }
+
+ if (props.selectedIds.length > 0) {
+ payload.submissionIds = props.selectedIds
+ }
+
+ formsApi.submissions.export(props.form.id, payload).then(response => {
// Check if this is an async export
if (response.is_async) {
// Start async export with polling
diff --git a/client/components/open/tables/OpenTable.vue b/client/components/open/tables/OpenTable.vue
index 4d73c1a5a..fdf09596e 100644
--- a/client/components/open/tables/OpenTable.vue
+++ b/client/components/open/tables/OpenTable.vue
@@ -46,6 +46,7 @@
<FormExportModal
:form="form"
:columns="columnVisibility"
+ :selected-ids="selectedIds"
/>
<UTooltip text="Refresh" arrow>