Migrate MediaType.sortByQualityValue() to local implementation by gdgenchev · Pull Request #3856 · cloudfoundry/uaa

gdgenchev · 2026-04-22T06:25:08Z

MediaType.sortByQualityValue() was deprecated in Spring 6 and later removed in Spring 7. Copy the sorting logic into a utility class to preserve content negotiation behavior that respects client quality value preferences from Accept headers.

Exact copy of Spring 6:

https://github.com/spring-projects/spring-framework/blob/9f431e2eac1b6d8d5ca385d0cc367bac94dd37e7/spring-web/src/main/java/org/springframework/http/MediaType.java#L906-L911

https://github.com/spring-projects/spring-framework/blob/9f431e2eac1b6d8d5ca385d0cc367bac94dd37e7/spring-web/src/main/java/org/springframework/http/MediaType.java#L927-L965

https://github.com/spring-projects/spring-framework/blob/9f431e2eac1b6d8d5ca385d0cc367bac94dd37e7/spring-web/src/test/java/org/springframework/http/MediaTypeTests.java#L390-L444 (+ some additional tests for the utility method)

This maintains backward compatibility.

The other approach would be to switch to https://github.com/spring-projects/spring-framework/blob/c6096ff6e5e7de92cf6a3466e211d72b401a0178/spring-core/src/main/java/org/springframework/util/MimeTypeUtils.java#L351-L358

but it will not be backward compatible and we will have to change some ITs that cover this.

…ng 7 Spring 7 removed MediaType.sortByQualityValue() and QUALITY_VALUE_COMPARATOR that were deprecated in Spring 6. Copy the sorting logic into a new MediaTypeComparators utility class to preserve content negotiation behavior that respects client quality value preferences from Accept headers. https://github.com/spring-projects/spring-framework/blob/9f431e2eac1b6d8d5ca385d0cc367bac94dd37e7/spring-web/src/main/java/org/springframework/http/MediaType.java#L927-L965

Copilot

Pull request overview

This PR preserves Spring content-negotiation behavior after MediaType.sortByQualityValue() was removed (Spring 7) by introducing a local MediaType quality-value comparator and updating call sites to use it.

Changes:

Added MediaTypeComparators.BY_QUALITY_VALUE, mirroring Spring 6’s quality-value comparator logic.
Replaced MediaType.sortByQualityValue(...) with acceptedMediaTypes.sort(MediaTypeComparators.BY_QUALITY_VALUE) in two renderers/views.

Reviewed changes

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

File	Description
`server/src/main/java/org/cloudfoundry/identity/uaa/web/ConvertingExceptionView.java`	Switches Accept media type sorting to the new local comparator.
`server/src/main/java/org/cloudfoundry/identity/uaa/util/MediaTypeComparators.java`	Introduces a Spring-6-compatible `MediaType` quality-value comparator.
`server/src/main/java/org/cloudfoundry/identity/uaa/oauth/provider/error/DefaultOAuth2ExceptionRenderer.java`	Switches Accept media type sorting to the new local comparator.

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

- Rename MediaTypeComparators to MediaTypeUtils for better semantics - Add sortByQualityValue() utility method to handle immutable lists - Fix usages to create mutable copies before sorting - Remove unnecessary if-else in ConvertingExceptionView - Add comprehensive unit tests including parameterized tests

Copilot

Pull request overview

This PR preserves UAA’s existing content-negotiation behavior by replacing the removed MediaType.sortByQualityValue(...) API with an equivalent local implementation, ensuring Accept header q (quality) preferences are still respected when selecting response converters.

Changes:

Added MediaTypeUtils with a BY_QUALITY_VALUE comparator and sortByQualityValue(...) method matching Spring 6 behavior.
Updated server-side rendering paths to use MediaTypeUtils.sortByQualityValue(...) instead of the removed Spring API.
Added unit tests covering sorting behavior and comparator edge cases (including stable ordering expectations).

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File	Description
`server/src/main/java/org/cloudfoundry/identity/uaa/util/MediaTypeUtils.java`	Introduces the local comparator + sort helper to replace removed Spring API.
`server/src/main/java/org/cloudfoundry/identity/uaa/web/ConvertingExceptionView.java`	Switches Accept sorting to the new local utility before choosing a message converter.
`server/src/main/java/org/cloudfoundry/identity/uaa/oauth/provider/error/DefaultOAuth2ExceptionRenderer.java`	Switches Accept sorting to the new local utility before choosing a message converter.
`server/src/test/java/org/cloudfoundry/identity/uaa/util/MediaTypeUtilsTest.java`	Adds unit coverage to validate ordering, stability, and comparator semantics.

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

Copilot

Pull request overview

