json way to send data to telegram

Author: Uzziahlukeka

.gitattributes

@@ -18,3 +18,4 @@
 /UPGRADING.md       export-ignore
 /phpstan.neon.dist  export-ignore
 /phpstan-baseline.neon  export-ignore
+/.env

.github/workflows/run-tests.yml

@@ -18,9 +18,12 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest]
         php: [8.4, 8.3]
-        laravel: [11.*, 10.*]
+        laravel: [12.*,11.*, 10.*]
         stability: [prefer-lowest, prefer-stable]
         include:
+          - laravel: 12.*
+            testbench: 9.*
+            carbon: ^2.63
           - laravel: 11.*
             testbench: 9.*
             carbon: ^2.63

composer.json

@@ -21,12 +21,14 @@
         "illuminate/contracts": "^10.0||^11.0||^12.0"
     },
     "require-dev": {
+        "larastan/larastan": "^3.6",
         "laravel/pint": "^1.14",
         "nunomaduro/collision": "^8.1.1||^7.10.0",
         "orchestra/testbench": "^9.0.0||^8.22.0",
         "pestphp/pest": "^3.0",
-        "pestphp/pest-plugin-arch": "^3.0",
-        "pestphp/pest-plugin-laravel": "^3.0"
+        "pestphp/pest-plugin-arch": "^3.1",
+        "pestphp/pest-plugin-laravel": "^3.0",
+        "phpstan/phpstan": "^2.1"
     },
     "autoload": {
         "psr-4": {

src/Telegramlogs.php

@@ -11,22 +11,29 @@
 class Telegramlogs extends AbstractProcessingHandler
 {
     protected string $botToken;
+
     protected string $chatId;
+
     protected ?string $topicId;
+
     protected Client $client;
+
     protected bool $ignoreEmptyMessages;
+
     protected int $timeout;
+
     protected bool $splitLongMessages;
+
     protected int $maxMessageLength;
 
     public function __construct(
         $level = Logger::DEBUG,
         bool $bubble = true,
         ?Client $client = null,
         bool $ignoreEmptyMessages = true,
-        int $timeout = null,
-        bool $splitLongMessages = null,
-        int $maxMessageLength = null
+        ?int $timeout = null,
+        ?bool $splitLongMessages = null,
+        ?int $maxMessageLength = null
     ) {
         parent::__construct($level, $bubble);
 
@@ -50,122 +57,50 @@ protected function write(LogRecord $record): void
             return;
         }
 
-        $formattedMessage = $this->formatRecord($record);
-
         try {
-            $this->sendMessage($formattedMessage);
-        } catch (GuzzleException $e) {
-            // Log the error to the default logger if Telegram fails
-            error_log('Failed to send Telegram log: ' . $e->getMessage());
-        }
-    }
-
-    protected function formatRecord(LogRecord $record): string
-    {
-        $includeContext = config('telegramlogs.formatting.include_context', true);
-        $includeStackTrace = config('telegramlogs.formatting.include_stack_trace', true);
-        $parseMode = config('telegramlogs.formatting.parse_mode', 'MarkdownV2');
-
-        $context = '';
-        if ($includeContext && $record->context) {
-            $context = "\n\nContext:\n```json\n" .
-                json_encode($record->context, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES) .
-                "\n```";
-        }
+            // Convert LogRecord to array for JSON serialization
+            $recordArray = $record->toArray();
 
-        $extra = '';
-        if ($record->extra) {
-            $extra = "\n\nExtra:\n```json\n" .
-                json_encode($record->extra, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES) .
-                "\n```";
-        }
-
-        // Add stack trace for error-level logs if enabled
-        $stackTrace = '';
-        if ($includeStackTrace &&
-            $record->level->value >= \Monolog\Level::Error->value &&
-            isset($record->context['exception'])) {
-            $stackTrace = "\n\nStack Trace:\n```\n" .
-                $record->context['exception']->getTraceAsString() .
-                "\n```";
-        }
-
-        if ($parseMode === 'MarkdownV2') {
-            return sprintf(
-                "*[%s] %s*\n\n`%s`%s%s%s",
-                $record->datetime->format('Y-m-d H:i:s'),
-                strtoupper($record->level->getName()),
-                $this->escapeMarkdown($record->message),
-                $context,
-                $extra,
-                $stackTrace
-            );
-        } elseif ($parseMode === 'HTML') {
-            return sprintf(
-                "<b>[%s] %s</b>\n\n<code>%s</code>%s%s%s",
-                $record->datetime->format('Y-m-d H:i:s'),
-                strtoupper($record->level->getName()),
-                htmlspecialchars($record->message),
-                str_replace(['```json', '```'], ['<pre>', '</pre>'], $context),
-                str_replace(['```json', '```'], ['<pre>', '</pre>'], $extra),
-                str_replace(['```', '```'], ['<pre>', '</pre>'], $stackTrace)
-            );
-        } else {
-            // Plain text
-            return sprintf(
-                "[%s] %s\n\n%s%s%s%s",
-                $record->datetime->format('Y-m-d H:i:s'),
-                strtoupper($record->level->getName()),
-                $record->message,
-                str_replace(['```json', '```', "\n"], ['', '', "\n"], $context),
-                str_replace(['```json', '```', "\n"], ['', '', "\n"], $extra),
-                str_replace(['```', '```'], ['', ''], $stackTrace)
-            );
-        }
-    }
+            // Encode the record array into JSON
+            $message = json_encode($recordArray, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT);
 
-    protected function escapeMarkdown(string $text): string
-    {
-        $characters = ['_', '*', '[', ']', '(', ')', '~', '`', '>', '#', '+', '-', '=', '|', '{', '}', '.', '!'];
-        foreach ($characters as $char) {
-            $text = str_replace($char, '\\' . $char, $text);
+            // Send the JSON message
+            $this->sendMessage($message);
+        } catch (GuzzleException $e) {
+            // Log the error to the default logger if Telegram fails
+            error_log('Failed to send Telegram log: '.$e->getMessage());
         }
-
-        return $text;
     }
 
     protected function sendMessage(string $message): void
     {
         $url = "/bot{$this->botToken}/sendMessage";
 
-        if ($this->splitLongMessages && strlen($message) > $this->maxMessageLength) {
-            $messages = str_split($message, $this->maxMessageLength - 100);
+        // Format message as JSON code block for better readability in Telegram
+        $formattedMessage = "```json\n".$message."\n```";
+
+        if ($this->splitLongMessages && strlen($formattedMessage) > $this->maxMessageLength) {
+            $messages = str_split($formattedMessage, $this->maxMessageLength - 100);
             foreach ($messages as $index => $partialMessage) {
                 $this->sendPartialMessage(
                     $url,
                     sprintf("(%d/%d)\n%s", $index + 1, count($messages), $partialMessage)
                 );
             }
         } else {
-            $this->sendPartialMessage($url, $message);
+            $this->sendPartialMessage($url, $formattedMessage);
         }
     }
 
     protected function sendPartialMessage(string $url, string $message): void
     {
-        $parseMode = config('telegramlogs.formatting.parse_mode', 'MarkdownV2');
-
         $payload = [
             'chat_id' => $this->chatId,
             'text' => $message,
+            'parse_mode' => 'MarkdownV2',
             'disable_web_page_preview' => true,
         ];
 
-        // Only add parse_mode if it's not null (plain text)
-        if ($parseMode) {
-            $payload['parse_mode'] = $parseMode;
-        }
-
         if ($this->topicId) {
             $payload['message_thread_id'] = $this->topicId;
         }

src/TelegramlogsServiceProvider.php

@@ -10,7 +10,7 @@ public function register()
     {
         // Merge package config with app config
         $this->mergeConfigFrom(
-            __DIR__ . '/../config/telegramlogs.php',
+            __DIR__.'/../config/telegramlogs.php',
             'telegramlogs'
         );
     }
@@ -19,7 +19,7 @@ public function boot()
     {
         // Publish config file
         $this->publishes([
-            __DIR__ . '/../config/telegramlogs.php' => config_path('telegramlogs.php'),
+            __DIR__.'/../config/telegramlogs.php' => config_path('telegramlogs.php'),
         ], 'telegramlogs-config');
 
         // Add telegram channel to logging configuration
@@ -32,7 +32,7 @@ protected function addTelegramLogChannel()
         $loggingConfig = config('logging.channels', []);
 
         // Add telegram channel if it doesn't exist, using the config from telegramlogs
-        if (!isset($loggingConfig['telegram'])) {
+        if (! isset($loggingConfig['telegram'])) {
             $telegramChannelConfig = config('telegramlogs.channels.telegram', [
                 'driver' => 'custom',
                 'via' => Telegramlogs::class,

tests/ArchTest.php

@@ -1,5 +1,21 @@
 <?php
 
 arch('it will not use debugging functions')
-    ->expect(['dd', 'dump', 'ray'])
-    ->each->not->toBeUsed();
+    ->expect('App')
+    ->toUseStrictTypes()
+    ->not->toUse(['die', 'dd', 'dump']);
+
+arch()
+    ->expect('Uzhlaravel\Telegramlogs\Commands')
+    ->toBeClasses()
+    ->toExtend('Illuminate\Console\Command')
+    ->toOnlyBeUsedIn('src\Commands');
+
+arch()
+    ->expect('Uzhlaravel\Telegramlogs\Facades')
+    ->toBeClasses()
+    ->toExtend('Illuminate\Support\Facades\Facade');
+
+arch('package classes should be in correct namespace')
+    ->expect('Uzhlaravel\\Telegramlogs')
+    ->toBeClasses();