CLI Panel respects disabled CLI option for Data Source (#87)

Author: mikhail-vl

src/redis-cli-panel/components/redis-cli-panel/redis-cli-panel.test.tsx

@@ -68,12 +68,17 @@ const dataSourceMock = {
   ),
   name: 'datasource',
 };
+const dataSourceInstanceSettingsMock = {
+  jsonData: { cliDisabled: false },
+};
 
 const dataSourceSrvGetMock = jest.fn().mockImplementation(() => Promise.resolve(dataSourceMock));
+const dataSourceSrvGetInstanceSettingsMock = jest.fn().mockImplementation(() => dataSourceInstanceSettingsMock);
 
 jest.mock('@grafana/runtime', () => ({
   getDataSourceSrv: () => ({
     get: dataSourceSrvGetMock,
+    getInstanceSettings: dataSourceSrvGetInstanceSettingsMock,
   }),
 }));
 
@@ -552,6 +557,31 @@ describe('RedisCLIPanel', () => {
     });
   });
 
+  it('If CLI disabled should not display buttons', () => {
+    const options = getOptions({
+      output: 'custom-output',
+    });
+    const overrideData = {
+      ...data,
+      request: { targets: [{ datasource: 'datasource/id' }] },
+    };
+
+    dataSourceInstanceSettingsMock.jsonData.cliDisabled = true;
+    const wrapper = shallow(
+      <RedisCLIPanel
+        {...additionalProps}
+        width={width}
+        height={height}
+        data={overrideData}
+        onOptionsChange={onOptionsChangeMock}
+        replaceVariables={replaceVariablesMock}
+        options={options}
+      />
+    );
+    const button = wrapper.find(Button);
+    expect(button.exists()).toBeFalsy();
+  });
+
   afterAll(() => {
     jest.resetAllMocks();
   });

src/redis-cli-panel/components/redis-cli-panel/redis-cli-panel.tsx

@@ -1,6 +1,7 @@
 import React, { ChangeEvent } from 'react';
 import { Observable } from 'rxjs';
 import { map as map$, switchMap as switchMap$ } from 'rxjs/operators';
+import { RedisDataSourceOptions } from 'types';
 import { css, cx } from '@emotion/css';
 import { DataFrame, DataQueryRequest, DataQueryResponse, PanelProps } from '@grafana/data';
 import { getDataSourceSrv } from '@grafana/runtime';
@@ -24,6 +25,15 @@ export const RedisCLIPanel: React.FC<PanelProps<PanelOptions>> = ({
   const { query, output, help } = options;
   const styles = Styles(useTheme2());
 
+  /**
+   * Get configured Data Source Id
+   */
+  const targets = data.request?.targets;
+  let datasource = '';
+  if (targets && targets.length && targets[0].datasource) {
+    datasource = targets[0].datasource;
+  }
+
   /**
    * Run Query
    *
@@ -38,28 +48,19 @@ export const RedisCLIPanel: React.FC<PanelProps<PanelOptions>> = ({
     }
 
     /**
-     * Get configured Data Source Id
+     * Check Data Source
      */
-    const targets = data.request?.targets;
-    let datasource = '';
-    if (targets && targets.length && targets[0].datasource) {
-      datasource = targets[0].datasource;
-    } else {
+    if (!datasource) {
       return onOptionsChange({ ...options, output: 'Unknown Data Source' });
     }
 
-    /**
-     * Get Data Source
-     */
-    const ds = await getDataSourceSrv().get(datasource);
-
     // Response Error
     let error = '';
 
     /**
      * Run Query
      */
-
+    const ds = await getDataSourceSrv().get(datasource);
     const dsQuery = ds.query({
       targets: [{ refId: 'A', query: replaceVariables(query), cli: !options.raw }],
     } as DataQueryRequest<RedisQuery>) as unknown;
@@ -142,6 +143,31 @@ export const RedisCLIPanel: React.FC<PanelProps<PanelOptions>> = ({
     onOptionsChange({ ...options, query: event.target.value, help });
   };
 
+  /**
+   * Check if CLI disabled
+   */
+  const jsonData = getDataSourceSrv().getInstanceSettings(datasource)?.jsonData as RedisDataSourceOptions;
+  const cliDisabled = jsonData?.cliDisabled;
+
+  /**
+   * CLI disabled
+   */
+  if (cliDisabled) {
+    return (
+      <div
+        className={cx(
+          styles.wrapper,
+          css`
+            width: ${width}px;
+            height: ${height}px;
+          `
+        )}
+      >
+        CLI is disabled for this Data Source.
+      </div>
+    );
+  }
+
   /**
    * Return
    */

src/redis-cli-panel/constants.ts

@@ -37,11 +37,11 @@ export enum ResponseMode {
  */
 export const ResponseModeOptions = [
   {
-    label: 'CLI',
+    label: ResponseMode.CLI,
     value: ResponseMode.CLI,
   },
   {
-    label: 'Raw',
+    label: ResponseMode.RAW,
     value: ResponseMode.RAW,
   },
 ];

src/types.ts

@@ -106,6 +106,13 @@ export interface RedisDataSourceOptions extends DataSourceJsonData {
    */
   acl: boolean;
 
+  /**
+   * CLI disabled
+   *
+   * @type {boolean}
+   */
+  cliDisabled: boolean;
+
   /**
    * ACL Username
    *