Merge branch 'fix/config_host-to-url' into main

Author: Rodrigo Chireia

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.1.0
+
+- support for Grafana provisioning configuration
+
 ## 1.0.2
 
 - update plugin's description and bump toolkit version

package.json

@@ -1,7 +1,7 @@
 {
   "name": "golioth-websocket",
-  "version": "1.0.2",
-  "description": "",
+  "version": "1.1.0",
+  "description": "A Web Socket Data Source Plugin for Grafana",
   "scripts": {
     "start": "yarn watch",
     "build": "grafana-toolkit plugin:build",
@@ -12,6 +12,11 @@
     "sign": "grafana-toolkit plugin:sign"
   },
   "author": "Golioth",
+  "contributors": [
+    {
+      "name": "@mountainash"
+    }
+  ],
   "license": "Apache-2.0",
   "dependencies": {
     "@grafana/data": "latest",

pkg/plugin/ws_data_proxy.go

@@ -95,19 +95,19 @@ func (wsdp *wsDataProxy) proxyMessage() {
 	}
 }
 
-// encodeURl is hard coded with some variables like scheme and x-api-key but will be definetly refactored after changes in the config editor
+// encodeURL is hard coded with some variables like scheme and x-api-key but will be definetly refactored after changes in the config editor
 func (wsdp *wsDataProxy) encodeURL(req *backend.RunStreamRequest) (string, error) {
 	var reqJsonData map[string]interface{}
 
 	if err := json.Unmarshal(req.PluginContext.DataSourceInstanceSettings.JSONData, &reqJsonData); err != nil {
 		return "", fmt.Errorf("failed to read JSON Data Source Instance Settings: %s", err.Error())
 	}
 
-	host := reqJsonData["host"].(string)
+	host := req.PluginContext.DataSourceInstanceSettings.URL
 
 	wsUrl, err := url.Parse(host)
 	if err != nil {
-		return "", fmt.Errorf("failed to parse host string from Config Editor: %s", err.Error())
+		return "", fmt.Errorf("failed to parse host string from the Plugin's Config Editor: %s", err.Error())
 	}
 
 	wsUrl.Path = path.Join(wsUrl.Path, req.Path)

src/components/ConfigEditor.tsx

@@ -10,13 +10,14 @@ const { FormField } = LegacyForms
 type Props = DataSourcePluginOptionsEditorProps<DataSourceOptions>
 
 export const ConfigEditor: FC<Props> = ({ options, onOptionsChange }) => {
-  const { jsonData } = options
+  const { url, jsonData } = options
+
   const onHostChange = (event: ChangeEvent<HTMLInputElement>) => {
-    const jsonData = {
-      ...options.jsonData,
-      host: event.target.value,
+    const newOptions = {
+      ...options,
+      url: event.target.value,
     }
-    onOptionsChange({ ...options, jsonData })
+    onOptionsChange({ ...newOptions, jsonData })
   }
 
   return (
@@ -29,7 +30,7 @@ export const ConfigEditor: FC<Props> = ({ options, onOptionsChange }) => {
             labelWidth={10}
             inputWidth={30}
             onChange={onHostChange}
-            value={jsonData.host || ''}
+            value={url || ''}
             placeholder='wss://api.domain.io/v1/ws/'
           />
         </div>

src/plugin.json

@@ -42,7 +42,7 @@
         "path": "img/assets/grafana-websockets-plugin-streaming.png"
       }
     ],
-    "version": "1.0.2",
+    "version": "1.1.0",
     "updated": "%TODAY%"
   },
   "dependencies": {

src/types.ts

@@ -24,7 +24,7 @@ export const defaultQuery: Partial<Query> = {
 }
 
 export interface DataSourceOptions extends DataSourceJsonData {
-  host?: string
+  url?: string
 }
 
 export interface SecureJsonData {