SOLR-15752: Migrate admin UI to v2 apis by epugh · Pull Request #4659 · apache/solr

epugh · 2026-07-24T12:13:14Z

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

Description

Start using V2 apis in our solr admin. We need to use them "in anger" if we want to build confidence in them, and to help us move away from v1 equivalents.

Solution

Work with Claude to do the updates to our javascript from v1 to v2. We don't have tests, so this is all manually tested.

We use the real generated solrApi client classes CoresApi, CollectionsApi, AliasesApi, ShardsApi, ReplicasApi, ConfigsetsApi, ClusterApi, SystemApi, LoggingApi, SegmentsApi via the *V2 factories in services.js.

We bumped to using the older style v2 without the strongly typed client for Collections (specically CLUSTERSTATUS), Threads, ParamSet.

Tests

Sigh. No JS tests. And not ready to even begin that!

We don't yet have the plumbing appaerntly to push the updates to "all" nodes in the V2 api.

epugh · 2026-07-24T12:19:54Z

Created https://issues.apache.org/jira/browse/SOLR-18318 to track blocker to finishing this.

…put, may not wokr.

…to not have a v2 equivalent.

epugh · 2026-07-24T13:23:47Z

Migrated to V2

Controller	What moved	Notes
cores.js	list/add/unload/rename/swap/reload → `CoresV2`	Full migration
segments.js	get → plain `$resource` on `/api/cores/:core/segments`	No generated client existed; response shape identical to v1
threads.js	get → plain `$resource` on `/api/node/threads`	No generated client (pre-dates OpenAPI v2 framework); same handler as v1 under the hood
index.js	system info → `SystemV2`	Full migration
app.js (MainController)	system info fetch in `resetMenu()`, core-list fetch → `SystemV2`, `CoresV2`	Drives nav/sidebar across the whole app
security.js	system info → `SystemV2`	Ported the 401/403 detection logic to the new callback shape
logging.js	events, levels → `LoggingV2`	`setLevel` stayed on v1 (see below)
collections.js	aliases, create/delete alias, create/delete collection, delete shard, create/delete replica, configsets, live-nodes → `AliasesV2`/`ShardsV2`/`ReplicasV2`/`ConfigSetsV2`/`ClusterV2`; `reloadCollection` was already on `CollectionsV2` before this work started	`Collections.status` (CLUSTERSTATUS) stayed on v1 (see below)
`cloud.js` `System.get({nodes:...})` (Nodes page)	Now dealt with. Full mgiration.

Still on v1 — deliberately, with a documented reason

Where	Why
`logging.js` `setLevel`	v1's `nodes=all` broadcasts the log-level change to every node in the cluster; the v2 `NodeLoggingApis` endpoint is single-node only until SOLR-16738 wires up proxying for it
`collections.js` `Collections.status` (CLUSTERSTATUS)	No v2 endpoint returns the full collections+shards+replicas topology in one call; only per-collection status exists, which would mean N+1 requests. Your call was to leave this on v1
`plugins.js`	Was migrated to `MetricsV2`, then you asked me to back it out — fully reverted to v1 `Metrics.raw`
`cloud.js` (everything else)	`Metrics.get`, `Zookeeper.*` (tree/simple/clusterState/detail) untouched — not in scope of any request so far

…_v2_apis

epugh · 2026-07-29T15:55:46Z

Merging #4661 unblocks the move to V2 for cloud.js.

…_v2_apis

The V2 client callback runs outside Angular's digest cycle, so setting $scope.reloadSuccess/reloadFailure directly (with only the delayed reset wrapped in $timeout) never triggered a re-render -- the ng-class success/warn flash on the Reload button silently never appeared. Wrap the whole callback body in $timeout instead. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

