fix: parsing of string map values (#582)

* fix: fix parsing of string map values

* fix: linting

* test: add them

* style: prettier

* fix: linting

* refactor: move util method to class that uses it

Author: jake-bassett

projects/components/src/filtering/filter/builder/types/string-map-filter-builder.ts

@@ -38,7 +38,9 @@ export class StringMapFilterBuilder extends AbstractFilterBuilder<string | [stri
       return attribute.displayName;
     }
 
-    return `${attribute.displayName}${MAP_LHS_DELIMITER}${Array.isArray(value) ? value[0] : value}`;
+    const displayValue: string = Array.isArray(value) ? (value.length > 0 ? value[0] : '') : value;
+
+    return `${attribute.displayName}${MAP_LHS_DELIMITER}${displayValue}`;
   }
 
   private buildUserFilterStringRhs(operator?: FilterOperator, value?: string | string[]): string {

projects/components/src/filtering/filter/parser/types/abstract-filter-parser.test.ts

@@ -0,0 +1,92 @@
+import { FilterAttribute, FilterAttributeType } from '@hypertrace/components';
+import { getTestFilterAttribute } from '@hypertrace/test-utils';
+import { ParsedFilter } from '../parsed-filter';
+import { ContainsFilterParser } from './contains-filter-parser';
+
+describe('Filter Parser', () => {
+  test('correctly parses CONTAINS_KEY with dot', () => {
+    const attribute: FilterAttribute = getTestFilterAttribute(FilterAttributeType.StringMap);
+    const filterString = 'String Map Attribute CONTAINS_KEY http.url';
+
+    const containsFilterParser: ContainsFilterParser = new ContainsFilterParser();
+    const parsedFilter: ParsedFilter<unknown> | undefined = containsFilterParser.parseFilterString(
+      attribute,
+      filterString
+    );
+
+    expect(parsedFilter).toEqual({
+      field: 'stringMapAttribute',
+      operator: 'CONTAINS_KEY',
+      value: ['http.url']
+    });
+  });
+
+  test('correctly parses CONTAINS_KEY with colon', () => {
+    const attribute: FilterAttribute = getTestFilterAttribute(FilterAttributeType.StringMap);
+    const filterString = 'String Map Attribute CONTAINS_KEY http:url';
+
+    const containsFilterParser: ContainsFilterParser = new ContainsFilterParser();
+    const parsedFilter: ParsedFilter<unknown> | undefined = containsFilterParser.parseFilterString(
+      attribute,
+      filterString
+    );
+
+    expect(parsedFilter).toEqual({
+      field: 'stringMapAttribute',
+      operator: 'CONTAINS_KEY',
+      value: ['http:url']
+    });
+  });
+
+  test('correctly parses CONTAINS_KEY_VALUE for tag with dot and URL', () => {
+    const attribute: FilterAttribute = getTestFilterAttribute(FilterAttributeType.StringMap);
+    const filterString =
+      'String Map Attribute.http.url CONTAINS_KEY_VALUE http://dataservice:9394/userreview?productId=f2620500-8b55-4fab-b7a2-fe8af6f5ae24';
+
+    const containsFilterParser: ContainsFilterParser = new ContainsFilterParser();
+    const parsedFilter: ParsedFilter<unknown> | undefined = containsFilterParser.parseFilterString(
+      attribute,
+      filterString
+    );
+
+    expect(parsedFilter).toEqual({
+      field: 'stringMapAttribute',
+      operator: 'CONTAINS_KEY_VALUE',
+      value: ['http.url', 'http://dataservice:9394/userreview?productId=f2620500-8b55-4fab-b7a2-fe8af6f5ae24']
+    });
+  });
+
+  test('correctly parses CONTAINS_KEY_VALUE for tag with colon and URL', () => {
+    const attribute: FilterAttribute = getTestFilterAttribute(FilterAttributeType.StringMap);
+    const filterString =
+      'String Map Attribute.http:url CONTAINS_KEY_VALUE http://dataservice:9394/userreview?productId=f2620500-8b55-4fab-b7a2-fe8af6f5ae24';
+
+    const containsFilterParser: ContainsFilterParser = new ContainsFilterParser();
+    const parsedFilter: ParsedFilter<unknown> | undefined = containsFilterParser.parseFilterString(
+      attribute,
+      filterString
+    );
+
+    expect(parsedFilter).toEqual({
+      field: 'stringMapAttribute',
+      operator: 'CONTAINS_KEY_VALUE',
+      value: ['http:url', 'http://dataservice:9394/userreview?productId=f2620500-8b55-4fab-b7a2-fe8af6f5ae24']
+    });
+  });
+
+  test('correctly parses CONTAINS_KEY_VALUE for tag with colon and empty string', () => {
+    const attribute: FilterAttribute = getTestFilterAttribute(FilterAttributeType.StringMap);
+    const filterString = 'String Map Attribute.http:url CONTAINS_KEY_VALUE ""';
+    const containsFilterParser: ContainsFilterParser = new ContainsFilterParser();
+    const parsedFilter: ParsedFilter<unknown> | undefined = containsFilterParser.parseFilterString(
+      attribute,
+      filterString
+    );
+
+    expect(parsedFilter).toEqual({
+      field: 'stringMapAttribute',
+      operator: 'CONTAINS_KEY_VALUE',
+      value: ['http:url', '""']
+    });
+  });
+});

projects/components/src/filtering/filter/parser/types/contains-filter-parser.ts

@@ -1,4 +1,4 @@
-import { assertUnreachable } from '@hypertrace/common';
+import { assertUnreachable, isNonEmptyString } from '@hypertrace/common';
 import { FilterAttribute } from '../../filter-attribute';
 import { FilterAttributeType } from '../../filter-attribute-type';
 import { MAP_LHS_DELIMITER, MAP_RHS_DELIMITER } from '../../filter-delimiters';
@@ -46,7 +46,23 @@ export class ContainsFilterParser extends AbstractFilterParser<PossibleValuesTyp
     splitFilter: SplitFilter<FilterOperator>
   ): string[] | undefined {
     if (splitFilter.lhs === attribute.displayName) {
-      return splitFilter.rhs.split(MAP_RHS_DELIMITER);
+      switch (splitFilter.operator) {
+        case FilterOperator.ContainsKey:
+          return [splitFilter.rhs];
+        case FilterOperator.ContainsKeyValue:
+          return splitFirstOccurrenceOmitEmpty(splitFilter.rhs, MAP_RHS_DELIMITER);
+        case FilterOperator.Equals:
+        case FilterOperator.NotEquals:
+        case FilterOperator.LessThan:
+        case FilterOperator.LessThanOrEqualTo:
+        case FilterOperator.GreaterThan:
+        case FilterOperator.GreaterThanOrEqualTo:
+        case FilterOperator.Like:
+        case FilterOperator.In:
+          return undefined;
+        default:
+          assertUnreachable(splitFilter.operator);
+      }
     }
 
     const splitLhs = this.splitLhs(attribute, splitFilter);
@@ -76,3 +92,9 @@ interface SplitLhs {
   displayName: string;
   key?: string;
 }
+
+const splitFirstOccurrenceOmitEmpty = (str: string, delimiter: string): string[] => {
+  const firstIndex = str.indexOf(delimiter);
+
+  return [str.substr(0, firstIndex), str.substr(firstIndex + 1)].filter(isNonEmptyString);
+};