mirror of
https://github.com/agent-substrate/substrate.git
synced 2026-11-12 10:35:06 +08:00
Tim Hockin
a8d83ee1b5
This mostly eliminates the need to hand-write validation code. This PR is a long series of commits which add DV for most of Actor and all of Atespace. Here is a map to the commits: * The first few take a dep on a new Kubernetes tag, import the code into third_party, and apply a single patch. Because we have different Go modules for tools, I had to do it twice. When that patch lands, we can revert these commits, but that won't be until the 1.38 cycle in a few months. * The next commits slowly add DV support, so a human can review each of them in a reasonable amount of time. The emphasis is on great test cases. * I made a bad choice early on as to where to generate the code into, so I moved it. Rebasing on that was exceedingly hard, so I left it as a move. * This required changing update/go-generate -> update/codegen -- we need to get the ordering of tools right, which `go generate` does not guarantee. * Then I added a "middle" layer called "ServiceImpl" between the RPC and storage layers. This allows things like workflow to call the same business logic as the RPC layer, including validation. Lots of test fixes. * Then I finished the Create() and Update() paths for Actor. Those represent the "right" (or closest to) way to implement resources, and tests for validation. I strongly encourage reviewers to read it commit-by-commit. Rebasing this is VERY tedious, so the sooner it lands or dies completely, the better. Then we can start converting the rest. `./hack/run-tool.sh validation-gen --docs` will produce some docs on the tool and the available tags. @laoj2 @juli4n @EItanya @HavenXia @lalitc375 @yongruilin @jpbetz FYI
51 lines
2.0 KiB
Go
51 lines
2.0 KiB
Go
// SPDX-FileCopyrightText: Copyright (c) 2015-2025 go-swagger maintainers
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package jsonpointer
|
|
|
|
import "reflect"
|
|
|
|
// JSONPointable is an interface for structs to implement, when they need to customize the json
|
|
// pointer process or want to avoid the use of reflection.
|
|
type JSONPointable interface {
|
|
// JSONLookup returns a value pointed at this (unescaped) key.
|
|
JSONLookup(key string) (any, error)
|
|
}
|
|
|
|
// JSONSetable is an interface for structs to implement, when they need to customize the json
|
|
// pointer process or want to avoid the use of reflection.
|
|
//
|
|
// # Handling of the RFC 6901 "-" token
|
|
//
|
|
// When a type implementing JSONSetable is the terminal parent of a [Pointer.Set] call, the library
|
|
// passes the raw reference token to JSONSet without interpretation.
|
|
//
|
|
// In particular, the RFC 6901 "-" token (which conventionally means "append" for arrays, per RFC
|
|
// 6902) is forwarded verbatim as the key argument.
|
|
//
|
|
// Implementations that model an array-like container are expected to give "-" the append semantics;
|
|
// implementations that do not should return an error wrapping [ErrDashToken] (or [ErrPointer]) for
|
|
// clarity.
|
|
//
|
|
// Implementations are responsible for any in-place mutation: the library does not attempt to rebind
|
|
// the result of JSONSet into a parent container.
|
|
type JSONSetable interface {
|
|
// JSONSet sets the value pointed at the (unescaped) key.
|
|
//
|
|
// The key may be the RFC 6901 "-" token when the pointer targets a slice-like member; see the
|
|
// interface documentation for details.
|
|
JSONSet(key string, value any) error
|
|
}
|
|
|
|
// NameProvider knows how to resolve go struct fields into json names.
|
|
//
|
|
// The default provider is brought by
|
|
// [github.com/go-openapi/jsonpointer/jsonname.DefaultJSONNameProvider].
|
|
type NameProvider interface {
|
|
// GetGoName gets the go name for a json property name
|
|
GetGoName(subject any, name string) (string, bool)
|
|
|
|
// GetGoNameForType gets the go name for a given type for a json property name
|
|
GetGoNameForType(tpe reflect.Type, name string) (string, bool)
|
|
}
|