[video_player] Remove test code from platform interface (#4589)
This is a breaking change to video_player_platform_interface to remove Pigeon mocks from the public interface. These should never have been there, as tests in packages outside of the platform interface should be mocking the platform interface rather than the method channel, but the app-facing tests weren't rewritten when they should have been so they ended up published to support the legacy tests. This creates an unwanted non-dev dependency on `flutter_test`, in addition to promoting an anti-pattern.
While making the breaking change, this also adopts `PlatformInterface`, removing `isMock` in favor of the standard mixin pattern provided by the base class.
Part of https://github.com/flutter/flutter/issues/83562
diff --git a/packages/video_player/video_player_platform_interface/CHANGELOG.md b/packages/video_player/video_player_platform_interface/CHANGELOG.md
index b3da9c8..e0e6a11 100644
--- a/packages/video_player/video_player_platform_interface/CHANGELOG.md
+++ b/packages/video_player/video_player_platform_interface/CHANGELOG.md
@@ -1,3 +1,11 @@
+## 5.0.0
+
+* **BREAKING CHANGES**:
+ * Updates to extending `PlatformInterface`. Removes `isMock`, in favor of the
+ now-standard `MockPlatformInterfaceMixin`.
+ * Removes test.dart from the public interface. Tests in other packages should
+ mock `VideoPlatformInterface` rather than the method channel.
+
## 4.2.0
* Add `contentUri` to `DataSourceType`.
diff --git a/packages/video_player/video_player_platform_interface/lib/video_player_platform_interface.dart b/packages/video_player/video_player_platform_interface/lib/video_player_platform_interface.dart
index 21ad972..66b6d70 100644
--- a/packages/video_player/video_player_platform_interface/lib/video_player_platform_interface.dart
+++ b/packages/video_player/video_player_platform_interface/lib/video_player_platform_interface.dart
@@ -2,12 +2,9 @@
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
-import 'dart:async';
-import 'dart:ui';
-
import 'package:flutter/foundation.dart';
import 'package:flutter/widgets.dart';
-import 'package:meta/meta.dart' show visibleForTesting;
+import 'package:plugin_platform_interface/plugin_platform_interface.dart';
import 'method_channel_video_player.dart';
@@ -18,37 +15,24 @@
/// (using `extends`) ensures that the subclass will get the default implementation, while
/// platform implementations that `implements` this interface will be broken by newly added
/// [VideoPlayerPlatform] methods.
-abstract class VideoPlayerPlatform {
- /// Only mock implementations should set this to true.
- ///
- /// Mockito mocks are implementing this class with `implements` which is forbidden for anything
- /// other than mocks (see class docs). This property provides a backdoor for mockito mocks to
- /// skip the verification that the class isn't implemented with `implements`.
- @visibleForTesting
- bool get isMock => false;
+abstract class VideoPlayerPlatform extends PlatformInterface {
+ /// Constructs a VideoPlayerPlatform.
+ VideoPlayerPlatform() : super(token: _token);
+
+ static final Object _token = Object();
static VideoPlayerPlatform _instance = MethodChannelVideoPlayer();
/// The default instance of [VideoPlayerPlatform] to use.
///
- /// Platform-specific plugins should override this with their own
- /// platform-specific class that extends [VideoPlayerPlatform] when they
- /// register themselves.
- ///
/// Defaults to [MethodChannelVideoPlayer].
static VideoPlayerPlatform get instance => _instance;
- // TODO(amirh): Extract common platform interface logic.
- // https://github.com/flutter/flutter/issues/43368
+ /// Platform-specific plugins should override this with their own
+ /// platform-specific class that extends [VideoPlayerPlatform] when they
+ /// register themselves.
static set instance(VideoPlayerPlatform instance) {
- if (!instance.isMock) {
- try {
- instance._verifyProvidesDefaultImplementations();
- } on NoSuchMethodError catch (_) {
- throw AssertionError(
- 'Platform interfaces must not be implemented with `implements`');
- }
- }
+ PlatformInterface.verifyToken(instance, _token);
_instance = instance;
}
@@ -119,14 +103,6 @@
Future<void> setMixWithOthers(bool mixWithOthers) {
throw UnimplementedError('setMixWithOthers() has not been implemented.');
}
-
- // This method makes sure that VideoPlayer isn't implemented with `implements`.
- //
- // See class doc for more details on why implementing this class is forbidden.
- //
- // This private method is called by the instance setter, which fails if the class is
- // implemented with `implements`.
- void _verifyProvidesDefaultImplementations() {}
}
/// Description of the data source used to create an instance of
diff --git a/packages/video_player/video_player_platform_interface/pubspec.yaml b/packages/video_player/video_player_platform_interface/pubspec.yaml
index 35b3079..b840477 100644
--- a/packages/video_player/video_player_platform_interface/pubspec.yaml
+++ b/packages/video_player/video_player_platform_interface/pubspec.yaml
@@ -4,7 +4,7 @@
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+video_player%22
# NOTE: We strongly prefer non-breaking changes, even at the expense of a
# less-clean API. See https://flutter.dev/go/platform-interface-breaking-changes
-version: 4.2.0
+version: 5.0.0
environment:
sdk: ">=2.12.0 <3.0.0"
@@ -13,9 +13,9 @@
dependencies:
flutter:
sdk: flutter
- flutter_test:
- sdk: flutter
- meta: ^1.3.0
+ plugin_platform_interface: ^2.0.0
dev_dependencies:
+ flutter_test:
+ sdk: flutter
pedantic: ^1.10.0
diff --git a/packages/video_player/video_player_platform_interface/test/method_channel_video_player_test.dart b/packages/video_player/video_player_platform_interface/test/method_channel_video_player_test.dart
index f5439b8..4d1c9b7 100644
--- a/packages/video_player/video_player_platform_interface/test/method_channel_video_player_test.dart
+++ b/packages/video_player/video_player_platform_interface/test/method_channel_video_player_test.dart
@@ -8,9 +8,10 @@
import 'package:flutter_test/flutter_test.dart';
import 'package:video_player_platform_interface/messages.dart';
import 'package:video_player_platform_interface/method_channel_video_player.dart';
-import 'package:video_player_platform_interface/test.dart';
import 'package:video_player_platform_interface/video_player_platform_interface.dart';
+import 'test.dart';
+
class _ApiLogger implements TestHostVideoPlayerApi {
final List<String> log = [];
TextureMessage? textureMessage;
diff --git a/packages/video_player/video_player_platform_interface/lib/test.dart b/packages/video_player/video_player_platform_interface/test/test.dart
similarity index 98%
rename from packages/video_player/video_player_platform_interface/lib/test.dart
rename to packages/video_player/video_player_platform_interface/test/test.dart
index b4fd81f..a12ae45 100644
--- a/packages/video_player/video_player_platform_interface/lib/test.dart
+++ b/packages/video_player/video_player_platform_interface/test/test.dart
@@ -10,8 +10,7 @@
import 'dart:typed_data' show Uint8List, Int32List, Int64List, Float64List;
import 'package:flutter/services.dart';
import 'package:flutter_test/flutter_test.dart';
-
-import 'messages.dart';
+import 'package:video_player_platform_interface/messages.dart';
abstract class TestHostVideoPlayerApi {
void initialize();
