[video_player] Convert iOS unit tests to Swift

[stuartmorgan-g]

Converts all of the native unit tests in video_player_avfoundation to Swift:

• For the UI integration tests, it's just a direct Swift conversion.
• For the unit tests, I first did a direct conversion to Swift, including ensuring that everything passed in that version, then converted from XCTest to Swift Testing.

To minimize churn, I deliberately didn't address other technical debt in the tests (e.g., testing of player instances by making an entire plugin instance just to make a player). Some changes were necessary though:

• Added some missing NS_ASSUME_NONNULL_BEGIN annotations to headers, to avoid having to deal with optional values in the Swift version of tests that couldn't ever actually be null.
• Changed a utility method to take the necessary parts of AVAssetTrack instead of AVAssetTrack. The tests for that worked by subclassing AVAssetTrack even though it has no public initializers, which was extremely sketchy. It worked okay in Obj-C because Obj-C will let you get away with almost anything, but it doesn't compile in Swift.
• Some tests that used Expectations to watch for KVO on player items extracted from the player internals have instead been changed to watch for player-level observable events. This is because I was having a lot of trouble getting KVO of AVPlayerItem to actually work in Swift, and rather than try to fix that when it wasn't great test design anyway, I just changed to using something that wasn't an internal detail anyway.

Part of flutter/flutter#119105

Pre-Review Checklist

• I read the Contributor Guide and followed the process outlined there for submitting PRs.
• I read the Tree Hygiene page, which explains my responsibilities.
• I read and followed the relevant style guides and ran the auto-formatter.
• I signed the CLA.
• The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
• I linked to at least one issue that this PR fixes in the description above.
• I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or I have commented below to indicate which version change exemption this PR falls under¹.
• I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style, or I have commented below to indicate which CHANGELOG exemption this PR falls under¹.
• I updated/added any relevant documentation (doc comments with ///).
• I added new tests to check the change I am making, or I have commented below to indicate which test exemption this PR falls under¹.
• All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

Footnotes

1. Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩² ↩³

[stuartmorgan-g]

It may be useful for review to look at the changes before ec4b403 first, to see the more direct conversion, and then review ec4b403 separately to see what I had to change for Swift Testing.

[hellohuanlin]

This and other places in this file: if videoPlayerDidInitialize is not called, the test suite would get stuck (rather than marking this test as failure and continuing).

SwiftTesting has a time limit trait: https://developer.apple.com/documentation/testing/trait/timelimit(_:), but it's iOS 16+ only.

Google search sends me to https://www.donnywals.com/implementing-task-timeout-with-swift-concurrency. I cleaned up the code and updated it for Swift 6:

enum TestError: Error {
  case timeout
}

func withTimeout(seconds: TimeInterval, operation: @escaping @Sendable () async throws -> Void) async throws {
  try await withThrowingTaskGroup(of: Void.self) { group in
    group.addTask { try await operation() }
    group.addTask {
      try await Task.sleep(nanoseconds: UInt64(seconds * 1_000_000_000))
      throw TestError.timeout
    }
    
    defer { group.cancelAll() }
    try await group.next()!
  }
}

Then in the test:

    try await withTimeout(seconds: 5) {
      await withCheckedContinuation { continuation in
        listener.onInitialized {
          continuation.resume()
        }
      }
    }

I verified it working by adding a sleep:

    try await withTimeout(seconds: 5) {
      try await Task.sleep(nanoseconds: 10 * 1_000_000_000)
      // ...
    }

[stuartmorgan-g]

Flutter style guidance is not to use timeouts, because timeouts are a source of flake. IIRC we used them with XCTest expectations because there wasn't a version without a timeout.

If a test hangs, then it will eventually fail in CI, and locally it's pretty obviously not working. What's the argument for adding timeouts here?

[hellohuanlin]

Oh nvm, i thought we use timeouts when using expectation API.

[hellohuanlin]

Oh nvm, i thought we use timeouts when using expectation API.

Oh i misread - we do use timeout in objc.

IIRC we used them with XCTest expectations because there wasn't a version without a timeout.

Gotcha. Good to know. I thought it was an explicit decision to make test fail faster. If we have the guideline i'm onboard.