Generate availability annotations #2232
Merged
Conversation
This file contains hidden or 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
Motivation: gRPC is moving from specifying the platforms in the package manifest to annotating code with availability annotations. In order to do this the generateed code must also be annotated. Modifications: - Generate appropriate annotations Result: Generated code has availability annotations
glbrntt
commented
May 6, 2025
| @@ -341,6 +353,7 @@ extension [CodeBlock] { | |||
| package static func serviceMetadata( | |||
| accessModifier: AccessModifier? = nil, | |||
| service: ServiceDescriptor, | |||
| availability: AvailabilityDescription, | |||
There was a problem hiding this comment.
API breakage is detecting a false positive here:
3 breaking changes detected in GRPCCodeGen:
💔 API breakage: func Array.serviceMetadata(accessModifier:service:namer:) has parameter 2 type change from GRPCCodeGen.Namer to GRPCCodeGen.AvailabilityDescription
💔 API breakage: func Array.serviceMetadata(accessModifier:service:namer:) has removed default argument from parameter 2
💔 API breakage: func Array.serviceMetadata(accessModifier:service:namer:) has been renamed to func serviceMetadata(accessModifier:service:availability:namer:)
gjcairo
requested changes
May 7, 2025
Comment on lines
+117
to
+122
| /// The default platform availability is: | ||
| /// - macOS 15.0 | ||
| /// - iOS 18.0 | ||
| /// - tvOS 18.0 | ||
| /// - watchOS 11.0 | ||
| /// - visionOS 2.0 |
There was a problem hiding this comment.
Can we include macCatalyst?
There was a problem hiding this comment.
macCatalyst is a derivative of iOS so it doesn't need to be included in the availability annotations (unless its availability differs from iOS).
I couldn't find authoritative documentation on this, but:
- NSHipster has an article on availability which mentions the same here
- Swift doesn't include macCatalyst in its availability macros (see here)
I also just tested this locally by building code for Mac Catalyst which only had iOS availability annotations on.
There was a problem hiding this comment.
TIL. We should reconsider what we do in other projects then, because we have added it explicitly elsewhere.
Co-authored-by: Gus Cairo <[email protected]>
gjcairo
approved these changes
May 7, 2025
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.
Motivation:
gRPC is moving from specifying the platforms in the package manifest to annotating code with availability annotations. In order to do this the generateed code must also be annotated.
Modifications:
Result:
Generated code has availability annotations