Skip to content
This repository was archived by the owner on Feb 22, 2023. It is now read-only.

Forbid ... implements UrlLauncherPlatform #2230

Merged
merged 3 commits into from
Oct 23, 2019
Merged

Forbid ... implements UrlLauncherPlatform #2230

merged 3 commits into from
Oct 23, 2019

Conversation

@amirh
Copy link
Contributor

@amirh amirh commented Oct 23, 2019

Description

Fail setting UrlLauncherPlatform.instance to something that implements (rather than extends) UrlLauncherPlatform.

I'm not bumping the major version as the breaking change policy for platform interface is that we're only guaranteeing to not break classes that extend it.

We leave a backdoor for mockito mocks which can do:

class MockUrlLauncherPlatform extends Mock
    implements UrlLauncherPlatform {}

test('', () {
  MockUrlLauncherPlatform mock = MockUrlLauncherPlatform();
  when(mock.isMock).thenReturn(true);
  UrlLauncherPlatform.instance = mock;
}

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

  • I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
  • My PR includes unit or integration tests for all changed/updated/fixed behaviors (See [Contributor Guide]).
  • All existing and new tests are passing.
  • I updated/added relevant documentation (doc comments with ///).
  • The analyzer (flutter analyze) does not report any problems on my PR.
  • I read and followed the [Flutter Style Guide].
  • The title of the PR starts with the name of the plugin surrounded by square brackets, e.g. [shared_preferences]
  • I updated pubspec.yaml with an appropriate new version according to the [pub versioning philosophy].
  • I updated CHANGELOG.md to add a description of the change.
  • I signed the [CLA].
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

  • Yes, this is a breaking change (please indicate a breaking change in CHANGELOG.md and increment major revision).
  • No, this is not a breaking change.

@amirh amirh mentioned this pull request Oct 23, 2019
Merged
13 tasks
@amirh amirh force-pushed the forbid_implements branch from ac24fc4 to 6c1906a Compare October 23, 2019 18:34
collinjackson
collinjackson reviewed Oct 23, 2019
View reviewed changes
...ages/url_launcher/url_launcher_platform_interface/test/method_channel_url_launcher_test.dart Outdated
}, throwsA(isInstanceOf<AssertionError>()));
});

test('Can be mocked with `implements', () {
Copy link
Contributor

@collinjackson collinjackson Oct 23, 2019

Choose a reason for hiding this comment

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

missing a backtick here

Copy link
Contributor Author

@amirh amirh Oct 23, 2019

Choose a reason for hiding this comment

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

done

...ages/url_launcher/url_launcher_platform_interface/test/method_channel_url_launcher_test.dart Outdated
UrlLauncherPlatform.instance = mock;
});

