Google Git
Sign in
dart / monorepo / / 7d93f6061c7dea688a9388276b71fcfb3f309d0f
commit7d93f6061c7dea688a9388276b71fcfb3f309d0f[log] [tgz]
authorDanny Tuppeny <danny@tuppeny.com>Thu Apr 04 21:08:47 2024 +0000
committerdart-internal-monorepo <dart-internal-monorepo@dart-ci-internal.iam.gserviceaccount.com>Thu Apr 04 14:10:28 2024 -0700
treed9e9146b617b051bc6af03efe27ad70f4d99dc1c
parent0e07320b2c91ce6c22c76a95ac765062186156bd [diff]
[analysis_server] Add sync versions of ErrorOr methods and extensions for records

This is a step towards restricting use of `.error` and `.result` in `ErrorOr` to avoid runtime errors (or at least, the wrong runtime errors when error occur).

The reason for adding `.result` was to reduce excessive nesting when functions required the "result" version of multiple things in a chain. This is now handled better using records - we can do:

```
(foo1, foo2).mapResults((foo1, foo2) => ...);
```

This will execute the function only if both values are results and otherwise return the first error. These extensions exist for 2, 3, and 4 field records.

Additionally, I added Sync() versions of several of the helper methods to avoid using `FutureOr` (something that has caused problems with error handline in the past) and needing to `await` in synchronous code that just wants to map results.

This CL does not migrate _all_ uses of `.result` as it would make the CL much larger. Assuming the approach seems good and we will land this, I will migrate the rest.

Change-Id: Ib3f4c390818a8a26467d27c2472f6435055a6bd7
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/361141
Reviewed-by: Brian Wilkerson <brianwilkerson@google.com>
Reviewed-by: Konstantin Shcheglov <scheglov@google.com>
Commit-Queue: Brian Wilkerson <brianwilkerson@google.com>

https://dart.googlesource.com/sdk/+/da0540dfc7d4ab636e6725cb8f2eb24a799371a1
2 files changed
tree: d9e9146b617b051bc6af03efe27ad70f4d99dc1c
  1. ci/
  2. tools/
  3. .gitignore
  4. commits.json
  5. DEPS
  6. OWNERS
  7. README.md
README.md

Monorepo

A gclient solution for checking out Dart and Flutter source trees

Monorepo is:

  • Optimized for Tip-of-Tree testing: The Monorepo DEPS used to check out Dart and Flutter dependencies comes from the Flutter engine DEPS with updated dependencies from Dart.

Checking out Monorepo

With depot_tools installed and on your path, create a directory for your monorepo checkout and run these commands to create a gclient solution in that directory:

mkdir monorepo
cd monorepo
gclient config --unmanaged https://dart.googlesource.com/monorepo
gclient sync -D

This gives you a checkout in the monorepo directory that contains:

monorepo/
  DEPS - the DEPS used for this gclient checkout
  commits.json - the pinned commits for Dart, flutter/engine,
                 and flutter/flutter
  tools/ - scripts used to create monorepo DEPS
engine/src/ - the flutter/buildroot repo
    flutter/ - the flutter/engine repo
    out/ - the build directory, where Flutter engine builds are created
    third_party/ - Flutter dependencies checked out by DEPS
      dart/ - the Dart SDK checkout.
        third_party - Dart dependencies, also used by Flutter
flutter/ - the flutter/flutter repo

Building Flutter engine

Flutter's instructions for building the engine are at Compiling the engine

They can be followed closely, with a few changes:

  • Googlers working on Dart do not need to switch to Fuchsia's Goma RBE, except for Windows. The GOMA_DIR enviroment variable can just point to the .cipd_bin directory in a depot_tools installation, and just goma_ctl ensure_start is sufficient.
  • The --no-prebuilt-dart-sdk option has to be added to every gn command, so that the build is set up to build and use a local Dart SDK.
  • The --full-dart-sdk option must be added to gn for the host build target if you will be building web or desktop apps.

Example build commands that work on linux:

MONOREPO_PATH=$PWD
if [[ ! $PATH =~ (^|:)$MONOREPO_PATH/flutter/bin(:|$) ]]; then
  PATH=$MONOREPO_PATH/flutter/bin:$PATH
fi

export GOMA_DIR=$(dirname $(command -v gclient))/.cipd_bin
goma_ctl ensure_start

pushd engine/src
flutter/tools/gn --goma --no-prebuilt-dart-sdk --unoptimized --full-dart-sdk
autoninja -C out/host_debug_unopt
popd

Building Flutter apps

The Flutter commands used to build and run apps will use the locally built Flutter engine and Dart SDK, instead of the one downloaded by the Flutter tool, if the --local-engine option is provided.

For example, to build and run the Flutter spinning square sample on the web platform,

MONOREPO_PATH=$PWD
cd flutter/examples/layers
flutter --local-engine=host_debug_unopt \
  -d chrome run widgets/spinning_square.dart
cd $MONOREPO_PATH

To build for desktop, specify the desktop platform device in flutter run as -d macos or -d linux or -d windows. You may also need to run the command

flutter create --platforms=windows,macos,linux

on existing apps, such as sample apps. New apps created with flutter create already include these support files. Details of desktop support are at Desktop Support for Flutter

Testing

Tests in the Flutter source tree can be run with the flutter test command, run in the directory of a package containing tests. For example:

MONOREPO_PATH=$PWD
cd flutter/packages/flutter
flutter test --local-engine=host_debug_unopt
cd $MONOREPO_PATH

Troubleshooting

Please file an issue or email the dart-engprod team with any problems with or questions about using monorepo.

We will update this documentation to address them.

  • flutter commands may download the engine and Dart SDK files for the configured channel, even though they will be using the local engine and its SDK.

Windows

  • On Windows, gclient sync needs to be run in an administrator session, because some installed dependencies create symlinks.