Same digest-cycle issue as cores.js's reloadCore: deleteShard, deleteReplica, addReplica, and reloadCollection set their success/failure/deleted flags outside $timeout, so the ng-class indicators never rendered. Wrap each callback body in $timeout. Also found and fixed a separate bug in reloadCollection while verifying the above: CollectionsApi.reloadCollection requires (collectionName, opts, callback), but the call only passed (collectionName, callback) -- the callback function was landing in the opts slot, so the generated client's `if (callback)` guard silently no-op'd and neither branch ever ran. Confirmed via browser testing that reload requests fired but had zero UI effect until this was fixed. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

janhoy

Impressive work - for a UI that is going away :)

I spot checked some files, and it is exactly what I expected. However, don't have time to go in detail on each conversion or to spin it up for a thorough test in the UI.

So I take the easy way out and ask our friend Copilot to do a thorough code review, perhaps they find some nasty bug or typo for us...

Copilot

Pull request overview

This PR migrates the Solr Admin UI’s AngularJS data-access layer from v1 admin endpoints toward v2 /api endpoints, primarily by introducing v2 OpenAPI client-backed factories and updating controllers to use them.

Changes:

Added v2 (*V2) service factories that wrap generated solrApi clients and updated multiple controllers to call v2 APIs.
Kept a small set of v1 $resource services where v2 equivalents aren’t available/complete yet (e.g., cluster status, threads, paramsets routing nuances, logging setLevel broadcast).
Updated ParamSet consumers to pass an explicit indexType (cores vs collections) required by the v2 config/params routing.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
solr/webapp/web/js/angular/services.js	Introduces multiple `*V2` factories and adjusts remaining v1 `$resource` services for endpoints that still require them.
solr/webapp/web/js/angular/controllers/segments.js	Switches segments page to use `SegmentsV2` client calls.
solr/webapp/web/js/angular/controllers/security.js	Switches system info loading to `SystemV2.getNodeSystemInfo`.
solr/webapp/web/js/angular/controllers/query.js	Adds `indexType` when calling ParamSet APIs.
solr/webapp/web/js/angular/controllers/paramsets.js	Adds `indexType` routing support and basic client-side validation before submit.
solr/webapp/web/js/angular/controllers/logging.js	Migrates log events/levels listing to `LoggingV2` while keeping v1 for broadcast `setLevel`.
solr/webapp/web/js/angular/controllers/index.js	Switches system info dashboard to `SystemV2.getNodeSystemInfo`.
solr/webapp/web/js/angular/controllers/cores.js	Migrates core admin operations to `CoresV2` client calls.
solr/webapp/web/js/angular/controllers/collections.js	Migrates aliases/shards/replicas/configsets/node listing to v2 clients, retaining cluster status via `$resource`.
solr/webapp/web/js/angular/controllers/cloud.js	Switches node system-info loading to `SystemV2.getNodeSystemInfo` for cloud nodes view.
solr/webapp/web/js/angular/app.js	Updates main navigation/menu refresh logic to use v2 clients for cores/collections/aliases/system.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+                  segment.deletedDocSize = Math.floor((segment.delCount / segment.size) * segment.totalSize);
+                  if (segment.delDocSize <= 0.001) delete segment.deletedDocSize;


