feat(asset): add asset data source (#62)

Co-authored-by: Carson Moore <carson.moore@ni.com>

.github/CODEOWNERS

@@ -1 +1,3 @@
 * @mure @cameronwaterman
+
+/src/datasources/asset @CiprianAnton @kkerezsi

README.md

@@ -18,6 +18,7 @@ Tools](https://grafana.github.io/plugin-tools/).
 - [Notebooks](src/datasources/notebook/)
 - [Systems](src/datasources/system/)
 - [Tags](src/datasources/tag/)
+- [Assets](src/datasources/asset/)
 
 ### Panels
 

provisioning/example.yaml

@@ -32,4 +32,8 @@ datasources:
   - name: SystemLink Workspaces
     type: ni-slworkspace-datasource
     uid: workspace
-    <<: *config
+    <<: *config
+  - name: SystemLink Assets
+    type: ni-slasset-datasource
+    uid: asset
+    <<: *config

src/core/DataSourceBase.ts

@@ -7,7 +7,7 @@ import {
 } from '@grafana/data';
 import { BackendSrv, BackendSrvRequest, TemplateSrv, isFetchError } from '@grafana/runtime';
 import { DataQuery } from '@grafana/schema';
-import { Workspace } from './types';
+import { QuerySystemsResponse, QuerySystemsRequest, Workspace } from './types';
 import { sleep } from './utils';
 import { lastValueFrom } from 'rxjs';
 
@@ -21,7 +21,9 @@ export abstract class DataSourceBase<TQuery extends DataQuery> extends DataSourc
   }
 
   abstract defaultQuery: Partial<TQuery> & Omit<TQuery, 'refId'>;
+
   abstract runQuery(query: TQuery, options: DataQueryRequest): Promise<DataFrameDTO>;
+
   abstract shouldRunQuery(query: TQuery): boolean;
 
   query(request: DataQueryRequest<TQuery>): Promise<DataQueryResponse> {
@@ -70,4 +72,10 @@ export abstract class DataSourceBase<TQuery extends DataQuery> extends DataSourc
 
     return (DataSourceBase.Workspaces = response.workspaces);
   }
+
+  async getSystems(body: QuerySystemsRequest): Promise<QuerySystemsResponse> {
+    return await this.post<QuerySystemsResponse>(
+      this.instanceSettings.url + '/nisysmgmt/v1/query-systems', body
+    )
+  }
 }

src/core/errors.test.tsx

@@ -0,0 +1,107 @@
+import { render, screen } from '@testing-library/react'
+import { FetchError } from '@grafana/runtime';
+import { act } from 'react-dom/test-utils';
+import { FloatingError, parseErrorMessage } from './errors';
+import { SystemLinkError } from "./types";
+import React from 'react';
+import { errorCodes } from "../datasources/data-frame/constants";
+
+test('renders with error message', () => {
+  render(<FloatingError message='error msg'/>)
+
+  expect(screen.getByText('error msg')).toBeInTheDocument()
+})
+
+test('does not render without error message', () => {
+  const { container } = render(<FloatingError message=''/>)
+
+  expect(container.innerHTML).toBeFalsy()
+})
+
+test('hides after timeout', () => {
+  jest.useFakeTimers();
+
+  const { container } = render(<FloatingError message='error msg'/>)
+  act(() => jest.runAllTimers())
+
+  expect(container.innerHTML).toBeFalsy()
+})
+
+test('parses error message', () => {
+  const errorMock: Error = {
+    name: 'error',
+    message: 'error message'
+  }
+
+  const result = parseErrorMessage(errorMock)
+
+  expect(result).toBe(errorMock.message)
+})
+
+test('parses fetch error message', () => {
+  const fetchErrorMock: FetchError = {
+    status: 404,
+    data: { message: 'error message' },
+    config: { url: 'URL' }
+  }
+
+  const result = parseErrorMessage(fetchErrorMock as any)
+
+  expect(result).toBe(fetchErrorMock.data.message)
+})
+
+test('parses fetch error status text', () => {
+  const fetchErrorMock: FetchError = {
+    status: 404,
+    data: {},
+    statusText: 'statusText',
+    config: { url: 'URL' }
+  }
+
+  const result = parseErrorMessage(fetchErrorMock as any)
+
+  expect(result).toBe(fetchErrorMock.statusText)
+})
+
+test('parses SystemLink error code', () => {
+  const systemLinkError: SystemLinkError = {
+    error: {
+      name: 'name',
+      args: [],
+      code: -255130,
+      message: 'error message'
+    }
+  }
+  const fetchErrorMock: FetchError = {
+    status: 404,
+    data: systemLinkError,
+    statusText: 'statusText',
+    config: { url: 'URL' }
+  }
+
+  const result = parseErrorMessage(fetchErrorMock as any)
+
+  expect(result).toBe(errorCodes[fetchErrorMock.data.error.code] ?? fetchErrorMock.data.error.message)
+})
+
+test('parses SystemLink error message', () => {
+  const systemLinkError: SystemLinkError = {
+    error: {
+      name: 'name',
+      args: [],
+      code: 123,
+      message: 'error message'
+    }
+  }
+  const fetchErrorMock: FetchError = {
+    status: 404,
+    data: systemLinkError,
+    statusText: 'statusText',
+    config: { url: 'URL' }
+  }
+
+  const result = parseErrorMessage(fetchErrorMock as any)
+
+  expect(result).toBe(errorCodes[fetchErrorMock.data.error.code] ?? fetchErrorMock.data.error.message)
+
+})

