Tighten SolrQueryResponse.getResponseHeader/addResponseHeader to SimpleOrderedMap by serhiy-bzhezytskyy · Pull Request #4809 · apache/solr

serhiy-bzhezytskyy · 2026-08-25T09:31:48Z

Follow-up to @dsmiley's suggestion on #4761 (review thread on QueryComponent.java): rather than keep the remove()+add() workaround needed there because getResponseHeader()'s declared return type (NamedList<Object>) doesn't have a put(), this tightens the declared type to what it always actually is at runtime -- SimpleOrderedMap<Object> -- removing the internal unchecked cast and letting the 4 call sites in QueryComponent/CombinedQueryComponent use put() directly.

This also closes the actual hole that caused #4761's ClassCastException: MockResponseBuilder's mock was stubbing getResponseHeader() to return a bare NamedList, which the contract allowed but reality never produced. With the tightened return type, that mismatch is now a compile error instead of a runtime ClassCastException.

Compatibility note: this is binary-incompatible for any external caller compiled against the old NamedList signature -- verified locally (compiled a caller against the old class files, ran it against the new ones without recompiling): NoSuchMethodError on both getResponseHeader() and addResponseHeader(NamedList). SolrQueryResponse is @since solr 0.9 public API with no experimental/internal marker, so flagging this explicitly rather than treating it as a purely internal cleanup -- your call whether that's acceptable for 11.0.

AI-assisted (Claude Sonnet 5)

…leOrderedMap getResponseHeader() always returned an actual SimpleOrderedMap internally, masked by an unchecked cast; declaring the real type removes the cast and lets 4 call sites in QueryComponent/CombinedQueryComponent use put() instead of asShallowMap().put()/remove()+add(). It also turns the exact class of bug hit in SOLR-18373 (a test mock returning a plain NamedList, causing a runtime ClassCastException) into a compile error instead. Binary-incompatible for external callers compiled against the old NamedList signature (verified: NoSuchMethodError). Flagging for review since this is long-standing public API, not something marked experimental/internal.

dsmiley

For Solr 11. The binary incompatibility break for a prolific API like this wouldn't be nice for Solr plugin writers.

epugh · 2026-08-25T20:51:31Z

@serhiy-bzhezytskyy can you add a changelog since this is a binary incompatbility?

serhiy-bzhezytskyy · 2026-08-26T06:02:35Z

Added — see changelog/unreleased/SOLR-solrqueryresponse-return-types.yml.

Resolved in QueryComponent and CombinedQueryComponent: kept the direct SimpleOrderedMap.put() calls and dropped updateResponseHeader, whose only purpose was to cast around getResponseHeader()'s old NamedList return type.

serhiy-bzhezytskyy · 2026-08-25T09:31:48Z

Follow-up to @dsmiley's suggestion on #4761 (review thread on QueryComponent.java): rather than keep the remove()+add() workaround needed there because getResponseHeader()'s declared return type (NamedList<Object>) doesn't have a put(), this tightens the declared type to what it always actually is at runtime -- SimpleOrderedMap<Object> -- removing the internal unchecked cast and letting the 4 call sites in QueryComponent/CombinedQueryComponent use put() directly.

This also closes the actual hole that caused #4761's ClassCastException: MockResponseBuilder's mock was stubbing getResponseHeader() to return a bare NamedList, which the contract allowed but reality never produced. With the tightened return type, that mismatch is now a compile error instead of a runtime ClassCastException.

Compatibility note: this is binary-incompatible for any external caller compiled against the old NamedList signature -- verified locally (compiled a caller against the old class files, ran it against the new ones without recompiling): NoSuchMethodError on both getResponseHeader() and addResponseHeader(NamedList). SolrQueryResponse is @since solr 0.9 public API with no experimental/internal marker, so flagging this explicitly rather than treating it as a purely internal cleanup -- your call whether that's acceptable for 11.0.

AI-assisted (Claude Sonnet 5)

