Skip to content

SOLR-18109: move SolrPluginUtils debug methods to DebugComponent - #4779

Open
serhiy-bzhezytskyy wants to merge 1 commit into
apache:mainfrom
serhiy-bzhezytskyy:SOLR-18109-move-debug-methods
Open

SOLR-18109: move SolrPluginUtils debug methods to DebugComponent#4779
serhiy-bzhezytskyy wants to merge 1 commit into
apache:mainfrom
serhiy-bzhezytskyy:SOLR-18109-move-debug-methods

Conversation

@serhiy-bzhezytskyy

Copy link
Copy Markdown
Contributor

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

Moves the four deprecated SolrPluginUtils debug methods to DebugComponent -- resolves the file's own TODO: "resolve duplicated code with DebugComponent. Perhaps it should be added to doStandardDebug?" They were @Deprecated // move to DebugComponent since SOLR-17561 but never actually moved.

Per Eric's comments on the ticket, included all four together (doStandardDebug, doStandardQueryDebug, doStandardResultsDebug, doSimpleQuery), not just the first one. Only 3 external call sites: 2 already in DebugComponent itself (now local calls, no prefix needed), 1 in MoreLikeThisHandler (updated, TODO removed). Widened SolrPluginUtils.explanationsToStrings from private to public -- the one cross-package dependency the move needed, since it isn't itself deprecated and stays a general-purpose utility in SolrPluginUtils.

26 tests, 0 failures (DebugComponentTest, DistributedDebugComponentTest, MoreLikeThisHandlerTest, MoreLikeThisComponentTest, SolrPluginUtilsTest).

AI-assisted (Claude Sonnet 5)

…tsDebug/doSimpleQuery to DebugComponent

Resolves the file's own TODO: 'resolve duplicated code with DebugComponent.
Perhaps it should be added to doStandardDebug?' -- these 4 methods were
@deprecated with 'move to DebugComponent' since SOLR-17561, but never moved.
Only 3 external call sites (2 in DebugComponent itself, 1 in
MoreLikeThisHandler). Widened SolrPluginUtils.explanationsToStrings from
private to public -- the only cross-package dependency the move needed,
since it wasn't itself deprecated and stays a general-purpose utility.
@serhiy-bzhezytskyy

Copy link
Copy Markdown
Contributor Author

cc @dsmiley -- you added the // move to DebugComponent note on these four methods (#2524). @epugh flagging since this is the first subtask picked up from SOLR-17931.

@dsmiley dsmiley left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

thanks

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

definitely not changelog worthy

@epugh epugh left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM. One question about the changelog...

@@ -0,0 +1,7 @@
title: Move the deprecated SolrPluginUtils.doStandardDebug, doStandardQueryDebug, doStandardResultsDebug, and doSimpleQuery to DebugComponent, where they now live as public static methods with the same signatures.
type: removed

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

is this really "removed"?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants