threshold-ui/addons/api/addon/utils/mql-query.js

/**
 * Copyright IBM Corp. 2021, 2026
 * SPDX-License-Identifier: BUSL-1.1
 */

/**
 * Takes a POJO representing a filter query and converts it to an
 * MQL expression string which is understood by the cache daemon.
 *
 * @example
 *   const filter = generateMQLFilterExpression({
 *     name: { logicalOperator: 'and', values: [{ notEquals: 'search text' }, { notEquals: 'test' }] },
 *     scope_id: [{ equals: 'scope1'}, { equals: 'scope2' }],
 *   });
 *
 *   // (name % "search text") and (scope_id = "scope1" or scope_id = "scope2")
 */
export function generateMQLFilterExpression(filterObj) {
  if (!filterObj) {
    return null;
  }

  const expressions = Object.entries(filterObj)
    .map(([key, filterArrayOrObject]) => {
      const filterValueArray = Array.isArray(filterArrayOrObject)
        ? filterArrayOrObject
        : filterArrayOrObject.values;

      let clauses;
      const filterValues = filterValueArray.map((filterObjValue) => {
        if (!filterObjValue) {
          return null;
        }

        const [operation, value] = Object.entries(filterObjValue)[0];

        switch (operation) {
          case 'contains':
            return contains(key, value);
          case 'gt':
            return gt(key, value);
          case 'gte':
            return gte(key, value);
          case 'lt':
            return lt(key, value);
          case 'lte':
            return lte(key, value);
          case 'notEquals':
            return notEquals(key, value);
          default:
            return equals(key, value);
        }
      });

      // Default to `or` if we don't have a logical operator
      const { logicalOperator } = filterArrayOrObject;
      if (logicalOperator === 'and') {
        clauses = and(filterValues);
      } else {
        clauses = or(filterValues);
      }

      return parenthetical(clauses);
    })
    .filter((item) => item);
  return and(expressions);
}

/**
 * Takes a POJO representing a search query and converts it to an
 * MQL expression string which is understood by the cache daemon.
 *
 * @example
 *   const search = generateMQLSearchExpression({
 *     text: 'search',
 *     fields: ['id', 'name', 'description']
 *   });
 *
 *   // (id % 'search' or name % 'search' or description % 'search')
 */
export function generateMQLSearchExpression(searchObj) {
  if (!searchObj) {
    return null;
  }

  const { text, fields } = searchObj;

  return parenthetical(
    or(fields.map((field) => contains(field, text)).filter((item) => item)),
  );
}

/**
 * Generates the MQL expression when a user passes in both search and filters.
 */
export function generateMQLExpression(obj) {
  const { search, filters } = obj;

  const expressions = [
    generateMQLSearchExpression(search),
    generateMQLFilterExpression(filters),
  ].filter((item) => item);

  return and(expressions);
}

const isEmpty = (input) =>
  input === null || input === undefined || input === '';

// Escape any double quotes or backslashes and add quotes if it's a string
const sanitize = (input) =>
  typeof input === 'string' ? `"${input?.replace(/(["\\])/g, '\\$1')}"` : input;

// Comparison Operators
const equals = (key, value) =>
  !isEmpty(value) ? `${key} = ${sanitize(value)}` : null;

const notEquals = (key, value) =>
  !isEmpty(value) ? `${key} != ${sanitize(value)}` : null;

const contains = (key, value) =>
  !isEmpty(value) ? `${key} % ${sanitize(value)}` : null;

const gt = (key, value) =>
  !isEmpty(value) ? `${key} > ${sanitize(value)}` : null;

const gte = (key, value) =>
  !isEmpty(value) ? `${key} >= ${sanitize(value)}` : null;

const lt = (key, value) =>
  !isEmpty(value) ? `${key} < ${sanitize(value)}` : null;

const lte = (key, value) =>
  !isEmpty(value) ? `${key} <= ${sanitize(value)}` : null;

// Logical Operators
const and = (clauses) => clauses.join(' and ');

const or = (clauses) => clauses.join(' or ');

const parenthetical = (expression) => (expression ? `(${expression})` : null);