…leOrderedMap getResponseHeader() always returned an actual SimpleOrderedMap internally, masked by an unchecked cast; declaring the real type removes the cast and lets 4 call sites in QueryComponent/CombinedQueryComponent use put() instead of asShallowMap().put()/remove()+add(). It also turns the exact class of bug hit in SOLR-18373 (a test mock returning a plain NamedList, causing a runtime ClassCastException) into a compile error instead. Binary-incompatible for external callers compiled against the old NamedList signature (verified: NoSuchMethodError). Flagging for review since this is long-standing public API, not something marked experimental/internal.

dsmiley

For Solr 11. The binary incompatibility break for a prolific API like this wouldn't be nice for Solr plugin writers.

epugh · 2026-08-25T20:51:31Z

@serhiy-bzhezytskyy can you add a changelog since this is a binary incompatbility?

serhiy-bzhezytskyy · 2026-08-26T06:02:35Z

Added — see changelog/unreleased/SOLR-solrqueryresponse-return-types.yml.

Resolved in QueryComponent and CombinedQueryComponent: kept the direct SimpleOrderedMap.put() calls and dropped updateResponseHeader, whose only purpose was to cast around getResponseHeader()'s old NamedList return type.

serhiy-bzhezytskyy · 2026-08-25T09:31:48Z

Follow-up to @dsmiley's suggestion on #4761 (review thread on QueryComponent.java): rather than keep the remove()+add() workaround needed there because getResponseHeader()'s declared return type (NamedList<Object>) doesn't have a put(), this tightens the declared type to what it always actually is at runtime -- SimpleOrderedMap<Object> -- removing the internal unchecked cast and letting the 4 call sites in QueryComponent/CombinedQueryComponent use put() directly.

This also closes the actual hole that caused #4761's ClassCastException: MockResponseBuilder's mock was stubbing getResponseHeader() to return a bare NamedList, which the contract allowed but reality never produced. With the tightened return type, that mismatch is now a compile error instead of a runtime ClassCastException.

Compatibility note: this is binary-incompatible for any external caller compiled against the old NamedList signature -- verified locally (compiled a caller against the old class files, ran it against the new ones without recompiling): NoSuchMethodError on both getResponseHeader() and addResponseHeader(NamedList). SolrQueryResponse is @since solr 0.9 public API with no experimental/internal marker, so flagging this explicitly rather than treating it as a purely internal cleanup -- your call whether that's acceptable for 11.0.

AI-assisted (Claude Sonnet 5)

…leOrderedMap getResponseHeader() always returned an actual SimpleOrderedMap internally, masked by an unchecked cast; declaring the real type removes the cast and lets 4 call sites in QueryComponent/CombinedQueryComponent use put() instead of asShallowMap().put()/remove()+add(). It also turns the exact class of bug hit in SOLR-18373 (a test mock returning a plain NamedList, causing a runtime ClassCastException) into a compile error instead. Binary-incompatible for external callers compiled against the old NamedList signature (verified: NoSuchMethodError). Flagging for review since this is long-standing public API, not something marked experimental/internal.

dsmiley

For Solr 11. The binary incompatibility break for a prolific API like this wouldn't be nice for Solr plugin writers.

epugh · 2026-08-25T20:51:31Z

@serhiy-bzhezytskyy can you add a changelog since this is a binary incompatbility?

serhiy-bzhezytskyy · 2026-08-26T06:02:35Z

Added — see changelog/unreleased/SOLR-solrqueryresponse-return-types.yml.

Resolved in QueryComponent and CombinedQueryComponent: kept the direct SimpleOrderedMap.put() calls and dropped updateResponseHeader, whose only purpose was to cast around getResponseHeader()'s old NamedList return type.

serhiy-bzhezytskyy · 2026-08-25T09:31:48Z

Follow-up to @dsmiley's suggestion on #4761 (review thread on QueryComponent.java): rather than keep the remove()+add() workaround needed there because getResponseHeader()'s declared return type (NamedList<Object>) doesn't have a put(), this tightens the declared type to what it always actually is at runtime -- SimpleOrderedMap<Object> -- removing the internal unchecked cast and letting the 4 call sites in QueryComponent/CombinedQueryComponent use put() directly.

