feat(query): remove cutoff_frequency (#134)

remove cutoff_frequency, deprecated in es7.3.0, forbidden in es8 From https://www.elastic.co/guide/en/elasticsearch/reference/8.8/migrating-8.0.html The cutoff_frequency parameter has been removed from the match and multi_match query. Details The cutoff_frequency parameter, deprecated in 7.x, has been removed in 8.0 from match and multi_match queries. The same functionality can be achieved without any configuration provided that the total number of hits is not tracked. Impact Discontinue use of the cutoff_frequency parameter. Search requests containing this parameter in a match or multi_match query will return an error. Note in the above "...provided that the total number of hits is not tracked". `track_total_hits` does not appear in the pelias codebases, so we shouldn't have any issues there.
pelias · Apr 18, 2024 · 28a73ba · 28a73ba
1 parent d4d293f
commit 28a73ba
Show file tree

Hide file tree

Showing 14 changed files with 3 additions and 135 deletions.
diff --git a/lib/leaf/match.js b/lib/leaf/match.js
@@ -2,7 +2,6 @@ const optional_params = [
   'boost',
   'operator',
   'analyzer',
-  'cutoff_frequency',
   'fuzziness',
   'max_expansions',
   'prefix_length',

diff --git a/lib/leaf/multi_match.js b/lib/leaf/multi_match.js
@@ -1,12 +1,12 @@
 const MATCH_PARAMS = [
   'tie_breaker', 'analyzer', 'boost', 'operator', 'minimum_should_match', 'fuzziness',
-  'lenient', 'prefix_length', 'max_expansions', 'rewrite', 'zero_terms_query', 'cutoff_frequency'
+  'lenient', 'prefix_length', 'max_expansions', 'rewrite', 'zero_terms_query'
 ];
 const PHRASE_PARAMS = ['analyzer', 'boost', 'lenient', 'slop', 'zero_terms_query'];
 const OPTIONAL_PARAMS = {
   'best_fields': MATCH_PARAMS,
   'most_fields': MATCH_PARAMS,
-  'cross_fields': ['analyzer', 'boost', 'operator', 'minimum_should_match', 'lenient', 'zero_terms_query', 'cutoff_frequency'],
+  'cross_fields': ['analyzer', 'boost', 'operator', 'minimum_should_match', 'lenient', 'zero_terms_query'],
   'phrase': PHRASE_PARAMS,
   'phrase_prefix': PHRASE_PARAMS.concat('max_expansions')
 };
@@ -33,4 +33,4 @@ module.exports = function( type, fields, value, params ) {
   return query;
 };
 
-module.exports.OPTIONAL_PARAMS = OPTIONAL_PARAMS;
+module.exports.OPTIONAL_PARAMS = OPTIONAL_PARAMS;
diff --git a/test/lib/leaf/match.js b/test/lib/leaf/match.js
@@ -49,22 +49,6 @@ module.exports.tests.match = function(test, common) {
     t.end();
   });
 
-  test('match query can handle optional cutoff_frequency parameter', function(t) {
-    const query = match('property', 'value', { cutoff_frequency: 0.01});
-
-    const expected = {
-      match: {
-        property: {
-          query: 'value',
-          cutoff_frequency: 0.01
-        }
-      }
-    };
-
-    t.deepEqual(query, expected, 'valid match query with cutoff_frequency');
-    t.end();
-  });
-
   test('match query can handle optional minimum_should_match parameter', function(t) {
     const query = match('property', 'value', { minimum_should_match: '25%'});
 

diff --git a/test/view/address.js b/test/view/address.js
@@ -34,7 +34,6 @@ module.exports.tests.no_property = function(test, common) {
     vs.var('address::analyzer', 'analyzer value');
     vs.var('address::field', 'field value');
     vs.var('address::boost', 'boost value');
-    vs.var('address::cutoff_frequency', 'cutoff_frequency value');
 
     var undefinedPropertyAddress = require('../../view/address')('');
     var actual = undefinedPropertyAddress(vs);
@@ -50,7 +49,6 @@ module.exports.tests.no_property = function(test, common) {
     vs.var('address:0:analyzer', 'analyzer value');
     vs.var('address:0:field', 'field value');
     vs.var('address:0:boost', 'boost value');
-    vs.var('address:0:cutoff_frequency', 'cutoff_frequency value');
 
     var numericPropertyAddress = require('../../view/address')(0);
     var actual = numericPropertyAddress(vs);
@@ -66,7 +64,6 @@ module.exports.tests.no_property = function(test, common) {
     vs.var('address:false:analyzer', 'analyzer value');
     vs.var('address:false:field', 'field value');
     vs.var('address:false:boost', 'boost value');
-    vs.var('address:false:cutoff_frequency', 'cutoff_frequency value');
 
     var falseyPropertyAddress = require('../../view/address')(false);
     var actual = falseyPropertyAddress(vs);
@@ -100,7 +97,6 @@ module.exports.tests.no_exceptions_conditions = function(test, common) {
     vs.var('address:asdf:analyzer', 'analyzer value');
     vs.var('address:asdf:field', 'field value');
     vs.var('address:asdf:boost', 'boost value');
-    vs.var('address:asdf:cutoff_frequency', 'cutoff_frequency value');
 
     var actual = address(vs);
 
@@ -113,9 +109,6 @@ module.exports.tests.no_exceptions_conditions = function(test, common) {
           boost: {
             $: 'boost value'
           },
-          cutoff_frequency: {
-            $: 'cutoff_frequency value'
-          },
           query: {
             $: 'input value'
           }

diff --git a/test/view/admin.js b/test/view/admin.js
@@ -88,39 +88,6 @@ module.exports.tests.no_exceptions_conditions = function(test, common) {
   });
 };
 
-module.exports.tests.cutoff_frequency = function(test, common) {
-  test('cutoff_frequency value used if provided', function(t) {
-    var vs = getBaseVariableStore();
-
-    vs.var('admin:asdf:cutoff_frequency', 'cutoff_frequency value');
-
-    var actual = admin(vs);
-
-    var expected = {
-      match: {
-        'field value': {
-          analyzer: {
-            $: 'analyzer value'
-          },
-          boost: {
-            $: 'boost value'
-          },
-          cutoff_frequency: {
-            $: 'cutoff_frequency value'
-          },
-          query: {
-            $: 'input value'
-          }
-        }
-      }
-    };
-
-    t.deepEquals(actual, expected, 'should have returned object');
-    t.end();
-
-  });
-};
-
 module.exports.all = function (tape, common) {
   function test(name, testFunction) {
     return tape('admin ' + name, testFunction);

diff --git a/test/view/leaf/match.js b/test/view/leaf/match.js
@@ -32,7 +32,6 @@ module.exports.tests.base_usage = function(test, common) {
     vs.var('match:example2:input', 'input value');
     vs.var('match:example2:field', 'field value');
     vs.var('match:example2:fuzziness', 2);
-    vs.var('match:example2:cutoff_frequency', 0.01);
     vs.var('match:example2:analyzer', 'customAnalyzer');
 
     const view = match('example2')(vs);
@@ -44,7 +43,6 @@ module.exports.tests.base_usage = function(test, common) {
         ['field value']: {
           query: 'input value',
           fuzziness: 2,
-          cutoff_frequency: 0.01,
           analyzer: 'customAnalyzer'
         }
       }

diff --git a/test/view/leaf/multi_match.js b/test/view/leaf/multi_match.js
@@ -30,7 +30,6 @@ module.exports.tests.base_usage = function(test, common) {
     const vs = new VariableStore();
     vs.var('multi_match:example2:input', 'input value');
     vs.var('multi_match:example2:fields', ['fields', 'values']);
-    vs.var('multi_match:example2:cutoff_frequency', 0.001);
     vs.var('multi_match:example2:analyzer', 'customAnalyzer');
 
     const view = multi_match('example2')(vs);
@@ -43,7 +42,6 @@ module.exports.tests.base_usage = function(test, common) {
         fields: ['fields', 'values'],
         query: 'input value',
         analyzer: 'customAnalyzer',
-        cutoff_frequency: 0.001
       }
     };
 
@@ -56,7 +54,6 @@ module.exports.tests.base_usage = function(test, common) {
     vs.var('multi_match:example2:input', 'input value');
     vs.var('multi_match:example2:type', 'phrase');
     vs.var('multi_match:example2:fields', ['fields', 'values']);
-    vs.var('multi_match:example2:cutoff_frequency', 0.001); // this will be ignored because it's a phrase type
     vs.var('multi_match:example2:analyzer', 'customAnalyzer');
     vs.var('multi_match:example2:slop', 3);
 

diff --git a/test/view/ngrams.js b/test/view/ngrams.js
@@ -87,30 +87,6 @@ module.exports.tests.fuzziness_variable = function(test, common) {
   });
 };
 
-module.exports.tests.cutoff_frequency = function(test, common) {
-  test('cutoff_frequency variable should be presented in query', function(t) {
-    var store = getBaseVariableStore();
-    store.var('ngram:cutoff_frequency', 'cutoff_frequency value');
-
-    var actual = ngrams(store);
-
-    var expected = {
-      match: {
-        'field value': {
-          analyzer: { $: 'analyzer value' },
-          boost: { $: 'boost value' },
-          query: { $: 'name value' },
-          cutoff_frequency: { $: 'cutoff_frequency value' }
-        }
-      }
-    };
-
-    t.deepEquals(actual, expected, 'should have returned object with cutoff_frequency field');
-    t.end();
-
-  });
-};
-
 module.exports.tests.minimum_should_match = function(test, common) {
   test('minimum_should_match variable should be presented in query', function(t) {
     var store = getBaseVariableStore();

diff --git a/test/view/phrase.js b/test/view/phrase.js
@@ -92,33 +92,6 @@ module.exports.tests.fuzziness_variable = function(test, common) {
   });
 };
 
-module.exports.tests.cutoff_frequency = function(test, common) {
-  test('cutoff_frequency variable should be presented in query', function(t) {
-    var store = getBaseVariableStore();
-    store.var('phrase:cutoff_frequency', 'cutoff_frequency value');
-
-    var actual = phrase(store);
-
-    var expected = {
-      match: {
-        'field value': {
-          analyzer: { $: 'analyzer value' },
-          type: 'phrase',
-          boost: { $: 'boost value' },
-          slop: { $: 'slop value' },
-          query: { $: 'name value' },
-          cutoff_frequency: { $: 'cutoff_frequency value' }
-        }
-      }
-    };
-
-    t.deepEquals(actual, expected, 'should have returned object with cutoff_frequency field');
-    t.end();
-
-  });
-};
-
-
 module.exports.all = function (tape, common) {
   function test(name, testFunction) {
     return tape('phrase ' + name, testFunction);

diff --git a/view/address.js b/view/address.js
@@ -26,11 +26,6 @@ module.exports = function( property ){
       query: vs.var('input:'+property)
     };
 
-    // optional 'cutoff_frequency' property
-    if( vs.isset('address:'+property+':cutoff_frequency') ){
-      section.cutoff_frequency = vs.var('address:'+property+':cutoff_frequency');
-    }
-
     return view;
   };
 };
diff --git a/view/admin.js b/view/admin.js
@@ -26,11 +26,6 @@ module.exports = function( property ){
       query: vs.var('input:'+property)
     };
 
-    // optional 'cutoff_frequency' property
-    if( vs.isset('admin:'+property+':cutoff_frequency') ){
-      section.cutoff_frequency = vs.var('admin:'+property+':cutoff_frequency');
-    }
-
     return view;
   };
 };
diff --git a/view/leaf/match.js b/view/leaf/match.js
@@ -15,7 +15,6 @@ module.exports = function( prefix ){
     const optional_params = ['boost',
       'operator',
       'analyzer',
-      'cutoff_frequency',
       'fuzziness',
       'max_expansions',
       'prefix_length',

diff --git a/view/ngrams.js b/view/ngrams.js
@@ -23,10 +23,6 @@ module.exports = function( vs ){
     view.match[ vs.var('ngram:field') ].fuzziness = vs.var('ngram:fuzziness');
   }
 
-  if (vs.isset('ngram:cutoff_frequency')) {
-    view.match[ vs.var('ngram:field') ].cutoff_frequency = vs.var('ngram:cutoff_frequency');
-  }
-
   if (vs.isset('ngram:minimum_should_match')) {
     view.match[ vs.var('ngram:field') ].minimum_should_match = vs.var('ngram:minimum_should_match');
   }

diff --git a/view/phrase.js b/view/phrase.js
@@ -26,9 +26,5 @@ module.exports = function( vs ){
     view.match[ vs.var('phrase:field') ].fuzziness = vs.var('phrase:fuzziness');
   }
 
-  if (vs.isset('phrase:cutoff_frequency')) {
-    view.match[ vs.var('phrase:field') ].cutoff_frequency = vs.var('phrase:cutoff_frequency');
-  }
-
   return view;
 };