Files
zeekayandHanzo Dev 1ed3377dce web: our own router; chi is gone from this codebase
modules/web/mux.go routes the 1333 routes. chi is no longer imported anywhere in
our source.

A tree over path segments, each node trying children by specificity: exact
segment, then patterned segments in registration order, then a trailing
wildcard. That ordering is the contract — "/user/settings" must beat
"/{username}" or a user named "settings" takes over the settings page — and
matching BACKTRACKS, because a segment can match here and fail deeper while the
next candidate at this level still has to be tried.

Four segment shapes, all of which this codebase actually uses:

	users             static
	{id}              whole segment          (577)
	{sha:[a-f0-9]+}   regexp-constrained     (43)
	PACKAGES{format}  parameter mid-segment  (CRAN indexes)
	*                 trailing wildcard      (131)

A plain {name} carries no regexp. It is the overwhelming majority, and it does
not need one to match a whole segment.

The tests are the point of this commit, not the code. Each case is a way a
router can be wrong that a passing build will not reveal: static beating a
param, a regexp declining and the NEXT candidate winning (/repo/zzz is not a
sha, but "repo" is a legal username), a wildcard capturing the remainder,
"/*" matching "/" itself, HEAD falling back to GET, and — the one that matters
most — a failed branch leaving NO captured parameters behind for the branch
tried next.

Three things this turned up while wiring it in:

  Mount had to strip its prefix. A sub-router mounted at "/v1" writes its
  patterns relative to it, so handing it the full path matches nothing.
  chi_middleware.GetHead was deleted rather than reimplemented: Mux.handlerFor
  already falls back from HEAD to GET, so keeping it would have been two
  implementations of one rule.
  ChiRoutePathHandler is now RoutePathHandler and sets RouteContext.RoutePath.
  It exists so a "%2f" inside a parameter routes as one segment — without it a
  branch called "feat/x" splits and matches the wrong handler.

The vendored middleware tests used chi to register two routes each; they use a
small stdlib ServeMux shim now. modules/web imports modules/binding, so those
tests cannot import web back.

github.com/go-chi/chi/v5 remains in go.mod as an INDIRECT dependency of
markbates/goth/gothic, which drives every OAuth2 login. That is goth pulling it,
not us.

Everything green; integration compile gate green.

Co-authored-by: Hanzo Dev <[email protected]>
2026-07-27 19:20:07 -07:00

291 lines
9.0 KiB
Go

