Add DatasourceWithAsyncBackend tests (#6)

* Add DatasourceWithAsyncBackend tests

* add test for feature toggle

Author: kevinwcyu

src/DatasourceWithAsyncBackend.test.ts

@@ -0,0 +1,109 @@
+import { DataQuery, DataSourceInstanceSettings, PluginType, getDefaultTimeRange } from '@grafana/data';
+import { DataSourceWithBackend } from '@grafana/runtime';
+import { DatasourceWithAsyncBackend } from './DatasourceWithAsyncBackend';
+
+const queryMock = jest.fn().mockImplementation(() => Promise.resolve({ data: [] }));
+jest.spyOn(DataSourceWithBackend.prototype, 'query').mockImplementation(queryMock);
+
+const defaultInstanceSettings: DataSourceInstanceSettings<{}> = {
+  id: 1,
+  uid: 'test',
+  type: 'test',
+  name: 'test',
+  meta: {
+    id: 'test',
+    name: 'test',
+    type: PluginType.datasource,
+    info: {
+      author: {
+        name: 'test',
+      },
+      description: 'test',
+      links: [],
+      logos: {
+        large: '',
+        small: '',
+      },
+      screenshots: [],
+      updated: '',
+      version: '',
+    },
+    module: '',
+    baseUrl: '',
+  },
+  access: 'direct',
+  jsonData: {},
+};
+const defaultQuery = { refId: 'refId-1' };
+const defaultQuery2 = { refId: 'refId-2' };
+const defaultRequest = {
+  requestId: 'requestId',
+  interval: '1',
+  intervalMs: 1,
+  range: getDefaultTimeRange(),
+  scopedVars: {},
+  targets: [defaultQuery, defaultQuery2],
+  timezone: 'utc',
+  app: 'test',
+  startTime: 0,
+};
+
+const setupDatasourceWithAsyncBackend = ({
+  settings = defaultInstanceSettings,
+  asyncQueryDataSupport = true,
+}: {
+  settings?: DataSourceInstanceSettings<{}>;
+  asyncQueryDataSupport?: boolean;
+}) => new DatasourceWithAsyncBackend<DataQuery>(settings, asyncQueryDataSupport);
+
+describe('DatasourceWithAsyncBackend', () => {
+  // beforeAll(() => {
+  //   queryMock.mockClear();
+  // });
+
+  it('can store running queries', () => {
+    const ds = setupDatasourceWithAsyncBackend({});
+
+    ds.storeQuery(defaultQuery, { queryID: '123' });
+    expect(ds.getQuery(defaultQuery)).toEqual({ queryID: '123' });
+  });
+
+  it('can remove running queries', () => {
+    const ds = setupDatasourceWithAsyncBackend({});
+
+    ds.storeQuery(defaultQuery, { queryID: '123' });
+    expect(ds.getQuery(defaultQuery)).toEqual({ queryID: '123' });
+    ds.removeQuery(defaultQuery);
+    expect(ds.getQuery(defaultQuery)).toEqual({});
+  });
+
+  it('can cancel running queries', () => {
+    const ds = setupDatasourceWithAsyncBackend({});
+
+    ds.storeQuery(defaultQuery, { queryID: '123' });
+    ds.cancel(defaultQuery);
+    expect(ds.getQuery(defaultQuery)).toEqual({ queryID: '123', shouldCancel: true });
+  });
+
+  it('can queue individual queries to run asynchronously if feature toggle asyncQueryDataSupport is `true`', () => {
+    const ds = setupDatasourceWithAsyncBackend({ asyncQueryDataSupport: true });
+
+    ds.doSingle = jest.fn().mockReturnValue(Promise.resolve({ data: [] }));
+    expect(ds.doSingle).not.toHaveBeenCalled();
+    ds.query(defaultRequest);
+    expect(ds.doSingle).toHaveBeenCalledTimes(2);
+    expect(ds.doSingle).toHaveBeenCalledWith(defaultQuery, defaultRequest);
+    expect(ds.doSingle).toHaveBeenCalledWith(defaultQuery2, defaultRequest);
+  });
+
+  it('can run queries synchronously if feature toggle asyncQueryDataSupport is `false`', () => {
+    const ds = setupDatasourceWithAsyncBackend({ asyncQueryDataSupport: false });
+
+    ds.doSingle = jest.fn();
+    expect(ds.doSingle).not.toHaveBeenCalled();
+    ds.query(defaultRequest);
+    expect(ds.doSingle).not.toHaveBeenCalled();
+    expect(queryMock).toHaveBeenCalledTimes(1);
+    expect(queryMock).toHaveBeenCalledWith(defaultRequest);
+  });
+});