Add Organization Users (#52)

* Refactor APIs * Update tests * Add local request mode * Update tests * Add get users query * Update with using convertToFrame util * Add Get Org Users query * Update CHANGELOG.md * Rename Org Users * Set default mode as Remote * Update provisioning --------- Co-authored-by: Mikhail <[email protected]>
VolkovLabs · Sep 10, 2023 · e2d2059 · e2d2059
1 parent b35fc76
commit e2d2059
Show file tree

Hide file tree

Showing 17 changed files with 425 additions and 69 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,11 +1,13 @@
 # Change Log
 
-## 2.1.0 (IN PROGRESS)
+## 2.1.0 (2023-09-10)
 
 ### Features / Enhancements
 
 - Refactor API and increase test coverage (#50)
 - Update ESLint configuration (#50)
+- Add Local mode to access local instance (#51)
+- Add Organization Users (#52)
 
 ## 2.0.0 (2023-07-17)
 

diff --git a/provisioning/dashboards/panels.json b/provisioning/dashboards/panels.json
@@ -69,6 +69,7 @@
       },
       "id": 6,
       "options": {
+        "cellHeight": "sm",
         "footer": {
           "countRows": false,
           "fields": "",
@@ -77,7 +78,7 @@
         },
         "showHeader": true
       },
-      "pluginVersion": "9.4.3",
+      "pluginVersion": "10.0.3",
       "targets": [
         {
           "annotationDashboard": "",
@@ -140,7 +141,7 @@
         },
         "textMode": "auto"
       },
-      "pluginVersion": "9.4.3",
+      "pluginVersion": "10.0.3",
       "targets": [
         {
           "annotationDashboard": "",
@@ -204,7 +205,7 @@
         },
         "textMode": "auto"
       },
-      "pluginVersion": "9.4.3",
+      "pluginVersion": "10.0.3",
       "targets": [
         {
           "datasource": {
@@ -260,6 +261,7 @@
       },
       "id": 3,
       "options": {
+        "cellHeight": "sm",
         "footer": {
           "countRows": false,
           "fields": "",
@@ -268,7 +270,7 @@
         },
         "showHeader": true
       },
-      "pluginVersion": "9.4.3",
+      "pluginVersion": "10.0.3",
       "targets": [
         {
           "datasource": {
@@ -327,13 +329,14 @@
         "overrides": []
       },
       "gridPos": {
-        "h": 8,
+        "h": 5,
         "w": 24,
         "x": 0,
         "y": 19
       },
       "id": 8,
       "options": {
+        "cellHeight": "sm",
         "footer": {
           "countRows": false,
           "fields": "",
@@ -342,7 +345,7 @@
         },
         "showHeader": true
       },
-      "pluginVersion": "9.4.3",
+      "pluginVersion": "10.0.3",
       "targets": [
         {
           "annotationDashboard": "",
@@ -362,6 +365,78 @@
       ],
       "title": "Alert Rules",
       "type": "table"
+    },
+    {
+      "datasource": {
+        "type": "volkovlabs-grapi-datasource",
+        "uid": "grapi"
+      },
+      "fieldConfig": {
+        "defaults": {
+          "color": {
+            "mode": "thresholds"
+          },
+          "custom": {
+            "align": "auto",
+            "cellOptions": {
+              "type": "auto"
+            },
+            "inspect": false
+          },
+          "mappings": [],
+          "thresholds": {
+            "mode": "absolute",
+            "steps": [
+              {
+                "color": "green",
+                "value": null
+              },
+              {
+                "color": "red",
+                "value": 80
+              }
+            ]
+          }
+        },
+        "overrides": []
+      },
+      "gridPos": {
+        "h": 5,
+        "w": 24,
+        "x": 0,
+        "y": 24
+      },
+      "id": 9,
+      "options": {
+        "cellHeight": "sm",
+        "footer": {
+          "countRows": false,
+          "fields": "",
+          "reducer": ["sum"],
+          "show": false
+        },
+        "showHeader": true
+      },
+      "pluginVersion": "10.0.3",
+      "targets": [
+        {
+          "annotationDashboard": "",
+          "annotationLimit": 100,
+          "annotationNewState": "",
+          "annotationPattern": "",
+          "annotationPrevState": "",
+          "annotationRange": "",
+          "annotationType": "",
+          "datasource": {
+            "type": "volkovlabs-grapi-datasource",
+            "uid": "grapi"
+          },
+          "refId": "A",
+          "requestType": "orgUsers"
+        }
+      ],
+      "title": "Users",
+      "type": "table"
     }
   ],
   "refresh": "",

diff --git a/src/api/datasources.ts b/src/api/datasources.ts
@@ -3,7 +3,7 @@ import { DataSourceSettings, FieldType, MutableDataFrame } from '@grafana/data';
 import { getBackendSrv } from '@grafana/runtime';
 import { Messages, RequestType } from '../constants';
 import { Query } from '../types';
-import { notifyError } from '../utils';
+import { convertToFrame, notifyError } from '../utils';
 import { BaseApi } from './base';
 
 /**
@@ -18,7 +18,7 @@ export class DataSources extends BaseApi {
      * Fetch
      */
     const response = await lastValueFrom(
-      getBackendSrv().fetch({
+      getBackendSrv().fetch<DataSourceSettings[]>({
         method: 'GET',
         url: `${this.api.instanceSettings.url}/api/datasources`,
       })
@@ -32,7 +32,7 @@ export class DataSources extends BaseApi {
       return [];
     }
 
-    return response.data as DataSourceSettings[];
+    return response.data;
   };
 
   /**
@@ -45,76 +45,69 @@ export class DataSources extends BaseApi {
     }
 
     /**
-     * Create frame
+     * Create Frame
      */
-    const frame = new MutableDataFrame({
+    const frame = convertToFrame<DataSourceSettings>({
       name: RequestType.DATASOURCES,
       refId: query.refId,
       fields: [
         {
           name: 'Id',
           type: FieldType.number,
+          getValue: (item) => item.id,
         },
         {
           name: 'Org Id',
           type: FieldType.number,
+          getValue: (item) => item.orgId,
         },
         {
           name: 'UID',
           type: FieldType.string,
+          getValue: (item) => item.uid,
         },
         {
           name: 'Name',
           type: FieldType.string,
+          getValue: (item) => item.name,
         },
         {
           name: 'Type',
           type: FieldType.string,
+          getValue: (item) => item.type,
         },
         {
           name: 'Type Logo URL',
           type: FieldType.string,
+          getValue: (item) => item.typeLogoUrl,
         },
         {
           name: 'Type Name',
           type: FieldType.string,
+          getValue: (item) => item.typeName,
         },
         {
           name: 'Is Default',
           type: FieldType.boolean,
+          getValue: (item) => item.isDefault,
         },
         {
           name: 'Read Only',
           type: FieldType.boolean,
+          getValue: (item) => item.readOnly,
         },
         {
           name: 'URL',
           type: FieldType.string,
+          getValue: (item) => item.url,
         },
         {
           name: 'User',
           type: FieldType.string,
+          getValue: (item) => item.user,
         },
       ],
-    });
-
-    /**
-     * Add Data
-     */
-    datasources.forEach((datasource) => {
-      frame.appendRow([
-        datasource.id,
-        datasource.orgId,
-        datasource.uid,
-        datasource.name,
-        datasource.type,
-        datasource.typeLogoUrl,
-        datasource.typeName,
-        datasource.isDefault,
-        datasource.readOnly,
-        datasource.url,
-        datasource.user,
-      ]);
+      items: datasources,
     });
 
     return [frame];

diff --git a/src/api/health.ts b/src/api/health.ts
@@ -3,7 +3,7 @@ import { FieldType, MutableDataFrame } from '@grafana/data';
 import { getBackendSrv } from '@grafana/runtime';
 import { Messages, RequestType } from '../constants';
 import { Health as HealthType, Query } from '../types';
-import { notifyError } from '../utils';
+import { convertToFrame, notifyError } from '../utils';
 import { BaseApi } from './base';
 
 /**
@@ -15,7 +15,7 @@ export class Health extends BaseApi {
    */
   get = async (): Promise<HealthType | undefined> => {
     const response = await lastValueFrom(
-      getBackendSrv().fetch({
+      getBackendSrv().fetch<HealthType>({
         method: 'GET',
         url: `${this.api.instanceSettings.url}/api/health`,
       })
@@ -32,7 +32,7 @@ export class Health extends BaseApi {
     /**
      * Data received
      */
-    return response.data as HealthType;
+    return response.data;
   };
 
   /**
@@ -45,32 +45,31 @@ export class Health extends BaseApi {
     }
 
     /**
-     * Create frame
+     * Create Frame
      */
-    const frame = new MutableDataFrame({
+    const frame = convertToFrame<HealthType>({
       name: RequestType.HEALTH,
       refId: query.refId,
       fields: [
         {
           name: 'Commit',
           type: FieldType.string,
+          getValue: (item) => item.commit,
         },
         {
           name: 'Database',
           type: FieldType.string,
+          getValue: (item) => item.database,
         },
         {
           name: 'Version',
           type: FieldType.string,
+          getValue: (item) => item.version,
         },
       ],
+      items: [health],
     });
 
-    /**
-     * Add Data
-     */
-    frame.appendRow([health.commit, health.database, health.version]);
-
     return [frame];
   };
 }