Beautiful Open-Source Form Builder
BE-005 - Implement auto-increment ID generation for forms and enhance form sub… (#1147)
Chirag Chhatrala5d5c193912f2
diff --git a/api/app/Jobs/Form/StoreFormSubmissionJob.php b/api/app/Jobs/Form/StoreFormSubmissionJob.phpindex 6145c297c..294a5bd47 100644--- a/api/app/Jobs/Form/StoreFormSubmissionJob.php+++ b/api/app/Jobs/Form/StoreFormSubmissionJob.php@@ -9,6 +9,7 @@ use App\Service\Storage\FileUploadPathService;use App\Models\Forms\Form;use App\Models\Forms\FormSubmission;use App\Service\Billing\Feature;+use App\Service\Forms\FormAutoIncrementSequence;use App\Service\Forms\FormLogicPropertyResolver;use App\Service\Storage\StorageFileNameParser;use Illuminate\Bus\Queueable;@@ -48,6 +49,8 @@ class StoreFormSubmissionJob implements ShouldQueueuse Queueable;use SerializesModels;+ private const AUTO_INCREMENT_ID_PLACEHOLDER = '__opnform_auto_increment_id__';+public ?int $submissionId = null;/**@@ -177,9 +180,9 @@ class StoreFormSubmissionJob implements ShouldQueue** @param array $formData*/- private function storeSubmission(array $formData)+ private function storeSubmission(array &$formData){- DB::transaction(function () use ($formData) {+ DB::transaction(function () use (&$formData) {// Handle record updateif ($recordToUpdate = $this->resolveRecordToUpdate($this->submissionData)) {$this->submissionId = $recordToUpdate;@@ -201,15 +204,43 @@ class StoreFormSubmissionJob implements ShouldQueue$submission->form_id = $this->form->id;}- $submission->data = $formData;- $submission->completion_time = $this->completionTime;-if ($this->isPartial) {- $submission->status = FormSubmission::STATUS_PARTIAL;- } else {- $submission->status = FormSubmission::STATUS_COMPLETED;+ foreach ($formData as $fieldId => $value) {+ if ($value === self::AUTO_INCREMENT_ID_PLACEHOLDER) {+ unset($formData[$fieldId]);+ }+ }+ } elseif (in_array(self::AUTO_INCREMENT_ID_PLACEHOLDER, $formData, true)) {+ $existingData = $submission->exists ? ($submission->data ?? []) : [];+ $isCompletedEdit = $submission->exists && $submission->status === FormSubmission::STATUS_COMPLETED;+ $generatedAutoIncrementId = null;++ foreach ($formData as $fieldId => $value) {+ if ($value !== self::AUTO_INCREMENT_ID_PLACEHOLDER) {+ continue;+ }++ if (array_key_exists($fieldId, $existingData)) {+ $formData[$fieldId] = $existingData[$fieldId];+ continue;+ }++ if ($isCompletedEdit) {+ unset($formData[$fieldId]);+ continue;+ }++ $generatedAutoIncrementId ??= FormAutoIncrementSequence::allocateNext($this->form);+ $formData[$fieldId] = $generatedAutoIncrementId;+ }}+ $submission->data = $formData;+ $submission->completion_time = $this->completionTime;+ $submission->status = $this->isPartial+ ? FormSubmission::STATUS_PARTIAL+ : FormSubmission::STATUS_COMPLETED;+if (!$this->submissionId) {$submission->public_id = Str::uuid()->toString();}@@ -293,7 +324,7 @@ class StoreFormSubmissionJob implements ShouldQueue}} elseif (isset($field['generates_auto_increment_id']) && $field['generates_auto_increment_id'] && $field['type'] == 'text') {if (empty($answerValue) || !is_numeric($answerValue)) {- $finalData[$field['id']] = $this->workspaceHasIdGenerationAccess() ? (string)($this->form->submissions_count + 1) : 'Please upgrade your OpenForm subscription to use our ID generation features';+ $finalData[$field['id']] = $this->autoIncrementIdPlaceholder();} else {$finalData[$field['id']] = $answerValue;}@@ -415,7 +446,7 @@ class StoreFormSubmissionJob implements ShouldQueue}if (isset($property['generates_auto_increment_id']) && $property['generates_auto_increment_id']) {- $formData[$property['id']] = $this->workspaceHasIdGenerationAccess() ? (string)($this->form->submissions_count + 1) : 'Please upgrade your OpenForm subscription to use our ID generation features';+ $formData[$property['id']] = $this->autoIncrementIdPlaceholder();return; // ID generated, so we skip prefill logic for this field.}}@@ -460,4 +491,13 @@ class StoreFormSubmissionJob implements ShouldQueuereturn $workspace->hasFeature(Feature::ID_GENERATION);}++ private function autoIncrementIdPlaceholder(): string+ {+ if (!$this->workspaceHasIdGenerationAccess()) {+ return 'Please upgrade your OpenForm subscription to use our ID generation features';+ }++ return self::AUTO_INCREMENT_ID_PLACEHOLDER;+ }}diff --git a/api/app/Service/Forms/FormAutoIncrementSequence.php b/api/app/Service/Forms/FormAutoIncrementSequence.phpnew file mode 100644index 000000000..79f7c7173--- /dev/null+++ b/api/app/Service/Forms/FormAutoIncrementSequence.php@@ -0,0 +1,30 @@+<?php++namespace App\Service\Forms;++use App\Models\Forms\Form;+use Illuminate\Support\Facades\DB;++class FormAutoIncrementSequence+{+ /**+ * Atomically allocate the next auto-increment ID for a form.+ */+ public static function allocateNext(Form $form): string+ {+ return (string) DB::transaction(function () use ($form) {+ $lockedForm = Form::query()+ ->whereKey($form->id)+ ->lockForUpdate()+ ->firstOrFail();++ $next = $lockedForm->auto_increment_sequence + 1;++ DB::table('forms')+ ->where('id', $lockedForm->id)+ ->update(['auto_increment_sequence' => $next]);++ return $next;+ });+ }+}diff --git a/api/database/migrations/2026_05_28_000000_add_auto_increment_sequence_to_forms_table.php b/api/database/migrations/2026_05_28_000000_add_auto_increment_sequence_to_forms_table.phpnew file mode 100644index 000000000..fff9a8ba5--- /dev/null+++ b/api/database/migrations/2026_05_28_000000_add_auto_increment_sequence_to_forms_table.php@@ -0,0 +1,56 @@+<?php++use App\Models\Forms\FormSubmission;+use Illuminate\Database\Migrations\Migration;+use Illuminate\Database\Schema\Blueprint;+use Illuminate\Support\Facades\DB;+use Illuminate\Support\Facades\Schema;++return new class () extends Migration {+ /**+ * Run the migrations.+ */+ public function up(): void+ {+ if (!Schema::hasColumn('forms', 'auto_increment_sequence')) {+ Schema::table('forms', function (Blueprint $table) {+ $table->unsignedBigInteger('auto_increment_sequence')->default(0);+ });+ }++ $completedStatus = FormSubmission::STATUS_COMPLETED;++ DB::table('forms')->orderBy('id')->chunkById(100, function ($forms) use ($completedStatus) {+ foreach ($forms as $form) {+ if ((int) $form->auto_increment_sequence !== 0) {+ continue;+ }++ $count = DB::table('form_submissions')+ ->where('form_id', $form->id)+ ->where('status', $completedStatus)+ ->count();++ if ($count === 0) {+ continue;+ }++ DB::table('forms')+ ->where('id', $form->id)+ ->update(['auto_increment_sequence' => $count]);+ }+ });+ }++ /**+ * Reverse the migrations.+ */+ public function down(): void+ {+ if (Schema::hasColumn('forms', 'auto_increment_sequence')) {+ Schema::table('forms', function (Blueprint $table) {+ $table->dropColumn('auto_increment_sequence');+ });+ }+ }+};diff --git a/api/tests/Unit/Service/Forms/FormAutoIncrementSequenceTest.php b/api/tests/Unit/Service/Forms/FormAutoIncrementSequenceTest.phpnew file mode 100644index 000000000..824bd15fe--- /dev/null+++ b/api/tests/Unit/Service/Forms/FormAutoIncrementSequenceTest.php@@ -0,0 +1,173 @@+<?php++use App\Events\Forms\FormSaved;+use App\Models\Forms\FormSubmission;+use App\Service\Forms\FormAutoIncrementSequence;+use Illuminate\Support\Facades\Event;++uses(\Tests\TestCase::class);++it('allocates monotonically increasing ids atomically per form', function () {+ $user = $this->createProUser();+ $workspace = $this->createUserWorkspace($user);+ $form = $this->createForm($user, $workspace);++ expect(FormAutoIncrementSequence::allocateNext($form))->toBe('1');+ expect(FormAutoIncrementSequence::allocateNext($form->fresh()))->toBe('2');+ expect(FormAutoIncrementSequence::allocateNext($form->fresh()))->toBe('3');++ expect($form->fresh()->auto_increment_sequence)->toBe(3);+});++it('uses independent sequences per form', function () {+ $user = $this->createProUser();+ $workspace = $this->createUserWorkspace($user);+ $formA = $this->createForm($user, $workspace);+ $formB = $this->createForm($user, $workspace);++ expect(FormAutoIncrementSequence::allocateNext($formA))->toBe('1');+ expect(FormAutoIncrementSequence::allocateNext($formB))->toBe('1');+ expect(FormAutoIncrementSequence::allocateNext($formA->fresh()))->toBe('2');+});++it('does not dispatch form saved events when allocating an id', function () {+ $user = $this->createProUser();+ $workspace = $this->createUserWorkspace($user);+ $form = $this->createForm($user, $workspace);++ Event::fake([FormSaved::class]);++ expect(FormAutoIncrementSequence::allocateNext($form))->toBe('1');++ Event::assertNotDispatched(FormSaved::class);+});++it('assigns the same generated id to multiple auto-increment fields in one submission', function () {+ $user = $this->actingAsProUser();+ $workspace = $this->createUserWorkspace($user);+ $fieldA = 'ticket_a';+ $fieldB = 'ticket_b';+ $form = $this->createForm($user, $workspace, [+ 'properties' => [+ [+ 'id' => $fieldA,+ 'type' => 'text',+ 'name' => 'Ticket A',+ 'hidden' => true,+ 'required' => false,+ 'generates_auto_increment_id' => true,+ ],+ [+ 'id' => $fieldB,+ 'type' => 'text',+ 'name' => 'Ticket B',+ 'hidden' => true,+ 'required' => false,+ 'generates_auto_increment_id' => true,+ ],+ ],+ ]);++ $this->postJson(route('forms.answer', $form->slug), [])+ ->assertSuccessful();++ $submission = $form->submissions()->first();+ expect($submission->data[$fieldA])->toBe('1');+ expect($submission->data[$fieldB])->toBe('1');++ $this->postJson(route('forms.answer', $form->slug), [])+ ->assertSuccessful();++ $secondSubmission = $form->submissions()->orderByDesc('id')->first();+ expect($secondSubmission->data[$fieldA])->toBe('2');+ expect($secondSubmission->data[$fieldB])->toBe('2');+});++it('does not allocate auto-increment ids for partial submissions until completion', function () {+ $user = $this->actingAsBusinessUser();+ $workspace = $this->createUserWorkspace($user);+ $nameField = '384172a5-7815-43f1-b865-bb6300a77c48';+ $autoIncrementField = 'f68c5823-588f-43a4-93dd-66553e4b6feb';+ $form = $this->createForm($user, $workspace, [+ 'enable_partial_submissions' => true,+ 'properties' => [+ [+ 'id' => $nameField,+ 'type' => 'text',+ 'name' => 'Name',+ 'required' => false,+ ],+ [+ 'id' => $autoIncrementField,+ 'type' => 'text',+ 'name' => 'Ticket ID',+ 'hidden' => true,+ 'required' => false,+ 'generates_auto_increment_id' => true,+ ],+ ],+ ]);++ $partialResponse = $this->postJson(route('forms.answer', $form->slug), [+ $nameField => 'Draft',+ 'is_partial' => true,+ ])->assertSuccessful();++ $submission = $form->submissions()->first();+ expect($submission->status)->toBe(FormSubmission::STATUS_PARTIAL);+ expect($submission->data)->not->toHaveKey($autoIncrementField);+ expect($form->fresh()->auto_increment_sequence)->toBe(0);++ $this->postJson(route('forms.answer', $form->slug), [+ $nameField => 'Completed',+ 'submission_hash' => $partialResponse->json('submission_hash'),+ ])->assertSuccessful();++ $submission->refresh();+ expect($submission->status)->toBe(FormSubmission::STATUS_COMPLETED);+ expect($submission->data[$autoIncrementField])->toBe('1');+ expect($form->fresh()->auto_increment_sequence)->toBe(1);+});++it('preserves existing auto-increment ids when editing completed submissions', function () {+ $user = $this->actingAsBusinessUser();+ $workspace = $this->createUserWorkspace($user);+ $nameField = 'dc4b72dc-3812-4ed8-aaba-9ef95b6b6cde';+ $autoIncrementField = 'c30a87b8-bc32-4215-9ec0-5d8f5f823e04';+ $form = $this->createForm($user, $workspace, [+ 'editable_submissions' => true,+ 'properties' => [+ [+ 'id' => $nameField,+ 'type' => 'text',+ 'name' => 'Name',+ 'required' => false,+ ],+ [+ 'id' => $autoIncrementField,+ 'type' => 'text',+ 'name' => 'Ticket ID',+ 'hidden' => true,+ 'required' => false,+ 'generates_auto_increment_id' => true,+ ],+ ],+ ]);++ $response = $this->postJson(route('forms.answer', $form->slug), [+ $nameField => 'Original',+ ])->assertSuccessful();++ $submission = $form->submissions()->first();+ expect($submission->data[$autoIncrementField])->toBe('1');++ $this->postJson(route('forms.answer', $form->slug), [+ $nameField => 'Edited',+ 'submission_id' => $response->json('submission_id'),+ ])->assertSuccessful();++ $submission->refresh();+ expect($submission->data[$nameField])->toBe('Edited');+ expect($submission->data[$autoIncrementField])->toBe('1');+ expect($form->fresh()->auto_increment_sequence)->toBe(1);+});