Visualize generic object/JSON data of element history data as pretty tree structure on log detail page

assets/controllers/elements/json_formatter_controller.js

@@ -0,0 +1,40 @@
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as published
+ *  by the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Affero General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+
+import {Controller} from "@hotwired/stimulus";
+
+import JSONFormatter from 'json-formatter-js';
+
+/**
+ * This controller implements an element that renders a JSON object as a collapsible tree.
+ * The JSON object is passed as a data attribute.
+ * You have to apply the controller to a div element or similar block element which can contain other elements.
+ */
+export default class extends Controller {
+    connect() {
+        const depth_to_open = this.element.dataset.depthToOpen ?? 0;
+        const json_string = this.element.dataset.json;
+        const json_object = JSON.parse(json_string);
+
+        const formatter = new JSONFormatter(json_object, depth_to_open);
+
+        this.element.appendChild(formatter.render());
+    }
+}

package.json

@@ -77,6 +77,7 @@
         "emoji.json": "^14.0.0",
         "exports-loader": "^3.0.0",
         "html5-qrcode": "^2.2.1",
+        "json-formatter-js": "^2.3.4",
         "jszip": "^3.2.0",
         "katex": "^0.16.0",
         "marked": "^4.3.0",

src/Services/LogSystem/LogDataFormatter.php

@@ -88,13 +88,23 @@ class LogDataFormatter
             }
 
 
-            return htmlspecialchars(json_encode($data, JSON_PRETTY_PRINT));
+            return $this->formatJSON($data);
         }
 
 
         throw new \RuntimeException('Type of $data not supported (' . gettype($data) . ')');
     }
 
+    private function formatJSON(array $data): string
+    {
+        $json = htmlspecialchars(json_encode($data, JSON_PRETTY_PRINT), ENT_QUOTES | ENT_SUBSTITUTE);
+
+        return sprintf(
+            '<div data-controller="elements--json-formatter" data-json="%s"></div>',
+            $json
+        );
+    }
+
     private function formatForeignKey(array $data, AbstractLogEntry $logEntry, string $fieldName): string
     {
         //Extract the id from the @id key

yarn.lock

@@ -4428,6 +4428,11 @@ jsesc@~0.5.0:
   resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-0.5.0.tgz#e7dee66e35d6fc16f710fe91d5cf69f70f08911d"
   integrity sha512-uZz5UnB7u4T9LvwmFqXii7pZSouaRPorGs5who1Ip7VO0wxanFvBL7GkM6dTHlgX+jhBApRetaWpnDabOeTcnA==
 
+json-formatter-js@^2.3.4:
+  version "2.3.4"
+  resolved "https://registry.yarnpkg.com/json-formatter-js/-/json-formatter-js-2.3.4.tgz#0b49b6facd0d54cb220eb65988157c0977a85c6f"
+  integrity sha512-gmAzYRtPRmYzeAT4T7+t3NhTF89JOAIioCVDddl9YDb3ls3kWcskirafw/MZGJaRhEU6fRimGJHl7CC7gaAI2Q==
+
 json-parse-even-better-errors@^2.3.0, json-parse-even-better-errors@^2.3.1:
   version "2.3.1"
   resolved "https://registry.yarnpkg.com/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz#7c47805a94319928e05777405dc12e1f7a4ee02d"