Skip to content

feat(search_family): Ignore unsupported options in the FT.CREATE command #5188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BagritsevichStepan merged 2 commits into from
May 27, 2025
Merged

feat(search_family): Ignore unsupported options in the FT.CREATE command #5188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c6555ca
feat(search_family): Ignore unsupported options in the FT.CREATE command
May 27, 2025
3f41a9a
refactor: address comments
May 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions src/server/search/search_family.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,6 @@ bool SendErrorIfOccurred(const ParseResult<T>& result, CmdArgParser* parser,
return false;
}

static const set<string_view> kIgnoredOptions = {"WEIGHT", "SEPARATOR"};

bool IsValidJsonPath(string_view path) {
error_code ec;
MakeJsonPathExpr(path, ec);
Expand Down Expand Up @@ -191,6 +189,11 @@ ParseResult<bool> ParseStopwords(CmdArgParser* parser, DocIndex* index) {
return true;
}

constexpr std::array<const std::string_view, 6> kIgnoredOptions = {
"UNF"sv, "NOSTEM"sv, "CASESENSITIVE"sv, "WITHSUFFIXTRIE"sv, "INDEXMISSING"sv, "INDEXEMPTY"sv};
constexpr std::array<const std::string_view, 3> kIgnoredOptionsWithArg = {"WEIGHT"sv, "SEPARATOR"sv,
"PHONETIC"sv};

// SCHEMA field [AS alias] type [flags...]
ParseResult<bool> ParseSchema(CmdArgParser* parser, DocIndex* index) {
auto& schema = index->schema;
Expand Down Expand Up @@ -237,16 +240,28 @@ ParseResult<bool> ParseSchema(CmdArgParser* parser, DocIndex* index) {
auto flag = parser->TryMapNext("NOINDEX", search::SchemaField::NOINDEX, "SORTABLE",
search::SchemaField::SORTABLE);
if (!flag) {
std::string_view option = parser->Peek();
if (std::find(kIgnoredOptions.begin(), kIgnoredOptions.end(), option) !=
kIgnoredOptions.end()) {
LOG_IF(WARNING, option != "INDEXMISSING"sv && option != "INDEXEMPTY"sv)
<< "Ignoring unsupported field option in FT.CREATE: " << option;
// Ignore these options
parser->Skip(1);
continue;
}
if (std::find(kIgnoredOptionsWithArg.begin(), kIgnoredOptionsWithArg.end(), option) !=
kIgnoredOptionsWithArg.end()) {
LOG(WARNING) << "Ignoring unsupported field option in FT.CREATE: " << option;
// Ignore these options with argument
parser->Skip(2);
continue;
}
break;
}

flags |= *flag;
}

// Skip all trailing ignored parameters
while (kIgnoredOptions.count(parser->Peek()) > 0)
parser->Skip(2);

schema.fields[field] = {field_type, flags, string{field_alias}, params};
schema.field_names[field_alias] = field;
}
Expand Down
34 changes: 34 additions & 0 deletions src/server/search/search_family_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2767,4 +2767,38 @@ TEST_F(SearchFamilyTest, JsonSetIndexesBug) {
resp = Run({"FT.AGGREGATE", "index", "*", "GROUPBY", "1", "@text"});
EXPECT_THAT(resp, IsUnordArrayWithSize(IsMap("text", "some text")));
}

TEST_F(SearchFamilyTest, IgnoredOptionsInFtCreate) {
Run({"HSET", "doc:1", "title", "Test Document"});

// Create an index with various options, some of which should be ignored
// INDEXMISSING and INDEXEMPTY are supported by default
auto resp = Run({"FT.CREATE",
"idx",
"ON",
"HASH",
"SCHEMA",
"title",
"TEXT",
"UNF",
"NOSTEM",
"CASESENSITIVE",
"WITHSUFFIXTRIE",
"INDEXMISSING",
"INDEXEMPTY",
"WEIGHT",
"1",
"SEPARATOR",
"|",
"PHONETIC",
"dm:en",
"SORTABLE"});

// Check that the response is OK, indicating the index was created successfully
EXPECT_THAT(resp, "OK");

// Verify that the index was created correctly
resp = Run({"FT.SEARCH", "idx", "*"});
EXPECT_THAT(resp, AreDocIds("doc:1"));
}
} // namespace dfly
Loading