feat(tag): Workspace variable resolution (#41)

ni · Oct 5, 2023 · f4fe35a · f4fe35a
1 parent 335fb5f
commit f4fe35a
Show file tree

Hide file tree

Showing 8 changed files with 39 additions and 8 deletions.
diff --git a/src/core/DataSourceBase.ts b/src/core/DataSourceBase.ts
@@ -6,14 +6,24 @@ import {
   DataSourceApi,
   DataSourceInstanceSettings,
 } from '@grafana/data';
-import { BackendSrv, BackendSrvRequest, TestingStatus, isFetchError } from '@grafana/runtime';
+import {
+  BackendSrv,
+  BackendSrvRequest,
+  TemplateSrv,
+  TestingStatus,
+  isFetchError
+} from '@grafana/runtime';
 import { DataQuery } from '@grafana/schema';
 import { Workspace } from './types';
 import { sleep } from './utils';
 import { lastValueFrom } from 'rxjs';
 
 export abstract class DataSourceBase<TQuery extends DataQuery> extends DataSourceApi<TQuery> {
-  constructor(readonly instanceSettings: DataSourceInstanceSettings, readonly backendSrv: BackendSrv) {
+  constructor(
+    readonly instanceSettings: DataSourceInstanceSettings,
+    readonly backendSrv: BackendSrv,
+    readonly templateSrv: TemplateSrv
+  ) {
     super(instanceSettings);
   }
 

diff --git a/src/core/utils.ts b/src/core/utils.ts
@@ -37,10 +37,19 @@ export function throwIfNullish<T>(value: T, error: string | Error): NonNullable<
 export function useWorkspaceOptions<DSType extends DataSourceBase<any>>(datasource: DSType) {
   return useAsync(async () => {
     const workspaces = await datasource.getWorkspaces();
-    return workspaces.map(w => ({ label: w.name, value: w.id }));
+    const workspaceOptions = workspaces.map(w => ({ label: w.name, value: w.id }));
+    workspaceOptions?.unshift(...getVariableOptions(datasource))
+    return workspaceOptions;
   });
 }
 
+/** Gets Dashboard variables as an array of {@link SelectableValue}. */
+export function getVariableOptions<DSType extends DataSourceBase<any>>(datasource: DSType) {
+  return datasource.templateSrv
+    .getVariables()
+    .map((variable) => ({ label: '$' + variable.name, value: '$' + variable.name }));
+}
+
 export function getWorkspaceName(workspaces: Workspace[], id: string) {
   return workspaces.find(w => w.id === id)?.name ?? id;
 }

diff --git a/src/datasources/data-frame/DataFrameDataSource.ts b/src/datasources/data-frame/DataFrameDataSource.ts
@@ -40,7 +40,7 @@ export class DataFrameDataSource extends DataSourceBase<DataFrameQuery> {
     readonly backendSrv: BackendSrv = getBackendSrv(),
     readonly templateSrv: TemplateSrv = getTemplateSrv()
   ) {
-    super(instanceSettings, backendSrv);
+    super(instanceSettings, backendSrv, templateSrv);
   }
 
   baseUrl = this.instanceSettings.url + '/nidataframe/v1';

diff --git a/src/datasources/system/SystemDataSource.ts b/src/datasources/system/SystemDataSource.ts
@@ -12,7 +12,7 @@ export class SystemDataSource extends DataSourceBase<SystemQuery> {
     readonly backendSrv: BackendSrv = getBackendSrv(),
     readonly templateSrv: TemplateSrv = getTemplateSrv()
   ) {
-    super(instanceSettings, backendSrv);
+    super(instanceSettings, backendSrv, templateSrv);
   }
 
   baseUrl = this.instanceSettings.url + '/nisysmgmt/v1';

diff --git a/src/datasources/tag/TagDataSource.test.ts b/src/datasources/tag/TagDataSource.test.ts
@@ -264,6 +264,17 @@ describe('queries', () => {
 
     expect(backendSrv.fetch).toHaveBeenCalledTimes(5);
   });
+
+  test('attempts to replace variables in history query', async () => {
+    const workspaceVariable = '$workspace';
+    backendSrv.fetch.mockReturnValueOnce(createQueryTagsResponse());
+    templateSrv.replace.calledWith(workspaceVariable).mockReturnValue('1');
+
+    await ds.query(buildQuery({ path: 'my.tag', workspace: workspaceVariable }));
+
+    expect(templateSrv.replace).toHaveBeenCalledTimes(2);
+    expect(templateSrv.replace.mock.calls[1][0]).toBe(workspaceVariable);
+  });
 });
 
 function createQueryTagsResponse(

diff --git a/src/datasources/tag/TagDataSource.ts b/src/datasources/tag/TagDataSource.ts
@@ -10,7 +10,7 @@ export class TagDataSource extends DataSourceBase<TagQuery> {
     readonly backendSrv: BackendSrv = getBackendSrv(),
     readonly templateSrv: TemplateSrv = getTemplateSrv()
   ) {
-    super(instanceSettings, backendSrv);
+    super(instanceSettings, backendSrv, templateSrv);
   }
 
   tagUrl = this.instanceSettings.url + '/nitag/v2';
@@ -25,7 +25,7 @@ export class TagDataSource extends DataSourceBase<TagQuery> {
   async runQuery(query: TagQuery, { range, maxDataPoints, scopedVars }: DataQueryRequest): Promise<DataFrameDTO> {
     const { tag, current } = await this.getLastUpdatedTag(
       this.templateSrv.replace(query.path, scopedVars),
-      query.workspace
+      this.templateSrv.replace(query.workspace, scopedVars)
     );
 
     const name = tag.properties?.displayName ?? tag.path;

diff --git a/src/datasources/workspace/WorkspaceDataSource.ts b/src/datasources/workspace/WorkspaceDataSource.ts
@@ -10,7 +10,7 @@ export class WorkspaceDataSource extends DataSourceBase<WorkspaceQuery> {
     readonly backendSrv: BackendSrv = getBackendSrv(),
     readonly templateSrv: TemplateSrv = getTemplateSrv()
   ) {
-    super(instanceSettings, backendSrv);
+    super(instanceSettings, backendSrv, templateSrv);
   }
 
   baseUrl = this.instanceSettings.url + '/niuser/v1';

diff --git a/src/test/fixtures.ts b/src/test/fixtures.ts
@@ -20,6 +20,7 @@ export function setupDataSource<T>(
   );
   const mockTemplateSrv = mock<TemplateSrv>({
     replace: calledWithFn({ fallbackMockImplementation: target => target ?? '' }),
+    getVariables: calledWithFn({ fallbackMockImplementation: () => [] })
   });
   const ds = new ctor({ url: '' } as DataSourceInstanceSettings, mockBackendSrv, mockTemplateSrv);
   return [ds, mockBackendSrv, mockTemplateSrv] as const;