Add "flutter symbolize" command by jonahwilliams · Pull Request #49465 · flutter/flutter

jonahwilliams · 2020-01-25T01:38:06Z

Adds flutter symbolize, for turning crashes into human readable stack traces.

Example Workflow:

Developer is ready to release an APK for distribution on the Play Store.
They create a directory for the specific version of the app to be released. Example: symbols/v1.2.3-final-final
They run flutter build apk --release --split-debug-info=symbols/v1.2.3-final-final/
They upload the APK as normal. The symbol files are either stored locally, or commited to some internal symbol database.
They receive a crash report from version v1.2.3-final-final on an arm64 ABI.
They retrieve the corresponding symbols file generated in step two.
They run flutter symbolize --symbols=v1.2.3-final-final/app.android-arm64.symbols < stack.txt

What if the symbols file is lost or destroyed? In theory it could be regenerated by being on the exact same version of flutter with the exact same dart code

Fixes #50206

jonahwilliams · 2020-01-25T01:38:46Z

+      output = _stdio.stdout;
+    }
+
+    final Uint8List debugInfo = _fileSystem.file(stringArg('debug-info')).readAsBytesSync();


This needs to be abstracted into a separate class so it can be faked for testing. The elf files are too big to commit only for unit testing

jonahwilliams · 2020-01-29T17:49:39Z

Waiting on an update to the native_stack_traces package, and then for a confirmed roll into google3 for this to be safe to land

zanderso · 2020-01-29T18:15:51Z

    UpdatePackagesCommand(hidden: !verboseHelp),
    UpgradeCommand(),
    VersionCommand(),
+    SymbolicateCommand(stdio: globals.stdio, fileSystem: globals.fs),


Alphabetize.

zanderso · 2020-01-29T18:16:48Z

+
+import 'package:meta/meta.dart';
+import 'package:native_stack_traces/native_stack_traces.dart';
+import 'package:native_stack_traces/src/elf.dart'; // ignore: implementation_imports


Is there a github issue for getting the things the tool needs made part of the public API of this package?

Yup, this is pending https://dart-review.googlesource.com/c/sdk/+/133720

zanderso · 2020-01-29T18:17:47Z

@@ -0,0 +1,125 @@
+// Copyright 2014 The Flutter Authors. All rights reserved.


symbolicate -> symbolize

zanderso · 2020-01-29T18:23:02Z

+    }
+    if ((argResults.wasParsed('input') && !argResults.wasParsed('output')) ||
+        (!argResults.wasParsed('input') && argResults.wasParsed('output'))) {
+      throwToolExit('"--input" and "--output" are only supported when both are provided.');


The feels a bit too prescriptive to me. I could imagine wanting the input to come from a file and the output to go on stdout, for example.

Done, now users can provide any combination of input/output and stdin/stdout

zanderso · 2020-01-29T18:25:10Z

+      .transform(const Utf8Decoder())
+      .transform(const LineSplitter())
+      .transform(DwarfStackTraceDecoder(dwarf, includeInternalFrames: true))
+      .listen(output.writeln, onDone: onDone.complete, onError: onDone.completeError);


I would prefer folks not have to say flutter run | flutter symbolize. flutter run should take a flag to point at debugging info, or look around the project for one that matches the targeted device.

Yeah I agree, I should wire up something to run - though I can imagine us not applying dwarf-stack-traces in run release too.

…olicate

…r into flutter_symbolicate

jonahwilliams · 2020-02-06T22:19:02Z

This is ready for another round of review, modulo the changes in native_stack_traces landing (CL is approved)

zanderso · 2020-02-07T00:00:57Z

+  final DwarfSymbolicationService _dwarfSymbolicationService;
+
+  @override
+  String get description => 'symbolicate a stack trace from an AOT compiled flutter application.';


symbolicate -> Symbolize

zanderso · 2020-02-07T00:25:27Z

+      .transform(const Utf8Decoder())
+      .transform(const LineSplitter())
+      .transform(DwarfStackTraceDecoder(dwarf, includeInternalFrames: true))
+      .listen(output.writeln, onDone: onDone.complete, onError: onDone.completeError);


If the writeln throws, it'll be thrown into the Zone. You can handle exceptions from writeln like:

StreamSubscription sub; sub = input .transform(const Utf8Decoder()) .transform(const LineSplitter()) .transform(DwarfStackTraceDecoder(dwarf, includeInternalFrames: true)) .listen((thing) async { try { output.writeln(thing); } on Exception catch(e, s) { sub.cancel().whenComplete(() { if (!onDone.isCompleted) { onDone.completeError(e, s); } ); } }, onDone: onDone.complete, onError: onDone.completeError);

zanderso · 2020-02-07T00:26:13Z

+}
+
+/// A service which decodes stack traces from Dart applications.
+class DwarfSymbolicationService {


Symbolication -> Symbolization

…olicate

…r into flutter_symbolicate

jonahwilliams · 2020-02-10T16:18:59Z

Updated to latest native_stack_traces package

zanderso

lgtm w/ nits

zanderso · 2020-02-10T17:45:14Z

+  SymbolizeCommand({
+    @required Stdio stdio,
+    @required FileSystem fileSystem,
+    DwarfSymbolizationService dwarfSymbolicationService = const DwarfSymbolizationService(),


dwarfSymbolicationService -> dwarfSymbolizationService

zanderso · 2020-02-10T17:48:53Z

+          output.writeln(line);
+        } on Exception catch(e, s) {
+          subscription.cancel().whenComplete(() {
+          if (!onDone.isCompleted) {


nit: indentation

add stack trace stripping and symbolication support

41be9ab

fluttergithubbot added c: contributor-productivity Team-specific productivity, code health, technical debt. tool Affects the "flutter" command-line tool. See also t: labels. work in progress; do not review labels Jan 25, 2020

googlebot added the cla: yes label Jan 25, 2020

jonahwilliams commented Jan 25, 2020

View reviewed changes

jonahwilliams changed the title ~~[WIP] add stack trace stripping and symbolication support~~ [WIP] add stack trace symbolication support Jan 29, 2020

jonahwilliams mentioned this pull request Jan 29, 2020

[flutter_tools] support --split-debug-info option in android builds #49650

Merged

zanderso reviewed Jan 29, 2020

View reviewed changes

jonahwilliams added 7 commits February 3, 2020 15:33

Merge branch 'master' of github.com:flutter/flutter into flutter_symb…

19c61a9

…olicate

API cleanups

7372f96

Merge branch 'master' of github.com:flutter/flutter into flutter_symb…

0dca029

…olicate

update to latest

2500923

Update symbolize_test.dart

078af6c

rename command to symbolize

e6b2a77

Merge branch 'flutter_symbolicate' of github.com:jonahwilliams/flutte…

43fe95c

…r into flutter_symbolicate

jonahwilliams marked this pull request as ready for review February 6, 2020 22:14

jonahwilliams removed the work in progress; do not review label Feb 6, 2020

Jonah Williams added 2 commits February 6, 2020 14:16

Update build.dart

080f7f6

Update symbolize.dart

72a81b3

jonahwilliams changed the title ~~[WIP] add stack trace symbolication support~~ Add "flutter symbolize" command Feb 6, 2020

Update symbolize_test.dart

fb69a69

zanderso reviewed Feb 7, 2020

View reviewed changes

jonahwilliams added 4 commits February 9, 2020 18:29

Merge branch 'master' of github.com:flutter/flutter into flutter_symb…

64b4f3e

…olicate

update to latest, remove src imports

54af216

Merge branch 'flutter_symbolicate' of github.com:jonahwilliams/flutte…

6c3740b

…r into flutter_symbolicate

Update BUILD.gn

32d99c2

jonahwilliams requested a review from zanderso February 10, 2020 16:18

zanderso approved these changes Feb 10, 2020

View reviewed changes

Jonah Williams added 2 commits February 10, 2020 09:53

Update symbolize.dart

157200f

Update symbolize_test.dart

c751f3d

jonahwilliams added the waiting for tree to go green label Feb 10, 2020

fluttergithubbot merged commit 5681727 into flutter:master Feb 10, 2020

github-actions Bot locked as resolved and limited conversation to collaborators Aug 1, 2021

		@@ -0,0 +1,125 @@
		// Copyright 2014 The Flutter Authors. All rights reserved.

Conversation

jonahwilliams commented Jan 25, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jonahwilliams commented Jan 29, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jonahwilliams commented Feb 6, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jonahwilliams commented Feb 10, 2020

Uh oh!

zanderso left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jonahwilliams commented Jan 25, 2020 •

edited

Loading