+    SystemV2.getNodeSystemInfo({"nodes": liveNodesToShow.join(',')}, function (error, data, response) {
+      if (error) {
+        console.error('Failed to fetch node system info:', error);
+        return;
      }
+      $timeout(function() {
+        var systemResponse = response.body;
+        for (var node in systemResponse) {


        if (!$scope.newCore.name) {
          $scope.addMessage = "Please provide a core name";
        } else if (false) { //@todo detect whether core exists
          $scope.AddMessage = "A core with that name already exists";
        } else {


epugh · 2026-08-01T19:40:32Z

Learning more about our OpenAPI JS client.. it uses "superagent" for http, and that doesn't wire into AngularJS existing $http object.. So we lost error handling. However, claude and I have a fix that restores:

…n the same way that v1 used to..

epugh · 2026-08-01T19:43:43Z

Okay, had claude via playwright give this a good testing, and I did a bunch of manual testing. I think it's ready for final review and merging in a few days...

Copilot

Pull request overview

Copilot reviewed 11 out of 12 changed files in this pull request and generated no new comments.

Suppressed comments (12)

solr/webapp/web/js/angular/controllers/cores.js:129

On v2 API errors, this handler sets a local message but skips ApiErrorHandler, so 401/403 won’t trigger the expected login redirect/authz banner. Call ApiErrorHandler.handle(response) when error is present.

              if (error) {
                $scope.renameMessage = "Error renaming core: " + error;
                return;
              }

solr/webapp/web/js/angular/controllers/cores.js:34

This loop uses an implicit global variable (firstCore). Declare it with var to avoid leaking globals and accidental cross-scope reuse.

              for (firstCore in cores) break;

solr/webapp/web/js/angular/app.js:576

This loop uses an implicit global variable (key). Declare it with var to avoid leaking globals and accidental cross-scope reuse.

                  for (key in cdata.collections) {

solr/webapp/web/js/angular/controllers/cores.js:159

On v2 API errors, this handler sets a local message but skips ApiErrorHandler, so 401/403 won’t trigger the expected login redirect/authz banner. Call ApiErrorHandler.handle(response) when error is present.

              if (error) {
                $scope.swapMessage = "Error swapping cores: " + error;
                return;
              }

solr/webapp/web/js/angular/controllers/cores.js:89

On v2 API errors, this handler sets a local message but skips ApiErrorHandler, so 401/403 won’t trigger the expected login redirect/authz banner. Call ApiErrorHandler.handle(response) when error is present.

This issue also appears in the following locations of the same file:

line 126
line 156

              if (error) {
                $scope.addMessage = "Error creating core: " + error;
                return;
              }

solr/webapp/web/js/angular/controllers/cores.js:179

Other CoresV2 methods are called with (core, opts, callback). reloadCore is missing the options argument, so the callback may be treated as opts and never run. Pass an explicit empty options object.

        CoresV2.reloadCore($scope.selectedCore,
          function(error, data, response) {

solr/webapp/web/js/angular/app.js:545

$scope.isSecurityEnabled is derived from $scope.authenticationPlugin, but that variable is never set in this controller; this will keep isSecurityEnabled false even when security is enabled. Derive it from the SystemV2 response instead.

        $scope.isSecurityEnabled = $scope.authenticationPlugin != null;

solr/webapp/web/js/angular/app.js:525

This loop uses an implicit global variable (key). Declare it with var to avoid leaking globals and accidental cross-scope reuse.

This issue also appears on line 576 of the same file.

        for (key in data.status) {

solr/webapp/web/js/angular/controllers/cores.js:71

This sets $scope.AddMessage, but the template shows addMessage; the user won’t see this validation error. Use a consistent casing.

          $scope.AddMessage = "A core with that name already exists";

solr/webapp/web/js/angular/controllers/cores.js:28

This loop uses an implicit global variable (_obj). Declare it with var to avoid leaking globals and accidental cross-scope reuse.

This issue also appears on line 34 of the same file.

            for (_obj in cores) coreCount++;

solr/webapp/web/js/angular/controllers/logging.js:135

This loop uses an implicit global variable (level). Declare it with var to avoid leaking globals and accidental cross-scope reuse.

          for (level in data.levels) {

solr/webapp/web/js/angular/controllers/segments.js:53

The check uses segment.delDocSize (undefined) instead of segment.deletedDocSize, so the delete branch never triggers. Also, deleting deletedDocSize before computing aliveDocSize can yield NaN. Use the correct property and compute aliveDocSize before deleting the display-only field.

                  segment.deletedDocSize = Math.floor((segment.delCount / segment.size) * segment.totalSize);
                  if (segment.delDocSize <= 0.001) delete segment.deletedDocSize;

                  segment.aliveDocSize = segment.totalSize - segment.deletedDocSize;

epugh added 3 commits July 23, 2026 16:44

Migrate Cores and Segments to using V2 APIs

51cc09f

Finalize removing Cores in favour of CoresV2

9ef7050

Migrate Logs to v2 except the setLevel, which is v1.

a29ef2b

We don't yet have the plumbing appaerntly to push the updates to "all" nodes in the V2 api.

github-actions Bot added the admin-ui label Jul 24, 2026

epugh added 3 commits July 24, 2026 09:40

migrate to v2 for threads, plugins. Plugins used a raw prometheus out…

f4f6d1b

…put, may not wokr.

Back out metrics chnages (and plugins.js), they need more investigagion.

194e9c7

Migrate all of Collections to V2, except ClusterStatus which appears …

b206b73

…to not have a v2 equivalent.

epugh added the no-changelog label Jul 24, 2026

epugh added 5 commits July 24, 2026 10:49

Migrate Paramsets to v2

4971a27

Ensure standalone/user-managed still works.

becbe1f

Two lingering bugs in the Admin UI that reviewing htis PR flagged.

be1e11f

More V2 API us for list collections and aliasss.

a8cd6cc

Merge remote-tracking branch 'upstream/main' into migrate_admin_ui_to…

dbc468d

…_v2_apis

epugh added 4 commits July 29, 2026 10:59

Merge remote-tracking branch 'upstream/main' into migrate_admin_ui_to…

bb577dd

…_v2_apis

Finish using SystemV2 throughout now.

88f14b9

Migrate Segments to V2 api.

68c7aae

Merge remote-tracking branch 'upstream/main' into migrate_admin_ui_to…

9cfd2a9

…_v2_apis

epugh marked this pull request as ready for review July 29, 2026 21:52

epugh requested review from gerlowskija and janhoy and removed request for janhoy July 29, 2026 21:53

epugh and others added 2 commits July 29, 2026 18:54

epugh requested a review from janhoy July 30, 2026 13:31

epugh added this to the 10.x milestone Jul 30, 2026

janhoy requested a review from Copilot July 31, 2026 10:15

Copilot started reviewing on behalf of janhoy July 31, 2026 10:16 View session

janhoy reviewed Jul 31, 2026

View reviewed changes

Copilot AI reviewed Jul 31, 2026

View reviewed changes

epugh added 2 commits August 1, 2026 14:25

Bug fix handling paramsets (race condition)

fa2da9b

using playwright mcp for testing

38e6f3a

epugh added 2 commits August 1, 2026 15:41

similar to paramsets, the race condition on picking cloud or not...

4e75449

Make v2 superagent based apis and v1 $http angular both emit errors i…

f2ea643

…n the same way that v1 used to..

epugh requested a review from Copilot August 1, 2026 19:43

Copilot started reviewing on behalf of epugh August 1, 2026 19:43 View session

Copilot AI reviewed Aug 1, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

SOLR-15752: Migrate admin UI to v2 apis - #4659

SOLR-15752: Migrate admin UI to v2 apis#4659
epugh wants to merge 21 commits into
apache:mainfrom
epugh:migrate_admin_ui_to_v2_apis

epugh commented Jul 24, 2026 •

edited

Loading

Uh oh!

epugh commented Jul 24, 2026

Uh oh!

epugh commented Jul 24, 2026 •

edited

Loading

Uh oh!

epugh commented Jul 29, 2026

Uh oh!

janhoy left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

epugh commented Aug 1, 2026

Uh oh!

epugh commented Aug 1, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		segment.deletedDocSize = Math.floor((segment.delCount / segment.size) * segment.totalSize);
		if (segment.delDocSize <= 0.001) delete segment.deletedDocSize;

Uh oh!

Conversation

epugh commented Jul 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Solution

Tests

Uh oh!

epugh commented Jul 24, 2026

Uh oh!

epugh commented Jul 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Still on v1 — deliberately, with a documented reason

Uh oh!

epugh commented Jul 29, 2026

Uh oh!

janhoy left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

epugh commented Aug 1, 2026

Uh oh!

epugh commented Aug 1, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

epugh commented Jul 24, 2026 •

edited

Loading

epugh commented Jul 24, 2026 •

edited

Loading