| commit | ed6c0369658fd79424f8eba72cf13ad88d8a1fa4 | [log] [tgz] |
|---|---|---|
| author | Alexander Biggs <akbiggs@google.com> | Tue Oct 18 19:47:52 2022 +0000 |
| committer | Alexander Biggs <akbiggs@google.com> | Tue Oct 18 19:47:52 2022 +0000 |
| tree | 506780679e16bced916a5e80c83f590900188c27 | |
| parent | 8cc821a153f67018ef3edbfac6efb83ede2c3f60 [diff] |
[embedder] Document attaching a debugger. Explains: - How to attach a debugger to the example component from the command-line. - How to run an example component using VSCode with support for breakpoints. Bug: 46971 Change-Id: I0883812bb59f1c31f3381da037c7209508e11208 Reviewed-on: https://fuchsia-review.googlesource.com/c/flutter-embedder/+/742302 Reviewed-by: Naud Ghebre <naudzghebre@google.com>
The Flutter Embedder for Fuchsia is a new in-progress runtime for Flutter apps on Fuchsia. This runtime is built on top of Flutter's embedder platform.
This repository is a work in progress and should be considered experimental.
If you're using WSL2 (Windows Subsystem for Linux), see SETUP_WINDOWS.md first.
Set $FUCHSIA_EMBEDDER_DIR to your flutter-embedder.git checkout location, for example ~/flutter-embedder.
export FUCHSIA_EMBEDDER_DIR=$HOME/flutter-embedder
Bootstrap the repository's dependencies:
$FUCHSIA_EMBEDDER_DIR/scripts/bootstrap.sh
This script initializes tools (including bazel and ffx), installs some Git hooks and downloads the workstation_eng.qemu-x64 product bundle, which you can use to run the examples below.
Start the emulator.
If running in a graphical environment:
$FUCHSIA_EMBEDDER_DIR/tools/ffx emu start workstation_eng.qemu-x64
If running in a terminal environment:
$FUCHSIA_EMBEDDER_DIR/tools/ffx emu start --headless workstation_eng.qemu-x64
The workflow below also supports Fuchsia builds from source that are within Fuchsia's SDK compatibility window (six weeks).
Set the default target in ffx to be fuchsia-emulator:
$FUCHSIA_EMBEDDER_DIR/tools/ffx target default set fuchsia-emulator
Run an example component:
$FUCHSIA_EMBEDDER_DIR/scripts/build_and_run_example.sh hello_flutter
To watch logs for the example component, run:
$FUCHSIA_EMBEDDER_DIR/scripts/build_and_run_example.sh hello_flutter --log
If you want to watch all logs, run $FUCHSIA_EMBEDDER_DIR/tools/ffx log in a separate terminal.
To watch FIDL calls for the example component, run:
$FUCHSIA_EMBEDDER_DIR/scripts/build_and_run_example.sh hello_flutter --fidl
Caveats:
--fidl currently requires setting $FUCHSIA_DIR to a Fuchsia source checkout with a build in $FUCHSIA_DIR/out/default. This directory is only used to read IR files for FIDL, you can still use the workstation_eng.qemu-x64 product bundle with --fidl.
--fidl attaches after the component has been run, so it does not pick up FIDL calls made when the component starts.
To attach a debugger to the example component, see debugging.md
TODO(akbiggs): Work with Bazel SDK team to get proper support for --fidl.
Running the Flutter app is handled by the Flutter Engine's embedder platform code. This code is compiled into a shared library called libflutter_engine.so, which we can interact with using the embedder.h header.
If you need to make changes to this Flutter Engine code (for example for testing a new API in embedder.h with this embedder) see making_engine_changes.md for instructions. This isn‘t required for changes to only flutter-embedder.git’s source code.
See git_workflow.md.
