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

Allow usage of toEventually with async expressions #1039

Merged
merged 3 commits into from
Mar 29, 2023

Conversation

younata
Copy link
Member

@younata younata commented Mar 28, 2023

  • Provide expecta to allow autoclosures with async expressions.
  • Provide expects to allow you to force synchronous expectations in Nimble.

Changes to the readme also documents this.

basically, this now allows the following code:

await expect { await someAsyncFunction() }.toEventually(equal(someValue))

await expecta(await someAsyncFunction()).to(equal(someValue))

toEventually will continuously call (and wait for) the expression passed in to evaluate, it's just now compatible with async expressions. It does kick off a new task each time it polls. This is due to the fact that toEventually uses dispatch queues under the hood, and dispatch queues are always synchronous contexts. If the expression you're verifying needs to run on the main thread, you'll likely have to force it to do so. Either by marking the test itself as running on the main thread, or by marking the expression as running on the main thread, like so:

@MainActor func test_something() async {
    await expect { await someFunctionThatMustRunOnTheMainThread() }.toEventually(equal(someValue))
}

func test_something() async {
    await expect { @MainActor in await someFunctionThatMustRunOnTheMainThread() }.toEventually(equal(someValue))
}

Predicates are unchanged. This implementation converts the async expression to a synchronous expression as part of the to/toNot/toEventually ... call. This does mean that a large amount of operator overloads are now duplicated, because we need to do the awaiting as part of the operator, and this change does break operator overloads for anyone else using this.