src/datasources/data-frame/errors.tsx → src/core/errors.tsx

@@ -1,9 +1,9 @@
 import { isFetchError } from '@grafana/runtime';
 import { Alert } from '@grafana/ui';
-import { errorCodes } from './constants';
+import { errorCodes } from '../datasources/data-frame/constants';
 import React, { useState, useEffect } from 'react';
 import { useTimeoutFn } from 'react-use';
-import { isSystemLinkError } from './types';
+import { isSystemLinkError } from './utils';
 
 export const FloatingError = ({ message = '' }) => {
   const [hide, setHide] = useState(false);
@@ -19,7 +19,7 @@ export const FloatingError = ({ message = '' }) => {
   return <Alert title={message} elevated style={{ position: 'absolute', top: 0, right: 0, width: '50%' }} />;
 };
 
-export const parseErrorMessage = (error: Error) => {
+export const parseErrorMessage = (error: Error): string | undefined => {
   if (isFetchError(error)) {
     if (isSystemLinkError(error.data)) {
       return errorCodes[error.data.error.code] ?? error.data.error.message;

src/core/types.ts

@@ -1,8 +1,34 @@
+import { SystemMetadata } from "../datasources/system/types";
+
 export interface Workspace {
-  name: string;
-  id: string;
+  id: string,
+  name: string,
+  default: boolean,
+  enabled: boolean,
+}
+
+export interface QuerySystemsRequest {
+  skip?: number,
+  take?: number,
+  filter?: string,
+  projection?: string,
+  orderBy?: string
+}
+
+export interface QuerySystemsResponse {
+  data: SystemMetadata[]
+  count: number
 }
 
 export type DeepPartial<T> = {
   [Key in keyof T]?: DeepPartial<T[Key]>;
 };
+
+export interface SystemLinkError {
+  error: {
+    args: string[];
+    code: number;
+    message: string;
+    name: string;
+  }
+}

src/core/utils.ts

@@ -1,7 +1,7 @@
 import { SelectableValue } from '@grafana/data';
 import { useAsync } from 'react-use';
 import { DataSourceBase } from './DataSourceBase';
-import { Workspace } from './types';
+import { SystemLinkError, Workspace } from './types';
 import { TemplateSrv } from '@grafana/runtime';
 
 export function enumToOptions<T>(stringEnum: { [name: string]: T }): Array<SelectableValue<T>> {
@@ -82,3 +82,7 @@ export function replaceVariables(values: string[], templateSrv: TemplateSrv) {
   // Dedupe and flatten
   return [...new Set(replaced.flat())];
 }
+
+export function isSystemLinkError(error: any): error is SystemLinkError {
+  return Boolean(error?.error?.code) && Boolean(error?.error?.name);
+}