NETOBSERV-223: filter by empty IP and numbers (#168)

* NETOBSERV-223: filter by empty IP

* filter by empty/undefined port and protocol

* renamed constant

* fix linting error

Author: Mario Macias

pkg/loki/flow_query.go

@@ -16,6 +16,7 @@ const (
 	limitParam     = "limit"
 	queryRangePath = "/loki/api/v1/query_range?query="
 	jsonOrJoiner   = "+or+"
+	emptyMatch     = `""`
 )
 
 // can contains only alphanumeric / '-' / '_' / '.' / ',' / '"' / '*' / ':' / '/' characteres
@@ -131,11 +132,11 @@ func (q *FlowQueryBuilder) addLineFilters(key string, values []string) {
 	for _, value := range values {
 		lm := lineMatch{}
 		switch {
-		case isNumeric:
-			lm = lineMatch{valueType: typeNumber, value: value}
 		case isExactMatch(value):
 			lm = lineMatch{valueType: typeString, value: trimExactMatch(value)}
 			emptyMatches = emptyMatches || len(lm.value) == 0
+		case isNumeric:
+			lm = lineMatch{valueType: typeNumber, value: value}
 		default:
 			lm = lineMatch{valueType: typeRegex, value: value}
 		}
@@ -153,9 +154,14 @@ func (q *FlowQueryBuilder) addLineFilters(key string, values []string) {
 // addIPFilters assumes that we are searching for that IP addresses as part
 // of the log line (not in the stream selector labels)
 func (q *FlowQueryBuilder) addIPFilters(key string, values []string) {
-	var filtersPerKey []labelFilter
+	filtersPerKey := make([]labelFilter, 0, len(values))
 	for _, value := range values {
-		filtersPerKey = append(filtersPerKey, ipLabelFilter(key, value))
+		// empty exact matches should be treated as attribute filters looking for empty IP
+		if value == emptyMatch {
+			filtersPerKey = append(filtersPerKey, stringLabelFilter(key, ""))
+		} else {
+			filtersPerKey = append(filtersPerKey, ipLabelFilter(key, value))
+		}
 	}
 	q.jsonFilters = append(q.jsonFilters, filtersPerKey)
 }

pkg/server/server_flows_test.go

@@ -185,6 +185,17 @@ func TestLokiFiltering(t *testing.T) {
 		outputQueries: []string{
 			"?query={app=\"netobserv-flowcollector\"}|json|SrcK8S_Type=\"\"+or+SrcK8S_Type=\"Pod\"",
 		},
+	}, {
+		inputPath: "?filters=" + url.QueryEscape(`SrcAddr=""|DstAddr=""`),
+		outputQueries: []string{
+			"?query={app=\"netobserv-flowcollector\"}|json|DstAddr=\"\"",
+			"?query={app=\"netobserv-flowcollector\"}|json|SrcAddr=\"\"",
+		},
+	}, {
+		inputPath: "?filters=" + url.QueryEscape(`SrcPort=""`),
+		outputQueries: []string{
+			"?query={app=\"netobserv-flowcollector\"}|json|SrcPort=\"\"",
+		},
 	}}
 
 	numberQueriesExpected := 0

web/locales/en/plugin__network-observability-plugin.json

@@ -205,6 +205,7 @@
   "A single IPv4 or IPv6 address like 192.0.2.0, ::1": "A single IPv4 or IPv6 address like 192.0.2.0, ::1",
   "An IP address range like 192.168.0.1-192.189.10.12, 2001:db8::1-2001:db8::8": "An IP address range like 192.168.0.1-192.189.10.12, 2001:db8::1-2001:db8::8",
   "A CIDR specification like 192.51.100.0/24, 2001:db8::/32": "A CIDR specification like 192.51.100.0/24, 2001:db8::/32",
+  "Empty double quotes \"\" for an empty IP": "Empty double quotes \"\" for an empty IP",
   "Not a valid IPv4 or IPv6, nor a CIDR, nor an IP range separated by hyphen": "Not a valid IPv4 or IPv6, nor a CIDR, nor an IP range separated by hyphen",
   "Owner Name": "Owner Name",
   "Incomplete resource name, either kind, namespace or name is missing.": "Incomplete resource name, either kind, namespace or name is missing.",
@@ -222,9 +223,11 @@
   "Specify a single port following one of these rules:": "Specify a single port following one of these rules:",
   "A port number like 80, 21": "A port number like 80, 21",
   "A IANA name like HTTP, FTP": "A IANA name like HTTP, FTP",
+  "Empty double quotes \"\" for undefined port": "Empty double quotes \"\" for undefined port",
   "Unknown protocol": "Unknown protocol",
   "Specify a single protocol number or name.": "Specify a single protocol number or name.",
   "Specify a single protocol following one of these rules:": "Specify a single protocol following one of these rules:",
   "A protocol number like 6, 17": "A protocol number like 6, 17",
-  "A IANA name like TCP, UDP": "A IANA name like TCP, UDP"
+  "A IANA name like TCP, UDP": "A IANA name like TCP, UDP",
+  "Empty double quotes \"\" for undefined protocol": "Empty double quotes \"\" for undefined protocol"
 }

web/src/utils/__tests__/ip.spec.ts

@@ -69,4 +69,7 @@ describe('validate IP filter', () => {
     expect(validateIPFilter('1.3.3.4/')).toBe(false);
     expect(validateIPFilter('1.3.3.4/3.2.1.0')).toBe(false);
   });
+  it('should validate empty IPs', () => {
+    expect(validateIPFilter('""')).toBe(true);
+  });
 });

web/src/utils/__tests__/port.spec.ts

