Remove deprecated methods from BuildContext #69620

goderbauer · 2020-11-02T23:31:44Z

Description

This removes the deprecated BuildContext methods that has reached the EOL . See table below:

Before	After
inheritFromElement	dependOnInheritedElement
inheritFromWidgetOfExactType	dependOnInheritedWidgetOfExactType
ancestorInheritedElementForWidgetOfExactType	getElementForInheritedWidgetOfExactType
ancestorWidgetOfExactType	findAncestorWidgetOfExactType
ancestorStateOfType	findAncestorStateOfType
rootAncestorStateOfType	findRootAncestorStateOfType
ancestorRenderObjectOfType	findAncestorRenderObjectOfType

Similar methods exist on the Element class and will be removed from there in #72903.

Part of deprecations that are slated for removal for next release in https://flutter.dev/go/deprecation-lifetime

More context: https://medium.com/flutter/deprecation-lifetime-in-flutter-e4d76ee738ad

Related Issues

Deprecated in #44189

Tests

Tests for quick fix tool.

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.
I signed the CLA.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I updated/added relevant documentation (doc comments with ///).
All existing and new tests are passing.
The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
I am willing to follow-up on review comments in a timely manner.

Breaking Change

Did any tests fail when you ran them? Please read Handling breaking changes.

No, no existing tests failed, so this is not a breaking change.

goderbauer · 2020-11-02T23:32:09Z

packages/flutter/lib/fix_data.yaml

@@ -0,0 +1,134 @@
+# Spec file for "dart fix", see <insert URL>.


@bwilkerson Where can we link to here?

We don't currently have a published version of the docs. They'll be the contents of the "User documentation" doc you've seen. I'd like to flesh them out a bit more before publishing them, but if we need them to be published sooner than that let me know.

Any additional feedback you have on the doc as a result of using it while writing this file would be much appreciated. (With thanks for your previous comment about adding some complete examples.)

goderbauer · 2020-11-02T23:33:25Z

packages/flutter/lib/fix_data.yaml

+  - title: 'Rename to dependOnInheritedElement'
+    date: 2019-11-22
+    element:
+      uris: [ 'material.dart', 'cupertino.dart', 'widgets.dart' ]


I can see that coming up with the correct list here will be difficult. It will be easy to miss a lib that exports the symbol...

That's a valid concern.

The design tradeoff is that we have less information that we can use to ensure that we're selecting the correct change in the case where a declaration has been removed. Having the URIs doesn't absolutely guarantee that we won't do the wrong thing, but it does make it significantly less likely. Unfortunately, I don't have concrete numbers for how often we'd do the wrong thing (either with or without them), but I am concerned about the effect on user trust if the tool makes incorrect changes.

goderbauer · 2020-11-02T23:35:49Z

/cc @Piinks

goderbauer · 2020-11-02T23:37:47Z

We have to come up with a way to test these fixes. @bwilkerson Have you already given testing these definitions some thoughts?

devoncarew · 2020-11-03T00:59:32Z

packages/flutter/lib/fix_data.yaml

+    changes:
+      - kind: 'rename'
+        newName: 'dependOnInheritedElement'
+  - title: 'Migrate to dependOnInheritedWidgetOfExactType'


As a drive by comment, you may want liberal use of whitespace and # comments to help separate the individual refactors. This file will likely get pretty large and will be tough to navigate w/o some visual separation between fixes.

Agreed and done.

bwilkerson · 2020-11-03T17:28:30Z

packages/flutter/lib/fix_data.yaml

+version: 1
+transforms:
+  # Change made in https://github.com/flutter/flutter/pull/44189.
+  - title: 'Rename to dependOnInheritedElement'


Unless the distinction is important to users we ought to be consistent in the naming of these actions. Consider changing "Rename" to "Migrate".

Piinks · 2020-12-23T20:59:43Z

@goderbauer do you want to move forward with this change?

Piinks · 2020-12-23T23:58:36Z

The tests that need to be added here are almost the same as #72903
This change will need to land before that one.

goderbauer · 2021-01-05T18:14:32Z

@goderbauer do you want to move forward with this change?

Yes, I'll update this PR.

flutter-dashboard · 2021-01-07T22:22:12Z

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.

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

Piinks · 2021-01-07T22:38:57Z

packages/flutter/lib/fix_data.yaml

+
+  # Change made in https://github.com/flutter/flutter/pull/44189.
+  - title: 'Migrate to ancestorRenderObjectOfType'
+    date: 2019-11-22


Oooh I see, this is the date of the deprecation? (#44189 here?)

Piinks

Thank you!

fluttergithubbot · 2021-01-07T23:24:05Z

This pull request is not suitable for automatic merging in its current state.

The status or check suite Google testing has failed. Please fix the issues identified (or deflake) before re-applying this label.

Piinks · 2021-01-08T20:58:18Z

Google tests have been fixed, this has a merge conflict now though. Strange Resolve conflicts is disabled here.

goderbauer · 2021-01-08T21:40:25Z

Merge conflict is resolved.

fluttergithubbot · 2021-01-08T22:44:04Z

This pull request is not suitable for automatic merging in its current state.

The status or check suite Google testing has failed. Please fix the issues identified (or deflake) before re-applying this label.

flutter-dashboard bot added framework work in progress; do not review labels Nov 2, 2020

google-cla bot added the cla: yes label Nov 2, 2020

goderbauer commented Nov 2, 2020

View reviewed changes

devoncarew reviewed Nov 3, 2020

View reviewed changes

bwilkerson reviewed Nov 3, 2020

View reviewed changes

dnfield removed the work in progress; do not review label Nov 9, 2020

devoncarew mentioned this pull request Nov 11, 2020

dart fix: an initial data driven migrations file exists in flutter/flutter/packages/flutter/lib dart-lang/sdk#44152

Closed

goderbauer closed this Nov 11, 2020

goderbauer deleted the flutterfix branch November 11, 2020 21:25

goderbauer restored the flutterfix branch November 11, 2020 21:26

goderbauer reopened this Nov 11, 2020

Piinks mentioned this pull request Dec 23, 2020

Remove deprecated Element methods #72903

Merged

9 tasks

goderbauer force-pushed the flutterfix branch from 621180b to 2eea361 Compare January 7, 2021 22:19

goderbauer changed the title ~~Add fix_data.yaml with first 7 fixes~~ Remove deprecated methods from BuildContext Jan 7, 2021

flutter-dashboard bot added f: cupertino f: material design labels Jan 7, 2021

goderbauer marked this pull request as ready for review January 7, 2021 22:22

goderbauer requested a review from Piinks January 7, 2021 22:22

Piinks reviewed Jan 7, 2021

View reviewed changes

Piinks approved these changes Jan 7, 2021

View reviewed changes

goderbauer added the waiting for tree to go green label Jan 7, 2021

fluttergithubbot removed the waiting for tree to go green label Jan 7, 2021

Piinks added the c: API break label Jan 8, 2021

added tests, removed API

Unverified

This user has not yet uploaded their public signing key.

GPG key ID: 5B3FBDB4FD74402C

Learn about vigilant mode

271528e

goderbauer force-pushed the flutterfix branch from 2eea361 to 271528e Compare January 8, 2021 21:39

Piinks added the waiting for tree to go green label Jan 8, 2021

fluttergithubbot removed the waiting for tree to go green label Jan 8, 2021

Piinks added the waiting for tree to go green label Jan 8, 2021

fluttergithubbot merged commit 535392b into flutter:master Jan 8, 2021

mohammadwali mentioned this pull request Jan 9, 2021

Upgrading to latest master channel breaks the build. rrousselGit/provider#597

Closed

sma mentioned this pull request Jan 11, 2021

Build error on master because of removed method inheritFromWidgetOfExactType Sub6Resources/chewie_audio#9

Closed

Piinks mentioned this pull request Jan 11, 2021

Remove deprecated TypeMatcher class #73751

Merged

9 tasks

goderbauer deleted the flutterfix branch January 15, 2021 18:38

Shvet mentioned this pull request Jan 21, 2021

The method 'inheritFromWidgetOfExactType' isn't defined for the class 'BuildContext'. fluttercommunity/chewie#422

Closed

		@@ -0,0 +1,134 @@
		# Spec file for "dart fix", see <insert URL>.

Remove deprecated methods from BuildContext #69620

Remove deprecated methods from BuildContext #69620

Conversation

goderbauer commented Nov 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Tests

Checklist

Breaking Change

Uh oh!

goderbauer Nov 2, 2020

Choose a reason for hiding this comment

Uh oh!

bwilkerson Nov 3, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

goderbauer Nov 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bwilkerson Nov 3, 2020

Choose a reason for hiding this comment

Uh oh!

goderbauer commented Nov 2, 2020

Uh oh!

goderbauer commented Nov 2, 2020

Uh oh!

devoncarew Nov 3, 2020

Choose a reason for hiding this comment

Uh oh!

goderbauer Nov 3, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bwilkerson Nov 3, 2020

Choose a reason for hiding this comment

Uh oh!

Piinks commented Dec 23, 2020

Uh oh!

Piinks commented Dec 23, 2020

Uh oh!

goderbauer commented Jan 5, 2021

Uh oh!

flutter-dashboard bot commented Jan 7, 2021

Uh oh!

Piinks Jan 7, 2021

Choose a reason for hiding this comment

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

fluttergithubbot commented Jan 7, 2021

Uh oh!

Piinks commented Jan 8, 2021

Uh oh!

goderbauer commented Jan 8, 2021

Uh oh!

fluttergithubbot commented Jan 8, 2021

Uh oh!

goderbauer commented Nov 2, 2020 •

edited

Loading

bwilkerson Nov 3, 2020 •

edited

Loading

goderbauer Nov 2, 2020 •

edited

Loading

goderbauer Nov 3, 2020 •

edited

Loading