feat(products): Add query builder to the Products Datasource

src/core/query-builder.constants.ts

@@ -1,3 +1,4 @@
+import { editorTemplate, handleNumberValue, handleStringValue, keyValueExpressionBuilderCallback, numericKeyValueExpressionReaderCallback, stringKeyValueExpressionReaderCallback, valueTemplate } from "datasources/products/components/query-builder/utils/keyValueOperationUtils";
 import { QueryBuilderCustomOperation } from "smart-webcomponents-react";
 
 export const queryBuilderMessages = {
@@ -40,6 +41,32 @@ export const queryBuilderMessages = {
   },
 };
 
+export enum FilterOperations {
+  KeyValueMatch = 'key_value_matches',
+  KeyValueDoesNotMatch = 'key_value_not_matches',
+  KeyValueContains = 'key_value_contains',
+  KeyValueDoesNotContains = 'key_value_not_contains',
+  KeyValueIsGreaterThan = 'key_value_>',
+  KeyValueIsGreaterThanOrEqual = 'key_value_>=',
+  KeyValueIsLessThan = 'key_value_<',
+  KeyValueIsLessThanOrEqual = 'key_value_<=',
+  KeyValueIsNumericallyEqual = 'key_value_===',
+  KeyValueIsNumericallyNotEqual = 'key_value_!==',
+}
+
+export enum FilterExpressions {
+  KeyValueMatches = '{0}["{1}"] = "{2}"',
+  KeyValueNotMatches = '{0}["{1}"] != "{2}"',
+  KeyValueContains = '{0}["{1}"].Contains("{2}")',
+  KeyValueNotContains = '!{0}["{1}"].Contains("{2}")',
+  KeyValueIsGreaterThan = 'SafeConvert.ToDecimal({0}["{1}"]) > {2}',
+  KeyValueIsGreaterThanOrEqual = 'SafeConvert.ToDecimal({0}["{1}"]) >= {2}',
+  KeyValueIsLessThan = 'SafeConvert.ToDecimal({0}["{1}"]) < {2}',
+  KeyValueIsLessThanOrEqual = 'SafeConvert.ToDecimal({0}["{1}"]) <= {2}',
+  KeyValueIsNumericallyEqual = 'SafeConvert.ToDecimal({0}["{1}"]) = {2}',
+  KeyValueIsNumericallyNotEqual = 'SafeConvert.ToDecimal({0}["{1}"]) != {2}',
+}
+
 export const QueryBuilderOperations = {
   EQUALS: {
     label: 'Equals',
@@ -167,31 +194,131 @@ export const QueryBuilderOperations = {
     expressionTemplate: '!string.IsNullOrEmpty(properties["{0}"])',
     hideValue: true,
   },
-}
+  KEY_VALUE_MATCH: {
+    label: `matches`,
+    name: FilterOperations.KeyValueMatch,
+    expressionTemplate: FilterExpressions.KeyValueMatches,
+    editorTemplate: editorTemplate,
+    valueTemplate: valueTemplate,
+    handleValue: handleStringValue,
+    expressionBuilderCallback: keyValueExpressionBuilderCallback,
+    expressionReaderCallback: stringKeyValueExpressionReaderCallback,
+  },
+  KEY_VALUE_DOES_NOT_MATCH: {
+    label: `does not match`,
+    name: FilterOperations.KeyValueDoesNotMatch,
+    expressionTemplate: FilterExpressions.KeyValueNotMatches,
+    editorTemplate: editorTemplate,
+    valueTemplate: valueTemplate,
+    handleValue: handleStringValue,
+    expressionBuilderCallback: keyValueExpressionBuilderCallback,
+    expressionReaderCallback: stringKeyValueExpressionReaderCallback,
+  },
+  KEY_VALUE_DOES_NOT_CONTAINS: {
+    label: `does not contain`,
+    name: FilterOperations.KeyValueDoesNotContains,
+    expressionTemplate: FilterExpressions.KeyValueNotContains,
+    editorTemplate: editorTemplate,
+    valueTemplate: valueTemplate,
+    handleValue: handleStringValue,
+    expressionBuilderCallback: keyValueExpressionBuilderCallback,
+    expressionReaderCallback: stringKeyValueExpressionReaderCallback,
+  },
+  KEY_VALUE_CONTAINS: {
+    label: `contains`,
+    name: FilterOperations.KeyValueContains,
+    expressionTemplate: FilterExpressions.KeyValueContains,
+    editorTemplate: editorTemplate,
+    valueTemplate: valueTemplate,
+    handleValue: handleStringValue,
+    expressionBuilderCallback: keyValueExpressionBuilderCallback,
+    expressionReaderCallback: stringKeyValueExpressionReaderCallback,
+  },
+  KEY_VALUE_IS_GREATER_THAN: {
+    label: `> (numeric)`,
+    name: FilterOperations.KeyValueIsGreaterThan,
+    expressionTemplate: FilterExpressions.KeyValueIsGreaterThan,
+    editorTemplate: editorTemplate,
+    valueTemplate: valueTemplate,
+    handleValue: handleNumberValue,
+    expressionBuilderCallback: keyValueExpressionBuilderCallback,
+    expressionReaderCallback: numericKeyValueExpressionReaderCallback,
+  },
+  KEY_VALUE_IS_GREATER_THAN_OR_EQUAL: {
+    label: `≥ (numeric)`,
+    name: FilterOperations.KeyValueIsGreaterThanOrEqual,
+    expressionTemplate: FilterExpressions.KeyValueIsGreaterThanOrEqual,
+    editorTemplate: editorTemplate,
+    valueTemplate: valueTemplate,
+    handleValue: handleNumberValue,
+    expressionBuilderCallback: keyValueExpressionBuilderCallback,
+    expressionReaderCallback: numericKeyValueExpressionReaderCallback,
+  },
+  KEY_VALUE_IS_LESS_THAN: {
+    label: `< (numeric)`,
+    name: FilterOperations.KeyValueIsLessThan,
+    expressionTemplate: FilterExpressions.KeyValueIsLessThan,
+    editorTemplate: editorTemplate,
+    valueTemplate: valueTemplate,
+    handleValue: handleNumberValue,
+    expressionBuilderCallback: keyValueExpressionBuilderCallback,
+    expressionReaderCallback: numericKeyValueExpressionReaderCallback,
+  },
+  KEY_VALUE_IS_LESS_THAN_OR_EQUAL: {
+    label: `≤ (numeric)`,
+    name: FilterOperations.KeyValueIsLessThanOrEqual,
+    expressionTemplate: FilterExpressions.KeyValueIsLessThanOrEqual,
+    editorTemplate: editorTemplate,
+    valueTemplate: valueTemplate,
+    handleValue: handleNumberValue,
+    expressionBuilderCallback: keyValueExpressionBuilderCallback,
+    expressionReaderCallback: numericKeyValueExpressionReaderCallback,
+  },
+  KEY_VALUE_IS_NUMERICAL_EQUAL: {
+    label: `= (numeric)`,
+    name: FilterOperations.KeyValueIsNumericallyEqual,
+    expressionTemplate: FilterExpressions.KeyValueIsNumericallyEqual,
+    editorTemplate: editorTemplate,
+    valueTemplate: valueTemplate,
+    handleValue: handleNumberValue,
+    expressionBuilderCallback: keyValueExpressionBuilderCallback,
+    expressionReaderCallback: numericKeyValueExpressionReaderCallback,
+  },
+  KEY_VALUE_IS_NUMERICAL_NOT_EQUAL: {
+    label: `≠ (numeric)`,
+    name: FilterOperations.KeyValueIsNumericallyNotEqual,
+    expressionTemplate: FilterExpressions.KeyValueIsNumericallyNotEqual,
+    editorTemplate: editorTemplate,
+    valueTemplate: valueTemplate,
+    handleValue: handleNumberValue,
+    expressionBuilderCallback: keyValueExpressionBuilderCallback,
+    expressionReaderCallback: numericKeyValueExpressionReaderCallback,
+  }
+};
 
 export const customOperations: QueryBuilderCustomOperation[] = [
-  QueryBuilderOperations.EQUALS,
-  QueryBuilderOperations.DOES_NOT_EQUAL,
-  QueryBuilderOperations.STARTS_WITH,
-  QueryBuilderOperations.ENDS_WITH,
-  QueryBuilderOperations.CONTAINS,
-  QueryBuilderOperations.DOES_NOT_CONTAIN,
-  QueryBuilderOperations.IS_BLANK,
-  QueryBuilderOperations.IS_NOT_BLANK,
-  QueryBuilderOperations.GREATER_THAN,
-  QueryBuilderOperations.GREATER_THAN_OR_EQUAL_TO,
-  QueryBuilderOperations.LESS_THAN,
-  QueryBuilderOperations.LESS_THAN_OR_EQUAL_TO,
-  QueryBuilderOperations.LIST_EQUALS,
-  QueryBuilderOperations.LIST_DOES_NOT_EQUAL,
-  QueryBuilderOperations.LIST_CONTAINS,
-  QueryBuilderOperations.LIST_DOES_NOT_CONTAIN,
-  QueryBuilderOperations.PROPERTY_EQUALS,
-  QueryBuilderOperations.PROPERTY_DOES_NOT_EQUAL,
-  QueryBuilderOperations.PROPERTY_STARTS_WITH,
-  QueryBuilderOperations.PROPERTY_ENDS_WITH,
-  QueryBuilderOperations.PROPERTY_CONTAINS,
-  QueryBuilderOperations.PROPERTY_DOES_NOT_CONTAIN,
-  QueryBuilderOperations.PROPERTY_IS_BLANK,
-  QueryBuilderOperations.PROPERTY_IS_NOT_BLANK,
-];
+    QueryBuilderOperations.EQUALS,
+    QueryBuilderOperations.DOES_NOT_EQUAL,
+    QueryBuilderOperations.STARTS_WITH,
+    QueryBuilderOperations.ENDS_WITH,
+    QueryBuilderOperations.CONTAINS,
+    QueryBuilderOperations.DOES_NOT_CONTAIN,
+    QueryBuilderOperations.IS_BLANK,
+    QueryBuilderOperations.IS_NOT_BLANK,
+    QueryBuilderOperations.GREATER_THAN,
+    QueryBuilderOperations.GREATER_THAN_OR_EQUAL_TO,
+    QueryBuilderOperations.LESS_THAN,
+    QueryBuilderOperations.LESS_THAN_OR_EQUAL_TO,
+    QueryBuilderOperations.LIST_EQUALS,
+    QueryBuilderOperations.LIST_DOES_NOT_EQUAL,
+    QueryBuilderOperations.LIST_CONTAINS,
+    QueryBuilderOperations.LIST_DOES_NOT_CONTAIN,
+    QueryBuilderOperations.PROPERTY_EQUALS,
+    QueryBuilderOperations.PROPERTY_DOES_NOT_EQUAL,
+    QueryBuilderOperations.PROPERTY_STARTS_WITH,
+    QueryBuilderOperations.PROPERTY_ENDS_WITH,
+    QueryBuilderOperations.PROPERTY_CONTAINS,
+    QueryBuilderOperations.PROPERTY_DOES_NOT_CONTAIN,
+    QueryBuilderOperations.PROPERTY_IS_BLANK,
+    QueryBuilderOperations.PROPERTY_IS_NOT_BLANK,
+  ];

src/datasources/products/ProductsDataSource.test.ts

@@ -4,6 +4,7 @@ import { ProductQuery, Properties, PropertiesOptions, QueryProductResponse } fro
 import { Field } from '@grafana/data';
 import { createFetchError, createFetchResponse, getQueryBuilder, requestMatching, setupDataSource } from 'test/fixtures';
 import { MockProxy } from 'jest-mock-extended';
+import { ProductsQueryBuilderFieldNames } from './constants/ProductsQueryBuilder.constants';
 
 const mockQueryProductResponse: QueryProductResponse = {
   products: [
@@ -62,7 +63,7 @@ describe('queryProducts', () => {
     expect(response).toMatchSnapshot();
   });
 
-  test('raises an error returns API fails', async () => {
+  test('raises an error when API fails', async () => {
     backendServer.fetch
       .calledWith(requestMatching({ url: '/nitestmonitor/v2/query-products' }))
       .mockReturnValue(createFetchError(400));
@@ -73,6 +74,28 @@ describe('queryProducts', () => {
   });
 });
 
+describe('queryProductValues', () => {
+  test('returns data when there are valid queries', async () => {
+    backendServer.fetch
+      .calledWith(requestMatching({ url: '/nitestmonitor/v2/query-product-values' }))
+      .mockReturnValue(createFetchResponse(['value1']));
+
+    const response = await datastore.queryProductValues(ProductsQueryBuilderFieldNames.PART_NUMBER);
+
+    expect(response).toMatchSnapshot();
+  });
+
+  test('raises an error when API fails', async () => {
+    backendServer.fetch
+      .calledWith(requestMatching({ url: '/nitestmonitor/v2/query-product-values' }))
+      .mockReturnValue(createFetchError(400));
+
+    await expect(datastore.queryProductValues(ProductsQueryBuilderFieldNames.PART_NUMBER))
+      .rejects
+      .toThrow('Request to url "/nitestmonitor/v2/query-product-values" failed with status code: 400. Error message: "Error"');
+  });
+});
+
 describe('query', () => {
   test('returns data when there are valid queries', async () => {
     const query = buildQuery(
@@ -84,6 +107,7 @@ describe('query', () => {
           PropertiesOptions.NAME,
           PropertiesOptions.WORKSPACE
         ] as Properties[],
+        queryBy: `${ProductsQueryBuilderFieldNames.PART_NUMBER} = "123"`,
         orderBy: PropertiesOptions.ID,
         descending: false,
         recordCount: 1
@@ -192,6 +216,87 @@ describe('query', () => {
       { name: 'properties', values: [''], type: 'string' },
     ]);
   });
+
+  test('should not query product values if cache exists', async () => {
+    backendServer.fetch
+      .calledWith(requestMatching({ url: '/nitestmonitor/v2/query-product-values' }))
+      .mockReturnValue(createFetchResponse(['value1']));
+    datastore.partNumbersCache.set('partNumber', 'value1');
+    backendServer.fetch.mockClear();
+
+    await datastore.query(buildQuery())
+
+    expect(backendServer.fetch).not.toHaveBeenCalled();
+  });
+
+  test('should not query workspace values if cache exists', async () => {
+    backendServer.fetch
+      .calledWith(requestMatching({ url: '/niauth/v1/user' }))
+      .mockReturnValue(createFetchResponse(['workspace1']));
+    datastore.workspacesCache.set('workspace', { id: 'workspace1', name: 'workspace1', default: false, enabled: true });
+    backendServer.fetch.mockClear();
+
+    await datastore.query(buildQuery())
+
+    expect(backendServer.fetch).not.toHaveBeenCalled();
+  });
+
+  describe('Query builder queries', () => {
+    test('should transform fields with single value', async () => {
+      const query = buildQuery(
+        {
+          refId: 'A',
+          properties: [
+            PropertiesOptions.PART_NUMBER
+          ] as Properties[],
+          orderBy: undefined,
+          queryBy: `${PropertiesOptions.PART_NUMBER} = '123'`
+        },
+      );
+
+      await datastore.query(query);
+
+      expect(backendServer.fetch).toHaveBeenCalledWith(
+        expect.objectContaining({
+          data: {
+            descending: false,
+            filter: "partNumber = '123'",
+            orderBy: undefined,
+            projection: ["partNumber"],
+            returnCount: false, take: 1000
+          }
+        })
+      );
+    });
+
+    test('should transform fields with multiple values', async () => {
+      const query = buildQuery(
+        {
+          refId: 'A',
+          properties: [
+            PropertiesOptions.PART_NUMBER
+          ] as Properties[],
+          orderBy: undefined,
+          queryBy: `${ProductsQueryBuilderFieldNames.PART_NUMBER} = "{partNumber1,partNumber2}"`
+        },
+      );
+
+      await datastore.query(query);
+
+      expect(backendServer.fetch).toHaveBeenCalledWith(
+        expect.objectContaining({
+          data: {
+            descending: false,
+            filter: "PartNumber = \"partNumber1\" || PartNumber = \"partNumber2\"",
+            orderBy: undefined,
+            projection: ["partNumber"],
+            returnCount: false, take: 1000
+          }
+        })
+      );
+    });
+
+  });
 });
 
 const buildQuery = getQueryBuilder<ProductQuery>()({