refactor: Rewrite DbRunner and Challenge page

* Typed query result: We previously returned the raw "array" and type-hinted them everywhere. Now, the DbRunner returns a QueryResultDto that wraps this type.
* Improved "Result Presenter": Instead of passing the result everywhere, retrieve it directly in the tabs rather than receiving it from the Executor.
* The executor now creates a new SolutionEvent without comparing the results.
* Added a new Comparer that provides more comprehensive difference information.
* Removed "Module" from the component namespace.
* Update DbRunner return style
  * All the cells are string now
  * The first row is header
  * The rows started from the second are the rows

Author: pan93412

assets/controllers/challenge_executor_controller.ts

@@ -53,7 +53,7 @@ export default class extends Controller<HTMLElement> {
       const query = editorView.state.doc.toString();
 
       console.debug("Executing query", { query });
-      await component.action("execute", {
+      await component.action("createNewQuery", {
         query,
       });
 

src/Entity/ChallengeDto/CompareResult/ColumnDifferent.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Entity\ChallengeDto\CompareResult;
+
+use Symfony\Component\Translation\TranslatableMessage;
+
+use function Symfony\Component\Translation\t;
+
+/**
+ * The columns name (first row) is different.
+ */
+readonly class ColumnDifferent implements CompareResult
+{
+    public function correct(): bool
+    {
+        return false;
+    }
+
+    public function reason(): TranslatableMessage
+    {
+        return t('challenge.compare-result.column-different');
+    }
+}

src/Entity/ChallengeDto/CompareResult/CompareResult.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Entity\ChallengeDto\CompareResult;
+
+use Symfony\Component\Translation\TranslatableMessage;
+
+/**
+ * The result of a comparison.
+ */
+interface CompareResult
+{
+    public function correct(): bool;
+
+    public function reason(): TranslatableMessage;
+}

src/Entity/ChallengeDto/CompareResult/EmptyAnswer.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Entity\ChallengeDto\CompareResult;
+
+use Symfony\Component\Translation\TranslatableMessage;
+
+use function Symfony\Component\Translation\t;
+
+readonly class EmptyAnswer implements CompareResult
+{
+    public function correct(): bool
+    {
+        return false;
+    }
+
+    public function reason(): TranslatableMessage
+    {
+        return t('challenge.compare-result.empty-answer');
+    }
+}

src/Entity/ChallengeDto/CompareResult/EmptyResult.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Entity\ChallengeDto\CompareResult;
+
+use Symfony\Component\Translation\TranslatableMessage;
+
+use function Symfony\Component\Translation\t;
+
+readonly class EmptyResult implements CompareResult
+{
+    public function correct(): bool
+    {
+        return false;
+    }
+
+    public function reason(): TranslatableMessage
+    {
+        return t('challenge.compare-result.empty-result');
+    }
+}

src/Entity/ChallengeDto/CompareResult/RowDifferent.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Entity\ChallengeDto\CompareResult;
+
+use Symfony\Component\Translation\TranslatableMessage;
+
+use function Symfony\Component\Translation\t;
+
+readonly class RowDifferent implements CompareResult
+{
+    /**
+     * @param int $row the row number that is different
+     */
+    public function __construct(public int $row)
+    {
+    }
+
+    public function correct(): bool
+    {
+        return false;
+    }
+
+    public function reason(): TranslatableMessage
+    {
+        return t('challenge.compare-result.row-different', [
+            '%row%' => $this->row,
+        ]);
+    }
+}

src/Entity/ChallengeDto/CompareResult/RowUnmatched.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Entity\ChallengeDto\CompareResult;
+
+use Symfony\Component\Translation\TranslatableMessage;
+
+use function Symfony\Component\Translation\t;
+
+readonly class RowUnmatched implements CompareResult
+{
+    /**
+     * @param int $expected the expected row number
+     * @param int $actual   the actual row number
+     */
+    public function __construct(
+        public int $expected,
+        public int $actual,
+    ) {
+    }
+
+    public function correct(): bool
+    {
+        return false;
+    }
+
+    public function reason(): TranslatableMessage
+    {
+        return t('challenge.compare-result.row-unmatched', [
+            '%expected%' => $this->expected,
+            '%actual%' => $this->actual,
+        ]);
+    }
+}

src/Entity/ChallengeDto/CompareResult/Same.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Entity\ChallengeDto\CompareResult;
+
+use Symfony\Component\Translation\TranslatableMessage;
+
+use function Symfony\Component\Translation\t;
+
+/**
+ * There is no different.
+ */
+readonly class Same implements CompareResult
+{
+    public function correct(): bool
+    {
+        return true;
+    }
+
+    public function reason(): TranslatableMessage
+    {
+        return t('challenge.compare-result.same');
+    }
+}

src/Entity/ChallengeDto/FallableQueryResultDto.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Entity\ChallengeDto;
+
+use Symfony\Component\Translation\TranslatableMessage;
+
+/**
+ * A DTO for the result of a query that may contain the error from DbRunner.
+ *
+ * If there is no error, the errorCode will be 0.
+ */
+class FallableQueryResultDto
+{
+    public ?QueryResultDto $result = null;
+    public ?TranslatableMessage $errorMessage = null;
+
+    public function getResult(): ?QueryResultDto
+    {
+        return $this->result;
+    }
+
+    public function setResult(?QueryResultDto $result): self
+    {
+        $this->result = $result;
+
+        return $this;
+    }
+
+    public function getErrorMessage(): ?TranslatableMessage
+    {
+        return $this->errorMessage;
+    }
+
+    public function setErrorMessage(?TranslatableMessage $errorMessage): self
+    {
+        $this->errorMessage = $errorMessage;
+
+        return $this;
+    }
+}

src/Entity/ChallengeDto/QueryResultDto.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Entity\ChallengeDto;
+
+use App\Service\DbRunner;
+
+/**
+ * The typed wrapper for the result of a query from {@link DbRunner}.
+ */
+class QueryResultDto
+{
+    /**
+     * @var array<array<int, string>> the result of the user's query
+     */
+    private array $result;
+
+    /**
+     * @return array<array<int, string>> the result of the user's query
+     */
+    public function getResult(): array
+    {
+        return $this->result;
+    }
+
+    /**
+     * @param array<array<int, string>> $result the result of the user's query
+     */
+    public function setResult(array $result): self
+    {
+        $this->result = $result;
+
+        return $this;
+    }
+}