Swift: Wire initializer refactor #2561
Merged
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
dnkoutso
approved these changes
Aug 16, 2023
|
|
efirestone
approved these changes
Aug 16, 2023
| public init( | ||
| seconds: Int64, | ||
| nanos: Int32, | ||
| configure: (inout Self) -> Void = { _ in } |
There was a problem hiding this comment.
Is there value in having the configure block if all of the fields are required? (Or if there are no fields, like the OneOfOptions below?)
| #if WIRE_INCLUDE_MEMBERWISE_INITIALIZER | ||
| extension Dinosaur { | ||
|
|
||
| @_disfavoredOverload |
There was a problem hiding this comment.
hehe I realized I would need it immediately for a bunch of types 🙂
| @@ -255,7 +259,7 @@ class SwiftGenerator private constructor( | |||
| fileMembers: MutableList<FileMemberSpec>, | |||
| ): List<TypeSpec> { | |||
| val structType = type.typeName | |||
| val oneOfEnumNames = type.oneOfs.associateWith { structType.nestedType(it.name.capitalize(US)) } | |||
There was a problem hiding this comment.
This fixes a deprecation warning that Kotlin keeps yelling about.
| return | ||
| } | ||
|
|
||
| val memberwiseExtension = ExtensionSpec.builder(structType) |
There was a problem hiding this comment.
Maybe add a comment noting we want to remove this, but it's left in temporarily for compatibility.
| @@ -180,13 +189,26 @@ public struct Form { | |||
|
|
|||
| public var unknownFields: Foundation.Data = .init() | |||
|
|
|||
| public init() { | |||
| public init(configure: (inout Self) -> Void = { _ in }) { | |||
There was a problem hiding this comment.
Yeah, we should remove the configure if there are no params.
github-merge-queue bot
referenced
this pull request
in slackhq/foundry
Aug 21, 2023
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [com.squareup.wire:wire-gradle-plugin](https://togithub.com/square/wire) | dependencies | patch | `4.8.0` -> `4.8.1` | --- ### ⚠ Dependency Lookup Warnings ⚠ Warnings were logged while processing this repo. Please check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>square/wire (com.squareup.wire:wire-gradle-plugin)</summary> ### [`v4.8.1`](https://togithub.com/square/wire/blob/HEAD/CHANGELOG.md#Version-481) [Compare Source](https://togithub.com/square/wire/compare/4.8.0...4.8.1) *2023-08-17* - New: Swift messages now have the form `init(REQUIRED FIELDS, (inout Storage) -> Void)` - New: Swift, the member-wise initializer has been removed by default. It can be re-enabled by defining `WIRE_INCLUDE_MEMBERWISE_INITIALIZER`; however, it will be removed in November 2024. See [https://github.com/square/wire/pull/2561](https://togithub.com/square/wire/pull/2561) for details - Fix: Correctly define sources folders vs. resources folders for Wire generated code. - Fix: Generated `.proto` are correctly added to the built artifact. - New: All options of KotlinTarget available on CLI. </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://togithub.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi41Mi4yIiwidXBkYXRlZEluVmVyIjoiMzYuNTIuMiIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->
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.
This removes the member-wise initializer by default.
There's two reasons for this:
Instead of a member wise initializer, this exposes a configuration closure for any optional parameters.
There's still guaranteed type safety as all
requiredparameters must have initialized values.Note
Memberwise initializers should now be considered deprecated and will be removed in the near future (for example, November 2023)
TODO:
configurewhen it's irrelevant