fix: Consistently apply lowerCaseServiceMethods=true #332
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
stephenh
approved these changes
Jul 11, 2021
| * @param obj The object to check | ||
| * @param constructor The constructor of the class to check | ||
| */ | ||
| export function assertInstanceOf<T>(obj: unknown, constructor: { new (...args: any[]): T }): asserts obj is T { |
There was a problem hiding this comment.
This is a pretty neat approach!
stephenh
pushed a commit
that referenced
this pull request
Jul 11, 2021
## [1.82.1](v1.82.0...v1.82.1) (2021-07-11) ### Bug Fixes * Consistently apply lowerCaseServiceMethods=true ([#332](#332)) ([57f2473](57f2473))
|
🎉 This PR is included in version 1.82.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Fixes #310.
The lowerCaseServiceMethods option was inconsistently applied, for example, it was being applied for nestjs but not for
grpc-web. It was also not applied to auto-generated batching methods, leading to inconsistent output and typescript compilation errors.This PR aims to address these issues by replacing all
MethodDescriptorProtoobjects with a new classFormattedMethodDescriptor. This class implementsMethodDescriptorProtoand copies all properties verbatim, so existing usage is not impacted in any way. However, an additional field,formattedName, is added which applies any formatting rules in theOptionsto the original method name. I expect that this pattern could be used in other areas where we want to conditionally format strings and other values.In order to not refactor the whole application to expect a
FormattedMethodDescriptorin place of aMethodDescriptorProto, areas which require access to theformattedNameproperty simplyassertthat the methodDescriptor is an instance ofFormattedMethodDescriptor, which should always succeed because they are all converted inmain. Code that doesn't use this new property does not need to know about the new class at all, and works as normal.Testing
Integration tests are setup to validate that the option produces a lower case implementation, but preserves the original name internally. It also validates the behavior works as expected for batch functions.