Add version_constant and check from generated code #274
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DennisSSDev
approved these changes
Sep 15, 2020
| t.P(`// is compatible with the twirp package used in your project.`) | ||
| t.P(`// A compilation error at this line likely means your copy of the`) | ||
| t.P(`// twirp package needs to be updated.`) | ||
| t.P(`const _ = `, t.pkgs["twirp"], `.TwirpPackageIsVersion7`) |
There was a problem hiding this comment.
This seems very similar to the protobuf assertion line, so I think this is a good idea to add so we can also validate the twirp version. LGTM!
marioizquierdo
deleted the
version_constant_for_backwards_compatibility
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The PR #264 includes new server options in the
twirppackage that are used by the generated code. If theprotoc-gen-twirpplugin used to generate code uses the latest version, but thetwirppackage in the project is an older version, the generated code will fail with a compile-time error. Without this constant, the error is something likeclientOpts.PathPrefix() function does not exist. With this constant, the error is more descriptive, liketwirp.TwirpPackageIsVersion7 does not exist, which better points to the solution.This pattern is similar to protobuf generated code, that uses compile-time assertions like
proto.ProtoPackageIsVersion4to make sure the right version of the proto library is included in the destination project.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.