This PR preserves UAA’s Accept-header content negotiation behavior after Spring Framework removed MediaType.sortByQualityValue() by introducing a local equivalent and updating call sites to use it.

Changes:

Added MediaTypeUtils with a Spring 6–compatible quality-value comparator and in-place sort helper.
Replaced usages of MediaType.sortByQualityValue(...) with MediaTypeUtils.sortByQualityValue(...).
Added unit tests covering null handling and comparator behavior.

Reviewed changes

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

File	Description
server/src/main/java/org/cloudfoundry/identity/uaa/util/MediaTypeUtils.java	New local Spring-6-equivalent comparator + sorting helper for `MediaType`.
server/src/test/java/org/cloudfoundry/identity/uaa/util/MediaTypeUtilsTest.java	New unit tests for the utility comparator/sort behavior.
server/src/main/java/org/cloudfoundry/identity/uaa/web/ConvertingExceptionView.java	Switched Accept sorting to use the local utility.
server/src/main/java/org/cloudfoundry/identity/uaa/oauth/provider/error/DefaultOAuth2ExceptionRenderer.java	Switched Accept sorting to use the local utility.

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

fhanik · 2026-05-05T14:27:09Z

I'd backfill the test copilot is asking for, then we can merge

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

strehle · 2026-05-06T12:20:55Z

alternative #3901

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

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

Copilot

Pull request overview

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

strehle

I have an alternative PR #3901 but not sure if this is 100% compatible, however others can decide which variant we should use. both allow spring 7

gdgenchev force-pushed the migrate-media-type-sort branch from 6b1a076 to 13ed684 Compare April 22, 2026 06:27

cf-foundation-community-automation Bot added this to Foundational Infrastructure Working Group Apr 22, 2026

cf-foundation-community-automation Bot moved this to Inbox in Foundational Infrastructure Working Group Apr 22, 2026

strehle requested a review from Copilot April 22, 2026 09:07

Copilot started reviewing on behalf of strehle April 22, 2026 09:07 View session

Copilot AI reviewed Apr 22, 2026

View reviewed changes

gdgenchev force-pushed the migrate-media-type-sort branch from e775cb2 to cf69219 Compare April 22, 2026 20:52

strehle requested a review from Copilot April 23, 2026 05:16

Copilot started reviewing on behalf of strehle April 23, 2026 05:16 View session

Copilot AI reviewed Apr 23, 2026

View reviewed changes

strehle requested a review from Copilot April 30, 2026 14:56

strehle assigned duanemay Apr 30, 2026

strehle requested a review from a team April 30, 2026 14:56

strehle unassigned duanemay Apr 30, 2026

strehle requested a review from duanemay April 30, 2026 14:57

Copilot started reviewing on behalf of strehle April 30, 2026 14:57 View session

Copilot AI reviewed Apr 30, 2026

View reviewed changes

fhanik previously approved these changes May 5, 2026

View reviewed changes

github-project-automation Bot moved this from Inbox to Pending Merge | Prioritized in Foundational Infrastructure Working Group May 5, 2026

fhanik added the accepted Accepted the issue label May 5, 2026

gdgenchev added 2 commits May 5, 2026 22:19

review: reformat

224dc60

review: add stability check for equally ranked types

59fdfc0

gdgenchev dismissed fhanik’s stale review via 59fdfc0 May 5, 2026 19:27

strehle requested a review from Copilot May 6, 2026 07:25

Copilot started reviewing on behalf of strehle May 6, 2026 07:25 View session

Copilot AI reviewed May 6, 2026

View reviewed changes

Comment thread server/src/test/java/org/cloudfoundry/identity/uaa/util/MediaTypeUtilsTest.java Outdated

strehle mentioned this pull request May 6, 2026

Migrate MediaType.sortByQualityValue #3901

Closed

Potential fix for pull request finding

4d8a33b

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

strehle requested a review from Copilot May 6, 2026 15:27

Copilot started reviewing on behalf of strehle May 6, 2026 15:28 View session

Copilot AI reviewed May 6, 2026

View reviewed changes

strehle requested a review from Copilot May 6, 2026 18:25

Copilot started reviewing on behalf of strehle May 6, 2026 18:26 View session

Copilot AI reviewed May 6, 2026

View reviewed changes

strehle approved these changes May 6, 2026

View reviewed changes

strehle merged commit bc2bd0f into cloudfoundry:develop May 7, 2026
35 checks passed

github-project-automation Bot moved this from Pending Merge | Prioritized to Done in Foundational Infrastructure Working Group May 7, 2026

Conversation

gdgenchev commented Apr 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fhanik commented May 5, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

strehle commented May 6, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

strehle left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

gdgenchev commented Apr 22, 2026 •

edited

Loading