Merge pull request #82 from grafana/fix-ds-variable-state

DataSourceVariable: Fix state property name to be more descriptive

Author: torkelo

CHANGELOG.md

@@ -1,6 +1,7 @@
 # 0.22 ()
 
 * Removal of isEditing from SceneComponentProps (also $editor from SceneObjectState, and sceneGraph.getSceneEditor)
+* DataSourceVariable state change, query property is now named pluginId
 
 # 0.21 (2023-03-17)
 

packages/scenes/src/variables/variants/DataSourceVariable.test.ts

@@ -74,7 +74,7 @@ describe('DataSourceVariable', () => {
         options: [],
         value: '',
         text: '',
-        query: '',
+        pluginId: '',
       });
 
       await lastValueFrom(variable.validateAndUpdate());
@@ -92,7 +92,7 @@ describe('DataSourceVariable', () => {
         options: [],
         value: '',
         text: '',
-        query: 'non-existant-datasource',
+        pluginId: 'non-existant-datasource',
       });
 
       await lastValueFrom(variable.validateAndUpdate());
@@ -113,7 +113,7 @@ describe('DataSourceVariable', () => {
         options: [],
         value: '',
         text: '',
-        query: 'prometheus',
+        pluginId: 'prometheus',
       });
 
       await lastValueFrom(variable.validateAndUpdate());
@@ -142,7 +142,7 @@ describe('DataSourceVariable', () => {
         options: [],
         value: '',
         text: '',
-        query: 'prometheus',
+        pluginId: 'prometheus',
       });
 
       await lastValueFrom(variable.validateAndUpdate());
@@ -164,7 +164,7 @@ describe('DataSourceVariable', () => {
         options: [],
         value: '',
         text: '',
-        query: 'prometheus',
+        pluginId: 'prometheus',
         regex: 'slow.*',
       });
 
@@ -181,7 +181,7 @@ describe('DataSourceVariable', () => {
         options: [],
         value: '',
         text: '',
-        query: 'prometheus',
+        pluginId: 'prometheus',
         regex: '$variable-1.*',
       });
 
@@ -198,7 +198,7 @@ describe('DataSourceVariable', () => {
       const variable = new DataSourceVariable({
         name: 'test',
         options: [],
-        query: 'prometheus',
+        pluginId: 'prometheus',
         value: 'slow-prometheus-mocked',
         text: 'slow-prometheus-mocked',
       });
@@ -214,7 +214,7 @@ describe('DataSourceVariable', () => {
         name: 'test',
         options: [],
         isMulti: true,
-        query: 'prometheus',
+        pluginId: 'prometheus',
         value: ['prometheus-mocked', 'slow-prometheus-mocked', 'elastic-mocked'],
         text: ['prometheus-mocked', 'slow-prometheus-mocked', 'elastic-mocked'],
       });
@@ -230,7 +230,7 @@ describe('DataSourceVariable', () => {
         name: 'test',
         options: [],
         isMulti: true,
-        query: 'elastic',
+        pluginId: 'elastic',
         value: ['prometheus-mocked', 'slow-prometheus-mocked'],
         text: ['prometheus-mocked', 'slow-prometheus-mocked'],
       });

packages/scenes/src/variables/variants/DataSourceVariable.tsx

@@ -12,7 +12,13 @@ import { VariableValueOption } from '../types';
 import { MultiValueVariable, MultiValueVariableState, VariableGetOptionsArgs } from './MultiValueVariable';
 
 export interface DataSourceVariableState extends MultiValueVariableState {
-  query: string;
+  /**
+   * Include all data source instances with this plugin id
+   */
+  pluginId: string;
+  /**
+   * Filter data source instances based on name
+   */
   regex: string;
 }
 
@@ -29,13 +35,13 @@ export class DataSourceVariable extends MultiValueVariable<DataSourceVariableSta
       options: [],
       name: '',
       regex: '',
-      query: '',
+      pluginId: '',
       ...initialState,
     });
   }
 
   public getValueOptions(args: VariableGetOptionsArgs): Observable<VariableValueOption[]> {
-    if (!this.state.query) {
+    if (!this.state.pluginId) {
       return of([]);
     }
 
@@ -52,7 +58,7 @@ export class DataSourceVariable extends MultiValueVariable<DataSourceVariableSta
     for (let i = 0; i < dataSourceTypes.length; i++) {
       const source = dataSourceTypes[i];
       // must match on type
-      if (source.meta.id !== this.state.query) {
+      if (source.meta.id !== this.state.pluginId) {
         continue;
       }