Java: `FT.PROFILE` #2473

Yury-Fridlyand · 2024-10-17T21:01:16Z

Issue link

#2428

Checklist

Before submitting the PR make sure the following are checked:

This Pull Request is related to one issue.
Commit message has a detailed description of what changed and why.
Tests are added or updated.
CHANGELOG.md and documentation files are updated.
Destination branch is correct - main or release
Commits will be squashed upon merging.

Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

…t-profile-valkey-424 Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

…t-profile-valkey-424 Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

prateek-kumar-improving · 2024-10-23T17:23:30Z

java/client/src/main/java/glide/api/models/commands/FT/FTProfileOptions.java

+    public FTProfileOptions(
+            @NonNull QueryType queryType, @NonNull GlideString[] commandLine, boolean limited) {
+        this.queryType = queryType;
+        this.query = commandLine;


Why is this called commandLine? It should be query.

Same for all occurrences of the variable in the entire file.

Actually it is a complete command line for aggregate/search except first 2 args

prateek-kumar-improving · 2024-10-23T17:26:32Z

java/client/src/main/java/glide/api/models/commands/FT/FTProfileOptions.java

+     * @param query The query itself.
+     * @param options {@link FT#aggregate} options.
+     */
+    public FTProfileOptions(@NonNull String query, @NonNull FTAggregateOptions options) {


Why do we need to pass FTAggregateOptions? I don't see anything in the documentation about this. In the documentation, the query option is the query string passed into the FT.SEARCH or FT.AGGREGATE.

I think maybe the documentation does not mention this clearly, but it is possible to pass everything after the query field from FT.SEARCH/FT.AGGREGATE to the FT.PROFILE query.

The command accepts all arguments of aggregate/search and does the same action + profiling.

prateek-kumar-improving · 2024-10-23T17:27:17Z

java/client/src/main/java/glide/api/models/commands/FT/FTProfileOptions.java

+     * @param query The query itself.
+     * @param options {@link FT#search} options.
+     */
+    public FTProfileOptions(@NonNull String query, @NonNull FTSearchOptions options) {


Same as above. Why do we need FTSearchOptions?

java/client/src/main/java/glide/api/commands/servermodules/FT.java

Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

acarbonetto · 2024-10-24T19:50:09Z

glide-core/src/client/value_conversion.rs

@@ -1472,6 +1511,14 @@ pub(crate) fn expected_type_for_cmd(cmd: &Cmd) -> Option<ExpectedReturnType> {
        }),
        b"FT.AGGREGATE" => Some(ExpectedReturnType::FTAggregateReturnType),
        b"FT.SEARCH" => Some(ExpectedReturnType::FTSearchReturnType),
+        // TODO replace with tuple
+        b"FT.PROFILE" => Some(ExpectedReturnType::FTProfileReturnType(
+            if cmd.arg_idx(2).is_some_and(|a| a == b"SEARCH") {


interesting solution - good re-use of code

acarbonetto · 2024-10-24T19:55:00Z

java/client/src/main/java/glide/api/models/commands/FT/FTProfileOptions.java

+     * @param queryType The query type.
+     * @param commandLine Command arguments (not including index name).
+     */
+    public FTProfileOptions(@NonNull QueryType queryType, @NonNull GlideString[] commandLine) {


did you consider using a @Builder for options? There are a lot of constructor combinations, and the QueryType could be abstracted behind a method instead of an enum.

This would also make adding a query and options simple, and the command line list could finally be constructor on .build() instead of using these constructors.

Also, where is this array of commandLine/Strings coming from? It's not in the API on either Redis or MemDB.

Shouldn't query be part of the FT.PROFILE method signature (required) and not included in the Options? I was expecting to see something like this for the FT.PROFILE method signatures:

FT.PROFILE(String query, QueryType queryType); FT.PROFILE(String query, QueryType queryType, boolean limited); FT.PROFILE(String query, FTAggregateOptions aggregateOptions); FT.PROFILE(String query, FTAggregateOptions aggregateOptions, boolean limited); FT.PROFILE(String query, FTSearchOptions searchOptions); FT.PROFILE(String query, FTSearchOptions searchOptions, boolean limited);

using a @builder for options

QueryType and commandLine are both mandatory parameters, but QueryType and WhateverOptions are mutually exclusive. We need a smart builder to restrict which combination of parameters are allowed.

It's not in the API

It is, but docs aren't clear. PROFILE accepts the entire command line of AGGREGATE/SEARCH with all options, not just query.

Shouldn't query be part of the FT.SEARCH

I think you considered FT.PROFILE. Yes, it is a good option, but keep in mind gs variant, which duplicates the API. We need to update FT.SEARCH and FT.AGGREGATE to align (and in python too?)

Ok. If you make the commandline constructors private, then only expose the QueryType | AggregateOptions | SearchOptions, I think that would be perfect.
You can do that with a builder, or with constructors.

I can remove them completely. I added this to allow a user to use FT.PROFILE with a CLI command line if it is stored somewhere in notes.

Yury-Fridlyand added the java issues and fixes related to the java client label Oct 17, 2024

Yury-Fridlyand requested a review from a team as a code owner October 17, 2024 21:01

Yury-Fridlyand marked this pull request as draft October 17, 2024 21:01

Yury-Fridlyand temporarily deployed to AWS_ACTIONS October 17, 2024 21:01 — with GitHub Actions Inactive

Yury-Fridlyand mentioned this pull request Oct 17, 2024

Java: VSS commands support #2428

Open

13 tasks

Yury-Fridlyand force-pushed the java/yuryf-ft-profile-valkey-424 branch from 6641d4d to 6b23e6b Compare October 17, 2024 23:18

Yury-Fridlyand marked this pull request as ready for review October 17, 2024 23:19

Yury-Fridlyand temporarily deployed to AWS_ACTIONS October 17, 2024 23:20 — with GitHub Actions Inactive

Yury-Fridlyand had a problem deploying to AWS_ACTIONS October 17, 2024 23:20 — with GitHub Actions Error

FT.PROFILE.

f1e346e

Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

Yury-Fridlyand force-pushed the java/yuryf-ft-profile-valkey-424 branch from 94ae1d3 to f1e346e Compare October 18, 2024 19:13

Yury-Fridlyand temporarily deployed to AWS_ACTIONS October 18, 2024 19:13 — with GitHub Actions Inactive

Yury-Fridlyand had a problem deploying to AWS_ACTIONS October 18, 2024 19:13 — with GitHub Actions Error

Merge remote-tracking branch 'upstream/release-1.2' into java/yuryf-f…

f854924

…t-profile-valkey-424 Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

Yury-Fridlyand had a problem deploying to AWS_ACTIONS October 18, 2024 23:09 — with GitHub Actions Failure

Yury-Fridlyand had a problem deploying to AWS_ACTIONS October 18, 2024 23:09 — with GitHub Actions Error

nonnulll

74a1500

Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

Yury-Fridlyand had a problem deploying to AWS_ACTIONS October 19, 2024 00:59 — with GitHub Actions Error

Yury-Fridlyand added 2 commits October 21, 2024 16:14

Merge remote-tracking branch 'upstream/release-1.2' into java/yuryf-f…

80b50a1

…t-profile-valkey-424 Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

cleanup

127f7f0

Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

Yury-Fridlyand temporarily deployed to AWS_ACTIONS October 21, 2024 23:15 — with GitHub Actions Inactive

Yury-Fridlyand had a problem deploying to AWS_ACTIONS October 21, 2024 23:15 — with GitHub Actions Error

Yury-Fridlyand had a problem deploying to AWS_ACTIONS October 21, 2024 23:53 — with GitHub Actions Error

prateek-kumar-improving reviewed Oct 23, 2024

View reviewed changes

java/client/src/main/java/glide/api/commands/servermodules/FT.java Show resolved Hide resolved

docs

14ee140

Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

Yury-Fridlyand temporarily deployed to AWS_ACTIONS October 24, 2024 16:41 — with GitHub Actions Inactive

Yury-Fridlyand requested a deployment to AWS_ACTIONS October 24, 2024 16:41 — with GitHub Actions Waiting

acarbonetto reviewed Oct 24, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Java: `FT.PROFILE` #2473

Java: `FT.PROFILE` #2473

Yury-Fridlyand commented Oct 17, 2024 •

edited

Loading

prateek-kumar-improving Oct 23, 2024 •

edited

Loading

Yury-Fridlyand Oct 24, 2024

prateek-kumar-improving Oct 23, 2024 •

edited

Loading

Yury-Fridlyand Oct 24, 2024

prateek-kumar-improving Oct 23, 2024 •

edited

Loading

acarbonetto Oct 24, 2024

acarbonetto Oct 24, 2024

acarbonetto Oct 24, 2024 •

edited

Loading

Yury-Fridlyand Oct 24, 2024 •

edited

Loading

acarbonetto Oct 24, 2024

Yury-Fridlyand Oct 24, 2024

Java: FT.PROFILE #2473

Are you sure you want to change the base?

Java: FT.PROFILE #2473

Conversation

Yury-Fridlyand commented Oct 17, 2024 • edited Loading

Issue link

Checklist

prateek-kumar-improving Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

Yury-Fridlyand Oct 24, 2024

Choose a reason for hiding this comment

prateek-kumar-improving Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

Yury-Fridlyand Oct 24, 2024

Choose a reason for hiding this comment

prateek-kumar-improving Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

acarbonetto Oct 24, 2024

Choose a reason for hiding this comment

acarbonetto Oct 24, 2024

Choose a reason for hiding this comment

acarbonetto Oct 24, 2024 • edited Loading

Choose a reason for hiding this comment

Yury-Fridlyand Oct 24, 2024 • edited Loading

Choose a reason for hiding this comment

acarbonetto Oct 24, 2024

Choose a reason for hiding this comment

Yury-Fridlyand Oct 24, 2024

Choose a reason for hiding this comment

Java: `FT.PROFILE` #2473

Java: `FT.PROFILE` #2473

Yury-Fridlyand commented Oct 17, 2024 •

edited

Loading

prateek-kumar-improving Oct 23, 2024 •

edited

Loading

prateek-kumar-improving Oct 23, 2024 •

edited

Loading

prateek-kumar-improving Oct 23, 2024 •

edited

Loading

acarbonetto Oct 24, 2024 •

edited

Loading

Yury-Fridlyand Oct 24, 2024 •

edited

Loading