Provide expecta to allow autoclosures with async expressions.
Provide expects to allow you to force synchronous expectations in Nimble
@younata younata added this to the v12.0.0 milestone Mar 28, 2023
@younata younata merged commit 734b59e into main Mar 29, 2023
@younata younata deleted the async_expressions_in_toEventually branch March 29, 2023 04:00
renovate bot added a commit to cgrindel/rules_swift_package_manager that referenced this pull request Jul 7, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [Quick/Nimble](https://togithub.com/Quick/Nimble) | major | `from:
"10.0.0"` -> `from: "v12.0.1"` |

---

### Release Notes

<details>
<summary>Quick/Nimble (Quick/Nimble)</summary>

### [`v12.0.1`](https://togithub.com/Quick/Nimble/releases/tag/v12.0.1)

[Compare
Source](https://togithub.com/Quick/Nimble/compare/v12.0.0...v12.0.1)

#### What's Changed

- Fix wasm build by [@&#8203;ikesyo](https://togithub.com/ikesyo) in
[Quick/Nimble#1053
- Bump cocoapods from 1.12.0 to 1.12.1 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[Quick/Nimble#1054
- Bump swiftwasm/swiftwasm-action from 5.7 to 5.8 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[Quick/Nimble#1057
- Make the async version of poll concurrency-safe by wrapping it in an
actor by [@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1059
- cast an empty array to avoid a warning during compile time by
[@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1060

**Full Changelog**:
Quick/Nimble@v12.0.0...v12.0.1

### [`v12.0.0`](https://togithub.com/Quick/Nimble/releases/tag/v12.0.0)

[Compare
Source](https://togithub.com/Quick/Nimble/compare/v11.2.2...v12.0.0)

Nimble 12 adds the ability to using polling expectations with async
expressions. Additionally, Nimble 12 includes a number of
quality-of-life improvements and bug fixes.

#### What's Changed

- Update the README to have an accurate usage of expect by
[@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1038
- Allow usage of toEventually with async expressions by
[@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1039
- Replace public usage of DispatchTimeInterval with a new
NimbleTimeInterval by [@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1042
- Make NimbleTimeInterval.dispatchTimeInterval public by
[@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1043
- Run SyncExpectation's expression in async contexts of toEventually on
the main actor. by [@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1044
- satisfyAllOf and satisfyAnyOf should only evaluate the expression
once. by [@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1045
- Rename AsyncDefaults to PollingDefaults by
[@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1023
- Fixed Swift.package: added macCatalyst to the condition for
CwlPreconditionTesting dependency by
[@&#8203;uebelack](https://togithub.com/uebelack) in
[Quick/Nimble#1048
- Raise minimum watchos deployment target to 7.0 by
[@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1050
- Feature/handle multithreaded notifications by
[@&#8203;johnmckerrell](https://togithub.com/johnmckerrell) and
[@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1051
- Objective-C support in the Swift Package version by
[@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1005
- Update documentation in preparation for Nimble 12 by
[@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1052

#### New Contributors

- [@&#8203;uebelack](https://togithub.com/uebelack) made their first
contribution in
[Quick/Nimble#1048
- [@&#8203;johnmckerrell](https://togithub.com/johnmckerrell) made their
first contribution in
[Quick/Nimble#1051

**Full Changelog**:
Quick/Nimble@v11.2.2...v12.0.0

### [`v11.2.2`](https://togithub.com/Quick/Nimble/releases/tag/v11.2.2)

[Compare
Source](https://togithub.com/Quick/Nimble/compare/v11.2.1...v11.2.2)

### Highlights

Nimble v11.2.2 is a minor bug fix release which fixes the build on Xcode
14.3 and Wasm.

Thanks to [@&#8203;dymv](https://togithub.com/dymv) for fixing the Xcode
14.3 build and to [@&#8203;ikesyo](https://togithub.com/ikesyo) for
fixing the wasm build!

### Autogenerated Changelog

#### What's Changed

- Bump activesupport from 6.1.5 to 6.1.7.1 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[Quick/Nimble#1029
- Bump cocoapods from 1.11.3 to 1.12.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[Quick/Nimble#1032
- Fixes the build on Xcode 14.3b2 by
[@&#8203;dymv](https://togithub.com/dymv) in
[Quick/Nimble#1033
- Bump activesupport from 7.0.4.2 to 7.0.4.3 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[Quick/Nimble#1034
- Fix wasm build by [@&#8203;ikesyo](https://togithub.com/ikesyo) in
[Quick/Nimble#1036

#### New Contributors

- [@&#8203;dymv](https://togithub.com/dymv) made their first
contribution in
[Quick/Nimble#1033

**Full Changelog**:
Quick/Nimble@v11.2.1...v11.2.2

### [`v11.2.1`](https://togithub.com/Quick/Nimble/releases/tag/v11.2.1)

[Compare
Source](https://togithub.com/Quick/Nimble/compare/v11.2.0...v11.2.1)

Fixed tripping the main thread checker in async `toEventually` checks.
Your CI should no longer report that tests erroneously crashed because
the expression's `debugDescription` dared to reference something that
needed to run on the main thread.

#### What's Changed

- Add documentation on recommended ways to configure AsyncDefaults by
[@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1022
- Ensure that stringify'ing an expression as part of the async/await
polling infrastructure always happens on the main thread by
[@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1024

**Full Changelog**:
Quick/Nimble@v11.2.0...v11.2.1

### [`v11.2.0`](https://togithub.com/Quick/Nimble/releases/tag/v11.2.0)

[Compare
Source](https://togithub.com/Quick/Nimble/compare/v11.1.1...v11.2.0)

Improved developer experience by allowing you to use the sync form of
`expect` in a test that has other usage of async test. i.e. the
following code compiles again:

```swift
class MyTest: XCTestCase {
    func testExample() {
        await someAsyncFunction()
        expect(someValue).to(equal(expectedValue))
    }
}
```

#### What's Changed

- Remove autoclosure tag with async expectations by
[@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1020

**Full Changelog**:
Quick/Nimble@v11.1.1...v11.2.0

### [`v11.1.1`](https://togithub.com/Quick/Nimble/releases/tag/v11.1.1)

[Compare
Source](https://togithub.com/Quick/Nimble/compare/v11.1.0...v11.1.1)

#### What's Changed

- Fix regression where named tuples could not be compared with unnamed
tuples of the same types using the == operator by
[@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1017
- Use uncached expression in the async versions of toEventually by
[@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1018

**Full Changelog**:
Quick/Nimble@v11.1.0...v11.1.1

### [`v11.1.0`](https://togithub.com/Quick/Nimble/releases/tag/v11.1.0)

[Compare
Source](https://togithub.com/Quick/Nimble/compare/v11.0.0...v11.1.0)

11.1.0 **drops support** for Swift 5.6 (you must use Xcode 14 or later).
[Quick/Nimble#1009

11.1.0 fixes a developer experience bug where you could unknowingly use
the sync version of `toEventually` in an async context, which will cause
test timeout failures.
[Quick/Nimble#1010

That is, the following test method (XCTest-style) would compile with no
errors or warnings emitted, but fail at test runtime due to timeout
issues. In v11.1.0, this now emits a warning that you're using the wrong
version of `toEventually` (and similar).

```swift
@&#8203;MainActor func testSomething() async {
    expect(1).toEventually(equal(1)) // (in v11.0.0, this would not emit any kind of warning or error, but would definitely fail with a timeout error)
}
```

**Full Changelog**:
Quick/Nimble@v11.0.0...v11.1.0

### [`v11.0.0`](https://togithub.com/Quick/Nimble/releases/tag/v11.0.0)

[Compare
Source](https://togithub.com/Quick/Nimble/compare/v10.0.0...v11.0.0)

This closes the [v11.0.0
milestone](https://togithub.com/Quick/Nimble/milestone/12).

### Highlights

Primarily, this release now supports running tests in async contexts.

#### Fixed

- `toEventually` et. al. now works from background threads.
[Quick/Nimble#1000
- `toEventually` et. al. now work in async tests.
[Quick/Nimble#1007

#### New

- Async/await support in expectation expressions (e.g. `await
expect(await someAsyncFunction()).to(...)`).
[Quick/Nimble#1004
- `append(details:)` now respects whitespace that is in the message.
[Quick/Nimble#1001
- watchOS support.
[Quick/Nimble#916
- You can now directly check if an expectation has passed or not.
[Quick/Nimble#995

#### Breaking

- Raised version requirements to Swift 5.6, iOS 13, macOS 10.15, tvOS
13, and watchOS 6.
[Quick/Nimble#984
- The `Expectation` struct is now a protocol. There are 2 concrete
implementations, `SyncExpectation` and `AsyncExpectation`.
`AsyncExpectation` does not support `toEventually`, and is meant for
awaiting on async functions. `SyncExpectation` is effectively the older
`Expectation` implementation, and works as it used to.
[Quick/Nimble#1004

### Auto-generated release notes

#### What's Changed

- Add support for watchOS by
[@&#8203;JosephDuffy](https://togithub.com/JosephDuffy) in
[Quick/Nimble#916
- Add [@&#8203;younata](https://togithub.com/younata) to funding.yml by
[@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#994
- Expose whether an expectation has passed and provide an option to
throw by [@&#8203;bnickel](https://togithub.com/bnickel) in
[Quick/Nimble#995
- Raise minimum required OS and Swift Versions to Async-Support
versions. by [@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#999
- Don't strip whitespace from appended newlines by
[@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1001
- Allow toEventually to run on background threads by
[@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1000
- Allow using async/await in expect by
[@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1004
- Get toEventually et al working in async contexts. by
[@&#8203;younata](https://togithub.com/younata) in
[Quick/Nimble#1007

#### New Contributors

- [@&#8203;JosephDuffy](https://togithub.com/JosephDuffy) made their
first contribution in
[Quick/Nimble#916
- [@&#8203;bnickel](https://togithub.com/bnickel) made their first
contribution in
[Quick/Nimble#995

**Full Changelog**:
Quick/Nimble@v10.0.0...v11.0.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.

🔕 **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 [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/cgrindel/rules_swift_package_manager).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4xNTkuNyIsInVwZGF0ZWRJblZlciI6IjM1LjE1OS43IiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+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
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant