labels filter interface changed in checkmk

Author: BenediktSeidl

src/DataSource.ts

@@ -6,7 +6,8 @@ import RestApiBackend from './backend/rest';
 import { Backend } from './backend/types';
 import WebApiBackend from './backend/web';
 import { Backend as BackendType, CmkQuery, DataSourceOptions, Edition, ResponseDataAutocomplete } from './types';
-import { createAutocompleteConfig } from './ui/autocomplete';
+import { AutoCompleteParams } from './ui/autocomplete';
+import { createCmkContext } from './utils';
 import { WebApiResponse, buildRequestBody } from './webapi';
 
 export class DataSource extends DataSourceApi<CmkQuery> {
@@ -40,13 +41,13 @@ export class DataSource extends DataSourceApi<CmkQuery> {
     ident: string,
     partialRequestSpec: Partial<RequestSpec>,
     prefix: string,
-    params: Record<string, string | boolean>
+    params: Partial<AutoCompleteParams>
   ): Promise<Array<{ value: string; label: string; isDisabled: boolean }>> {
     if (ident === 'label' && this.getBackendType() === 'web') {
       // we have a 2.1.0 version without werk #15074 so label autocompleter is a special edge case
       // can be removed after we stop supporting 2.1.0
       const response = await this.autocompleterRequest<Array<{ value: string }>>('ajax_autocomplete_labels.py', {
-        world: params['world'],
+        world: params.world,
         search_label: prefix,
       });
       return response.data.result.map((val: { value: string }) => ({
@@ -55,10 +56,15 @@ export class DataSource extends DataSourceApi<CmkQuery> {
         isDisabled: false,
       }));
     }
-    const response = await this.autocompleterRequest<ResponseDataAutocomplete>(
-      'ajax_vs_autocomplete.py',
-      createAutocompleteConfig(partialRequestSpec, ident, prefix, params)
-    );
+    const context = createCmkContext(partialRequestSpec, this.getBackendType() === 'rest' ? 'latest' : '2.1.0');
+    const response = await this.autocompleterRequest<ResponseDataAutocomplete>('ajax_vs_autocomplete.py', {
+      ident,
+      value: prefix,
+      params: {
+        ...params,
+        context,
+      },
+    });
     return response.data.result.choices.map(([value, label]: [string, string]) => ({
       value,
       label,

src/types.ts

@@ -18,7 +18,7 @@ export interface Context {
   hostregex?: { host_regex: string; neg_host_regex?: Negative };
   service?: { service: string };
   serviceregex?: { neg_service_regex?: Negative; service_regex: string };
-  host_labels?: { host_label: string };
+  host_labels?: Record<string, string>;
   opthostgroup?: { opthost_group: string; neg_opthost_group?: Negative };
   optservicegroup?: { optservice_group: string; neg_optservice_group?: Negative };
   host_tags?: {

src/ui/autocomplete.ts

@@ -1,39 +1,17 @@
-import { RequestSpec } from '../RequestSpec';
 import { ContextHTTPVars } from '../types';
-import { createCmkContext } from '../utils';
 
 type Context = Record<string, ContextHTTPVars>;
 
 export type Presentation = 'lines' | 'sum' | 'average' | 'min' | 'max';
 
-interface AutoCompleteConfig {
-  ident: string;
-  value?: string;
-  params: {
-    group_id?: string;
-    strict?: string | boolean;
-    mode?: string;
-    presentation?: Presentation;
-    context?: Context;
-    datasource?: string;
-    single_infos?: string[];
-  };
-}
-
-export function createAutocompleteConfig(
-  requestSpec: Partial<RequestSpec>,
-  ident: string,
-  value: string,
-  params: Record<string, string | boolean>
-): AutoCompleteConfig {
-  const context = createCmkContext(requestSpec) as Context;
-
-  return {
-    ident,
-    value,
-    params: {
-      ...params,
-      context,
-    },
-  };
+export interface AutoCompleteParams {
+  group_id: string;
+  strict: string | boolean;
+  mode: string;
+  presentation: Presentation;
+  context: Context;
+  datasource: string;
+  single_infos: string[];
+  world: string;
+  group_type: string;
 }

src/utils.ts

@@ -15,7 +15,10 @@ export function contextEntryFromNegatableOption(option: NegatableOption, keyName
   return result;
 }
 
-export function createCmkContext(requestSpec: Partial<RequestSpec>): Record<string, unknown> {
+export function createCmkContext(
+  requestSpec: Partial<RequestSpec>,
+  checkmkVersion: 'latest' | '2.1.0' = 'latest'
+): Record<string, unknown> {
   const context: Record<string, unknown> = {};
 
   if (!isUndefined(requestSpec.site)) {
@@ -28,15 +31,34 @@ export function createCmkContext(requestSpec: Partial<RequestSpec>): Record<stri
     context['service'] = { service: requestSpec.service };
   }
   if (!isUndefined(requestSpec.host_labels) && requestSpec.host_labels.length !== 0) {
-    context['host_labels'] = {
-      host_label: JSON.stringify(
-        requestSpec.host_labels.map((v: string) => {
-          return {
-            value: v,
-          };
-        })
-      ),
-    };
+    if (checkmkVersion === 'latest') {
+      const count = requestSpec.host_labels.length;
+      const hl: Record<string, string> = {
+        host_labels_count: '1',
+        host_labels_1_bool: 'and',
+        host_labels_1_vs_count: `${count}`,
+      };
+      for (let i = 1; i < count + 1; i++) {
+        const label = requestSpec.host_labels[i - 1];
+        hl[`host_labels_1_vs_${i}_bool`] = 'and';
+        if (label !== undefined) {
+          hl[`host_labels_1_vs_${i}_vs`] = label;
+        }
+      }
+      context['host_labels'] = hl;
+    } else if (checkmkVersion === '2.1.0') {
+      context['host_labels'] = {
+        host_label: JSON.stringify(
+          requestSpec.host_labels.map((v: string) => {
+            return {
+              value: v,
+            };
+          })
+        ),
+      };
+    } else {
+      throw new Error(`checkmk version ${checkmkVersion} not known`);
+    }
   }
 
   if (!isUndefined(requestSpec.service_in_group) && requestSpec.service_in_group.value !== '') {

tests/unit/webapi.test.ts

@@ -3,6 +3,7 @@ import { Context, Params } from '../../src/types';
 import { createCmkContext } from '../../src/utils';
 import { requestSpecFromLegacy } from '../../src/webapi';
 
+// representation of the query in grafana plugin
 const rs: RequestSpec = {
   aggregation: 'off',
   graph_type: 'single_metric',
@@ -21,18 +22,31 @@ const rs: RequestSpec = {
   service_in_group: { value: 'APT_Updates', negated: true },
 };
 
+// filter query that is sent to checkmk for graph and autocompleters
 const context: Context = {
   host: { host: 'ut_hostname' },
   siteopt: { site: 'ut_site' },
   hostregex: { host_regex: 'ut_host_regex' },
   service: { service: 'Check_MK' },
   serviceregex: { service_regex: 'ut_service_regex' },
-  host_labels: { host_label: '[{"value":"cmk/site:cmk210d"}]' },
+  host_labels: {
+    host_labels_1_bool: 'and',
+    host_labels_1_vs_1_bool: 'and',
+    host_labels_1_vs_1_vs: 'cmk/site:cmk210d',
+    host_labels_1_vs_count: '1',
+    host_labels_count: '1',
+  },
   opthostgroup: { opthost_group: 'Drucker', neg_opthost_group: 'on' },
   optservicegroup: { optservice_group: 'APT_Updates', neg_optservice_group: 'on' },
   host_tags: { host_tag_0_grp: 'criticality', host_tag_0_op: 'is', host_tag_0_val: 'prod' },
 };
 
+// filter query as it was persisted with version < 3.0.0
+const legacy_context: Context = {
+  ...context,
+  host_labels: { host_label: '[{"value":"cmk/site:cmk210d"}]' },
+};
+
 const params: Params = {
   presentation: 'lines',
   graphMode: 'metric',
@@ -55,6 +69,7 @@ const rs_graph: Partial<RequestSpec> = {
   host_in_group: undefined,
 };
 
+// no differences between legacy_context and context for graphs, yet.
 const context_graph: Context = {
   host: { host: 'localhost' },
   service: { service: 'Check_MK' },
@@ -71,9 +86,10 @@ const params_graph: Params = {
 describe('requestspec transformation', () => {
   it('requestspec -> context', () => {
     expect(createCmkContext(rs)).toStrictEqual(context);
+    expect(createCmkContext(rs, '2.1.0')).toStrictEqual(legacy_context);
   });
   it('legacyQuery -> requestspec', () => {
-    expect(requestSpecFromLegacy(context, params)).toStrictEqual(rs);
+    expect(requestSpecFromLegacy(legacy_context, params)).toStrictEqual(rs);
   });
   it('legacyQuery -> requestspec (simple graph)', () => {
     expect(requestSpecFromLegacy(context_graph, params_graph)).toStrictEqual(rs_graph);