SOLR-18248 : Migration of Tasks V2 APIs to JAX-RS Constructs by jaykay12 · Pull Request #4452 · apache/solr

jaykay12 · 2026-05-19T20:09:07Z

https://issues.apache.org/jira/browse/SOLR-18248

Description

Migrating 2 out of the 3 V2 APIs of Tasks, from existing homegrown annotations to JAX-RS Standard constructs & annotations

List Tasks API
Task Status API

Solution

Have exposed 1 new interface: ListActiveTasksApi which serves the /lists/task as well as /list/task/<taskId> endpoints.
ListActiveTasks is the main class which takes on the responsibility for v2 path as well as also for the v1 api path via ActiveTasksListHandler
2 new DTO for List Task API
1 new DTO for Task Status API
Removed the now deprecated files: ListActiveTasksAPI & ActiveTasksListComponent from the codebase.

No Coding Agent used.

Tests

Please describe the tests you've developed or run to confirm this patch implements the feature or solves the problem.

Checklist

Please review the following and check all that apply:

I have reviewed the guidelines for How to Contribute and my code conforms to the standards described there to the best of my ability.
I have created a Jira issue and added the issue ID to my pull request title.
I have given Solr maintainers access to contribute to my PR branch. (optional but recommended, not available for branches on forks living under an organisation)
I have developed this patch against the main branch.
I have run ./gradlew check.
I have added tests for my changes.
I have added documentation for the Reference Guide
I have added a changelog entry for my change

epugh · 2026-05-19T21:11:15Z

+
+import static org.apache.solr.client.api.util.Constants.INDEX_PATH_PREFIX;
+
+@Path(INDEX_PATH_PREFIX + "/tasks/listjalaz")


;-) Look slike you have some debugging?

yeah, started with firstly wiring this api to give any random response, & now using this to compare my V2 response with the original V2 response, 😄 thus, kept a different api endpoint for now to do response comparision.

will surely update this during self-review before raising for formal review 💯

epugh

Thanks for getting started on this, I went ahead and put some comments in that may be too early to be added ;-)

epugh · 2026-05-19T21:12:13Z

+  @GET
+  @StoreApiParameters
+  @Operation(
+      summary = "Lists all the currently running tasks or status of any taskUUID being passed as queryParam",


So, I think we would revamp this api... if you look at the desired api, ListActiveTasks would just list all tasks. If you wanted a specfific task, then it would be a idfferent end point with a /taskUUID.

yes, have updated this Api class for now, handling the taskUUID as a path param now, it was queryParam in the V1 as well as homegrown v2.

epugh · 2026-05-19T21:13:04Z

+
+public class ListActiveTaskResponse extends SolrJerseyResponse {
+  @JsonProperty
+  public Map<String, String> taskList;


We are trying to move to more strongly typed responses so taht we don't have Map everywhere. Go ahead and specify out the return properties!

Yes, have done so.

epugh · 2026-05-19T21:17:40Z

+
+  }
+
+  private void handleStandAloneMode(ListActiveTaskResponse response, String taskUUID) {


One thing we are trying to do is move the V1 API logic into the V2 code base, and have the V1 call the V2 version, this way, as these apis evolve, we know that v1 and v2 stay in sync till we get rid of V1. I believe that ideally we would want ActiveTasksListComponent to delegate to the same code as this V2 api. Now, maybe it's so simple that both can just call core getCancellableQueryTracker().getActiveQueriesGenerated. In other V2 apis, you can see the code live in the V2 and then V1 calls it...

understood this part, have made suitable changes.

epugh · 2026-05-19T21:18:23Z

+        log.debug("solr cloud");
+      }
+      handleSolrCloudMode(response, taskUUID);
+    } else {


not quite sure I see the differences in the two paths yet?

yea, i am also checking this up.
I have tested this endpoint by running on cloud example which we have in examples, it worked fine. It should work fine for standalone as well, will remove the current conditional branching done once that's verified.

jaykay12 · 2026-05-19T22:50:58Z

Thanks for getting started on this, I went ahead and put some comments in that may be too early to be added ;-)

thank you so much @epugh for the prompt reviews & initial guidance, much appreciated.

I will keep addressing your comments as we go, I kept this PR as draft for now as per our community guidelines, but yea thanks again for reviewing this at such initial state, so that i can course correct myself promptly. ✨

jaykay12

self review ✅

[pending] to add tests.

jaykay12 added 9 commits May 16, 2026 03:35

initial changes

acccb16

testing

e426014

working api

7b15791

working setup

02c14b9

cleanup

177d2c6

cleanup

95ace8d

logging

7dc167a

minor

1a32bb1

Merge branch 'main' into SOLR-18248-list-tasks

6b6f536

github-actions Bot added cat:search cat:api labels May 19, 2026

jaykay12 changed the title ~~[SOLR-18248] | Migration of ListAllTasks & SingleTaskStatus V2 APIs to JAX-RS Constructs~~ SOLR-18248 : Migration of Tasks V2 APIs to JAX-RS Constructs May 19, 2026

epugh reviewed May 19, 2026

View reviewed changes

jaykay12 added 2 commits May 20, 2026 02:51

response model for 2nd API

d746e21

verifies for solr cloud

df5c428

jaykay12 added 7 commits May 20, 2026 23:51

changes related to pojo & duplicate code removal

354d0f5

removed older interfaces

1cad09d

removing debug

579925d

done

eb1cd97

self review

4e10720

added cl

eb9b51b

tidying done

adc7006

jaykay12 commented May 20, 2026

View reviewed changes

added apache license

996b45b

jaykay12 marked this pull request as ready for review May 20, 2026 22:33

jaykay12 requested a review from epugh May 20, 2026 22:33


		import static org.apache.solr.client.api.util.Constants.INDEX_PATH_PREFIX;

		@Path(INDEX_PATH_PREFIX + "/tasks/listjalaz")


		}

		private void handleStandAloneMode(ListActiveTaskResponse response, String taskUUID) {

Conversation

jaykay12 commented May 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Solution

Tests

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jaykay12 May 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

epugh left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jaykay12 commented May 19, 2026

Uh oh!

jaykay12 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jaykay12 commented May 19, 2026 •

edited

Loading

jaykay12 May 19, 2026 •

edited

Loading