Skip to content

New starters in 4.3 should not depend on spring-boot-properties-migrator #4022

@DidierLoiseau

Description

@DidierLoiseau

The new modules spring-cloud-starter-gateway-server-webflux and spring-cloud-starter-gateway-server-webmvc both depend on spring-boot-properties-migrator.

This is unexpected from a user point of view, since

  • this should be used only temporarily to help with property migration,
  • this is probably a lesser-known tool that people are not aware of,
  • the documentation says “Remember to remove the dependency when your migration is complete.”,
  • those are the new modules, so one wouldn’t expect them to work with the old properties,
  • the Spring Cloud 2025.0 Release Notes explicitly specify that the dependency should be added if desired:

Migration to new property prefixes to match the new module names: #3361, #3362, #3363, #3647. Use spring-boot-properties-migrator to support the deprecated prefixes.

People might thus not notice it – especially in production environments where operations might not be looking for the corresponding warning in the logs.

Even worse, since cloud.gateway.server.webflux.routes is a list, if you mix the old and new prefixes, the deprecated properties will override routes from the new prefix (since the properties are migrated by index position).

People who completed the migration (and are thus using the new modules) shouldn’t need this dependency, right?

I think it would thus be better to leave the choice to end users, otherwise they have to put an exclusion for it.

(I initially wrote this in spring-cloud/spring-cloud-release#452 (comment) but I guess it was overlooked as the ticket was already closed)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions