[flutter_tools] cache flutter sdk version to disk #124558
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -123,7 +123,10 @@ function upgrade_flutter () ( | |||
| # * STAMP_PATH is an empty file, or | |||
| # * Contents of STAMP_PATH is not what we are going to compile, or | |||
| # * pubspec.yaml last modified after pubspec.lock | |||
| if [[ ! -f "$SNAPSHOT_PATH" || ! -s "$STAMP_PATH" || "$(cat "$STAMP_PATH")" != "$compilekey" || "$FLUTTER_TOOLS_DIR/pubspec.yaml" -nt "$FLUTTER_TOOLS_DIR/pubspec.lock" ]]; then | |||
| if [[ ! -f "$SNAPSHOT_PATH" || \ | |||
There was a problem hiding this comment.
This is just a formatting change that makes it more legible
1529476 to
0926016
Compare
fd582af to
c2e57ee
Compare
92ae949 to
110f7aa
Compare
b740229 to
9d92fd4
Compare
.gitignore
Outdated
| @@ -39,6 +39,7 @@ | |||
| /dev/integration_tests/**/Pods | |||
| /packages/flutter/coverage/ | |||
| version | |||
| .version.json | |||
There was a problem hiding this comment.
Unfortunately if a user tries out a beta flutter version that generates this file, then switches back to stable that doesn't, it won't be gitignored.
There was a problem hiding this comment.
Would it worth getting a hot fix into stable that just adds this into the gitignore as well?
There was a problem hiding this comment.
@zanderso what do you think? Having a dirty checkout of the framework would cause flutter upgrade to fail, so I think it would make sense to cherrypick this. If not, then we should probably land the gitignore change first, and then only land the rest of this once that's reached stable.
There was a problem hiding this comment.
Can the .version.json live in a directory that's already .gitignore'd? Maybe bin/cache?
There was a problem hiding this comment.
that's a good idea!
There was a problem hiding this comment.
Seems like moving into the cache directory is causing errors when trying to find the version file.
We may need to first create the version file recursively before we try to write to it now that it is in a nested directory?
andrewkolos
reviewed
May 5, 2023
andrewkolos
reviewed
May 5, 2023
andrewkolos
reviewed
May 5, 2023
|
Is this vulnerable to the staleness concerns you had with #111392? |
Good question, but this is covered by https://github.com/flutter/flutter/pull/124558/files#diff-092e00109d9e1589fbc7c6de750e29a6ae512b2dd44e85d60028953561201605R91 // if we are fetching tags, ignore cached versionFile
if (fetchTags && versionFile.existsSync()) {
versionFile.deleteSync();
} |
andrewkolos
approved these changes
May 8, 2023
There was a problem hiding this comment.
LGTM with minor question.
I still advise a second thorough review from @eliasyishak.
Yep still reviewing on my end as well |
eliasyishak
reviewed
May 8, 2023
b4b62aa to
8d4c751
Compare
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Jun 15, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Jun 15, 2023
auto-submit bot
pushed a commit
to flutter/packages
that referenced
this pull request
Jun 15, 2023
flutter/flutter@95be76a...b0188cd 2023-06-15 [email protected] [web] Pass creation params to the platform view factory (flutter/flutter#128146) 2023-06-15 [email protected] [flutter_tools] cache flutter sdk version to disk (flutter/flutter#124558) 2023-06-14 [email protected] Fix inconsistently suffixed macOS flavored bundle directory (flutter/flutter#127997) 2023-06-14 [email protected] Update golden tests for material (flutter/flutter#128839) 2023-06-14 [email protected] Update getChildrenSummaryTree to handle Diagnosticable as input. (flutter/flutter#128833) 2023-06-14 [email protected] Improve the error message for non-normalized constraints (flutter/flutter#127906) 2023-06-14 [email protected] ContextAction.isEnabled needs a context (flutter/flutter#127721) 2023-06-14 [email protected] Remove temporary default case for PointerSignalKind (flutter/flutter#128900) 2023-06-14 [email protected] Respect allowlisted count of leaks. (flutter/flutter#128823) 2023-06-14 [email protected] Unpin flutter_plugin_android_lifecycle (flutter/flutter#128898) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Aug 16, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Aug 17, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Aug 17, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Aug 17, 2023
fluttermirroringbot
pushed a commit
that referenced
this pull request
Aug 23, 2023
Fixes #133093 When I introduced the new, more robust version file `//flutter/bin/cache/version.json` in #124558, I changed `class FlutterVersion` into an abstract interface, implemented by `_FlutterVersionFromGit` (which is essentially the previous behavior) and `_FlutterVersionFromFile`, which merely reads the data it would have computed via git from `//flutter/bin/cache/version.json`. While doing this, I made `_FlutterVersionFromGit.ensureVersionFile()` to be a no-op, since I assumed this would not be necessary since we already had a version file in the cache. However, this method was what was previously responsible for ensuring `//flutter/version` existed on disk. This means that if, for whatever reason, the user had `//flutter/bin/cache/flutter.version.json` present but NOT `//flutter/version`, the tool would have never created that file, and they would hit the tool crash seen in #133093. This fixes the tool by ensuring `//flutter/version` exists regardless of if we're hydrating `FlutterVersion` from `//flutter/bin/cache/flutter.version.json` or not.
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #112833
Most of the actual changes here are in packages/flutter_tools/lib/src/version.dart, while the rest is largely just addressing changes to the constructor of
FlutterVersionwhich now has different dependencies.This change makes
FlutterVersionan interface with two concrete implementations:_FlutterVersionGitwhich is mostly the previous implementation, and_FlutterVersionFromFilewhich will read a new.version.jsonfile from the root of the repoThe
FlutterVersionconstructor is now a factory that first checks if.version.jsonexists, and if so returns an instance of_FlutterVersionFromGitelse it returns the fallback_FlutterVersionGitwhich will end up writing.version.jsonso that we don't need to re-calculate the version on the next invocation..version.jsonwill be deleted in the bash/batch entrypoints any time we need to rebuild he tool (this will usually be because the user didflutter upgradeorflutter channel, or manually changed the commit with git).