Skip to content

Add query rule tests to the wikipedia track #627

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
kderusso merged 5 commits into from
Jul 17, 2024
Merged

Add query rule tests to the wikipedia track #627

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
22e232b
Add query rule tests to the wikipedia track
kderusso Jul 3, 2024
9f1ec80
Update rule query to 8.15.0 syntax
kderusso Jul 11, 2024
e6f9480
Merge branch 'master' into kderusso/query-rules
kderusso Jul 12, 2024
2f67724
Add pinned
kderusso Jul 16, 2024
4d6ce1c
Revert back to 8.15 syntax after local testing is completed
kderusso Jul 16, 2024
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
74 changes: 74 additions & 0 deletions wikipedia/challenges/default.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,80 @@
"time-period": {{ application_search_time_period | default(300) | int }},
"warmup-time-period": {{ application_search_warmup_time_period | default(10) | int }}
},
{
"name":"update-query-rules-settings",
"tags": ["setup"],
"operation": {
"operation-type": "raw-request",
"method": "PUT",
"path": "/_cluster/settings",
"body": {
"persistent": {
"xpack.applications.rules.max_rules_per_ruleset" : 1000
}
},
"include-in-reporting": false
}
},
{
"name": "create-query-ruleset-1",
"operation": "create-query-ruleset-1",
"ruleset_id": "ruleset_1",
"ruleset_size": 1
},
{
"name": "create-query-ruleset-10",
"operation": "create-query-ruleset-10",
"ruleset_id": "ruleset_10",
"ruleset_size": 10
},
{
"name": "create-query-ruleset-100",
"operation": "create-query-ruleset-100",
"ruleset_id": "ruleset_100",
"ruleset_size": 100
},
{
"name": "create-query-ruleset-1000",
"operation": "create-query-ruleset-1000",
"ruleset_id": "ruleset_1000",
"ruleset_size": 1000
},
{
"name": "query-rules-search-1",
"operation": "query-rules-search-1",
"clients": {{ application_search_clients | default(20) | int }},
"time-period": {{ application_search_time_period | default(300) | int }},
"warmup-time-period": {{ application_search_warmup_time_period | default(10) | int }}
},
{
"name": "query-rules-search-10",
"operation": "query-rules-search-10",
"clients": {{ application_search_clients | default(20) | int }},
"time-period": {{ application_search_time_period | default(300) | int }},
"warmup-time-period": {{ application_search_warmup_time_period | default(10) | int }}
},
{
"name": "query-rules-search-100",
"operation": "query-rules-search-100",
"clients": {{ application_search_clients | default(20) | int }},
"time-period": {{ application_search_time_period | default(300) | int }},
"warmup-time-period": {{ application_search_warmup_time_period | default(10) | int }}
},
{
"name": "query-rules-search-1000",
"operation": "query-rules-search-1000",
"clients": {{ application_search_clients | default(20) | int }},
"time-period": {{ application_search_time_period | default(300) | int }},
"warmup-time-period": {{ application_search_warmup_time_period | default(10) | int }}
},
{
"name": "pinned-search",
"operation": "pinned-search",
"clients": {{ application_search_clients | default(20) | int }},
"time-period": {{ application_search_time_period | default(300) | int }},
"warmup-time-period": {{ application_search_warmup_time_period | default(10) | int }}
},
{
"parallel": {
"completed-by": "parallel-documents-indexing-query-string-search",
Expand Down
71 changes: 71 additions & 0 deletions wikipedia/operations/default.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,77 @@
"operation-type": "raw-request",
"param-source": "search-application-search-param-source"
},
{
"name": "create-query-ruleset-1",
"operation-type": "raw-request",
"param-source": "create-query-ruleset-param-source",
"include-in-reporting": false,
"ruleset_id": "ruleset_1",
"ruleset_size": 1
},
{
"name": "create-query-ruleset-10",
"operation-type": "raw-request",
"param-source": "create-query-ruleset-param-source",
"include-in-reporting": false,
"ruleset_id": "ruleset_10",
"ruleset_size": 10
},
{
"name": "create-query-ruleset-100",
"operation-type": "raw-request",
"param-source": "create-query-ruleset-param-source",
"include-in-reporting": false,
"ruleset_id": "ruleset_100",
"ruleset_size": 100
},
{
"name": "create-query-ruleset-1000",
"operation-type": "raw-request",
"param-source": "create-query-ruleset-param-source",
"include-in-reporting": false,
"ruleset_id": "ruleset_1000",
"ruleset_size": 1000
},
{
"name": "query-rules-search-1",
"operation-type": "raw-request",
"param-source": "query-rules-search-param-source",
"size" : {{ query_string_search_page_size | default(20) | int }},
"search-fields" : "{{ query_string_search_fields | default("*") }}",
"ruleset_id": "ruleset_1"
},
{
"name": "query-rules-search-10",
"operation-type": "raw-request",
"param-source": "query-rules-search-param-source",
"size" : {{ query_string_search_page_size | default(20) | int }},
"search-fields" : "{{ query_string_search_fields | default("*") }}",
"ruleset_id": "ruleset_10"
},
{
"name": "query-rules-search-100",
"operation-type": "raw-request",
"param-source": "query-rules-search-param-source",
"size" : {{ query_string_search_page_size | default(20) | int }},
"search-fields" : "{{ query_string_search_fields | default("*") }}",
"ruleset_id": "ruleset_100"
},
{
"name": "query-rules-search-1000",
"operation-type": "raw-request",
"param-source": "query-rules-search-param-source",
"size" : {{ query_string_search_page_size | default(20) | int }},
"search-fields" : "{{ query_string_search_fields | default("*") }}",
"ruleset_id": "ruleset_1000"
},
{
"name": "pinned-search",
"operation-type": "raw-request",
"param-source": "pinned-search-param-source",
"size" : {{ query_string_search_page_size | default(20) | int }},
"search-fields" : "{{ query_string_search_fields | default("*") }}"
},
{
"name": "query-string-search",
"operation-type": "search",
Expand Down
88 changes: 88 additions & 0 deletions wikipedia/track.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
QUERIES_FILENAME: str = f"{QUERIES_DIRNAME}/queries.csv"

SEARCH_APPLICATION_ROOT_ENDPOINT: str = "/_application/search_application"
QUERY_RULES_ENDPOINT: str = "/_query_rules"

QUERY_CLEAN_REXEXP = regexp = re.compile("[^0-9a-zA-Z]+")

Expand Down Expand Up @@ -51,6 +52,13 @@ def params(self):
}


class QueryRulesetParams:
def __init__(self, track, params):
self.indices = params.get("indices", track.index_names())
self.ruleset_id = params.get("ruleset_id")
self.ruleset_size = params.get("ruleset_size")


class QueryIteratorParamSource(ParamSource):
def __init__(self, track, params, **kwargs):
super().__init__(track, params, **kwargs)
Expand Down Expand Up @@ -113,7 +121,87 @@ def params(self):
return self.params()


class CreateQueryRulesetParamSource(ParamSource):
def __init__(self, track, params, **kwargs):
super().__init__(track, params, **kwargs)
self.query_ruleset_params = QueryRulesetParams(track, params)

def partition(self, partition_index, total_partitions):
return self

def params(self):
rules = []
for i in range(self.query_ruleset_params.ruleset_size):
# Note: `AccessibleComputing` is one of the _ids indexed in the dataset
rule = {
"rule_id": "rule_{{i}}",
"type": "pinned",
"criteria": [{"type": "exact", "metadata": "rule_key", "values": [random.choice(["match", "no-match"])]}],
"actions": {"ids": [random.choice(["AccessibleComputing", "pinned-miss"])]},
}
rules.append(rule)

return {"method": "PUT", "path": f"{QUERY_RULES_ENDPOINT}/{self.query_ruleset_params.ruleset_id}", "body": {"rules": rules}}


class QueryRulesSearchParamSource(QueryIteratorParamSource):
def __init__(self, track, params, **kwargs):
super().__init__(track, params, **kwargs)
self.query_ruleset_params = QueryRulesetParams(track, params)

def params(self):
try:
query = next(self._queries_iterator)
# TODO Update this to use current syntax with 8.15.0+
return {
"method": "POST",
"path": "/_search",
"body": {
"query": {
"rule": {
Copy link
Member Author

@kderusso kderusso Jul 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: This syntax will only work for versions 8.15.0+ - is there anything else we should do for these challenges?

"match_criteria": {"rule_key": random.choice(["match", "no-match"])},
"ruleset_ids": [self.query_ruleset_params.ruleset_id],
"organic": {"query_string": {"query": query, "default_field": self._params["search-fields"]}},
}
},
"size": self._params["size"],
},
}
except StopIteration:
self._queries_iterator = iter(self._sample_queries)
return self.params()


class PinnedSearchParamSource(QueryIteratorParamSource):
def __init__(self, track, params, **kwargs):
super().__init__(track, params, **kwargs)
self.query_ruleset_params = QueryRulesetParams(track, params)

def params(self):
try:
query = next(self._queries_iterator)
return {
"method": "POST",
"path": "/_search",
"body": {
"query": {
"pinned": {
"organic": {"query_string": {"query": query, "default_field": self._params["search-fields"]}},
"ids": [random.choice(["AccessibleComputing", "pinned-miss"])],
}
},
"size": self._params["size"],
},
}
except StopIteration:
self._queries_iterator = iter(self._sample_queries)
return self.params()


def register(registry):
registry.register_param_source("query-string-search", QueryParamSource)
registry.register_param_source("create-search-application-param-source", CreateSearchApplicationParamSource)
registry.register_param_source("search-application-search-param-source", SearchApplicationSearchParamSource)
registry.register_param_source("create-query-ruleset-param-source", CreateQueryRulesetParamSource)
registry.register_param_source("query-rules-search-param-source", QueryRulesSearchParamSource)
registry.register_param_source("pinned-search-param-source", PinnedSearchParamSource)