Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make EventLoopPromise conform to Equatable #2714

Merged
merged 3 commits into from
Jul 31, 2024
Merged

Conversation

gjcairo
Copy link
Contributor

@gjcairo gjcairo commented May 3, 2024

This PR conforms EventLoopPromise to the Equatable protocol.

Motivation:

EventLoopPromise is not currently Equatable, whereas the underlying EventLoopFuture is.
For consistency, it makes sense for EventLoopPromise to conform to Equatable too.

Modifications:

Conform EventLoopPromise to Equatable. This is trivial, as the only property is the underlying EventLoopFuture, which is already Equatable.

Result:

EventLoopPromise is now Equatable.

@gjcairo gjcairo requested a review from Lukasa May 3, 2024 17:18
@Lukasa Lukasa added the semver/minor Adds new public API. label May 7, 2024
Copy link
Contributor

@Lukasa Lukasa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mind adding some tests here Gus?

Copy link
Member

@dnadoba dnadoba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bad idea. Promise can change at any time, violating all requirements of Equatable, including the most basic one:
a == a is always true (Reflexivity)

we should deprecate the existing conformance.

Copy link
Member

@dnadoba dnadoba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Never mind, it is based on identity, not on the actual value of the promise which is fine.

@gjcairo gjcairo enabled auto-merge (squash) July 31, 2024 13:46
@gjcairo gjcairo merged commit de68e48 into apple:main Jul 31, 2024
27 of 28 checks passed
@gjcairo gjcairo deleted the elp-equatable branch July 31, 2024 15:25
cgrindel-self-hosted-renovate bot added a commit to cgrindel/rules_swift_package_manager that referenced this pull request Aug 19, 2024
This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [apple/swift-nio](https://github.com/apple/swift-nio) | minor |
`2.68.0` -> `2.70.0` |

---

### Release Notes

<details>
<summary>apple/swift-nio (apple/swift-nio)</summary>

###
[`v2.70.0`](https://github.com/apple/swift-nio/releases/tag/2.70.0):
SwiftNIO 2.70.0

[Compare
Source](https://github.com/apple/swift-nio/compare/2.69.0...2.70.0)

<!-- Release notes generated using configuration in .github/release.yml
at main -->

#### What's Changed

##### SemVer Minor

- `FileSystem.copyItem` can parallelise directory copy by
[@&#8203;UncleMattHope](https://github.com/UncleMattHope) in
[apple/swift-nio#2806
- `ChannelOption`: Allow types to be accessed with leading dot syntax by
[@&#8203;ayush1794](https://github.com/ayush1794) in
[apple/swift-nio#2816
- Make `EventLoopPromise` conform to Equatable by
[@&#8203;gjcairo](https://github.com/gjcairo) in
[apple/swift-nio#2714
- Provide a default `CopyStrategy` overload for copyItem. by
[@&#8203;UncleMattHope](https://github.com/UncleMattHope) in
[apple/swift-nio#2818

##### SemVer Patch

- Better align shutdown semantics of testing event loops by
[@&#8203;simonjbeaumont](https://github.com/simonjbeaumont) in
[apple/swift-nio#2800
- Clone files on Darwin rather than copying them by
[@&#8203;rnro](https://github.com/rnro) in
[apple/swift-nio#2823

##### Other Changes

- Fix compose file used in update-benchmark-thresholds script by
[@&#8203;simonjbeaumont](https://github.com/simonjbeaumont) in
[apple/swift-nio#2808
- Remove advice to generate linux tests. by
[@&#8203;PeterAdams-A](https://github.com/PeterAdams-A) in
[apple/swift-nio#2807
- Make `testInstantTCPConnectionResetThrowsError` more reliable by
[@&#8203;hamzahrmalik](https://github.com/hamzahrmalik) in
[apple/swift-nio#2810
- \[CI] Add `shellcheck` and fix up warnings by
[@&#8203;FranzBusch](https://github.com/FranzBusch) in
[apple/swift-nio#2809
- \[CI] Fix docs check by
[@&#8203;FranzBusch](https://github.com/FranzBusch) in
[apple/swift-nio#2811
- \[CI] Add Swift 6 language mode workflow by
[@&#8203;FranzBusch](https://github.com/FranzBusch) in
[apple/swift-nio#2812
- Fix test compilation on non-macOS Darwin platforms by
[@&#8203;simonjbeaumont](https://github.com/simonjbeaumont) in
[apple/swift-nio#2817
- Add `.index-build` to `.gitignore` by
[@&#8203;MaxDesiatov](https://github.com/MaxDesiatov) in
[apple/swift-nio#2819
- \[CI] Add action and workflow to check for semver label by
[@&#8203;FranzBusch](https://github.com/FranzBusch) in
[apple/swift-nio#2814
- Update repository docs for swift-version support and recent CI check
changes by [@&#8203;UncleMattHope](https://github.com/UncleMattHope)
in
[apple/swift-nio#2815
- Fix failing build for test by
[@&#8203;ayush1794](https://github.com/ayush1794) in
[apple/swift-nio#2824
- Fix typo in comment in `WebSocketErrorCodes.swift` by
[@&#8203;valeriyvan](https://github.com/valeriyvan) in
[apple/swift-nio#2604
- \[CI] Add a scheduled workflow for tests and benchmarks by
[@&#8203;FranzBusch](https://github.com/FranzBusch) in
[apple/swift-nio#2822
- \[CI] Fix label check by
[@&#8203;FranzBusch](https://github.com/FranzBusch) in
[apple/swift-nio#2827

#### New Contributors

- [@&#8203;UncleMattHope](https://github.com/UncleMattHope) made their
first contribution in
[apple/swift-nio#2806
- [@&#8203;ayush1794](https://github.com/ayush1794) made their first
contribution in
[apple/swift-nio#2816
- [@&#8203;valeriyvan](https://github.com/valeriyvan) made their first
contribution in
[apple/swift-nio#2604

**Full Changelog**:
apple/swift-nio@2.69.0...2.70.0

###
[`v2.69.0`](https://github.com/apple/swift-nio/releases/tag/2.69.0):
SwiftNIO 2.69.0

[Compare
Source](https://github.com/apple/swift-nio/compare/2.68.0...2.69.0)

<!-- Release notes generated using configuration in .github/release.yml
at main -->

#### What's Changed

##### SemVer Minor

- Add manual control to `NIOLockedValueBox` by
[@&#8203;glbrntt](https://github.com/glbrntt) in
[apple/swift-nio#2786
- ChannelHandler: provide static `(un)wrap(In|Out)bound(In|Out)` by
[@&#8203;weissi](https://github.com/weissi) in
[apple/swift-nio#2791

##### SemVer Patch

- Pre-box some errors to reduce allocations by
[@&#8203;glbrntt](https://github.com/glbrntt) in
[apple/swift-nio#2765
- Allow in-place mutation of `NIOLoopBoundBox.value` by
[@&#8203;dnadoba](https://github.com/dnadoba) in
[apple/swift-nio#2771
- Avoid creating a yield ID counter per async writer by
[@&#8203;glbrntt](https://github.com/glbrntt) in
[apple/swift-nio#2768
- Combine the two `NIOAsyncChannel` channel handlers by
[@&#8203;glbrntt](https://github.com/glbrntt) in
[apple/swift-nio#2779
- Use the new Android overlay and Bionic module from Swift 6 by
[@&#8203;finagolfin](https://github.com/finagolfin) in
[apple/swift-nio#2784
- Change `unsafeDownCast` to `as!` by
[@&#8203;FranzBusch](https://github.com/FranzBusch) in
[apple/swift-nio#2802

##### Other Changes

- CI migration to GitHub Action by
[@&#8203;FranzBusch](https://github.com/FranzBusch) in
([apple/swift-nio#2760
[apple/swift-nio#2762
[apple/swift-nio#2763
[apple/swift-nio#2764
[apple/swift-nio#2767
[apple/swift-nio#2766
[apple/swift-nio#2776
[apple/swift-nio#2780
[apple/swift-nio#2785
[apple/swift-nio#2781
[apple/swift-nio#2787
[apple/swift-nio#2783
[apple/swift-nio#2789
[apple/swift-nio#2790)
- Ignore format commit from git blame by
[@&#8203;FranzBusch](https://github.com/FranzBusch) in
[apple/swift-nio#2796
[apple/swift-nio#2797
[apple/swift-nio#2801
[apple/swift-nio#2803
- Adopt swift-format by
[@&#8203;FranzBusch](https://github.com/FranzBusch) in
[apple/swift-nio#2794
- `HTTPPart` Documentation Clarification by
[@&#8203;dimitribouniol](https://github.com/dimitribouniol) in
[apple/swift-nio#2775
- Add benchmark for creating `NIOAsyncChannel` by
[@&#8203;glbrntt](https://github.com/glbrntt) in
[apple/swift-nio#2774
- Disable warnings as errors on Swift 6 and main by
[@&#8203;glbrntt](https://github.com/glbrntt) in
[apple/swift-nio#2793

**Full Changelog**:
apple/swift-nio@2.68.0...2.69.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config help](https://github.com/renovatebot/renovate/discussions) if
that's undesired.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Renovate
Bot](https://github.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC4xOC4xIiwidXBkYXRlZEluVmVyIjoiMzguMzkuMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOltdfQ==-->

Co-authored-by: cgrindel-self-hosted-renovate[bot] <139595543+cgrindel-self-hosted-renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver/minor Adds new public API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants