goprotobuf v1.4.0-rc.2 Release Notes

Release Date: 2020-02-29 // over 1 year ago
  • Overview

    πŸš€ This release of the module introduces a number of significant changes relative to the previous minor release. In particular, this module is now implemented in terms of the new module, which is the next major revision of Go bindings for protocol buffers. From this point onwards, most of the development effort for Go protobufs will be dedicated to the new module, with minimal changes being made to this module.

    πŸš€ See the release notes for the new module for specific implementation details that may affect this release.

    Backwards compatibility

    πŸš€ This release maintains backwards compatibility with previous releases of this module. Any observable changes in behavior are to fix bugs, change unspecified behavior, or to make behavior more compliant with the protobuf specification. The compatibility document provides us the freedom to make changes in these areas.

    Notable changes

    Wire serialization

    πŸš€ Wire serialization is now implemented in terms of the new proto package by calling out to the relevant functionality in that package (e.g., proto.Marshal and proto.Unmarshal). There should be no observable changes in behavior other what is mentioned elsewhere in the release notes (e.g., behavior around errors or nil values).

    JSON and text serialization

    πŸš€ The JSON and text format implementations have been ported to use protobuf reflection under the hood instead of relying on Go reflection. This provides flexibility as they can operate on any concrete message type that properly implements the new proto.Message interface.

    The implementations do not use the new protojson or prototext packages in order to maintain a higher degree of backwards compatibility. Our analysis unfortunately showed us that too many tests rely on their output being stable by performing byte-for-byte comparisons. Even though the compatibility promise gives us the freedom to change the output, we have chosen not to do so for pragmatic reasons. The implementations are now functionally frozen (bugs and all) and will not receive future improvements. Users are encouraged to migrate to the protojson or prototext packages instead.

    Well-known types

    πŸ“¦ The well-known types declared under ptypes are moved to the module. The packages continue to exist, but all declarations forward to ones in the new module.

    πŸš€ For a period of time, it is expected that the protoc-gen-go plugin continues to generate code with dependencies on the well-known types in this module. The import paths for the well-known types are determined by the go_package option specified in the .proto files. Since these files are managed by the main protocol buffers project, it will require a new release of the protobuf toolchain before the new import paths take effect. Depending on this module’s packages for well-known types is fine since they simply forward over to the new packages.

    πŸ“¦ While descriptor and plugin are not packages for well-known types, they too have also been moved to the new module.

    Types registry

    πŸ“¦ In order for dynamic usages of protobufs to operate correctly, there must be a unified registry between this module and the new module. The protoregistry package is the primary registry for all protobuf files that are linked into a Go program. The registration functions (e.g., proto.RegisterType) in this package forward to the global registries in that module, and the lookup functions (e.g., proto.MessageType) in this package source from the global registry in that module.

    Nil values

    πŸš€ Use of the module for the underlying implementation means that semantics for nil values may have changed. See that module’s release notes for details.


    πŸš€ A consequence of using the module as the underlying implementation means that the text for some errors may change in trivial ways. This may break brittle tests depending on the error message. See that module’s release notes for details.

    Generated code

    πŸš€ The protoc-gen-go plugin in this module is now a thin wrapper over the protoc-gen-go plugin in the module. As a result, there are many changes to the generated code. See that module’s release notes for details. Users should migrate to use the new protoc-gen-go plugin instead of the old one. Code generated by either plugin should be compatible with either module.

    πŸš€ For backward compatibility purposes, the protoc-gen-go plugin in this module continues to support generation of gRPC bindings, while the protoc-gen-go plugin in the new module does not.

    Upcoming breakage changes

    Per the compatibility agreement for Go protobufs, we promise to make announcements about deliberate or potentially breaking changes 6 months in advance.

    πŸš€ None of these changes are effective yet in this release.

    πŸ—„ Deprecation of Descriptor methods

    πŸš€ The Descriptor methods on generated messages are deprecated and may be removed in the future.

    πŸ—„ The descriptor.Message type is deprecated as fewer and fewer message types in the future will implement the descriptor.Message interface. Existing usages should migrate to the new proto.Message interface.

    πŸš€ The descriptor.ForMessage function is also deprecated. Users should migrate the code to use protobuf reflection to access descriptor information.

    πŸ“¦ Removal of generator package

    πŸš€ The generator package is an internal implementation detail of protoc-gen-go and existed before the internal package mechanism. It has long been exempt from the compatibility promise. A future release of this module will remove the package. Existing users must migrate to the new compiler/protogen package, which is a stable API for implementing protoc plugins, or fork the existing generator package.

    πŸš€ Similarly, the grpc package is also an internal implementation detail of protoc-gen-go and will also be deleted in a future release of this module.