Fix excludeOperators (prox1 at example) (#1072)

* Fix excludeOperators (prox1 at example) * test * chlog
ukrbublik · Jun 26, 2024 · de2d0c7 · de2d0c7
1 parent 82c56b0
commit de2d0c7
Show file tree

Hide file tree

Showing 6 changed files with 100 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
     Added settings `reverseOperatorsForNot` and `canShortMongoQuery`
   - Scope CSS classes to `.query-builder` (PR #1070) (issue #1018)
   - Update packages (PR #1071)
+  - Fixed issue with `excludeOperators` (affects `prox1` at example) (PR #1072)
 - 6.6.0
   - Optimizations for rendering and export utils (PR #1054) (issue #342)
   - Added support of JsonLogic export for ternary mode (PR #1013) (issue #978)

diff --git a/packages/core/modules/config/index.js b/packages/core/modules/config/index.js
@@ -511,7 +511,7 @@ const operators = {
     formatOp: (field, op, values, valueSrc, valueType, opDef, operatorOptions, isForDisplay) => {
       const val1 = values.first();
       const val2 = values.get(1);
-      const prox = operatorOptions.get("proximity");
+      const prox = operatorOptions?.get("proximity");
       return `${field} ${val1} NEAR/${prox} ${val2}`;
     },
     sqlFormatOp: function (field, op, values, valueSrc, valueType, opDef, operatorOptions, fieldDef) {
@@ -520,7 +520,7 @@ const operators = {
       const val2 = values.get(1);
       const aVal1 = this.utils.SqlString.trim(val1);
       const aVal2 = this.utils.SqlString.trim(val2);
-      const prox = operatorOptions.get("proximity");
+      const prox = operatorOptions?.get("proximity");
       return `CONTAINS(${field}, 'NEAR((${aVal1}, ${aVal2}), ${prox})')`;
     },
     mongoFormatOp: undefined, // not supported

diff --git a/packages/core/modules/utils/configExtend.js b/packages/core/modules/utils/configExtend.js
@@ -258,7 +258,11 @@ function extendFieldConfig(fieldConfig, config, path = [], isFuncArg = false, is
   });
 
   // copy/merge widgets
-  const excludeOperatorsForType = typeConfig.excludeOperators || [];
+  let excludeOperatorsForType = (typeConfig.excludeOperators || []);
+  if (fieldConfig.operators) {
+    // `operators` from field can override `excludeOperators` from type, see `prox1` at examples
+    excludeOperatorsForType = excludeOperatorsForType.filter(op => !fieldConfig.operators.includes(op));
+  }
   if (!fieldConfig.widgets)
     fieldConfig.widgets = {};
   for (let widget in typeConfig.widgets) {

diff --git a/packages/tests/specs/QueryWithProximity.test.js b/packages/tests/specs/QueryWithProximity.test.js
@@ -5,23 +5,50 @@ import { with_qb, export_checks } from "../support/utils";
 
 describe("proximity", () => {
 
-  describe("export", () => {
+  describe("when text type has proximity operator", () => {
     export_checks(configs.with_prox, inits.with_prox, "default", {
       "query": "str \"a\" NEAR/3 \"b\"",
       "queryHuman": "String a NEAR/3 b",
       "sql": "CONTAINS(str, 'NEAR((a, b), 3)')"
     });
+
+    it("change NEAR", async () => {
+      await with_qb(configs.with_prox, inits.with_prox, "default", (qb, {expect_queries}) => {
+        qb
+          .find(".rule .rule--operator-options .rule--operator .operator--options select")
+          .simulate("change", { target: { value: "5" } });
+        expect_queries([
+          "str \"a\" NEAR/3 \"b\"",
+          "str \"a\" NEAR/5 \"b\""
+        ]);
+      });
+    });
   });
 
-  it("change NEAR", async () => {
-    await with_qb(configs.with_prox, inits.with_prox, "default", (qb, {expect_queries}) => {
-      qb
-        .find(".rule .rule--operator-options .rule--operator .operator--options select")
-        .simulate("change", { target: { value: "5" } });
-      expect_queries([
-        "str \"a\" NEAR/3 \"b\"",
-        "str \"a\" NEAR/5 \"b\""
-      ]);
+  describe("when text type has no proximity operator, but prox field has", () => {
+    export_checks(configs.with_prox1, inits.with_prox1, "default", {
+      "query": "prox1 \"a\" NEAR/3 \"b\"",
+      "queryHuman": "Prox1 a NEAR/3 b",
+      "sql": "CONTAINS(prox1, 'NEAR((a, b), 3)')"
+    });
+
+    it("renders widgets correctly", async () => {
+      await with_qb([
+        configs.with_prox1, configs.with_dont_fix_on_load, configs.with_show_error,
+      ], inits.with_prox1_no_values, "default", async (qb) => {
+        expect(qb.find(".rule .rule--value .widget--widget")).to.have.length(2);
+      }, {
+        expectedLoadErrors: [
+          "Prox1 ? NEAR/3 ?  >>  [rhs] Incomplete RHS"
+        ],
+        sanitizeOptions: {
+          // don't fix tree in `load_tree`
+          removeEmptyGroups: false,
+          removeEmptyRules: false,
+          removeIncompleteRules: false,
+        },
+      });
     });
   });
+
 });
diff --git a/packages/tests/support/configs.js b/packages/tests/support/configs.js
@@ -1175,6 +1175,28 @@ export  const with_dropdown = (AntdConfig) => {
   };
 };
 
+export const with_prox1 = (BasicConfig) => ({
+  ...BasicConfig,
+  types: {
+    ...BasicConfig.types,
+    text: {
+      ...BasicConfig.types.text,
+      excludeOperators: ["proximity"]
+    }
+  },
+  fields: {
+    str: {
+      label: "String",
+      type: "text",
+    },
+    prox1: {
+      label: "Prox1",
+      type: "text",
+      operators: ["proximity"],
+    }
+  },
+});
+
 export const with_prox = (BasicConfig) => ({
   ...BasicConfig,
   fields: {

diff --git a/packages/tests/support/inits.js b/packages/tests/support/inits.js
@@ -1203,6 +1203,39 @@ export const with_prox = {
   }
 };
 
+export const with_prox1 = {
+  type: "group",
+  children1: [
+    {
+      type: "rule",
+      properties: {
+        field: "prox1",
+        operator: "proximity",
+        value: [ "a", "b" ],
+        operatorOptions: {
+          proximity: 3
+        }
+      }
+    },
+  ],
+};
+
+export const with_prox1_no_values = {
+  type: "group",
+  children1: [
+    {
+      type: "rule",
+      properties: {
+        field: "prox1",
+        operator: "proximity",
+        operatorOptions: {
+          proximity: 3
+        }
+      }
+    },
+  ],
+};
+
 export const with_jl_value = {
   "==": [
     { "var": "num" },  { "+": [1, 2] }