// Copyright 2026 Hanzo AI, Inc. All rights reserved.
// Copyright 2014 Martini Authors
// Copyright 2014 The Macaron Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"): you may
// not use this file except in compliance with the License. You may obtain
// a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations
// under the License.
package binding
import (
"encoding/json"
"fmt"
"io"
"net/http"
"net/http/httptest"
"reflect"
"runtime"
"strings"
"testing"
"github.com/stretchr/testify/assert"
)
var jsonTestCases = []jsonTestCase{
{
description: "Happy path",
shouldSucceedOnJson: true,
payload: `{"title": "Glorious Post Title", "content": "Lorem ipsum dolor sit amet"}`,
contentType: _JSON_CONTENT_TYPE,
expected: Post{Title: "Glorious Post Title", Content: "Lorem ipsum dolor sit amet"},
},
{
description: "Happy path with interface",
shouldSucceedOnJson: true,
withInterface: true,
payload: `{"title": "Glorious Post Title", "content": "Lorem ipsum dolor sit amet"}`,
contentType: _JSON_CONTENT_TYPE,
expected: Post{Title: "Glorious Post Title", Content: "Lorem ipsum dolor sit amet"},
},
{
description: "Nil payload",
shouldSucceedOnJson: false,
payload: `-nil-`,
contentType: _JSON_CONTENT_TYPE,
expected: Post{},
},
{
description: "Empty payload",
shouldSucceedOnJson: false,
payload: ``,
contentType: _JSON_CONTENT_TYPE,
expected: Post{},
},
{
description: "Empty content type",
shouldSucceedOnJson: true,
shouldFailOnBind: true,
payload: `{"title": "Glorious Post Title", "content": "Lorem ipsum dolor sit amet"}`,
contentType: ``,
expected: Post{Title: "Glorious Post Title", Content: "Lorem ipsum dolor sit amet"},
},
{
description: "Unsupported content type",
shouldSucceedOnJson: true,
shouldFailOnBind: true,
payload: `{"title": "Glorious Post Title", "content": "Lorem ipsum dolor sit amet"}`,
contentType: `BoGuS`,
expected: Post{Title: "Glorious Post Title", Content: "Lorem ipsum dolor sit amet"},
},
{
description: "Malformed JSON",
shouldSucceedOnJson: false,
payload: `{"title":"foo"`,
contentType: _JSON_CONTENT_TYPE,
expected: Post{Title: "foo"},
},
{
description: "Deserialization with nested and embedded struct",
shouldSucceedOnJson: true,
payload: `{"title":"Glorious Post Title", "id":1, "author":{"name":"Matt Holt"}}`,
contentType: _JSON_CONTENT_TYPE,
expected: BlogPost{Post: Post{Title: "Glorious Post Title"}, Id: 1, Author: Person{Name: "Matt Holt"}},
},
{
description: "Deserialization with nested and embedded struct with interface",
shouldSucceedOnJson: true,
withInterface: true,
payload: `{"title":"Glorious Post Title", "id":1, "author":{"name":"Matt Holt"}}`,
contentType: _JSON_CONTENT_TYPE,
expected: BlogPost{Post: Post{Title: "Glorious Post Title"}, Id: 1, Author: Person{Name: "Matt Holt"}},
},
{
description: "Required nested struct field not specified",
shouldSucceedOnJson: false,
payload: `{"title":"Glorious Post Title", "id":1, "author":{}}`,
contentType: _JSON_CONTENT_TYPE,
expected: BlogPost{Post: Post{Title: "Glorious Post Title"}, Id: 1},
},
{
description: "Required embedded struct field not specified",
shouldSucceedOnJson: false,
payload: `{"id":1, "author":{"name":"Matt Holt"}}`,
contentType: _JSON_CONTENT_TYPE,
expected: BlogPost{Id: 1, Author: Person{Name: "Matt Holt"}},
},
{
description: "Slice of Posts",
shouldSucceedOnJson: true,
payload: `[{"title": "First Post"}, {"title": "Second Post"}]`,
contentType: _JSON_CONTENT_TYPE,
expected: []Post{Post{Title: "First Post"}, Post{Title: "Second Post"}},
},
{
description: "Slice of structs",
shouldSucceedOnJson: true,
payload: `{"name": "group1", "people": [{"name":"awoods"}, {"name": "anthony"}]}`,
contentType: _JSON_CONTENT_TYPE,
expected: Group{Name: "group1", People: []Person{Person{Name: "awoods"}, Person{Name: "anthony"}}},
},
}
func Test_Json(t *testing.T) {
for _, testCase := range jsonTestCases {
performJsonTest(t, JSON, testCase)
}
}
func performJsonTest(t *testing.T, binder handlerFunc, testCase jsonTestCase) {
fnName := runtime.FuncForPC(reflect.ValueOf(binder).Pointer()).Name()
t.Run(testCase.description, func(t *testing.T) {
var payload io.Reader
httpRecorder := httptest.NewRecorder()
m := newTestRouter()
jsonTestHandler := func(actual interface{}, errs Errors) {
if fnName == "JSON" {
if testCase.shouldSucceedOnJson {
assert.Empty(t, errs, errs)
assert.EqualValues(t, fmt.Sprintf("%+v", testCase.expected), fmt.Sprintf("%+v", actual))
} else {
assert.NotEmpty(t, errs)
}
} else if fnName == "Bind" {
if !testCase.shouldFailOnBind {
assert.Empty(t, errs, errs)
} else {
assert.NotEmpty(t, errs)
assert.EqualValues(t, fmt.Sprintf("%+v", testCase.expected), fmt.Sprintf("%+v", actual))
}
}
}
switch testCase.expected.(type) {
case []Post:
if testCase.withInterface {
m.Post(testRoute, func(resp http.ResponseWriter, req *http.Request) {
var actual []Post
errs := binder(req, &actual)
for i, a := range actual {
assert.EqualValues(t, testCase.expected.([]Post)[i].Title, a.Title)
jsonTestHandler(a, errs)
}
})
} else {
m.Post(testRoute, func(resp http.ResponseWriter, req *http.Request) {
var actual []Post
errs := binder(req, &actual)
jsonTestHandler(actual, errs)
})
}
case Post:
if testCase.withInterface {
m.Post(testRoute, func(resp http.ResponseWriter, req *http.Request) {
var actual Post
errs := binder(req, &actual)
assert.EqualValues(t, testCase.expected.(Post).Title, actual.Title)
jsonTestHandler(actual, errs)
})
} else {
m.Post(testRoute, func(resp http.ResponseWriter, req *http.Request) {
var actual Post
errs := binder(req, &actual)
jsonTestHandler(actual, errs)
})
}
case BlogPost:
if testCase.withInterface {
m.Post(testRoute, func(resp http.ResponseWriter, req *http.Request) {
var actual BlogPost
errs := binder(req, &actual)
assert.EqualValues(t, testCase.expected.(BlogPost).Title, actual.Title)
jsonTestHandler(actual, errs)
})
} else {
m.Post(testRoute, func(resp http.ResponseWriter, req *http.Request) {
var actual BlogPost
errs := binder(req, &actual)
jsonTestHandler(actual, errs)
})
}
case Group:
if testCase.withInterface {
m.Post(testRoute, func(resp http.ResponseWriter, req *http.Request) {
var actual Group
errs := binder(req, &actual)
assert.EqualValues(t, testCase.expected.(Group).Name, actual.Name)
jsonTestHandler(actual, errs)
})
} else {
m.Post(testRoute, func(resp http.ResponseWriter, req *http.Request) {
var actual Group
errs := binder(req, &actual)
jsonTestHandler(actual, errs)
})
}
}
if testCase.payload == "-nil-" {
payload = nil
} else {
payload = strings.NewReader(testCase.payload)
}
req, err := http.NewRequest("POST", testRoute, payload)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", testCase.contentType)
m.ServeHTTP(httpRecorder, req)
switch httpRecorder.Code {
case http.StatusNotFound:
panic("Routing is messed up in test fixture (got 404): check method and path")
case http.StatusInternalServerError:
panic("Something bad happened on '" + testCase.description + "'")
default:
if testCase.shouldSucceedOnJson &&
httpRecorder.Code != http.StatusOK &&
!testCase.shouldFailOnBind {
assert.EqualValues(t, http.StatusOK, httpRecorder.Code)
}
}
})
}
type (
jsonTestCase struct {
description string
withInterface bool
shouldSucceedOnJson bool
shouldFailOnBind bool
payload string
contentType string
expected interface{}
}
)
type jsonProvider struct{}
func (j jsonProvider) Marshal(v any) ([]byte, error) {
return json.Marshal(v)
}
func (j jsonProvider) Unmarshal(data []byte, v any) error {
return json.Unmarshal(data, v)
}
func (j jsonProvider) NewDecoder(reader io.Reader) JSONDecoder {
return json.NewDecoder(reader)
}
func (j jsonProvider) NewEncoder(writer io.Writer) JSONEncoder {
return json.NewEncoder(writer)
}
func init() {
JSONProvider = jsonProvider{}
}