This also closes the actual hole that caused #4761's ClassCastException: MockResponseBuilder's mock was stubbing getResponseHeader() to return a bare NamedList, which the contract allowed but reality never produced. With the tightened return type, that mismatch is now a compile error instead of a runtime ClassCastException.

Compatibility note: this is binary-incompatible for any external caller compiled against the old NamedList signature -- verified locally (compiled a caller against the old class files, ran it against the new ones without recompiling): NoSuchMethodError on both getResponseHeader() and addResponseHeader(NamedList). SolrQueryResponse is @since solr 0.9 public API with no experimental/internal marker, so flagging this explicitly rather than treating it as a purely internal cleanup -- your call whether that's acceptable for 11.0.

AI-assisted (Claude Sonnet 5)

…leOrderedMap getResponseHeader() always returned an actual SimpleOrderedMap internally, masked by an unchecked cast; declaring the real type removes the cast and lets 4 call sites in QueryComponent/CombinedQueryComponent use put() instead of asShallowMap().put()/remove()+add(). It also turns the exact class of bug hit in SOLR-18373 (a test mock returning a plain NamedList, causing a runtime ClassCastException) into a compile error instead. Binary-incompatible for external callers compiled against the old NamedList signature (verified: NoSuchMethodError). Flagging for review since this is long-standing public API, not something marked experimental/internal.

dsmiley

For Solr 11. The binary incompatibility break for a prolific API like this wouldn't be nice for Solr plugin writers.

epugh · 2026-08-25T20:51:31Z

@serhiy-bzhezytskyy can you add a changelog since this is a binary incompatbility?

serhiy-bzhezytskyy · 2026-08-26T06:02:35Z

Added — see changelog/unreleased/SOLR-solrqueryresponse-return-types.yml.

Resolved in QueryComponent and CombinedQueryComponent: kept the direct SimpleOrderedMap.put() calls and dropped updateResponseHeader, whose only purpose was to cast around getResponseHeader()'s old NamedList return type.

serhiy-bzhezytskyy · 2026-08-25T09:31:48Z

Follow-up to @dsmiley's suggestion on #4761 (review thread on QueryComponent.java): rather than keep the remove()+add() workaround needed there because getResponseHeader()'s declared return type (NamedList<Object>) doesn't have a put(), this tightens the declared type to what it always actually is at runtime -- SimpleOrderedMap<Object> -- removing the internal unchecked cast and letting the 4 call sites in QueryComponent/CombinedQueryComponent use put() directly.

This also closes the actual hole that caused #4761's ClassCastException: MockResponseBuilder's mock was stubbing getResponseHeader() to return a bare NamedList, which the contract allowed but reality never produced. With the tightened return type, that mismatch is now a compile error instead of a runtime ClassCastException.

Compatibility note: this is binary-incompatible for any external caller compiled against the old NamedList signature -- verified locally (compiled a caller against the old class files, ran it against the new ones without recompiling): NoSuchMethodError on both getResponseHeader() and addResponseHeader(NamedList). SolrQueryResponse is @since solr 0.9 public API with no experimental/internal marker, so flagging this explicitly rather than treating it as a purely internal cleanup -- your call whether that's acceptable for 11.0.

AI-assisted (Claude Sonnet 5)

…leOrderedMap getResponseHeader() always returned an actual SimpleOrderedMap internally, masked by an unchecked cast; declaring the real type removes the cast and lets 4 call sites in QueryComponent/CombinedQueryComponent use put() instead of asShallowMap().put()/remove()+add(). It also turns the exact class of bug hit in SOLR-18373 (a test mock returning a plain NamedList, causing a runtime ClassCastException) into a compile error instead. Binary-incompatible for external callers compiled against the old NamedList signature (verified: NoSuchMethodError). Flagging for review since this is long-standing public API, not something marked experimental/internal.

dsmiley

For Solr 11. The binary incompatibility break for a prolific API like this wouldn't be nice for Solr plugin writers.

epugh · 2026-08-25T20:51:31Z

