API Breaking Change in Minor Release: `Route.Handler` -> `Route.Name`?

[splittingfield]

/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
/ / / / / / / / / / / / / / / / / /

Please use forum https://forum.labstack.com to ask questions!

/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
/ / / / / / / / / / / / / / / / / /

Issue Description

In 3.2.2, the Route struct was changed to have a Name method as opposed to Handler.

In 3.2.1,

Route struct {
		Method  string `json:"method"`
		Path    string `json:"path"`
		Handler string `json:"handler"`
	}

In 3.2.2,

	// Route contains a handler and information for matching against requests.
	Route struct {
		Method string `json:"method"`
		Path   string `json:"path"`
		Name   string `json:"name"`
	}

Checklist

• [ x] Dependencies installed
• [ x] No typos
• [ x] Searched existing issues and docs

Expected behaviour

No API breaking changed in minor releases.

Actual behaviour

API breaking changes in a minor release.

Steps to reproduce

Pin Echo to a SemVer range 3.2.x and see API breaking behavior within hours of a new release in which this change was pulled by our build servers.

Version/commit

This change happened in commit
c04b028#diff-252e46e448f4e037d84d69193c8fdf79

[vishr]

@splittingfield thanks for reporting, we should have at least made it backward compatible - lesson learned. If you have any suggestion to improve/fix it, please let me know.

[splittingfield]

@vishr I think this is more of a process thing than anything else. For example, the documentation for Listing Routes is now incorrect. Going forward, (and what I have done in the past) is to have a suite of tests aimed at verifying API compatibility of exposed structs and values. It is so easy to make a change that is completely innocuous, but actually breaks users (such as this one ;-)

Also, documenting changes would help. Is Name the same is Handler? Was Handler removed as a concept? It was unclear to me as to whether we should just change our usage to the new variable or why this change occured.

Also, SemVer is hard ;-)

[vishr]

@splittingfield Here is the complete discussion https://forum.labstack.com/t/named-routes-for-use-in-templates/241

@skyflyer might be able to talk more about it.

I will check on documentation mismatch.

[splittingfield]

@vishr Thanks! Echo is awesome by the way. No hard feelings or big deal, just wasted some time to understand what happened.

[skyflyer]

@splittingfield, that rename was my bad, sorry. And to answer your question:

Name is the same as Handler was before; I wrongly assumed Handler was even used outside of Echo since it is more-or-less an infrastructure thing.

[splittingfield]

No worries my friend. As I said, easy mistake to make and one I am sure I have made myself, but in software no one used so no one noticed 👹

Keep up the great work!