@@ -1,5 +1,8 @@
 import { formatPort, comparePorts } from '../port';
 import { config } from '../config';
+import { getFilterDefinitions } from '../filter-definitions';
+
+const t = (k: string) => k;
 
 describe('formatport', () => {
   beforeEach(() => {
@@ -46,3 +49,10 @@ describe('comparePort', () => {
     expect(comparePorts(45392, 45392)).toEqual(0);
   });
 });
+
+describe('validatePort', () => {
+  it('should accept empty double quotes for empty/undefined ports', () => {
+    const portFilter = getFilterDefinitions(t).find(f => f.id == 'port')!;
+    expect(portFilter.validate(`""`)).toEqual({ val: '""' });
+  });
+});

web/src/utils/__tests__/protocol.spec.ts

@@ -1,4 +1,7 @@
 import { compareProtocols, formatProtocol } from '../protocol';
+import { getFilterDefinitions } from '../filter-definitions';
+
+const t = (k: string) => k;
 
 describe('formatProtocol', () => {
   it('should format protocol', () => {
@@ -15,3 +18,10 @@ describe('compareProtocol', () => {
     expect(sorted).toEqual([121, 6, 17, undefined]);
   });
 });
+
+describe('validateProtocol', () => {
+  it('should accept empty double quotes for empty/undefined protocols', () => {
+    const protocolFilter = getFilterDefinitions(t).find(f => f.id == 'protocol')!;
+    expect(protocolFilter.validate(`""`)).toEqual({ val: '""' });
+  });
+});

web/src/utils/filter-definitions.ts

@@ -24,6 +24,9 @@ import {
   cap10
 } from './filter-options';
 
+// Convenience string to filter by undefined field values
+export const undefinedValue = '""';
+
 type Field = keyof Fields | keyof Labels;
 
 const singleFieldMapping = (field: Field) => {
@@ -133,7 +136,8 @@ export const getFilterDefinitions = (t: TFunction): FilterDefinition[] => {
     const ipExamples = `${t('Specify IP following one of these rules:')}
     - ${t('A single IPv4 or IPv6 address like 192.0.2.0, ::1')}
     - ${t('An IP address range like 192.168.0.1-192.189.10.12, 2001:db8::1-2001:db8::8')}
-    - ${t('A CIDR specification like 192.51.100.0/24, 2001:db8::/32')}`;
+    - ${t('A CIDR specification like 192.51.100.0/24, 2001:db8::/32')}
+    - ${t('Empty double quotes "" for an empty IP')}`;
 
     const invalidIPMessage = t('Not a valid IPv4 or IPv6, nor a CIDR, nor an IP range separated by hyphen');
 
@@ -284,15 +288,16 @@ export const getFilterDefinitions = (t: TFunction): FilterDefinition[] => {
               return invalid(t('Value is empty'));
             }
             //allow any port number or valid name / value
-            if (!isNaN(Number(value)) || getPort(value)) {
+            if (value == undefinedValue || !isNaN(Number(value)) || getPort(value)) {
               return valid(value);
             }
             return invalid(t('Unknown port'));
           },
           hint: t('Specify a single port number or name.'),
           examples: `${t('Specify a single port following one of these rules:')}
         - ${t('A port number like 80, 21')}
-        - ${t('A IANA name like HTTP, FTP')}`,
+        - ${t('A IANA name like HTTP, FTP')}
+        - ${t('Empty double quotes "" for undefined port')}`,
           fieldMatching: {}
         },
         singleFieldMapping('SrcPort'),
@@ -344,7 +349,7 @@ export const getFilterDefinitions = (t: TFunction): FilterDefinition[] => {
             return invalid(t('Value is empty'));
           }
           //allow any protocol number or valid name / value
-          if (!isNaN(Number(value))) {
+          if (value == undefinedValue || !isNaN(Number(value))) {
             return valid(value);
           } else {
             const proto = findProtocolOption(value);
@@ -357,7 +362,8 @@ export const getFilterDefinitions = (t: TFunction): FilterDefinition[] => {
         hint: t('Specify a single protocol number or name.'),
         examples: `${t('Specify a single protocol following one of these rules:')}
         - ${t('A protocol number like 6, 17')}
-        - ${t('A IANA name like TCP, UDP')}`,
+        - ${t('A IANA name like TCP, UDP')}
+        - ${t('Empty double quotes "" for undefined protocol')}`,
         fieldMatching: { always: singleFieldMapping('Proto') }
       }
     ];

web/src/utils/ip.ts

@@ -1,3 +1,5 @@
+import { undefinedValue } from './filter-definitions';
+
 export const compareIPs = (ip1: string, ip2: string) => {
   const splitIp2 = ip2.split('.');
   const tmpRes = ip1.split('.').map((num, i) => Number(num) - Number(splitIp2[i]));
@@ -14,10 +16,11 @@ export const compareIPs = (ip1: string, ip2: string) => {
  * - A single IPv4 or IPv6 address. Examples: 192.0.2.0, ::1
  * - A range within the IP address. Examples: 192.168.0.1-192.189.10.12, 2001:db8::1-2001:db8::8
  * - A CIDR specification. Examples: 192.51.100.0/24, 2001:db8::/32
+ * - Empty double quotes "" for empty/null IP
  */
 export const validateIPFilter = (ipFilter: string) => {
   ipFilter = ipFilter.trim();
-  if (ipv4.test(ipFilter) || ipv6.test(ipFilter)) {
+  if (ipFilter == undefinedValue || ipv4.test(ipFilter) || ipv6.test(ipFilter)) {
     return true;
   }
   const ips = ipFilter.split('-');