- WIP on negundo's JS client

asset/negundo/js/debug.js

@@ -1,4 +1,7 @@
 class ErrorHandler {
+
+    #unhandledRection = false
+
     constructor(options) {
         if (!options) throw new Error("Options not provided");
         if (!options.url) throw new Error("URL is required");
@@ -9,36 +12,6 @@ class ErrorHandler {
         this.catchError();
     }
 
-    getSourceCode(lineNumber) {
-        return this.getInlineSourceCode(lineNumber) || this.getFullSourceWithHighlight(lineNumber);
-    }
-
-    getInlineSourceCode(lineNumber) {
-        const scripts = document.querySelectorAll('script');
-        for (let script of scripts) {
-            if (!script.src) { 
-                const scriptLines = script.textContent.split("\n");
-                const scriptPosition = this.getErrorPosition(script);
-                if (lineNumber >= scriptPosition.startLine && lineNumber <= scriptPosition.endLine) {
-                    return this.highlightSource(scriptLines, lineNumber - scriptPosition.startLine);
-                }
-            }
-        }
-        return null;
-    }
-
-    getFullSourceWithHighlight(lineNumber) {
-        const lines = document.documentElement.outerHTML.split("\n");
-        return this.highlightSource(lines, lineNumber - 1);
-    }
-
-    highlightSource(lines, lineNumber) {
-        const start = Math.max(lineNumber - 2, 0);
-        const end = Math.min(lineNumber + 2, lines.length - 1);
-        lines[lineNumber] = '>> ' + lines[lineNumber] + ' <<'; 
-        return lines.slice(start, end + 1).join("\n");
-    }
-
     getErrorPosition(script) {
         let totalLines = 0;
         let element = script.previousElementSibling;
@@ -54,32 +27,93 @@ class ErrorHandler {
 
     catchError() {
         window.onerror = (message, url, lineNumber, column, error) => {
-            this.reportError(message, url, lineNumber, column, error.stack, 'JavaScript Error');
+            let type = 'JavaScript Error';
+
+            if (message.indexOf(':')) {
+                type = message.substring(0, message.indexOf(':'));
+                message = message.substring(message.indexOf(':') + 1).trim();
+            }
+
+            this.reportError(message, url, lineNumber, column, error.stack, type);
+
             return false;
         };
 
         window.addEventListener('unhandledrejection', event => {
-            this.reportError(event.reason.toString(), document.location.href, 0, 0, event.reason.stack, 'Promise Rejection');
+            if (! this.#unhandledRection) {
+                this.#unhandledRection = true;
+                this.reportError(event.reason.toString(), document.location.href, 0, 0, event.reason.stack, 'Promise Rejection');
+            }
         });
     }
 
-    reportError(message, url, lineNumber, column, stack, type = 'JavaScript Error') {
+    async reportError(message, url, line, column, stack, type = 'JavaScript Error') {
-        fetch(this.url ? `${location.protocol}//${this.url}/${this.apikey}` : window.location.href, {
+        await new Promise(r => setTimeout(r, 2000));
-            method: "post",
+
-            headers: {
+        try {
-                'Accept': "application/json",
+            const response = await fetch(this.url ? `${this.url}/${this.apikey}` : window.location.href, {
-                'Content-Type': "application/json"
+                method: "PUT",
-            },
+                headers: {
-            body: JSON.stringify({
+                    'Accept': "application/json",
-                type,
+                    'Content-Type': "application/json"
-                message,
+                },
-                url,
+                body: JSON.stringify({
-                lineNumber,
+                    type,
-                column,
+                    message,
-                stack,
+                    url,
-                location: window.location.href,
+                    line,
-                source: this.getSourceCode(lineNumber)
+                    code: column,
-            })
+                    backtrace: stack ? stack.split("\n").filter((e) => !!e).map((e) => this.parseErrorLine(e)) : [],
-        }).then(response => response.json()).then(console.info);
+                    file: window.location.href,
+                    source: await this.getSourceCode(url, line),
+                })
+            });
+
+            if (response.ok) {
+                this.#unhandledRection = false;
+
+                return await response.json()
+            }
+        } catch (error) {
+            console.error('CORS or network error:', error.message);
+        }
+    }
+
+    async getSourceCode(url, errorLineNumber) {
+        try {
+            const response = await fetch(url);
+            const originalHtml = await response.text();
+            const lines = originalHtml.split('\n');
+
+            const start = Math.max(0, errorLineNumber - 5);
+            const end = Math.min(lines.length, errorLineNumber + 5);
+
+            return lines.slice(start, end).join('\n');
+        }
+        catch (error) {
+            console.error('Failed to fetch original HTML:', error);
+        }
+    }
+
+    parseErrorLine(errorLine) {
+        const obj = {};
+
+        // Pattern for: functionName@url:line:column
+        const pattern =  /^(.*)@(.+?):(\d+):(\d+)$/;
+        const match = errorLine.match(pattern);
+
+        if (match) {
+            obj.function = match[1];
+            obj.file = match[2];
+            obj.line = match[3];
+            // column would be match[4] if needed
+        }
+
+        // Remove undefined/empty values
+        Object.keys(obj).forEach(key => {
+            if (!obj[key]) delete obj[key];
+        });
+
+        return obj;
     }
 }

meta/negundo.php

@@ -1,15 +1,33 @@
 <?php
 
-use function DI\autowire, DI\create, DI\get;
-
 use Negundo\Client\{ SoftwareConfig, Dump, Task, NegundoMiddleware };
 
+use function DI\{ autowire, create, get, add };
+
+if (! function_exists('getenvonce')) {
+    function getenvonce(string $name) : array|string|false
+    {
+        $value = getenv($name);
+        unset($_ENV[$name], $_SERVER[$name]);
+        putenv($name . "=");
+        return $value;
+    }
+}
+
 return [
-    SoftwareConfig::class => create(SoftwareConfig::class)->constructor(getenv('NEGUNDO_HASH'), getenv('NEGUNDO_SERVER')),
+    SoftwareConfig::class => create(SoftwareConfig::class)->constructor(
+        serverUrl: getenvonce('NEGUNDO_SERVER'),
+        softwareHash: getenvonce('NEGUNDO_HASH'),
+    ),
     NegundoMiddleware::class => autowire(NegundoMiddleware::class),
     Dump::class => autowire(Dump::class),
     Task::class => autowire(Task::class),
 
+    'lean.autoload' => add([
+        Dump::class,
+        Task::class,
+    ]),
+
     'negundo.client' => [
         'picea' => [
             'asset' => [

src/Dump.php

@@ -14,7 +14,7 @@ namespace Negundo\Client {
 
         protected Util\DumpHandler $dumpHandler;
 
-        public function __construct(SoftwareConfig $config, ? DataInterface $dataManipulator = null, Transport\TransportInterface $transport = null)
+        public function __construct(SoftwareConfig $config, ? DataInterface $dataManipulator = null, ? Transport\TransportInterface $transport = null)
         {
             $this->config = $config;
             $this->transport = $transport ?: new Transport\Curl();
@@ -35,7 +35,9 @@ namespace Negundo\Client {
 
             $this->sent[$dumpHash] = true;
 
-            return $this->transport->push($this->config->url('dump/report'), $data);
+            $url = $this->config->url('dump/report');
+
+            return $url ? $this->transport->push($url, $data) : false;
         }
     }
 }

src/Handler.php

@@ -23,7 +23,7 @@ abstract class Handler {
     
     public abstract function handleException(\Throwable $ex) : array;
 
-    public function __construct(SoftwareConfig $config, ? DataInterface $dataManipulator = null, ? Closure $callback = null, Transport\TransportInterface $transport = null)
+    public function __construct(SoftwareConfig $config, ? DataInterface $dataManipulator = null, ? Closure $callback = null, ? Transport\TransportInterface $transport = null)
     {
         $this->config = $config;
 
@@ -68,6 +68,8 @@ abstract class Handler {
         
         $data = $this->handleException($ex);
 
-        return $this->transport->push($this->config->url('bug/report'), $data);
+        $url = $this->config->url('bug/report');
+
+        return $url ? $this->transport->push($url, $data) : false;
     }
 }

src/SoftwareConfig.php

@@ -4,29 +4,17 @@ namespace Negundo\Client;
 
 class SoftwareConfig
 {
-    public string $serverUrl;
+    public function __construct(
+        public string $serverUrl,
+        public string $softwareHash,
+    ) {}
 
-    public string $softwareHash;
+    public function url(string $path) : string|null
-
-    public function __construct(string $softwareHash, string $serverUrl)
     {
-        if (! $softwareHash ) {
+        if (empty($this->serverUrl) || empty($this->softwareHash)) {
-            throw new \Exception("[Negundo] - You must provide a software hash to match a registered application on the plateform.");
+            return null;
-        }
-        else {
-            $this->softwareHash = $softwareHash;
         }
 
-        if (! $serverUrl ) {
-            throw new \Exception("[Negundo] - You must provide a valid Negundo server url endpoint.");
-        }
-        else {
-            $this->serverUrl = $serverUrl;
-        }
-    }
-
-    public function url(string $path) : string
-    {
         return sprintf("%s/%s/%s", rtrim($this->serverUrl, '/'), $path, $this->softwareHash);
     }
 }

src/Task.php

@@ -14,7 +14,7 @@ namespace Negundo\Client {
 
         protected SoftwareConfig $config;
 
-        public function __construct(SoftwareConfig $config, ? DataInterface $dataManipulator = null, Transport\TransportInterface $transport = null)
+        public function __construct(SoftwareConfig $config, ? DataInterface $dataManipulator = null, ? Transport\TransportInterface $transport = null)
         {
             $this->config = $config;
 
@@ -25,18 +25,18 @@ namespace Negundo\Client {
             static::$instances[] = $this;
         }
 
-        public function newReport(string $message, ? string $title = null, ? array $data = []) : object|null|bool
+        public function newReport(string $message, ? string $title = null, ? array $data = [], ? array $events = []) : object|null|bool
         {
-            $report = $this->taskHandler->sendReport($message, $title, $data);
+            $report = $this->taskHandler->sendReport($message, $title, $data, $events);
 
             // Make sure not to spam the server if an ErrorMessage or Exception was already sent (like inside a loop)
-            $dumpHash = $this->taskHandler->hash($report);
+            $taskHash = $this->taskHandler->hash($report);
 
-            if ( $this->sent[$dumpHash] ?? false ) {
+            if ( $this->sent[$taskHash] ?? false ) {
                 return null;
             }
 
-            $this->sent[$dumpHash] = true;
+            $this->sent[$taskHash] = true;
 
             return $this->transport->push($this->config->url('task/report'), $report);
         }
@@ -44,15 +44,26 @@ namespace Negundo\Client {
 }
 
 namespace {
+
+    use Negundo\Client\Task\StatusEnum;
+    use Negundo\Client\Task\TaskReport;
+
     if (! function_exists('ntask') ) {
-        function ntask(string $message, ? string $title = null, ? array $data = null, ? Negundo\Client\Task\StatusEnum $status = null) {
+        function ntask(string $message, ? string $title = null, ? array $data = null, ? Negundo\Client\Task\StatusEnum $status = null, array $events = []) {
             foreach (\Negundo\Client\Task::$instances as $instance) {
-                $sent = $instance->newReport($message, $title, $data);
+                $sent = $instance->newReport($message, $title, $data, $events);
 
                 if (! $sent ) {
                     throw new \Exception(sprintf('Could not send report titled `%s`.', $title));
                 }
             }
         }
+
+        function nreport(TaskReport $report)
+        {
+            if ($report->status !== StatusEnum::NothingToDo || $report->getEvents()) {
+                ntask($report->getMessage(), $report->getTitle(), $report->getData(), $report->getStatus(), $report->getEvents());
+            }
+        }
     }
 }

src/Task/StatusEnum.php

@@ -4,7 +4,10 @@ namespace Negundo\Client\Task;
 
 enum StatusEnum : string
 {
-    case Completed = "completed";
+    case New = "new";
     case Failed = "failed";
     case Warning = "warning";
+    case Completed = "completed";
+    case Empty = "empty";
+    case NothingToDo = "nothing-to-do";
 }

src/Task/TaskReport.php

@@ -0,0 +1,84 @@
+<?php
+
+namespace Negundo\Client\Task;
+
+class TaskReport implements \JsonSerializable
+{
+    protected array $events = [];
+
+    public function __construct(
+        public string|array $message,
+        public string $title,
+        public ? StatusEnum $status = null,
+        public array $data = [],
+    ) {}
+
+
+    public function addData(string $name, array $data) : static
+    {
+        $this->data[$name][] = $data;
+
+        return $this;
+    }
+
+    public function addEvent(string $key, ? StatusEnum $status = null, array $data = []) : static
+    {
+        $this->events[] = [
+            'key' => $key,
+            'status' => $status ? $status->value : null,
+            'data' => $data
+        ];
+
+        return $this;
+    }
+
+    public function addMessage(string $message) : static
+    {
+        if ( is_string($this->message) ) {
+            $this->message = [
+                $this->message, $message
+            ];
+        }
+        else {
+            $this->message[] = $message;
+        }
+
+        return $this;
+    }
+
+    public function getMessage() : string
+    {
+        return implode(PHP_EOL, (array) $this->message);
+    }
+
+    public function getTitle() : string
+    {
+        return $this->title;
+    }
+
+    public function getData() : array
+    {
+        return $this->data;
+    }
+
+    public function getEvents(?StatusEnum $filterType = null) : array
+    {
+        return $filterType ? array_filter($this->events, fn($e) => StatusEnum::tryFrom($e['status']) === $filterType) : $this->events;
+    }
+
+    public function getStatus() : StatusEnum
+    {
+        return $this->status;
+    }
+
+    public function jsonSerialize(): mixed
+    {
+        return [
+            'title' => $this->getTitle(),
+            'message' => $this->getMessage(),
+            'status' => $this->getStatus(),
+            'events' => $this->getEvents(),
+            'data' => $this->getData(),
+        ];
+    }
+}

src/Transport/Curl.php

@@ -4,7 +4,7 @@ namespace Negundo\Client\Transport;
 
 class Curl implements TransportInterface {
     
-    public $timeout = 2;
+    public $timeout = 4;
 
     public $throwErrors = true;
 
@@ -21,7 +21,7 @@ class Curl implements TransportInterface {
         curl_setopt($ch, CURLOPT_HTTPHEADER, $this->headers ); 
         curl_setopt($ch, CURLOPT_POST, 1);
         curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data, '', '&'));
-        curl_setopt($ch, CURLOPT_TIMEOUT_MS, $this->timeout * 200);
+        curl_setopt($ch, CURLOPT_TIMEOUT, $this->timeout);
         curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, $this->verifySsl);
 
         $exec = curl_exec($ch);
@@ -31,8 +31,6 @@ class Curl implements TransportInterface {
         if ($this->throwErrors) {
             if ( false === $exec) {
                 $errno = curl_errno($ch);
-                curl_close($ch);
-
                 throw new CurlException(implode(PHP_EOL, array_filter([ curl_error($ch) , static::CURL_ERROR[$errno] ?? null ])), $errno);
             }
             elseif ($code >= 400) {
@@ -40,8 +38,6 @@ class Curl implements TransportInterface {
             }
         }
 
-        curl_close($ch);
-
         return $exec;
     }
 
@@ -59,12 +55,8 @@ class Curl implements TransportInterface {
         if ( ( false === $execute ) && $this->throwErrors ) {
             $errno = curl_errno($ch);
 
-            curl_close($ch);
             throw new CurlException(implode(PHP_EOL, array_filter([ curl_error($ch) , static::CURL_ERROR[$errno] ?? null ])), $errno);
         }
-        else {
-            curl_close($ch);
-        }
 
         return $execute ? (object) $execute : null;
     }

src/Util/DumpHandler.php

@@ -6,12 +6,9 @@ use Negundo\Client\DataInterface;
 
 class DumpHandler {
     
-    public ? DataInterface $dataManipulator;
+    public function __construct(
-
+        public ? DataInterface $dataManipulator = null
-    public function __construct(DataInterface $dataManipulator = null)
+    ) {}
-    {
-        $this->dataManipulator = $dataManipulator;
-    }
 
     public function dumpData(...$content) : array
     {

src/Util/ExceptionHandler.php

@@ -6,12 +6,9 @@ use Negundo\Client\DataInterface;
 
 class ExceptionHandler {
 
-    public ? DataInterface $dataManipulator;
+    public function __construct(
-
+        public ? DataInterface $dataManipulator = null
-    public function __construct(DataInterface $dataManipulator = null)
+    ) {}
-    {
-        $this->dataManipulator = $dataManipulator;
-    }
 
     public function extractExceptionData(\Throwable $ex, array $serverData, array $postData, $dataManipulator = null) : array
     {
@@ -20,7 +17,7 @@ class ExceptionHandler {
             'HTTP_HOST' => $serverData['HTTP_HOST'] ?? "",
             'REQUEST_URI' => $serverData['REQUEST_URI'] ?? "",
             'HTTP_USER_AGENT' => $serverData['HTTP_USER_AGENT'] ?? "# UNKNOWN #",
-            'REMOTE_ADDR' => $serverData['REMOTE_ADDR'] ?? null,
+            'REMOTE_ADDR' => $server['HTTP_X_FORWARDED_FOR'] ?? $serverData['REMOTE_ADDR'] ?? null,
             'REQUEST_METHOD' => $serverData['HTTP_X_HTTP_METHOD'] ??  $serverData['REQUEST_METHOD'] ?? null,
         ];
 
@@ -31,7 +28,7 @@ class ExceptionHandler {
             'type' => $ex::class,
             'message' => $ex->getMessage(),
             'url' => ( ( 'on' === $serverData['HTTPS'] ) ? 'https' : 'http' ) . '://' . $serverData['HTTP_HOST'] . $serverData["REQUEST_URI"],
-            'http_method' => $serverData['REQUEST_METHOD'],
+            'http_method' => strtolower($serverData['REQUEST_METHOD']),
             'backtrace' => json_encode($ex->getTrace()),
             'backtrace_string' => $ex->getTraceAsString(),
             'source' => ( new SourceCodeFormatter() )->generateFromException($ex),

src/Util/SourceCodeFormatter.php

@@ -42,8 +42,7 @@ class SourceCodeFormatter {
                 $content = $fileSpl->current();
             }
 
-            # Get code between <code></code> tags
+            $content = strip_tags($content, '<span>');
-            $content = substr($content, strpos($content, "<code>") + 6, strrpos($content, "</code>") - 6);
 
             # Removing the added <?php tag
             $content = str_replace("&lt;?php", "", $content);

src/Util/TaskHandler.php

@@ -6,14 +6,11 @@ use Negundo\Client\DataInterface;
 
 class TaskHandler {
 
-    public ? DataInterface $dataManipulator;
+    public function __construct(
+        public ? DataInterface $dataManipulator = null
+    ) {}
 
-    public function __construct(DataInterface $dataManipulator = null)
+    public function sendReport(string $message, ? string $title = null, array $data = [], array $events = []) : array
-    {
-        $this->dataManipulator = $dataManipulator;
-    }
-
-    public function sendReport(string $message, ? string $title = null, array $data = []) : array
     {
         $backtrace = debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS);
         array_shift($backtrace);
@@ -36,6 +33,7 @@ class TaskHandler {
                 'request_body' => json_encode($_POST),
                 'remote_addr' => $_SERVER['REMOTE_ADDR'] ?? null,
             ],
+            'events' => $events,
         ];
 
         if ( $this->dataManipulator ?? false ) {

view/negundo/client_bugs.phtml

@@ -1,8 +1,10 @@
+{% php $softwareConfig = di_get(\Negundo\Client\SoftwareConfig::class) %}
+
 <script  src="{% asset 'static/negundo/js/debug.js' %}"></script>
 
 <script>
     new ErrorHandler({
-        url: "{{ getenv('NEGUNDO_SERVER') }}/bug/client/report",
+        url: "{{ rtrim($softwareConfig->serverUrl, '/') }}/bug/client/report",
-        apikey: "{{ getenv('NEGUNDO_HASH') }}"
+        apikey: "{{ $softwareConfig->softwareHash }}"
     });
 </script>