Add Flutter runtime information #2742

ueman · 2025-02-20T16:54:05Z

📜 Description

Fixes Report version of Flutter #416
Relevant Flutter PR Make Flutter version information accessible at runtime flutter/flutter#140783
Edit: It got reverted again Reverts "Make Flutter version information accessible at runtime (#140783)" flutter/flutter#163753
Edit Edit: Let's try again: Reland "Make Flutter version information accessible at runtime (#140783)" flutter/flutter#163761

Fun fact: This fixes the oldest currently open issue in this repo

💡 Motivation and Context

#416

💚 How did you test it?

I'm not entirely sure how to test this, since Dart defines aren't mockable.

You can test this manually by switching to the master channel of Flutter and building an app.

📝 Checklist

I reviewed submitted code
I added tests to verify changes
No new PII added or SDK only sends newly added PII if sendDefaultPii is enabled
I updated the docs if needed
All tests passing
No breaking changes

🔮 Next steps

Wait until the Flutter PR is merged, then merge this.

codecov · 2025-02-20T16:55:39Z

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Project coverage is 88.96%. Comparing base (40daa7b) to head (e5e0425).
Report is 6 commits behind head on main.

Files with missing lines	Patch %	Lines
...rocessor/enricher/io_enricher_event_processor.dart	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2742      +/-   ##
==========================================
- Coverage   88.97%   88.96%   -0.01%     
==========================================
  Files         263      263              
  Lines        8925     8926       +1     
==========================================
  Hits         7941     7941              
- Misses        984      985       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

CHANGELOG.md

buenaflor · 2025-02-20T18:10:11Z

ohh nice! 🥳

dart/lib/src/event_processor/enricher/flutter_runtime.dart

ueman · 2025-02-24T08:09:05Z

dart/lib/src/event_processor/enricher/flutter_runtime.dart

+  /// The URL of the Git repository from which Flutter was obtained.
+  static const String? gitUrl = bool.hasEnvironment('FLUTTER_GIT_URL')
+      ? String.fromEnvironment('FLUTTER_GIT_URL')
+      : null;


Should this be included in a context somewhere?

ueman · 2025-02-24T21:39:05Z

This PR is ready to review now, but maybe we should wait with merging a little to see whether the changes are sticking this time in the Flutter framework

dart/lib/src/event_processor/enricher/flutter_runtime.dart

…lutter-runtime

ueman · 2025-02-28T09:39:38Z

@buenaflor The linked PR is sticking, so it should be safe to merge now.

ueman · 2025-03-01T17:34:15Z

dart/lib/src/event_processor/enricher/flutter_runtime.dart

+  // This is included since [Platform.version](https://api.dart.dev/stable/dart-io/Platform/version.html)
+  // is not included on web platforms.
+  /// The Dart version used to compile the app.
+  static const String? dartVersion = bool.hasEnvironment('FLUTTER_DART_VERSION')


It's slightly different than Platform.version:

Platform.version: 3.8.0-133.0.dev (dev) (Sun Feb 23 12:02:50 2025 -0800) on "macos_x64"

FlutterVersion.dartVersion: 3.8.0 (build 3.8.0-133.0.dev)

ueman · 2025-03-05T17:41:11Z

@denrase Are you able to do a review on this?

denrase

Nice! \o/ We just need to make sure to also add it in the html enricher, as well as make CI happy.

dart/lib/src/event_processor/enricher/flutter_runtime.dart

denrase · 2025-03-06T08:56:40Z

dart/lib/src/event_processor/enricher/flutter_runtime.dart

+///
+/// When this Flutter version was build from a fork, or when Flutter runs in a
+/// custom embedder, these values might be unreliable.
+abstract class FlutterVersion {


Since this is code from your Flutter PR, would it also make sense to bring the corresponding tests over?

dart/lib/src/event_processor/enricher/web_enricher_event_processor.dart

dart/lib/src/event_processor/enricher/flutter_runtime.dart

denrase

Lookin' good, thank you!

denrase · 2025-03-10T09:18:11Z

@ueman The tests are failing on current dart versions and we have one analyser issue (formatting) left. Could we disable the tests for unsupported dart/flutter versions?

ueman · 2025-03-10T09:28:03Z

Ahh, good point. I think we can wrap the tests in a group and use bool.hasEnvironment() to enable the tests if the environment things are available.

Edit: Nevermind, those test will never work since they're executed in the Dart test runner which will never have those dart defines available, since they're only available in a Flutter environment. Soooo, maybe we should just delete the tests again?

denrase · 2025-03-10T09:34:13Z

@ueman Ah got it, moving them to sentry_flutter will probably not work as this is not exposed publicly?

ueman · 2025-03-10T09:35:37Z

@ueman Ah got it, moving them to sentry_flutter will probably not work?

Good idea! I haven't thought about that, but I could imagine that working.

ueman · 2025-03-10T10:50:25Z

@denrase It works 🥳 Everything that's red is unrelated to what I've done, I think.

denrase · 2025-03-10T10:58:24Z

@ueman Cool, i'll check out your branch and see that I fix what's causing the CI to fail.

denrase · 2025-03-10T12:49:10Z

@ueman Think the skip condition needs to be inverted. Also we can ignore failing e2e tests, since the token is missing in your branch, which is also why they fail.

denrase · 2025-03-11T08:39:22Z

@ueman Would you be so kind and sync the main of your fork with sentry? Just landed a fix for CI issues. After that, I'll merge those in here and then we are good to go. 🙇‍♂️

denrase · 2025-03-11T09:01:16Z

@buenaflor FYI, the integration e2e test is not running because we do not have the token available in forks. Maybe we should consider skipping the test in this case?

buenaflor · 2025-03-11T09:14:41Z

qq, is this important to have in v8? maybe we can just add it to v9 directly

denrase · 2025-03-11T09:15:57Z

@buenaflor This is not breaking anything, just adding additional info about Flutter runtime. Don't see a reason why this could not be merged directly to main. WDYT?

buenaflor · 2025-03-11T09:28:24Z

@denrase nothing really wrong with the PR and adding it to v8 but I'm asking because I was thinking of making a 8.14.0 (non-beta) release but I guess we'd wanna do another beta now if we merge this. or we just include this into the 8.14.0 without a beta, not sure, let's talk about it in the sync

ueman · 2025-03-11T09:46:31Z

FWIW, I don't think the changes in this PR need a beta release

dart/lib/src/event_processor/enricher/io_enricher_event_processor.dart

buenaflor · 2025-03-11T12:32:57Z

I'll merge this unless there's anything else to be added @denrase @ueman

ueman · 2025-03-11T12:53:12Z

Please go ahead, there's nothing to add from my side

ueman added 2 commits February 20, 2025 17:46

Add Flutter runtime

d3b2989

add explaining comment

1fa65d3

add changelog

65496d4

ueman marked this pull request as ready for review February 20, 2025 17:48

ueman requested review from krystofwoldrich, stefanosiano and buenaflor as code owners February 20, 2025 17:48

ueman commented Feb 20, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

ueman marked this pull request as draft February 20, 2025 18:14

Update CHANGELOG.md

ce305a1

ueman commented Feb 24, 2025

View reviewed changes

dart/lib/src/event_processor/enricher/flutter_runtime.dart Outdated Show resolved Hide resolved

ueman commented Feb 24, 2025

View reviewed changes

ueman marked this pull request as ready for review February 24, 2025 21:39

ueman commented Feb 24, 2025

View reviewed changes

dart/lib/src/event_processor/enricher/flutter_runtime.dart Outdated Show resolved Hide resolved

ueman and others added 6 commits February 25, 2025 06:12

make things const

c8b4793

Merge branch 'main' into flutter-runtime

760c175

Merge branch 'flutter-runtime' of github.com:ueman/sentry-dart into f…

04006fb

…lutter-runtime

fix changelog

0fa7d7b

more doc comments

feecc70

Fix formatting

1c20261

ueman commented Mar 1, 2025

View reviewed changes

Merge branch 'main' into flutter-runtime

8095f99

denrase requested changes Mar 6, 2025

View reviewed changes

ueman and others added 2 commits March 7, 2025 07:00

add test and requested changes

d54096c

Merge branch 'main' into flutter-runtime

1a1584b

denrase approved these changes Mar 10, 2025

View reviewed changes

move tests to flutter package

6e32339

denrase added 2 commits March 10, 2025 13:48

skip if environment is missing

9638c11

add ignore

81fd25c

denrase mentioned this pull request Mar 10, 2025

Format command fails for flutter/microbench #2778

Closed

Merge branch 'main' into flutter-runtime

e5e0425

buenaflor reviewed Mar 11, 2025

View reviewed changes

dart/lib/src/event_processor/enricher/io_enricher_event_processor.dart Show resolved Hide resolved

buenaflor approved these changes Mar 11, 2025

View reviewed changes

buenaflor merged commit 95ebf3f into getsentry:main Mar 11, 2025
142 of 146 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Flutter runtime information #2742

Add Flutter runtime information #2742

ueman commented Feb 20, 2025 •

edited

Loading

codecov bot commented Feb 20, 2025 •

edited

Loading

buenaflor commented Feb 20, 2025

ueman Feb 24, 2025

ueman commented Feb 24, 2025

ueman commented Feb 28, 2025

ueman Mar 1, 2025

ueman commented Mar 5, 2025

denrase left a comment

denrase Mar 6, 2025

denrase left a comment

denrase commented Mar 10, 2025

ueman commented Mar 10, 2025 •

edited

Loading

denrase commented Mar 10, 2025 •

edited

Loading

ueman commented Mar 10, 2025

ueman commented Mar 10, 2025

denrase commented Mar 10, 2025

denrase commented Mar 10, 2025

denrase commented Mar 11, 2025

denrase commented Mar 11, 2025

buenaflor commented Mar 11, 2025

denrase commented Mar 11, 2025

buenaflor commented Mar 11, 2025

ueman commented Mar 11, 2025

buenaflor commented Mar 11, 2025

ueman commented Mar 11, 2025

Add Flutter runtime information #2742

Add Flutter runtime information #2742

Conversation

ueman commented Feb 20, 2025 • edited Loading

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

codecov bot commented Feb 20, 2025 • edited Loading

Codecov Report

buenaflor commented Feb 20, 2025

ueman Feb 24, 2025

Choose a reason for hiding this comment

ueman commented Feb 24, 2025

ueman commented Feb 28, 2025

ueman Mar 1, 2025

Choose a reason for hiding this comment

ueman commented Mar 5, 2025

denrase left a comment

Choose a reason for hiding this comment

denrase Mar 6, 2025

Choose a reason for hiding this comment

denrase left a comment

Choose a reason for hiding this comment

denrase commented Mar 10, 2025

ueman commented Mar 10, 2025 • edited Loading

denrase commented Mar 10, 2025 • edited Loading

ueman commented Mar 10, 2025

ueman commented Mar 10, 2025

denrase commented Mar 10, 2025

denrase commented Mar 10, 2025

denrase commented Mar 11, 2025

denrase commented Mar 11, 2025

buenaflor commented Mar 11, 2025

denrase commented Mar 11, 2025

buenaflor commented Mar 11, 2025

ueman commented Mar 11, 2025

buenaflor commented Mar 11, 2025

ueman commented Mar 11, 2025

ueman commented Feb 20, 2025 •

edited

Loading

codecov bot commented Feb 20, 2025 •

edited

Loading

ueman commented Mar 10, 2025 •

edited

Loading

denrase commented Mar 10, 2025 •

edited

Loading