First draft of a converter web extension

Author: K-Phoen

.gitignore

@@ -1 +1,2 @@
 /bin
+*.wasm

cmd/wasm/main.go

@@ -0,0 +1,40 @@
+package main
+
+import (
+	"strings"
+	"syscall/js"
+
+	"github.com/K-Phoen/dark/internal/pkg/converter"
+	"go.uber.org/zap"
+)
+
+func dashboardToDarkFunc() js.Func {
+	return js.FuncOf(func(this js.Value, args []js.Value) interface{} {
+		if len(args) != 1 {
+			return "invalid nnumber of arguments passed"
+		}
+
+		logger := zap.NewNop()
+		conv := converter.NewJSON(logger)
+
+		inputJSON := args[0].String()
+		output := &strings.Builder{}
+
+		if err := conv.ToK8SManifest(strings.NewReader(inputJSON), output, converter.K8SManifestOptions{
+			Folder:    "folder_name",
+			Name:      "name",
+			Namespace: "default",
+		}); err != nil {
+			logger.Fatal("Could not convert dashboard", zap.Error(err))
+		}
+
+		return output.String()
+	})
+}
+
+func main() {
+	js.Global().Set("dashboardToDark", dashboardToDarkFunc())
+
+	c := make(chan struct{}, 0)
+	<-c
+}

dark-web-extension/README.md

@@ -0,0 +1,27 @@
+# DARK web extension
+
+Browser extension to convert Grafana dashboards into an equivalent DARK YAML file.
+
+Whenever a Grafana dashboard is viewed, the extension will add an export button to the dashboard's toolbar.
+
+**Note:** only tested with Firefox.
+
+## Building
+
+### Compile the `./cmd/wasm` binary to WebAssembly
+
+The extension re-uses the conversion logic written in Go, thanks to WebAssembly.
+
+A binary specific to this use-case is bundled within the repository, and needs to be compiled for the extension to run:
+
+```sh
+GOOS=js GOARCH=wasm go build -o dark-web-extension/dark.wasm ./cmd/wasm
+```
+
+### `./dark-web-extension/wasm_exec.js` file
+
+Distributed with Go:
+
+```sh
+cp "$(go env GOROOT)/misc/wasm/wasm_exec.js" ./dark-web-extension
+```

dark-web-extension/background_script.js

@@ -0,0 +1,34 @@
+// Put all the javascript code here, that you want to execute in background.
+
+console.debug("starting background worker");
+
+browser.runtime.onMessage.addListener(handleMessage);
+
+function handleMessage(request, _sender, _sendResponse) {
+    console.info(`content script sent a message`, request);
+
+    if (request.action === 'convert-to-k8s') {
+        convertToK8s(request.data.model).then(result => {
+            const blob = new Blob([result], {type: 'text/yaml'});
+
+            browser.downloads.download({
+                url: window.URL.createObjectURL(blob),
+                filename: 'dark-dashboard.yaml',
+                conflictAction: 'uniquify',
+            });
+        });
+    }
+}
+
+async function convertToK8s(dashboardModel) {
+    const go = new Go();
+
+    return WebAssembly.instantiateStreaming(
+        fetch(browser.runtime.getURL("dark.wasm")),
+        go.importObject,
+    ).then(result => {
+        go.run(result.instance);
+
+        return dashboardToDark(dashboardModel);
+    });
+}

dark-web-extension/content_script.js

@@ -0,0 +1,103 @@
+// Put all the javascript code here, that you want to execute after page load.
+if (isGrafana()) {
+    console.debug("content_script bootstrap");
+
+    // hackish way of giving enough time for grafana to load the dashboard
+    waitForElm('.page-toolbar').then((elm) => {
+        console.debug('page-toolbar found, inserting DARK export button');
+        setupExportButton();
+    });
+}
+
+function setupExportButton() {
+    var elements = document.getElementsByClassName("page-toolbar");
+
+    if (elements.length === 0) {
+        console.debug("page-toolbar not found");
+        return;
+    }
+
+    console.debug("appending export button");
+    const pageToolbarElmt = elements[0];
+
+    const lastButton = pageToolbarElmt.childNodes[pageToolbarElmt.childNodes.length - 1];
+    const darkExportButton = lastButton.cloneNode(true);
+    darkExportButton.onclick = triggerExport;
+    darkExportButton.title = 'Export as DARK dashboard';
+
+    darkExportButton.childNodes[0].childNodes[0].childNodes[0].innerHTML = `<svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+    viewBox="0 0 493.525 493.525" style="enable-background:new 0 0 493.525 493.525;" xml:space="preserve">
+<g id="XMLID_30_">
+   <path id="XMLID_32_" d="M430.557,79.556H218.44c21.622,12.688,40.255,29.729,54.859,49.906h157.258
+       c7.196,0,13.063,5.863,13.063,13.06v238.662c0,7.199-5.866,13.064-13.063,13.064H191.894c-7.198,0-13.062-5.865-13.062-13.064
+       V222.173c-6.027-3.1-12.33-5.715-18.845-7.732c-3.818,11.764-12.105,21.787-23.508,27.781c-2.39,1.252-4.987,2.014-7.554,2.844
+       v136.119c0,34.717,28.25,62.971,62.968,62.971h238.663c34.718,0,62.969-28.254,62.969-62.971V142.522
+       C493.525,107.806,465.275,79.556,430.557,79.556z"/>
+   <path id="XMLID_31_" d="M129.037,175.989c51.419,1.234,96.388,28.283,122.25,68.865c2.371,3.705,6.434,5.848,10.657,5.848
+       c1.152,0,2.322-0.162,3.46-0.486c5.377-1.545,9.114-6.418,9.179-12.006c0-0.504,0-1.01,0-1.51
+       c0-81.148-64.853-147.023-145.527-148.957V64.155c0-5.492-3.038-10.512-7.879-13.078c-2.16-1.139-4.533-1.707-6.889-1.707
+       c-2.94,0-5.848,0.88-8.35,2.584L5.751,120.526C2.162,122.98,0.018,127.041,0,131.394c-0.017,4.338,2.113,8.418,5.687,10.902
+       l100.17,69.451c2.518,1.753,5.459,2.631,8.414,2.631c2.355,0,4.696-0.553,6.857-1.676c4.855-2.549,7.909-7.6,7.909-13.092V175.989z
+       "/>
+</g>
+</svg>`;
+
+    pageToolbarElmt.appendChild(darkExportButton);
+}
+
+function triggerExport() {
+    const dashboardUID = getDashboardUID();
+
+    if (!dashboardUID) {
+        console.warn('could not infer dashboard UID');
+        return;
+    }
+
+    console.debug("exporting dashboard with UID", dashboardUID);
+
+    fetch(`${window.location.origin}/api/dashboards/uid/${dashboardUID}`)
+        .then(response => response.json())
+        .then(apiResponse => convertGrafanaDashboard(apiResponse.dashboard))
+        .catch(error => {
+            console.error(`Error: ${error}`);
+        })
+}
+
+function getDashboardUID() {
+    const pagePath = window.location.pathname;
+
+    return pagePath.split('/')[2];
+}
+
+function convertGrafanaDashboard(model) {
+    return browser.runtime.sendMessage({
+        action: "convert-to-k8s",
+        data: {
+            model: JSON.stringify(model),
+        },
+    });
+}
+
+function isGrafana() {
+    return document.body.classList.contains('app-grafana');
+}
+
+function waitForElm(selector) {
+    return new Promise(resolve => {
+        if (document.querySelector(selector)) {
+            return resolve(document.querySelector(selector));
+        }
+
+        const observer = new MutationObserver(mutations => {
+            if (document.querySelector(selector)) {
+                resolve(document.querySelector(selector));
+                observer.disconnect();
+            }
+        });
+
+        observer.observe(document.body, {
+            childList: true,
+            subtree: true
+        });
+    });
+}

dark-web-extension/icons/icon.png

@@ -0,0 +1,31 @@
+{
+  "manifest_version": 2,
+  "name": "dark",
+  "description": "Converts Grafana dashboards into an equivalent DARK YAML file",
+  "version": "0.0.1",
+  "icons": {
+    "64": "icons/icon.png"
+  },
+
+  "permissions": [
+    "downloads"
+  ],
+
+  "background": {
+    "scripts": [
+      "wasm_exec.js",
+      "background_script.js"
+    ]
+  },
+  "content_scripts": [
+    {
+      "matches": [
+        "http://*/*",
+        "https://*/*"
+      ],
+      "js": [
+        "content_script.js"
+      ]
+    }
+  ]
+}