Add Create or update query rule API call #109042

kderusso · 2024-05-24T20:09:24Z

Adds a new API call to create or update an individual query rule within a ruleset. If this call is made against a nonexistent ruleset the ruleset will be created.

Adds the ability to specify a priority of a query rule, which indicates the order in which it is inserted into an existing ruleset and subsequently processed.

Coming in followup PRs:

GET, DELETE API calls
More thorough yaml testing that requires GET and DELETE API calls
Documentation

Example API call:

PUT /_query_rules/test-ruleset/query-rule-id
{
  "type": "pinned",
  "priority": 4,
  "criteria": [
    {
      "type": "exact",
      "metadata": "query_string",
      "values": [
        "search"
      ]
    }
  ],
  "actions": {
    "ids": [
      "doc1",
      "doc4"
    ]
  }
}

…sting rulesets by priority

kderusso · 2024-05-28T18:54:59Z

.../qa/rest/src/yamlRestTest/resources/rest-api-spec/test/entsearch/rules/50_query_rule_put.yml

@@ -0,0 +1,114 @@
+setup:


Note: There's not a lot of validation here. These will be fleshed out more in a followup PR when the GET and DELETE endpoints are implemented.

elasticsearchmachine · 2024-05-28T19:08:07Z

Pinging @elastic/search-relevance (Team:Search - Relevance)

elasticsearchmachine · 2024-05-28T19:08:08Z

Pinging @elastic/ent-search-eng (Team:SearchOrg)

elasticsearchmachine · 2024-05-28T19:08:09Z

Hi @kderusso, I've created a changelog YAML for you.

.../qa/rest/src/yamlRestTest/resources/rest-api-spec/test/entsearch/rules/50_query_rule_put.yml

...lugin/ent-search/src/test/java/org/elasticsearch/xpack/application/rules/QueryRuleTests.java

.../qa/rest/src/yamlRestTest/resources/rest-api-spec/test/entsearch/rules/50_query_rule_put.yml

Mikep86

Partial review, will finish up tomorrow :)

x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/rules/QueryRule.java

Mikep86

Got a bit farther this morning, looking good!

...ch/src/main/java/org/elasticsearch/xpack/application/rules/action/PutQueryRulesetAction.java

...earch/src/test/java/org/elasticsearch/xpack/application/EnterpriseSearchModuleTestUtils.java

...rch/src/test/java/org/elasticsearch/xpack/application/rules/QueryRulesIndexServiceTests.java

This reverts commit 66d6171.

Mikep86

Nice work!

...rch/src/test/java/org/elasticsearch/xpack/application/rules/QueryRulesIndexServiceTests.java

.../test/java/org/elasticsearch/xpack/application/rules/action/RestPutQueryRuleActionTests.java

.../qa/rest/src/yamlRestTest/resources/rest-api-spec/test/entsearch/rules/50_query_rule_put.yml

Mikep86

LGTM, thanks for the iterations!

Mikep86 · 2024-06-07T13:11:51Z

.../main/java/org/elasticsearch/xpack/application/rules/action/TransportPutQueryRuleAction.java

@@ -43,7 +43,7 @@ public TransportPutQueryRuleAction(
    protected void doExecute(Task task, PutQueryRuleAction.Request request, ActionListener<PutQueryRuleAction.Response> listener) {
        String queryRulesetId = request.queryRulesetId();
        QueryRule queryRule = request.queryRule();
-        systemIndexService.putQueryRule(queryRulesetId, queryRule, listener.map(r -> new PutQueryRuleAction.Response(r.getResult())));
+        systemIndexService.putQueryRule(queryRulesetId, queryRule, ActionListener.wrap(listener::onResponse, listener::onFailure));


Dumb question: how is this different than passing listener directly?

I had to do this because we're modifying the response from a DocWriteResponse to PutQueryRuleAction.Response but it's basically just wrapping it so we can change it to created for rulesets with new rules.

PS there is no such thing as a dumb question 😛

kderusso added 3 commits May 23, 2024 15:40

Add API call to put an individual query rule at the end of a ruleset

85a39f9

Add priority to the query rule index, and merge rule updates into exi…

a3f1fae

…sting rulesets by priority

Add yaml test

44e46d2

elasticsearchmachine added the v8.15.0 label May 24, 2024

kderusso commented May 28, 2024

View reviewed changes

Don't require double specification of rule_id

ddbad4a

kderusso force-pushed the kderusso/put-query-rule-api-call branch from 66b9b79 to ddbad4a Compare May 28, 2024 18:59

kderusso changed the title ~~WIP: Create or update query rule API call~~ Add Create or update query rule API call May 28, 2024

Merge from main

152367a

kderusso marked this pull request as ready for review May 28, 2024 19:04

kderusso requested a review from a team as a code owner May 28, 2024 19:04

kderusso requested a review from a team May 28, 2024 19:04

elasticsearchmachine added the needs:triage Requires assignment of a team area label label May 28, 2024

kderusso added >enhancement :SearchOrg/Relevance Label for the Search (solution/org) Relevance team and removed needs:triage Requires assignment of a team area label labels May 28, 2024

Update docs/changelog/109042.yaml

111ceb4

kderusso added 2 commits May 28, 2024 15:13

Fix autogenerated changelog error

ec9ddbc

Fix broken test

e049c46

ioanatia reviewed May 29, 2024

View reviewed changes

Mikep86 self-requested a review May 29, 2024 17:26

PR feedback on tests

d3324ef

kderusso requested a review from ioanatia May 29, 2024 18:45

kderusso commented May 29, 2024

View reviewed changes

.../qa/rest/src/yamlRestTest/resources/rest-api-spec/test/entsearch/rules/50_query_rule_put.yml Show resolved Hide resolved

Mikep86 reviewed May 29, 2024

View reviewed changes

Remove DEFAULT_PRIORITY in favor of null

5940d75

Mikep86 reviewed May 30, 2024

View reviewed changes

kderusso added 3 commits May 30, 2024 11:35

PR feedback on tests

f1ba755

Revert whitespace changes to stats doc

66d6171

Revert "Revert whitespace changes to stats doc"

5105245

This reverts commit 66d6171.

Mikep86 reviewed May 30, 2024

View reviewed changes

kderusso added 2 commits May 30, 2024 14:24

Return created when a rule is created in an existing ruleset

36f2793

Remove AtomicReference

5e87ecc

Mikep86 approved these changes Jun 7, 2024

View reviewed changes

Merge branch 'main' into kderusso/put-query-rule-api-call

5167179

kderusso merged commit ec0b573 into elastic:main Jun 10, 2024
15 checks passed

kderusso mentioned this pull request Jun 21, 2024

[Query Rules] Update Query Rules API for 8.15 elastic/elasticsearch-specification#2639

Merged

kderusso deleted the kderusso/put-query-rule-api-call branch July 8, 2024 17:25

Add Create or update query rule API call #109042

Add Create or update query rule API call #109042

Uh oh!

Conversation

kderusso commented May 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kderusso May 28, 2024

Choose a reason for hiding this comment

Uh oh!

elasticsearchmachine commented May 28, 2024

Uh oh!

elasticsearchmachine commented May 28, 2024

Uh oh!

elasticsearchmachine commented May 28, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Mikep86 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Mikep86 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Mikep86 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Mikep86 left a comment

Choose a reason for hiding this comment

Uh oh!

Mikep86 Jun 7, 2024

Choose a reason for hiding this comment

Uh oh!

kderusso Jun 10, 2024

Choose a reason for hiding this comment

Uh oh!

kderusso Jun 10, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kderusso commented May 24, 2024 •

edited

Loading