Backend for Form Logic

.github/workflows/docker-publish.yml

@@ -34,7 +34,7 @@ jobs:
       # Login against a Docker registry except on PR
       # https://github.com/docker/login-action
       - name: Log into registry ${{ env.REGISTRY }}
-        if: ${{ github.event_name != 'pull_request' }}
+        if: ${{ github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository }}
         uses: docker/login-action@v3.1.0
         with:
           registry: ${{ env.REGISTRY }}
@@ -48,6 +48,14 @@ jobs:
         uses: docker/metadata-action@v5.5.1
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
 
       # Build and push Docker image with Buildx (don't push on PR)
       # https://github.com/docker/build-push-action
@@ -57,7 +65,7 @@ jobs:
         with:
           context: .
           platforms: linux/amd64,linux/arm64
-          push: ${{ github.event_name != 'pull_request' }}
+          push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           cache-from: type=gha

README.md

@@ -20,6 +20,7 @@ We are using [Laravel Sail](https://laravel.com/docs/master/sail) to develop Inp
 
 -   [Docker](https://www.docker.com/get-started/)
 -   [NodeJS](https://nodejs.org/) (v16 LTS preferred)
+-   [mise-en-place](https://mise.jdx.dev/) (for task automation)
 
 ### Download
 
@@ -39,10 +40,10 @@ cp .env.dev.example .env
 
 ### Running
 
-Make sure that your Docker agent is running. There are several steps necessary to build the app for the first time. To simplify these tasks, we have a Makefile in place. Just run the following command, and all build steps will run automatically:
+Make sure that your Docker agent is running. There are several steps necessary to build the app for the first time. To simplify these tasks, we use mise-en-place. Just run the following command, and all build steps will run automatically:
 
 ```bash
-make up
+mise task up
 ```
 
 ### Webpack (Mix)

app/Http/Controllers/Api/FormBlockLogicController.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace App\Http\Controllers\Api;
+
+use App\Models\FormBlock;
+use App\Models\FormBlockLogic;
+use App\Http\Controllers\Controller;
+use App\Http\Requests\FormBlockLogicRequest;
+
+class FormBlockLogicController extends Controller
+{
+    public function create(FormBlockLogicRequest $request, FormBlock $block)
+    {
+        return response()->json($block->formBlockLogics()->create($request->validated()), 201);
+    }
+
+    public function update(FormBlockLogicRequest $request, FormBlockLogic $logic)
+    {
+        return response()->json($logic->update($request->validated()));
+    }
+
+    public function delete(FormBlockLogic $logic)
+    {
+        $logic->delete();
+
+        return response()->json(null, 200);
+    }
+}

app/Http/Requests/FormBlockLogicRequest.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace App\Http\Requests;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class FormBlockLogicRequest extends FormRequest
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     */
+    public function authorize(): bool
+    {
+        return true;
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array<string, \Illuminate\Contracts\Validation\ValidationRule|array<mixed>|string>
+     */
+    public function rules(): array
+    {
+        return [
+            'name' => 'required|string|max:255',
+            'conditions' => 'required|array',
+            'conditions.*.source' => 'required|string',
+            'conditions.*.operator' => 'required|string|in:equals,equalsNot,contains,containsNot,isLowerThan,isGreaterThan',
+            'conditions.*.value' => 'required|string',
+            'conditions.*.chainOperator' => 'required|string|in:and,or',
+            'action' => 'required|string|in:hide,show,goto',
+            'action_payload' => 'nullable|string',
+            'evaluate' => 'required|string|in:before,after',
+        ];
+    }
+
+    public function messages()
+    {
+        return [
+            'name.required' => 'The name is required.',
+            'conditions.required' => 'At least one condition is required.',
+            'conditions.*.source.required' => 'The source block for your #:position condition is required.',
+            'conditions.*.value.required' => 'The value for your #:position condition is required.',
+            'conditions.*.operator.required' => 'The operator for the #:position condition is required.',
+            'conditions.*.chainOperator.required' => 'The chain operator for the #:position condition is required.',
+            'action.required' => 'The action is required.',
+            'evaluate.required' => 'The evaluate is required.',
+        ];
+    }
+}

app/Http/Resources/PublicFormBlockLogicResource.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Http\Resources;
+
+use Illuminate\Http\Request;
+use Illuminate\Http\Resources\Json\JsonResource;
+
+class PublicFormBlockLogicResource extends JsonResource
+{
+    /**
+     * Transform the resource into an array.
+     *
+     * @return array<string, mixed>
+     */
+    public function toArray(Request $request): array
+    {
+        return [
+            'id' => $this->uuid,
+            'name' => $this->name,
+            'action' => $this->action,
+            'evaluate' => $this->evaluate,
+            'conditions' => $this->conditions,
+            'action_payload' => $this->action_payload,
+        ];
+    }
+}

app/Http/Resources/PublicFormBlockResource.php

@@ -3,6 +3,7 @@
 namespace App\Http\Resources;
 
 use Illuminate\Http\Resources\Json\JsonResource;
+use App\Http\Resources\PublicFormBlockLogicResource;
 
 class PublicFormBlockResource extends JsonResource
 {
@@ -14,6 +15,7 @@ class PublicFormBlockResource extends JsonResource
      */
     public function toArray($request)
     {
+        $logics = $this->formBlockLogics;
         $interactions = $this->activeInteractions;
 
         if ($this->options && $this->options['randomize_responses'] === true) {
@@ -34,6 +36,7 @@ public function toArray($request)
             'is_required' => $this->is_required,
             'parent_block' => $this->parent_block,
             'interactions' => PublicFormBlockInteractionResource::collection($interactions),
+            'logics' => PublicFormBlockLogicResource::collection($logics),
         ];
     }
 }

app/Models/FormBlock.php

@@ -2,12 +2,13 @@
 
 namespace App\Models;
 
-use App\Enums\FormBlockInteractionType;
-use App\Enums\FormBlockType;
-use App\Scopes\Sequence;
 use Hashids\Hashids;
-use Illuminate\Database\Eloquent\Factories\HasFactory;
+use App\Scopes\Sequence;
 use Webpatser\Uuid\Uuid;
+use App\Enums\FormBlockType;
+use App\Models\FormBlockLogic;
+use App\Enums\FormBlockInteractionType;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
 
 class FormBlock extends BaseModel
 {
@@ -26,7 +27,7 @@ class FormBlock extends BaseModel
 
     protected $guarded = [];
 
-    protected $with = ['formBlockInteractions'];
+    protected $with = ['formBlockInteractions', 'formBlockLogics'];
 
     protected $casts = [
         'is_required' => 'boolean',
@@ -38,10 +39,12 @@ class FormBlock extends BaseModel
 
     protected $appends = [
         'interactions',
+        'logics',
     ];
 
     protected $hidden = [
         'formBlockInteractions',
+        'formBlockLogics',
     ];
 
     protected static function boot()
@@ -93,6 +96,11 @@ public function formBlockInteractions()
         return $this->hasMany(FormBlockInteraction::class, 'form_block_id');
     }
 
+    public function formBlockLogics()
+    {
+        return $this->hasMany(FormBlockLogic::class, 'form_block_id');
+    }
+
     public function activeInteractions()
     {
         return $this->hasMany(FormBlockInteraction::class, 'form_block_id')
@@ -106,6 +114,11 @@ public function getInteractionsAttribute()
         return $this->formBlockInteractions;
     }
 
+    public function getLogicsAttribute()
+    {
+        return $this->formBlockLogics;
+    }
+
     public function getSessionCountAttribute()
     {
         return $this->formSessionResponses()->selectRaw('COUNT(DISTINCT form_session_id) as count')->first()->count;

app/Models/FormBlockLogic.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace App\Models;
+
+use Illuminate\Support\Str;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+
+class FormBlockLogic extends Model
+{
+    use HasFactory;
+
+    protected $guarded = [];
+
+    protected $casts = [
+        'conditions' => 'array',
+        'action_payload' => 'array',
+    ];
+
+    protected static function boot()
+    {
+        parent::boot();
+
+        self::creating(function ($model) {
+            $model->uuid = (string) Str::orderedUuid();
+        });
+    }
+
+    public function formBlock()
+    {
+        return $this->belongsTo(FormBlock::class);
+    }
+}

database/factories/FormBlockLogicFactory.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Database\Factories;
+
+use App\Models\FormBlock;
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+/**
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\FormBlockLogic>
+ */
+class FormBlockLogicFactory extends Factory
+{
+    /**
+     * Define the model's default state.
+     *
+     * @return array<string, mixed>
+     */
+    public function definition(): array
+    {
+        return [
+            'name' => $this->faker->name(),
+            'action' => 'hide',
+            'evaluate' => 'before',
+            'conditions' => [
+                [
+                    'source' => $this->faker->uuid,
+                    'operator' => 'equals',
+                    'value' => 'test',
+                    'chainOperator' => 'and',
+                ]
+            ],
+            'action_payload' => [],
+            'form_block_id' => FormBlock::factory(),
+        ];
+    }
+}

database/migrations/2024_10_04_132306_create_form_block_rules_table.php

@@ -0,0 +1,25 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class () extends Migration {
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::create('form_block_logics', function (Blueprint $table) {
+            $table->bigIncrements('id');
+            $table->char('uuid', 36);
+            $table->string('name');
+            $table->json('conditions');
+            $table->string('action');
+            $table->json('actionPayload')->nullable();
+            $table->string('evaluate')->default('before');
+            $table->unsignedBigInteger('form_block_id');
+            $table->timestamps();
+        });
+    }
+};

database/migrations/2024_11_01_155436_fix_wrong_attribute_name.php

@@ -0,0 +1,17 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class () extends Migration {
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::table('form_block_logics', function (Blueprint $table) {
+            $table->renameColumn('actionPayload', 'action_payload');
+        });
+    }
+};

mise.toml

@@ -0,0 +1,12 @@
+[tools]
+node = "18"
+
+[tasks.up]
+run = [
+    "docker run --rm -u \"$(id -u):$(id -g)\" -v \"$(pwd):/var/www/html\" -w \"/var/www/html\" laravelsail/php83-composer:latest composer install --ignore-platform-reqs",
+    "./vendor/bin/sail up -d",
+    "./vendor/bin/sail artisan migrate",
+    "./vendor/bin/sail artisan key:generate",
+    "npm ci",
+    "npm run dev",
+]