httpcaddyfile: Fix sorting edgecase for nested handle_path

[francislavoie]

Fixes a bug reported in https://caddy.community/t/handle-path-being-ignored-when-paired-with-handle-in-same-block/14393

We had some code in ServerType.Setup() that would ensure handle_path has the same sort level as handle, but we were missing the same check in parseSegmentAsConfig to make sure that works properly inside of any nested subroute (handle, route, handle_errors, handle_response).

To be clear, the fix is copy-paste from another spot where we do the same thing:

caddy/caddyconfig/httpcaddyfile/httptype.go

Lines 196 to 202 in 78b5356

	// As a special case, we want "handle_path" to be sorted
	// at the same level as "handle", so we force them to use
	// the same directive name after their parsing is complete.
	// See https://github.com/caddyserver/caddy/issues/3675#issuecomment-678042377
	if dir == "handle_path" {
	dir = "handle"
	}

The new test fails before the change (the handle_path ends up after the handle in the same level, and they're missing a group name because the group is omitted if there's no two handlers with the same level) and passes after.

[adityaxdiwakar]

OP from the community thread, thank you very much @francislavoie. You guys are fast! Glad I switched to Caddy.

[mholt]

Thanks for the fix. Hmm, unfortunate that we need to repeat that logic. I wonder if there's any way to combine the other function where this is from with this logic. 🤔 (Maybe for another PR, if so.)

Can we move the change any lower? The only next use of dir is on L352, other than in an error message earlier on L349. It'd be helpful if the directive in the error message is the same as appears in the config. So I wonder if we move this change to between, say, L350-351 it might be a little more helpful.

[francislavoie]

Yeah we should extract this to a method to do these kinds of normalizations. I'll move it.

[francislavoie]

Updated

[mholt]

That looks better. Thanks!