Skip to content

Open Source alternative to Algolia + Pinecone and an Easier-to-Use alternative to ElasticSearch ⚡ 🔍 ✨ Fast, typo tolerant, in-memory fuzzy Search Engine for building delightful search experiences

Fix geo sorting options + handle space around unit.

Kishore Nallan76460589fa33
diff --git a/src/collection.cpp b/src/collection.cpp
index 5ea4eea8..f1c522d1 100644
--- a/src/collection.cpp
+++ b/src/collection.cpp
@@ -545,23 +545,35 @@ Option<bool> Collection::validate_and_standardize_sort_fields(const std::vector<
return Option<bool>(400, error);
}
- std::vector<std::string> param_value_parts;
- StringUtils::split(param_parts[1], param_value_parts, " ");
+ // param_parts[1] is the value, in either "20km" or "20 km" format
- if(param_value_parts.size() != 2) {
+ if(param_parts[1].size() < 2) {
return Option<bool>(400, error);
}
- if(!StringUtils::is_float(param_value_parts[0])) {
+ std::string unit = param_parts[1].substr(param_parts[1].size()-2, 2);
+
+ if(unit != "km" && unit != "mi") {
+ return Option<bool>(400, "Sort field's parameter unit must be either `km` or `mi`.");
+ }
+
+ std::vector<std::string> dist_values;
+ StringUtils::split(param_parts[1], dist_values, unit);
+
+ if(dist_values.size() != 1) {
+ return Option<bool>(400, error);
+ }
+
+ if(!StringUtils::is_float(dist_values[0])) {
return Option<bool>(400, error);
}
int32_t value_meters;
- if(param_value_parts[1] == "km") {
- value_meters = std::stof(param_value_parts[0]) * 1000;
- } else if(param_value_parts[1] == "mi") {
- value_meters = std::stof(param_value_parts[0]) * 1609.34;
+ if(unit == "km") {
+ value_meters = std::stof(dist_values[0]) * 1000;
+ } else if(unit == "mi") {
+ value_meters = std::stof(dist_values[0]) * 1609.34;
} else {
return Option<bool>(400, "Sort field's parameter "
"unit must be either `km` or `mi`.");
diff --git a/src/collection_manager.cpp b/src/collection_manager.cpp
index 00be89f1..0b3739d2 100644
--- a/src/collection_manager.cpp
+++ b/src/collection_manager.cpp
@@ -496,15 +496,28 @@ bool CollectionManager::parse_sort_by_str(std::string sort_by_str, std::vector<s
sort_field_expr += sort_by_str[i];
}
- std::vector<std::string> expression_parts;
- StringUtils::split(sort_field_expr, expression_parts, ":");
+ int colon_index = sort_field_expr.size()-1;
- if(expression_parts.size() != 2) {
+ while(colon_index >= 0) {
+ if(sort_field_expr[colon_index] == ':') {
+ break;
+ }
+
+ colon_index--;
+ }
+
+ if(colon_index < 0 || colon_index+1 == sort_field_expr.size()) {
return false;
}
- StringUtils::toupper(expression_parts[1]);
- sort_fields.emplace_back(expression_parts[0], expression_parts[1]);
+ std::string order_str = sort_field_expr.substr(colon_index+1, sort_field_expr.size()-colon_index+1);
+ StringUtils::trim(order_str);
+ StringUtils::toupper(order_str);
+
+ std::string field_name = sort_field_expr.substr(0, colon_index);
+ StringUtils::trim(field_name);
+
+ sort_fields.emplace_back(field_name, order_str);
sort_field_expr = "";
} else {
sort_field_expr += sort_by_str[i];
diff --git a/src/field.cpp b/src/field.cpp
index de599949..ff7a7df9 100644
--- a/src/field.cpp
+++ b/src/field.cpp
@@ -16,7 +16,7 @@ Option<bool> filter::parse_geopoint_filter_value(std::string& raw_value,
auto raw_val_without_paran = raw_value.substr(1, raw_value.size() - 2);
StringUtils::split(raw_val_without_paran, filter_values, ",");
- // we will end up with: "10.45 34.56 2 km" or a geo polygon
+ // we will end up with: "10.45 34.56 2 km" or "10.45 34.56 2mi" or a geo polygon
if(filter_values.size() < 3) {
return Option<bool>(400, format_err_msg);
@@ -43,19 +43,30 @@ Option<bool> filter::parse_geopoint_filter_value(std::string& raw_value,
processed_filter_val = raw_val_without_paran;
} else {
// point + radius
+ // filter_values[2] is distance, get the unit, validate it and split on that
+ if(filter_values[2].size() < 2) {
+ return Option<bool>(400, "Unit must be either `km` or `mi`.");
+ }
+
+ std::string unit = filter_values[2].substr(filter_values[2].size()-2, 2);
+
+ if(unit != "km" && unit != "mi") {
+ return Option<bool>(400, "Unit must be either `km` or `mi`.");
+ }
+
std::vector<std::string> dist_values;
- StringUtils::split(filter_values[2], dist_values, " ");
+ StringUtils::split(filter_values[2], dist_values, unit);
- if(dist_values.size() != 2) {
+ if(dist_values.size() != 1) {
return Option<bool>(400, format_err_msg);
}
- if(dist_values[1] != "km" && dist_values[1] != "mi") {
- return Option<bool>(400, "Unit must be either `km` or `mi`.");
+ if(!StringUtils::is_float(dist_values[0])) {
+ return Option<bool>(400, format_err_msg);
}
processed_filter_val = filter_values[0] + ", " + filter_values[1] + ", " + // co-ords
- dist_values[0] + ", " + dist_values[1]; // X km
+ dist_values[0] + ", " + unit; // X km
}
return Option<bool>(true);
diff --git a/src/index.cpp b/src/index.cpp
index db589f3a..f7de9758 100644
--- a/src/index.cpp
+++ b/src/index.cpp
@@ -1367,7 +1367,7 @@ void Index::do_filtering(uint32_t*& filter_ids, uint32_t& filter_ids_length,
std::vector<uint32_t> geo_result_ids;
std::vector<std::string> filter_value_parts;
- StringUtils::split(filter_value, filter_value_parts, ","); // x, y, 2 km (or) list of points
+ StringUtils::split(filter_value, filter_value_parts, ","); // x, y, 2, km (or) list of points
bool is_polygon = StringUtils::is_float(filter_value_parts.back());
S2Region* query_region;
diff --git a/test/collection_filtering_test.cpp b/test/collection_filtering_test.cpp
index 2d3d8879..cfe454a5 100644
--- a/test/collection_filtering_test.cpp
+++ b/test/collection_filtering_test.cpp
@@ -1051,6 +1051,16 @@ TEST_F(CollectionFilteringTest, GeoPointFiltering) {
ASSERT_FALSE(add_op.ok());
ASSERT_EQ("Field `loc` must be a 2 element array: [lat, lng].", add_op.error());
+ bad_doc["loc"] = "loc: (48.910544830985785, 2.337218333651177, 2k)";
+ add_op = coll1->add(bad_doc.dump(), CREATE, "", DIRTY_VALUES::REJECT);
+ ASSERT_FALSE(add_op.ok());
+ ASSERT_EQ("Field `loc` must be a 2 element array: [lat, lng].", add_op.error());
+
+ bad_doc["loc"] = "loc: (48.910544830985785, 2.337218333651177, 2)";
+ add_op = coll1->add(bad_doc.dump(), CREATE, "", DIRTY_VALUES::REJECT);
+ ASSERT_FALSE(add_op.ok());
+ ASSERT_EQ("Field `loc` must be a 2 element array: [lat, lng].", add_op.error());
+
bad_doc["loc"] = {"foo", "bar"};
add_op = coll1->add(bad_doc.dump(), CREATE, "", DIRTY_VALUES::COERCE_OR_REJECT);
ASSERT_FALSE(add_op.ok());
@@ -1134,7 +1144,7 @@ TEST_F(CollectionFilteringTest, GeoPointArrayFiltering) {
// pick a location close to Chennai
auto results = coll1->search("*",
- {}, "loc: (13.12631, 80.20252, 100 km)",
+ {}, "loc: (13.12631, 80.20252, 100km)",
{}, {}, {0}, 10, 1, FREQUENCY).get();
ASSERT_EQ(2, results["found"].get<size_t>());
@@ -1161,7 +1171,7 @@ TEST_F(CollectionFilteringTest, GeoPointArrayFiltering) {
// 1 mile radius
results = coll1->search("*",
- {}, "loc: (12.98941, 80.23073, 1 mi)",
+ {}, "loc: (12.98941, 80.23073, 1mi)",
{}, {}, {0}, 10, 1, FREQUENCY).get();
ASSERT_EQ(1, results["found"].get<size_t>());
diff --git a/test/collection_manager_test.cpp b/test/collection_manager_test.cpp
index 01f5d4d6..26cfe464 100644
--- a/test/collection_manager_test.cpp
+++ b/test/collection_manager_test.cpp
@@ -617,7 +617,7 @@ TEST_F(CollectionManagerTest, ParseSortByClause) {
sort_fields.clear();
- sort_by_parsed = CollectionManager::parse_sort_by_str(" loc(24.56,10.45):ASC, points:desc ", sort_fields);
+ sort_by_parsed = CollectionManager::parse_sort_by_str(" loc(24.56,10.45):ASC, points: desc ", sort_fields);
ASSERT_TRUE(sort_by_parsed);
ASSERT_STREQ("loc(24.56,10.45)", sort_fields[0].name.c_str());
@@ -626,11 +626,31 @@ TEST_F(CollectionManagerTest, ParseSortByClause) {
ASSERT_STREQ("points", sort_fields[1].name.c_str());
ASSERT_STREQ("DESC", sort_fields[1].order.c_str());
+ sort_fields.clear();
+ sort_by_parsed = CollectionManager::parse_sort_by_str(" location(48.853, 2.344, exclude_radius: 2mi):asc,popularity:desc", sort_fields);
+ ASSERT_TRUE(sort_by_parsed);
+ ASSERT_EQ("location(48.853, 2.344, exclude_radius: 2mi)", sort_fields[0].name);
+ ASSERT_STREQ("ASC", sort_fields[0].order.c_str());
+
+ sort_fields.clear();
+ sort_by_parsed = CollectionManager::parse_sort_by_str(" _text_match(buckets: 10):ASC, points:desc ", sort_fields);
+ ASSERT_TRUE(sort_by_parsed);
+ ASSERT_EQ("_text_match(buckets: 10)", sort_fields[0].name);
+ ASSERT_EQ("ASC", sort_fields[0].order);
+
sort_fields.clear();
sort_by_parsed = CollectionManager::parse_sort_by_str("", sort_fields);
ASSERT_TRUE(sort_by_parsed);
ASSERT_EQ(0, sort_fields.size());
+ sort_fields.clear();
+ sort_by_parsed = CollectionManager::parse_sort_by_str("foobar:", sort_fields);
+ ASSERT_FALSE(sort_by_parsed);
+
+ sort_fields.clear();
+ sort_by_parsed = CollectionManager::parse_sort_by_str("foobar:,bar:desc", sort_fields);
+ ASSERT_FALSE(sort_by_parsed);
+
sort_fields.clear();
sort_by_parsed = CollectionManager::parse_sort_by_str(",", sort_fields);
ASSERT_FALSE(sort_by_parsed);
@@ -638,5 +658,4 @@ TEST_F(CollectionManagerTest, ParseSortByClause) {
sort_fields.clear();
sort_by_parsed = CollectionManager::parse_sort_by_str(",,", sort_fields);
ASSERT_FALSE(sort_by_parsed);
-
-}
\ No newline at end of file
+}
diff --git a/test/collection_sorting_test.cpp b/test/collection_sorting_test.cpp
index b50aebfa..2b1e179d 100644
--- a/test/collection_sorting_test.cpp
+++ b/test/collection_sorting_test.cpp
@@ -608,7 +608,7 @@ TEST_F(CollectionSortingTest, GeoPointSorting) {
};
auto results = coll1->search("*",
- {}, "loc: (48.84442912268208, 2.3490714964332353, 20 km)",
+ {}, "loc: (48.84442912268208, 2.3490714964332353, 20km)",
{}, geo_sort_fields, {0}, 10, 1, FREQUENCY).get();
ASSERT_EQ(10, results["found"].get<size_t>());
@@ -739,7 +739,7 @@ TEST_F(CollectionSortingTest, GeoPointSortingWithExcludeRadius) {
}
std::vector<sort_by> geo_sort_fields = {
- sort_by("loc(32.24348, 77.1893, exclude_radius: 1 km)", "ASC"),
+ sort_by("loc(32.24348, 77.1893, exclude_radius: 1km)", "ASC"),
sort_by("points", "DESC"),
};
@@ -801,6 +801,25 @@ TEST_F(CollectionSortingTest, GeoPointSortingWithExcludeRadius) {
ASSERT_FALSE(res_op.ok());
ASSERT_EQ("Sort field's parameter must be a positive number.", res_op.error());
+ geo_sort_fields = { sort_by("loc(32.24348, 77.1893, exclude_radius: 10 km 20 mi)", "ASC") };
+ res_op = coll1->search("*", {}, "loc: (32.24348, 77.1893, 20 km)",
+ {}, geo_sort_fields, {0}, 10, 1, FREQUENCY);
+
+ ASSERT_FALSE(res_op.ok());
+ ASSERT_EQ("Bad syntax for geopoint sorting field `loc`", res_op.error());
+
+ geo_sort_fields = { sort_by("loc(32.24348, 77.1893, exclude_radius: 1k)", "ASC") };
+ res_op = coll1->search("*", {}, "loc: (32.24348, 77.1893, 20 km)",
+ {}, geo_sort_fields, {0}, 10, 1, FREQUENCY);
+ ASSERT_FALSE(res_op.ok());
+ ASSERT_EQ("Sort field's parameter unit must be either `km` or `mi`.", res_op.error());
+
+ geo_sort_fields = { sort_by("loc(32.24348, 77.1893, exclude_radius: 5)", "ASC") };
+ res_op = coll1->search("*", {}, "loc: (32.24348, 77.1893, 20 km)",
+ {}, geo_sort_fields, {0}, 10, 1, FREQUENCY);
+ ASSERT_FALSE(res_op.ok());
+ ASSERT_EQ("Bad syntax for geopoint sorting field `loc`", res_op.error());
+
collectionManager.drop_collection("coll1");
}