test('Can be exteneded', () {
Copy link
Contributor

@collinjackson collinjackson Oct 23, 2019

Choose a reason for hiding this comment

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

typo

Copy link
Contributor Author

@amirh amirh Oct 23, 2019

Choose a reason for hiding this comment

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

done

packages/url_launcher/url_launcher_platform_interface/lib/url_launcher_platform_interface.dart
/// 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;
Copy link
Contributor

@collinjackson collinjackson Oct 23, 2019

Choose a reason for hiding this comment

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

A lot of this functionality will be shared across many plugins. Should it be a mixin or base class?

Copy link
Contributor Author

@amirh amirh Oct 23, 2019

Choose a reason for hiding this comment

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

Filed flutter/flutter#43368 and added a TODO (we will have to wait for a stable release before we can use common framework code for this)

@amirh amirh mentioned this pull request Oct 23, 2019
Closed
@amirh amirh merged commit a68932e into flutter:master Oct 23, 2019
@amirh amirh deleted the forbid_implements branch October 23, 2019 21:06
harryterkelsen pushed a commit that referenced this pull request Oct 23, 2019
[url_launcher] Use url_launcher_platform_interface to handle calls (#…
63b4e6b 
…2228)

* [url_launcher] Use `url_launcher_platform_interface` to handle calls

* Exclude platform interface from all-plugins-app

* Update now that #2230 has landed
mormih pushed a commit to mormih/plugins that referenced this pull request Nov 17, 2019
@amirh @mormih
Forbid ... implements UrlLauncherPlatform (flutter#2230)
2259b67 
Fail setting `UrlLauncherPlatform.instance` to something that `implements` (rather than `extends`) `UrlLauncherPlatform`.

I'm not bumping the major version as the breaking change policy for platform interface is that we're only guaranteeing to not break classes that `extend` it.

We leave a backdoor for mockito mocks which can do:
```dart
class MockUrlLauncherPlatform extends Mock
    implements UrlLauncherPlatform {}

test('', () {
  MockUrlLauncherPlatform mock = MockUrlLauncherPlatform();
  when(mock.isMock).thenReturn(true);
  UrlLauncherPlatform.instance = mock;
}
```
mormih pushed a commit to mormih/plugins that referenced this pull request Nov 17, 2019
@mormih
[url_launcher] Use url_launcher_platform_interface to handle calls (f…
9400085 
…lutter#2228)

* [url_launcher] Use `url_launcher_platform_interface` to handle calls

* Exclude platform interface from all-plugins-app

* Update now that flutter#2230 has landed
Hixie
Hixie reviewed Nov 26, 2019
View reviewed changes
packages/url_launcher/url_launcher_platform_interface/lib/url_launcher_platform_interface.dart

// TODO(amirh): Extract common platform interface logic.
// https://github.com/flutter/flutter/issues/43368
static set instance(UrlLauncherPlatform instance) {
Copy link
Contributor

@Hixie Hixie Nov 26, 2019

Choose a reason for hiding this comment

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

nit: style guide gives the order for getters/setters as "getter/field/setter" with no whitespace between them

Hixie
Hixie reviewed Nov 26, 2019
View reviewed changes
packages/url_launcher/url_launcher_platform_interface/lib/url_launcher_platform_interface.dart
static set instance(UrlLauncherPlatform instance) {
if (!instance.isMock) {
try {
instance._verifyProvidesDefaultImplementations();
Copy link
Contributor

@Hixie Hixie Nov 26, 2019

Choose a reason for hiding this comment

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

this should be in an assert so it doesn't run in release builds

@Hixie
Copy link
Contributor

Hixie commented Nov 26, 2019

@goderbauer suggested that instead of having the mock implement isMock, it could implement _verifyProvidesDefaultImplementations using noSuchMethod.

@collinjackson collinjackson mentioned this pull request Nov 27, 2019
Closed
@collinjackson
Copy link
Contributor

collinjackson commented Nov 27, 2019

@goderbauer suggested that instead of having the mock implement isMock, it could implement _verifyProvidesDefaultImplementations using noSuchMethod.

@Hixie If the underlying concern here is developers ignoring the @visibleForTesting annotation I've proposed a fix for that in #2326

sungmin-park pushed a commit to sungmin-park/flutter-plugins that referenced this pull request Dec 17, 2019
@amirh
Forbid ... implements UrlLauncherPlatform (flutter#2230)
13dac5e 
Fail setting `UrlLauncherPlatform.instance` to something that `implements` (rather than `extends`) `UrlLauncherPlatform`.

I'm not bumping the major version as the breaking change policy for platform interface is that we're only guaranteeing to not break classes that `extend` it.

We leave a backdoor for mockito mocks which can do:
```dart
class MockUrlLauncherPlatform extends Mock
    implements UrlLauncherPlatform {}

test('', () {
  MockUrlLauncherPlatform mock = MockUrlLauncherPlatform();
  when(mock.isMock).thenReturn(true);
  UrlLauncherPlatform.instance = mock;
}
```
sungmin-park pushed a commit to sungmin-park/flutter-plugins that referenced this pull request Dec 17, 2019
[url_launcher] Use url_launcher_platform_interface to handle calls (f…
c96c329 
…lutter#2228)

* [url_launcher] Use `url_launcher_platform_interface` to handle calls

* Exclude platform interface from all-plugins-app

* Update now that flutter#2230 has landed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

3 more reviewers

@Hixie Hixie Hixie left review comments

@collinjackson collinjackson collinjackson approved these changes

@harryterkelsen harryterkelsen harryterkelsen approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

cla: yes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@amirh @Hixie @collinjackson @harryterkelsen @googlebot