openconfig / ygot / 40422617514

89%

master: 89%

Build Type

Pull #1115

github

Committed by robshakir

Commit Message

ygot, ytypes: remove repeated JSON normalisation and debug allocations

`ygot` previously ran repeated JSON round-trips during RFC7951 rendering and
formatted debug strings when debug logging was off. This change removes those
redundant operations whilst preserving identical JSON output and Go types.

JSON rendering (`ygot/render.go`, `ygot/struct_validation_map.go`):
- Remove `normalizeJSONValue` calls from `structJSON` and `jsonValue`.
- Add `normalizeScalars` to `jsonOutputConfig` and `makeJSON`.
- Convert scalar values directly in `writeIETFScalarJSON` when
  `normalizeScalars` is `true` (`ConstructIETFJSON` and `MergeStructJSON`).
- Leave `normalizeScalars` set to `false` when callers serialise directly to
  JSON bytes (`Marshal7951`, `EncodeTypedValue`, and `EmitJSON`).
- Skip `nil` map, slice, pointer, and interface fields at the start of
  `structJSON` before parsing struct tags.
- Pre-size output slices in `leaflistToSlice`, `mapValuePairsToJSON`,
  `mapJSON`, `jsonSlice`, and `jsonAnnotationSlice`.

Debug logging (`util/debug.go`, `util/reflect.go`, `ytypes/*.go`):
- Add `IsDebugLibraryEnabled` and `IsDebugSchemaEnabled` helpers in
  `util/debug.go`.
- Check `debugLibrary` in `util.DbgErr` before concatenating error strings.
- Guard `DbgPrint` and `DbgSchema` calls that allocate arguments -- such as
  `pretty.Sprint` and `Schema.Path` -- when debug logging is disabled.

Tests (`util/debug_test.go`, `ytypes/unmarshal_test.go`, `ygot/render_test.go`):
- Add `ConstructIETFJSON` type-parity tests in `ygot/render_test.go`.
- Add `5%` allocation regression tests and benchmarks in `util`, `ytypes`, and
  `ygot`.

Pull Request Pull Request #1115: ygot, ytypes: remove repeated JSON normalisation and debug allocations

Coverage Stats

138 of 220 new or added lines in 10 files covered. (62.73%)

12 existing lines in 2 files now uncovered.

14199 of 16080 relevant lines covered (88.3%)

1678.3 hits per line