pomerium / pomerium / 21443506677

44%

Build Type

push

github

Committed by web-flow

Commit Message

core/protoutil: implement sorting of arbitrary protobuf messages (#6064)

## Summary
Add support for sorting a slice of arbitrary protobuf messages.

This is implemented via field masks. Each field mask path is used to
reference a field of a protobuf message. For example, with:

```proto
message Example {
  string id   = 1;
  string name = 2;
}
```

You can use a field mask path of `name` to sort a list of `Example`
messages by name. Sorting of scalar types uses the standard
`cmp.Compare` function, as well as `bytes.Compare` for `[]byte`,
duration and timestamp support, and `proto.Marshal` for any other
message type. A final repeated field is supported by comparing lists of
values.

The field mask path can support embedded messages. For example, with:

```proto
message Inner {
  string name = 1;
}
message Outer {
  Inner inner = 1;
}
```

You can use a field mask path of `inner.name` to sort a list of `Outer`
messages. A repeated inner message is not supported, nor are map types,
though support for these could probably be added in the future.

## Related issues
-
[ENG-3495](https://linear.app/pomerium/issue/ENG-3495/corestorage-implement-arbitrary-sorting-for-protobuf-messages)


## Checklist

- [x] reference any related issues
- [x] updated unit tests
- [x] add appropriate label (`enhancement`, `bug`, `breaking`,
`dependencies`, `ci`)
- [x] ready for review

Run Details

118 of 180 new or added lines in 2 files covered. (65.56%)

28 existing lines in 6 files now uncovered.

30887 of 67117 relevant lines covered (46.02%)

105.89 hits per line