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

Conversation

@kosukesaigusa
Copy link

@kosukesaigusa kosukesaigusa commented Jul 14, 2022

Just fixed a typo of a method name, from setCookieForInsances to setCookieForInstances

No version change: Only updates internal method name.

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. (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, or this PR is exempt from version changes.
  • I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is test-exempt.
  • All existing and new tests are passing.

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

@kosukesaigusa kosukesaigusa requested a review from cyanglaz as a code owner July 14, 2022 02:54
@flutter-dashboard
Copy link

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat (don't just cc him here, he won't see it! He's on Discord!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

@github-actions github-actions bot added p: webview_flutter Edits files for a webview_flutter plugin platform-ios labels Jul 14, 2022
@bparrishMines
Copy link
Contributor

Hi @kosukesaigusa, thanks for fixing this.

Could you updated the CHANGELOG by following: https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#updating-a-changelog-that-has-a-next.

@bparrishMines bparrishMines self-requested a review July 14, 2022 19:12
@kosukesaigusa
Copy link
Author

Thank you for your message, @bparrishMines.
Now I updated the CHANGELOG.md in this commit: cec0ebc

Copy link
Contributor

@bparrishMines bparrishMines left a comment

Choose a reason for hiding this comment

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

I looks like you also need to pull in the latest changes to merge this.

@@ -1,3 +1,7 @@
## NEXT

* Fix typo in a method name, from `setCookieForInsances` to `setCookieForInstances`.
Copy link
Contributor

Choose a reason for hiding this comment

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

@kosukesaigusa
Copy link
Author

@bparrishMines
Thank you. Resolved the conflict and updated the grammar.

@@ -1,6 +1,9 @@
## 2.9.1
## NEXT
Copy link
Contributor

Choose a reason for hiding this comment

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

When pulling in main it looks like you are erasing the 2.9.1 change. This should have been

## Next

* Fixes typo in a method name, from `setCookieForInsances` to `setCookieForInstances`.

## 2.9.1

* Fixes regression where the behavior for the `UIScrollView` insets were removed.

Copy link
Contributor

@cyanglaz cyanglaz left a comment

Choose a reason for hiding this comment

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

Need to make it a breaking change.


/// Calls [setCookie] with the ids of the provided object instances.
Future<void> setCookieForInsances(
Future<void> setCookieForInstances(
Copy link
Contributor

Choose a reason for hiding this comment

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

This is technically public API, so we might need to do a breaking change for this.
https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#breaking-changes

Copy link
Contributor

Choose a reason for hiding this comment

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

The plugin doesn't expose these classes: https://github.com/flutter/plugins/blob/main/packages/webview_flutter/webview_flutter_wkwebview/lib/webview_flutter_wkwebview.dart.

However, Dart does still allow access to implementation files. But, there are lint warning about importing implementation files of a package and proper usage of the plugin will make accessing them difficult.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, technically one can use those classes by importing webview_flutter_wkweview/lib/src/web_kit/web_kit_api.impls.dart, and those app will break after this change.

I'm not sure the policy of making "public" API change in these files.

Copy link
Contributor

Choose a reason for hiding this comment

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

cc @stuartmorgan Is there documented policy on changing files in lib/src in a plugin?

In Dart's documentation on implementation files, it looks to be implied that changing files in lib/src are not considered a breaking change. As a user shouldn't be importing them: https://dart.dev/tools/pub/package-layout#implementation-files

Copy link
Contributor

Choose a reason for hiding this comment

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

Anything we're not exporting is fair game to change.

@jmagman
Copy link
Member

jmagman commented Aug 10, 2022

Is the only thing remaining here the CHANGELOG issue? @kosukesaigusa can you rebase/merge onto top of tree and make sure your pubpsec and CHANGELOG version matches?

@jmagman
Copy link
Member

jmagman commented Aug 17, 2022

Friendly ping, @kosukesaigusa, this is so close to being mergeable! 🙂

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants