Fix exception throwing for MSSQL insert queries (#993)

Author: mvorisek

.github/workflows/test-unit.yml

@@ -221,7 +221,7 @@ jobs:
           if [ -n "$LOG_COVERAGE" ]; then mv coverage/phpunit.cov coverage/phpunit-mssql.cov; fi
 
       - name: "Run tests: Oracle - PDO (only for coverage or cron)"
-        if: (success() || failure()) && env.LOG_COVERAGE || github.event_name == 'schedule'
+        if: (success() || failure()) && (env.LOG_COVERAGE || github.event_name == 'schedule')
         env:
           DB_DSN: "pdo_oci:dbname=oracle/xe"
           DB_USER: system

composer.json

@@ -57,6 +57,9 @@
     "suggest": {
         "jdorn/sql-formatter": "*"
     },
+    "conflict": {
+        "jdorn/sql-formatter": "<1.2.9"
+    },
     "minimum-stability": "dev",
     "prefer-stable": true,
     "autoload": {

src/Model/UserAction.php

@@ -241,10 +241,10 @@ public function getConfirmation()
         if ($this->confirmation instanceof \Closure) {
             return ($this->confirmation)($this);
         } elseif ($this->confirmation === true) {
-            $confirmation = 'Are you sure you wish to execute ';
-            $confirmation .= $this->getCaption();
-            $confirmation .= $this->getEntity()->getTitle() ? ' using ' . $this->getEntity()->getTitle() : '';
-            $confirmation .= '?';
+            $confirmation = 'Are you sure you wish to execute '
+                . $this->getCaption()
+                . ($this->getEntity()->getTitle() ? ' using ' . $this->getEntity()->getTitle() : '')
+                . '?';
 
             return $confirmation;
         }

src/Persistence/Sql/Mssql/ExpressionTrait.php

@@ -4,6 +4,9 @@
 
 namespace Atk4\Data\Persistence\Sql\Mssql;
 
+use Doctrine\DBAL\Exception\DriverException;
+use Doctrine\DBAL\Result as DbalResult;
+
 trait ExpressionTrait
 {
     private function fixOpenEscapeChar(string $v): string
@@ -37,4 +40,73 @@ protected function hasNativeNamedParamSupport(): bool
     {
         return false;
     }
+
+    /**
+     * Fix exception throwing for MSSQL TRY/CATCH SQL (for Query::$template_insert).
+     *
+     * Remove once https://github.com/microsoft/msphpsql/issues/1387 is fixed and released.
+     */
+    public function execute(object $connection = null): DbalResult
+    {
+        $templateStr = preg_replace('~^\s*begin\s+(.+?)\s+end\s*$~is', '$1', $this->template ?? 'select...'); // @phpstan-ignore-line
+        if (preg_match('~^(.*?)begin\s+try(.+?)end\s+try\s+begin\s+catch(.+)end\s+catch(.*?)$~is', $templateStr, $matches)) {
+            $executeFx = function (string $template) use ($connection): DbalResult {
+                $thisCloned = clone $this;
+                $thisCloned->template = !str_contains(trim(trim($template), ';'), ';')
+                    ? $template
+                    : 'BEGIN' . "\n" . $template . "\n" . 'END';
+
+                return $thisCloned->execute($connection);
+            };
+
+            $templateBefore = trim($matches[1]);
+            $templateTry = trim($matches[2]);
+            $templateAfter = trim($matches[4]);
+
+            $expectedInsertTemplate = <<<'EOF'
+                begin try
+                  insert[option] into [table_noalias] ([set_fields]) values ([set_values]);
+                end try begin catch
+                  if ERROR_NUMBER() = 544 begin
+                    set IDENTITY_INSERT [table_noalias] on;
+                    begin try
+                      insert[option] into [table_noalias] ([set_fields]) values ([set_values]);
+                      set IDENTITY_INSERT [table_noalias] off;
+                    end try begin catch
+                      set IDENTITY_INSERT [table_noalias] off;
+                      throw;
+                    end catch
+                  end else begin
+                    throw;
+                  end
+                end catch
+                EOF;
+
+            if ($templateBefore === '' && $templateAfter === '' && $templateStr === $expectedInsertTemplate) {
+                $executeCatchFx = function (\Exception $e) use ($executeFx): DbalResult {
+                    $eDriver = $e->getPrevious();
+                    if ($eDriver !== null && $eDriver instanceof DriverException && $eDriver->getCode() === 544) {
+                        try {
+                            return $executeFx('set IDENTITY_INSERT [table_noalias] on;'
+                                . "\n" . 'insert[option] into [table_noalias] ([set_fields]) values ([set_values]);');
+                        } finally {
+                            $executeFx('set IDENTITY_INSERT [table_noalias] off;');
+                        }
+                    }
+
+                    throw $e;
+                };
+            } else {
+                throw new \Error('Unexpected MSSQL TRY/CATCH SQL: ' . $templateStr);
+            }
+
+            try {
+                return $executeFx($templateTry);
+            } catch (\Exception $e) {
+                return $executeCatchFx($e);
+            }
+        }
+
+        return parent::execute($connection);
+    }
 }

src/Persistence/Sql/Query.php

@@ -435,17 +435,10 @@ public function _render_join(): ?string
         }
         $joins = [];
         foreach ($this->args['join'] as $j) {
-            $jj = '';
-
-            $jj .= $j['t'] . ' join ';
-
-            $jj .= $this->escapeIdentifierSoft($j['f1']);
-
-            if ($j['fa'] !== null) {
-                $jj .= ' ' . $this->escapeIdentifier($j['fa']);
-            }
-
-            $jj .= ' on ';
+            $jj = $j['t'] . ' join '
+                . $this->escapeIdentifierSoft($j['f1'])
+                . ($j['fa'] !== null ? ' ' . $this->escapeIdentifier($j['fa']) : '')
+                . ' on ';
 
             if (isset($j['expr'])) {
                 $jj .= $this->consume($j['expr']);