Improves DB transaction retry mechanism

Enhances the database transaction retry helper by reducing default retries and delay for quicker failure detection.

Introduces detailed logging for deadlock or serialization errors, including request context for debugging.

Implements exponential backoff with jitter to avoid thundering herd issues.

Improves the log file path generation by adding the date at the beginning.

Author: Ahed92Wakim

src/DBTransactionRetryHelper.php

@@ -19,7 +19,7 @@ class DBTransactionRetryHelper
      * @throws QueryException
      * @throws Throwable
      */
-    public static function transactionWithRetry(callable $callback, int $maxRetries = 5, int $retryDelay = 5, string $logFileName = 'mysql-deadlocks-log'): mixed
+    public static function transactionWithRetry(callable $callback, int $maxRetries = 3, int $retryDelay = 2, string $logFileName = 'mysql-deadlocks'): mixed
     {
         $attempt = 0;
         $throwable = null;
@@ -80,5 +80,64 @@ public static function transactionWithRetry(callable $callback, int $maxRetries
                 }
             }
         }
+
+        // If we exit the loop without returning, throw a generic runtime exception
+        throw new \RuntimeException('Transaction with retry exhausted after ' . $maxRetries . ' attempts.');
+    }
+
+    protected static function isDeadlockOrSerializationError(QueryException $e): bool
+    {
+        // MySQL deadlock: driver error 1213; lock wait timeout: 1205 (often not retryable); SQLSTATE 40001 serialization failure
+        $sqlState = $e->getCode(); // In Laravel, getCode often returns SQLSTATE (e.g., '40001')
+        $driverErr = is_array($e->errorInfo ?? null) && isset($e->errorInfo[1]) ? $e->errorInfo[1] : null;
+
+        return ($sqlState === '40001')
+            || ($driverErr === 1213)
+            || ($sqlState === 1213) // in case driver bubbles numeric
+            ;
+    }
+
+    protected static function buildLogContext(QueryException $e, int $attempt): array
+    {
+        $requestData = [
+            'url' => null,
+            'method' => null,
+            'token' => null,
+            'userId' => null,
+        ];
+
+        try {
+            // Only access request() when available (HTTP context)
+            if (function_exists('request') && app()->bound('request')) {
+                $req = request();
+                $requestData['url'] = method_exists($req, 'getUri') ? $req->getUri() : null;
+                $requestData['method'] = method_exists($req, 'getMethod') ? $req->getMethod() : null;
+                $requestData['token'] = method_exists($req, 'header') ? ($req->header('authorization') ?? null) : null;
+                $requestData['userId'] = method_exists($req, 'user') && $req->user() ? ($req->user()->id ?? null) : null;
+            }
+        } catch (Throwable) {
+            // ignore request context errors for CLI/queue
+        }
+
+        return array_merge([
+            'attempt' => $attempt,
+            'errorInfo' => $e->errorInfo,
+            'ExceptionName' => get_class($e),
+            'QueryException' => $e->getMessage(),
+            'trace' => getDebugBacktraceArray() ?? null,
+        ], $requestData);
+    }
+
+    /**
+     * @throws RandomException
+     */
+    protected static function backoffDelay(int $baseDelay, int $attempt): int
+    {
+        // Simple exponential backoff with jitter: baseDelay * 2^(attempt-1) +/- 25%
+        $delay = max(1, (int)round($baseDelay * pow(2, max(0, $attempt - 1))));
+        $jitter = max(0, (int)round($delay * 0.25));
+        $min = max(1, $delay - $jitter);
+        $max = $delay + $jitter;
+        return random_int($min, $max);
     }
 }

src/Helper.php

@@ -22,19 +22,27 @@ function getDebugBacktraceArray(): array
 if (!function_exists('generateLog')) {
     function generateLog($var, $logFileName, $logType = 'error'): void
     {
-        if (is_null($logFileName)) {
-            $logFilePath = storage_path('logs/general_' . now()->toDateString() . '.log');
+        $date = function_exists('now') ? now()->toDateString() : date('Y-m-d');
+
+        if (empty($logFileName)) {
+            $logFilePath = storage_path('logs/' . date('Y-m-d') . 'general_' . $date . '.log');
         } else {
-            $logFilePath = storage_path("logs/{$logFileName}_" . now()->toDateString() . '.log');
+            $logFilePath = storage_path("logs/" . date('Y-m-d') . "{$logFileName}_" . $date . '.log');
         }
         $log = Log::build([
             'driver' => 'single',
             'path' => $logFilePath,
         ]);
-        if ($logType == 'error') {
-            $log->error(var_export($var, true));
-        } elseif ($logType == 'warning') {
-            $log->warning(var_export($var, true));
+        $payload = is_array($var) ? $var : ['message' => (string)$var];
+        $attempts = $var['attempt'] ?? 0;
+        $errorInfo = $var['errorInfo'][2] ?? '';
+
+        if ($logType === 'error') {
+            $log->error($attempts . ' ' . $errorInfo, $payload);
+        } elseif ($logType === 'warning') {
+            $log->warning($attempts . ' ' . $errorInfo, $payload);
+        } else {
+            $log->info($attempts . ' ' . $errorInfo, $payload);
         }
     }
 }