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

[flutter_plugin_tools] Add a federated PR safety check #4329

Merged
merged 4 commits into from
Sep 20, 2021
Merged

[flutter_plugin_tools] Add a federated PR safety check #4329

merged 4 commits into from
Sep 20, 2021

Conversation

stuartmorgan
Copy link
Contributor

@stuartmorgan stuartmorgan commented Sep 9, 2021 •
edited
Loading

Creates a new command to validate that PRs don't change platform interface packages and implementations at the same time, to try to prevent ecosystem-breaking changes. See flutter/flutter#89518 for context.

Per the explanation in the issue, this has carve-outs for:

  • Changes to platform interfaces that aren't published (allowing for past uses cases such as making a substantive change to an implementation, and making minor adjustments to comments in the PI package based on those changes).
  • Things that look like bulk changes (e.g., a mass change to account for a new lint rule)

Fixes flutter/flutter#89518

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the relevant style guides and ran the auto-formatter. (Note that unlike the flutter/flutter repo, the flutter/plugins repo does use dart format.)
  • I signed the CLA.
  • The title of the PR starts with the name of the plugin surrounded by square brackets, e.g. [shared_preferences]
  • I listed 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.
  • I updated CHANGELOG.md to add a description of the change.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making or feature I am adding, or Hixie said the PR is test exempt.
  • All existing and new tests are passing.

@google-cla google-cla bot added the cla: yes label Sep 9, 2021
@stuartmorgan
Copy link
Contributor Author

@gaaclarke Ping

gaaclarke
gaaclarke reviewed Sep 16, 2021
View reviewed changes
script/tool/lib/src/federation_safety_check_command.dart Outdated
return PackageResult.skip('Not a plugin.');
}

if (package.directory.parent.basename == 'packages') {
Copy link
Member

Choose a reason for hiding this comment

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

This seems like something we might want to turn into a function since the it has very clear semantics whose details could potentially change in the future. Something like package.isFederated.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

script/tool/lib/src/federation_safety_check_command.dart Outdated
return PackageResult.success();
}

printError('Dart changes are not allowed to other packages in foo in the '
Copy link
Member

Choose a reason for hiding this comment

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

foo?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Turns out that when writing the error message's test first, and copy/pasting it to the implementation rather than rewriting it, it's a good idea to remember to swap the variables in.

script/tool/lib/src/federation_safety_check_command.dart Outdated
printError('Dart changes are not allowed to other packages in foo in the '
'same PR as changes to public Dart code in foo_platform_interface, '
'as this can cause accidental breaking changes to be missed by '
'automated checks. Please move these changes to a separate PR.\n\n'
Copy link
Member

Choose a reason for hiding this comment

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

s/move these changes/split the changes to X and Y into separate PRs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

gaaclarke
gaaclarke approved these changes Sep 20, 2021
View reviewed changes
Copy link
Member

@gaaclarke gaaclarke left a comment

Choose a reason for hiding this comment

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

lgtm!

@stuartmorgan stuartmorgan merged commit a8e0129 into flutter:master Sep 20, 2021
@stuartmorgan stuartmorgan deleted the multi-package-safety-check branch September 20, 2021 17:54
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Sep 20, 2021
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Sep 20, 2021
@engine-flutter-autoroll
a8e0129 [flutter_plugin_tools] Add a federated PR safety check (flutt…
ac70086 
…er/plugins#4329)
fluttergithubbot pushed a commit to flutter/flutter that referenced this pull request Sep 20, 2021
@engine-flutter-autoroll
a8e0129 [flutter_plugin_tools] Add a federated PR safety check (flutt…
5b7d671 
…er/plugins#4329) (#90404)
amantoux pushed a commit to amantoux/plugins that referenced this pull request Sep 27, 2021
@stuartmorgan @amantoux
[flutter_plugin_tools] Add a federated PR safety check (flutter#4329)
062e135 
Creates a new command to validate that PRs don't change platform interface packages and implementations at the same time, to try to prevent ecosystem-breaking changes. See flutter/flutter#89518 for context.

Per the explanation in the issue, this has carve-outs for:
- Changes to platform interfaces that aren't published (allowing for past uses cases such as making a substantive change to an implementation, and making minor adjustments to comments in the PI package based on those changes).
- Things that look like bulk changes (e.g., a mass change to account for a new lint rule)

Fixes flutter/flutter#89518
NickalasB added a commit to NickalasB/plugins that referenced this pull request Sep 27, 2021
@NickalasB
Merge branch 'master' into add_zoom_to_android_webview
8dd870b 
* master: (51 commits)
  [webview_flutter] Update version number app_facing package (flutter#4375)
  [webview_flutter] Adjust integration test domains (flutter#4383)
  Remove some trivial custom analysis options files (flutter#4379)
  [google_maps_flutter_platfomr_interface] Add Marker drag events (flutter#2653)
  [flutter_plugin_tools] Improve version check error handling (flutter#4376)
  [flutter_plugin_tools] Allow overriding breaking change check (flutter#4369)
  [url_launcher] Error handling when URL cannot be parsed with Uri.parse (flutter#4365)
  [webview_flutter] Migrate main package to fully federated architecture. (flutter#4366)
  [google_sign_in] Bump minimum Flutter version and iOS deployment target (flutter#4334)
  Add false secret lists, and enforce ordering (flutter#4372)
  [camera_web] Update usage documentation (flutter#4371)
  [video_player] VTT Support (flutter#2878)
  Require authors file (flutter#4367)
  [flutter_plugin_tools] Fix federated safety check (flutter#4368)
  [webview_flutter] Extract WKWebView implementation into a separate package (flutter#4345)
  [webview_flutter] Extract Android implementation into a separate package (flutter#4343)
  [in_app_purchase] Ensure the `introductoryPriceMicros` field is populated correctly. (flutter#4364)
  [flutter_plugin_tools] Add a federated PR safety check (flutter#4329)
  [camera] Add web support (flutter#4240)
  [webview_flutter] Bump minimum Flutter version and iOS deployment target (flutter#4361)
  ...

# Conflicts:
#	packages/webview_flutter/webview_flutter/lib/platform_interface.dart
#	packages/webview_flutter/webview_flutter/lib/src/webview_method_channel.dart
#	packages/webview_flutter/webview_flutter/lib/webview_flutter.dart
clocksmith pushed a commit to clocksmith/flutter that referenced this pull request Oct 29, 2021
@engine-flutter-autoroll @clocksmith
a8e0129 [flutter_plugin_tools] Add a federated PR safety check (flutt…
50890d4 
…er/plugins#4329) (flutter#90404)
KyleFin pushed a commit to KyleFin/plugins that referenced this pull request Dec 21, 2021
@stuartmorgan @KyleFin
[flutter_plugin_tools] Add a federated PR safety check (flutter#4329)
f860e03 
Creates a new command to validate that PRs don't change platform interface packages and implementations at the same time, to try to prevent ecosystem-breaking changes. See flutter/flutter#89518 for context.

Per the explanation in the issue, this has carve-outs for:
- Changes to platform interfaces that aren't published (allowing for past uses cases such as making a substantive change to an implementation, and making minor adjustments to comments in the PI package based on those changes).
- Things that look like bulk changes (e.g., a mass change to account for a new lint rule)

Fixes flutter/flutter#89518
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@gaaclarke gaaclarke gaaclarke approved these changes

Assignees
No one assigned
Labels
cla: yes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add more safeties against breaking the ecosystem with federated plugin PRs
2 participants
@stuartmorgan @gaaclarke