@serhiy-bzhezytskyy can you add a changelog since this is a binary incompatbility?

serhiy-bzhezytskyy · 2026-08-26T06:02:35Z

Added — see changelog/unreleased/SOLR-solrqueryresponse-return-types.yml.

Resolved in QueryComponent and CombinedQueryComponent: kept the direct SimpleOrderedMap.put() calls and dropped updateResponseHeader, whose only purpose was to cast around getResponseHeader()'s old NamedList return type.

serhiy-bzhezytskyy · 2026-08-25T09:31:48Z

Follow-up to @dsmiley's suggestion on #4761 (review thread on QueryComponent.java): rather than keep the remove()+add() workaround needed there because getResponseHeader()'s declared return type (NamedList<Object>) doesn't have a put(), this tightens the declared type to what it always actually is at runtime -- SimpleOrderedMap<Object> -- removing the internal unchecked cast and letting the 4 call sites in QueryComponent/CombinedQueryComponent use put() directly.

This also closes the actual hole that caused #4761's ClassCastException: MockResponseBuilder's mock was stubbing getResponseHeader() to return a bare NamedList, which the contract allowed but reality never produced. With the tightened return type, that mismatch is now a compile error instead of a runtime ClassCastException.

Compatibility note: this is binary-incompatible for any external caller compiled against the old NamedList signature -- verified locally (compiled a caller against the old class files, ran it against the new ones without recompiling): NoSuchMethodError on both getResponseHeader() and addResponseHeader(NamedList). SolrQueryResponse is @since solr 0.9 public API with no experimental/internal marker, so flagging this explicitly rather than treating it as a purely internal cleanup -- your call whether that's acceptable for 11.0.

AI-assisted (Claude Sonnet 5)

…leOrderedMap getResponseHeader() always returned an actual SimpleOrderedMap internally, masked by an unchecked cast; declaring the real type removes the cast and lets 4 call sites in QueryComponent/CombinedQueryComponent use put() instead of asShallowMap().put()/remove()+add(). It also turns the exact class of bug hit in SOLR-18373 (a test mock returning a plain NamedList, causing a runtime ClassCastException) into a compile error instead. Binary-incompatible for external callers compiled against the old NamedList signature (verified: NoSuchMethodError). Flagging for review since this is long-standing public API, not something marked experimental/internal.

dsmiley

For Solr 11. The binary incompatibility break for a prolific API like this wouldn't be nice for Solr plugin writers.

epugh · 2026-08-25T20:51:31Z

@serhiy-bzhezytskyy can you add a changelog since this is a binary incompatbility?

serhiy-bzhezytskyy · 2026-08-26T06:02:35Z

Added — see changelog/unreleased/SOLR-solrqueryresponse-return-types.yml.

Resolved in QueryComponent and CombinedQueryComponent: kept the direct SimpleOrderedMap.put() calls and dropped updateResponseHeader, whose only purpose was to cast around getResponseHeader()'s old NamedList return type.

serhiy-bzhezytskyy · 2026-08-25T09:31:48Z

Follow-up to @dsmiley's suggestion on #4761 (review thread on QueryComponent.java): rather than keep the remove()+add() workaround needed there because getResponseHeader()'s declared return type (NamedList<Object>) doesn't have a put(), this tightens the declared type to what it always actually is at runtime -- SimpleOrderedMap<Object> -- removing the internal unchecked cast and letting the 4 call sites in QueryComponent/CombinedQueryComponent use put() directly.

This also closes the actual hole that caused #4761's ClassCastException: MockResponseBuilder's mock was stubbing getResponseHeader() to return a bare NamedList, which the contract allowed but reality never produced. With the tightened return type, that mismatch is now a compile error instead of a runtime ClassCastException.

Compatibility note: this is binary-incompatible for any external caller compiled against the old NamedList signature -- verified locally (compiled a caller against the old class files, ran it against the new ones without recompiling): NoSuchMethodError on both getResponseHeader() and addResponseHeader(NamedList). SolrQueryResponse is @since solr 0.9 public API with no experimental/internal marker, so flagging this explicitly rather than treating it as a purely internal cleanup -- your call whether that's acceptable for 11.0.

AI-assisted (Claude Sonnet 5)

…leOrderedMap getResponseHeader() always returned an actual SimpleOrderedMap internally, masked by an unchecked cast; declaring the real type removes the cast and lets 4 call sites in QueryComponent/CombinedQueryComponent use put() instead of asShallowMap().put()/remove()+add(). It also turns the exact class of bug hit in SOLR-18373 (a test mock returning a plain NamedList, causing a runtime ClassCastException) into a compile error instead. Binary-incompatible for external callers compiled against the old NamedList signature (verified: NoSuchMethodError). Flagging for review since this is long-standing public API, not something marked experimental/internal.

dsmiley

For Solr 11. The binary incompatibility break for a prolific API like this wouldn't be nice for Solr plugin writers.

epugh · 2026-08-25T20:51:31Z

@serhiy-bzhezytskyy can you add a changelog since this is a binary incompatbility?

serhiy-bzhezytskyy · 2026-08-26T06:02:35Z

Added — see changelog/unreleased/SOLR-solrqueryresponse-return-types.yml.

Resolved in QueryComponent and CombinedQueryComponent: kept the direct SimpleOrderedMap.put() calls and dropped updateResponseHeader, whose only purpose was to cast around getResponseHeader()'s old NamedList return type.

serhiy-bzhezytskyy · 2026-08-25T09:31:48Z

Follow-up to @dsmiley's suggestion on #4761 (review thread on QueryComponent.java): rather than keep the remove()+add() workaround needed there because getResponseHeader()'s declared return type (NamedList<Object>) doesn't have a put(), this tightens the declared type to what it always actually is at runtime -- SimpleOrderedMap<Object> -- removing the internal unchecked cast and letting the 4 call sites in QueryComponent/CombinedQueryComponent use put() directly.

This also closes the actual hole that caused #4761's ClassCastException: MockResponseBuilder's mock was stubbing getResponseHeader() to return a bare NamedList, which the contract allowed but reality never produced. With the tightened return type, that mismatch is now a compile error instead of a runtime ClassCastException.

Compatibility note: this is binary-incompatible for any external caller compiled against the old NamedList signature -- verified locally (compiled a caller against the old class files, ran it against the new ones without recompiling): NoSuchMethodError on both getResponseHeader() and addResponseHeader(NamedList). SolrQueryResponse is @since solr 0.9 public API with no experimental/internal marker, so flagging this explicitly rather than treating it as a purely internal cleanup -- your call whether that's acceptable for 11.0.

AI-assisted (Claude Sonnet 5)

…leOrderedMap getResponseHeader() always returned an actual SimpleOrderedMap internally, masked by an unchecked cast; declaring the real type removes the cast and lets 4 call sites in QueryComponent/CombinedQueryComponent use put() instead of asShallowMap().put()/remove()+add(). It also turns the exact class of bug hit in SOLR-18373 (a test mock returning a plain NamedList, causing a runtime ClassCastException) into a compile error instead. Binary-incompatible for external callers compiled against the old NamedList signature (verified: NoSuchMethodError). Flagging for review since this is long-standing public API, not something marked experimental/internal.

dsmiley

For Solr 11. The binary incompatibility break for a prolific API like this wouldn't be nice for Solr plugin writers.

epugh · 2026-08-25T20:51:31Z

@serhiy-bzhezytskyy can you add a changelog since this is a binary incompatbility?

serhiy-bzhezytskyy · 2026-08-26T06:02:35Z

Added — see changelog/unreleased/SOLR-solrqueryresponse-return-types.yml.

Resolved in QueryComponent and CombinedQueryComponent: kept the direct SimpleOrderedMap.put() calls and dropped updateResponseHeader, whose only purpose was to cast around getResponseHeader()'s old NamedList return type.

github-actionsBot added tests cat:search cat:index labels Aug 25, 2026

dsmiley approved these changes Aug 25, 2026
View reviewed changes