binding.dart 20.4 KB
Newer Older
1 2 3 4
// Copyright 2016 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5
import 'dart:async';
6
import 'dart:convert' show json;
7
import 'dart:developer' as developer;
8
import 'dart:io' show exit;
9
import 'dart:ui' as ui show saveCompilationTrace, Window, window;
10
// Before adding any more dart:ui imports, please read the README.
11

12
import 'package:meta/meta.dart';
13 14 15

import 'assertions.dart';
import 'basic_types.dart';
16
import 'constants.dart';
17
import 'debug.dart';
18
import 'platform.dart';
19
import 'print.dart';
20 21 22 23 24 25 26 27

/// Signature for service extensions.
///
/// The returned map must not contain the keys "type" or "method", as
/// they will be replaced before the value is sent to the client. The
/// "type" key will be set to the string `_extensionType` to indicate
/// that this is a return value from a service extension, and the
/// "method" key will be set to the full name of the method.
28
typedef ServiceExtensionCallback = Future<Map<String, dynamic>> Function(Map<String, String> parameters);
29

30 31 32
/// Base class for mixins that provide singleton services (also known as
/// "bindings").
///
33
/// To use this class in an `on` clause of a mixin, inherit from it and implement
34 35 36
/// [initInstances()]. The mixin is guaranteed to only be constructed once in
/// the lifetime of the app (more precisely, it will assert if constructed twice
/// in checked mode).
37
///
38 39 40 41 42 43 44
/// The top-most layer used to write the application will have a concrete class
/// that inherits from [BindingBase] and uses all the various [BindingBase]
/// mixins (such as [ServicesBinding]). For example, the Widgets library in
/// Flutter introduces a binding called [WidgetsFlutterBinding]. The relevant
/// library defines how to create the binding. It could be implied (for example,
/// [WidgetsFlutterBinding] is automatically started from [runApp]), or the
/// application might be required to explicitly call the constructor.
45
abstract class BindingBase {
46 47 48 49 50 51
  /// Default abstract constructor for bindings.
  ///
  /// First calls [initInstances] to have bindings initialize their
  /// instance pointers and other state, then calls
  /// [initServiceExtensions] to have bindings initialize their
  /// observatory service extensions, if any.
52
  BindingBase() {
53 54
    developer.Timeline.startSync('Framework initialization');

55 56 57
    assert(!_debugInitialized);
    initInstances();
    assert(_debugInitialized);
58 59 60 61

    assert(!_debugServiceExtensionsRegistered);
    initServiceExtensions();
    assert(_debugServiceExtensionsRegistered);
62

63
    developer.postEvent('Flutter.FrameworkInitialization', <String, String>{});
64

65
    developer.Timeline.finishSync();
66 67 68
  }

  static bool _debugInitialized = false;
69
  static bool _debugServiceExtensionsRegistered = false;
70

71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
  /// The window to which this binding is bound.
  ///
  /// A number of additional bindings are defined as extensions of [BindingBase],
  /// e.g., [ServicesBinding], [RendererBinding], and [WidgetsBinding]. Each of
  /// these bindings define behaviors that interact with a [ui.Window], e.g.,
  /// [ServicesBinding] registers a [ui.Window.onPlatformMessage] handler, and
  /// [RendererBinding] registers [ui.Window.onMetricsChanged],
  /// [ui.Window.onTextScaleFactorChanged], [ui.Window.onSemanticsEnabledChanged],
  /// and [ui.Window.onSemanticsAction] handlers.
  ///
  /// Each of these other bindings could individually access a [Window] statically,
  /// but that would preclude the ability to test these behaviors with a fake
  /// window for verification purposes.  Therefore, [BindingBase] exposes this
  /// [Window] for use by other bindings.  A subclass of [BindingBase], such as
  /// [TestWidgetsFlutterBinding], can override this accessor to return a
  /// different [Window] implementation, such as a [TestWindow].
  ui.Window get window => ui.window;

89 90 91 92 93 94 95 96
  /// The initialization method. Subclasses override this method to hook into
  /// the platform and otherwise configure their services. Subclasses must call
  /// "super.initInstances()".
  ///
  /// By convention, if the service is to be provided as a singleton, it should
  /// be exposed as `MixinClassName.instance`, a static getter that returns
  /// `MixinClassName._instance`, a static field that is set by
  /// `initInstances()`.
97 98
  @protected
  @mustCallSuper
99
  void initInstances() {
100
    assert(!_debugInitialized);
101 102 103 104
    assert(() {
      _debugInitialized = true;
      return true;
    }());
105 106
  }

107 108 109 110 111 112 113 114 115 116 117 118 119
  /// Called when the binding is initialized, to register service
  /// extensions.
  ///
  /// Bindings that want to expose service extensions should overload
  /// this method to register them using calls to
  /// [registerSignalServiceExtension],
  /// [registerBoolServiceExtension],
  /// [registerNumericServiceExtension], and
  /// [registerServiceExtension] (in increasing order of complexity).
  ///
  /// Implementations of this method must call their superclass
  /// implementation.
  ///
120
  /// {@macro flutter.foundation.bindingBase.registerServiceExtension}
121 122 123 124
  ///
  /// See also:
  ///
  ///  * <https://github.com/dart-lang/sdk/blob/master/runtime/vm/service/service.md#rpcs-requests-and-responses>
125 126
  @protected
  @mustCallSuper
127 128
  void initServiceExtensions() {
    assert(!_debugServiceExtensionsRegistered);
129 130 131 132 133 134 135 136 137

    assert(() {
      registerSignalServiceExtension(
        name: 'reassemble',
        callback: reassembleApplication,
      );
      return true;
    }());

138
    if (!kReleaseMode && !kIsWeb) {
139 140 141 142
      registerSignalServiceExtension(
        name: 'exit',
        callback: _exitApplication,
      );
143
      registerServiceExtension(
144
        name: 'saveCompilationTrace',
145
        callback: (Map<String, String> parameters) async {
146
          return <String, dynamic>{
147
            'value': ui.saveCompilationTrace(),
148
          };
149
        },
150
      );
151 152
    }

153
    assert(() {
154
      const String platformOverrideExtensionName = 'platformOverride';
155
      registerServiceExtension(
156
        name: platformOverrideExtensionName,
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
        callback: (Map<String, String> parameters) async {
          if (parameters.containsKey('value')) {
            switch (parameters['value']) {
              case 'android':
                debugDefaultTargetPlatformOverride = TargetPlatform.android;
                break;
              case 'iOS':
                debugDefaultTargetPlatformOverride = TargetPlatform.iOS;
                break;
              case 'fuchsia':
                debugDefaultTargetPlatformOverride = TargetPlatform.fuchsia;
                break;
              case 'default':
              default:
                debugDefaultTargetPlatformOverride = null;
            }
173 174 175 176
            _postExtensionStateChangedEvent(
              platformOverrideExtensionName,
              defaultTargetPlatform.toString().substring('$TargetPlatform.'.length),
            );
177 178
            await reassembleApplication();
          }
179
          return <String, dynamic>{
180 181 182 183
            'value': defaultTargetPlatform
                     .toString()
                     .substring('$TargetPlatform.'.length),
          };
184
        },
185 186
      );
      return true;
187
    }());
188 189 190 191
    assert(() {
      _debugServiceExtensionsRegistered = true;
      return true;
    }());
192 193
  }

194 195 196 197 198 199 200 201 202 203 204 205 206 207
  /// Whether [lockEvents] is currently locking events.
  ///
  /// Binding subclasses that fire events should check this first, and if it is
  /// set, queue events instead of firing them.
  ///
  /// Events should be flushed when [unlocked] is called.
  @protected
  bool get locked => _lockCount > 0;
  int _lockCount = 0;

  /// Locks the dispatching of asynchronous events and callbacks until the
  /// callback's future completes.
  ///
  /// This causes input lag and should therefore be avoided when possible. It is
208 209 210
  /// primarily intended for use during non-user-interactive time such as to
  /// allow [reassembleApplication] to block input while it walks the tree
  /// (which it partially does asynchronously).
211 212 213
  ///
  /// The [Future] returned by the `callback` argument is returned by [lockEvents].
  @protected
214
  Future<void> lockEvents(Future<void> callback()) {
215 216
    developer.Timeline.startSync('Lock events');

217 218
    assert(callback != null);
    _lockCount += 1;
219
    final Future<void> future = callback();
220
    assert(future != null, 'The lockEvents() callback returned null; it should return a Future<void> that completes when the lock is to expire.');
221 222
    future.whenComplete(() {
      _lockCount -= 1;
223 224
      if (!locked) {
        developer.Timeline.finishSync();
225
        unlocked();
226
      }
227 228 229 230 231 232 233 234
    });
    return future;
  }

  /// Called by [lockEvents] when events get unlocked.
  ///
  /// This should flush any events that were queued while [locked] was true.
  @protected
235
  @mustCallSuper
236 237 238 239
  void unlocked() {
    assert(!locked);
  }

240
  /// Cause the entire application to redraw, e.g. after a hot reload.
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
  ///
  /// This is used by development tools when the application code has changed,
  /// to cause the application to pick up any changed code. It can be triggered
  /// manually by sending the `ext.flutter.reassemble` service extension signal.
  ///
  /// This method is very computationally expensive and should not be used in
  /// production code. There is never a valid reason to cause the entire
  /// application to repaint in production. All aspects of the Flutter framework
  /// know how to redraw when necessary. It is only necessary in development
  /// when the code is literally changed on the fly (e.g. in hot reload) or when
  /// debug flags are being toggled.
  ///
  /// While this method runs, events are locked (e.g. pointer events are not
  /// dispatched).
  ///
  /// Subclasses (binding classes) should override [performReassemble] to react
  /// to this method being called. This method itself should not be overridden.
258
  Future<void> reassembleApplication() {
259 260 261 262
    return lockEvents(performReassemble);
  }

  /// This method is called by [reassembleApplication] to actually cause the
263
  /// application to reassemble, e.g. after a hot reload.
264
  ///
265
  /// Bindings are expected to use this method to re-register anything that uses
266 267 268 269 270 271 272 273
  /// closures, so that they do not keep pointing to old code, and to flush any
  /// caches of previously computed values, in case the new code would compute
  /// them differently. For example, the rendering layer triggers the entire
  /// application to repaint when this is called.
  ///
  /// Do not call this method directly. Instead, use [reassembleApplication].
  @mustCallSuper
  @protected
274
  Future<void> performReassemble() {
275
    FlutterError.resetErrorCount();
276
    return Future<void>.value();
277
  }
278 279 280 281 282

  /// Registers a service extension method with the given name (full
  /// name "ext.flutter.name"), which takes no arguments and returns
  /// no value.
  ///
283
  /// Calls the `callback` callback when the service extension is called.
284 285
  ///
  /// {@macro flutter.foundation.bindingBase.registerServiceExtension}
286
  @protected
287
  void registerSignalServiceExtension({
288
    @required String name,
289
    @required AsyncCallback callback,
290 291 292 293 294 295
  }) {
    assert(name != null);
    assert(callback != null);
    registerServiceExtension(
      name: name,
      callback: (Map<String, String> parameters) async {
296
        await callback();
297
        return <String, dynamic>{};
298
      },
299 300 301 302 303 304 305 306 307 308
    );
  }

  /// Registers a service extension method with the given name (full
  /// name "ext.flutter.name"), which takes a single argument
  /// "enabled" which can have the value "true" or the value "false"
  /// or can be omitted to read the current value. (Any value other
  /// than "true" is considered equivalent to "false". Other arguments
  /// are ignored.)
  ///
309 310
  /// Calls the `getter` callback to obtain the value when
  /// responding to the service extension method being called.
311
  ///
312 313
  /// Calls the `setter` callback with the new value when the
  /// service extension method is called with a new value.
314 315
  ///
  /// {@macro flutter.foundation.bindingBase.registerServiceExtension}
316
  @protected
317
  void registerBoolServiceExtension({
318
    @required String name,
319
    @required AsyncValueGetter<bool> getter,
320
    @required AsyncValueSetter<bool> setter,
321 322 323 324 325
  }) {
    assert(name != null);
    assert(getter != null);
    assert(setter != null);
    registerServiceExtension(
326
      name: name,
327
      callback: (Map<String, String> parameters) async {
328
        if (parameters.containsKey('enabled')) {
329
          await setter(parameters['enabled'] == 'true');
330 331
          _postExtensionStateChangedEvent(name, await getter() ? 'true' : 'false');
        }
332
        return <String, dynamic>{'enabled': await getter() ? 'true' : 'false'};
333
      },
334 335 336 337 338 339 340 341 342
    );
  }

  /// Registers a service extension method with the given name (full
  /// name "ext.flutter.name"), which takes a single argument with the
  /// same name as the method which, if present, must have a value
  /// that can be parsed by [double.parse], and can be omitted to read
  /// the current value. (Other arguments are ignored.)
  ///
343 344
  /// Calls the `getter` callback to obtain the value when
  /// responding to the service extension method being called.
345
  ///
346 347
  /// Calls the `setter` callback with the new value when the
  /// service extension method is called with a new value.
348 349
  ///
  /// {@macro flutter.foundation.bindingBase.registerServiceExtension}
350
  @protected
351
  void registerNumericServiceExtension({
352
    @required String name,
353
    @required AsyncValueGetter<double> getter,
354
    @required AsyncValueSetter<double> setter,
355 356 357 358 359 360 361
  }) {
    assert(name != null);
    assert(getter != null);
    assert(setter != null);
    registerServiceExtension(
      name: name,
      callback: (Map<String, String> parameters) async {
362
        if (parameters.containsKey(name)) {
363
          await setter(double.parse(parameters[name]));
364 365
          _postExtensionStateChangedEvent(name, (await getter()).toString());
        }
366
        return <String, dynamic>{name: (await getter()).toString()};
367
      },
368 369 370
    );
  }

371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
  /// Sends an event when a service extension's state is changed.
  ///
  /// Clients should listen for this event to stay aware of the current service
  /// extension state. Any service extension that manages a state should call
  /// this method on state change.
  ///
  /// `value` reflects the newly updated service extension value.
  ///
  /// This will be called automatically for service extensions registered via
  /// [registerBoolServiceExtension], [registerNumericServiceExtension], or
  /// [registerStringServiceExtension].
  void _postExtensionStateChangedEvent(String name, dynamic value) {
    postEvent(
      'Flutter.ServiceExtensionStateChanged',
      <String, dynamic>{
        'extension': 'ext.flutter.$name',
        'value': value,
      },
    );
  }

  /// All events dispatched by a [BindingBase] use this method instead of
  /// calling [developer.postEvent] directly so that tests for [BindingBase]
  /// can track which events were dispatched by overriding this method.
  @protected
  void postEvent(String eventKind, Map<String, dynamic> eventData) {
    developer.postEvent(eventKind, eventData);
  }

400 401 402 403 404 405 406 407 408 409
  /// Registers a service extension method with the given name (full name
  /// "ext.flutter.name"), which optionally takes a single argument with the
  /// name "value". If the argument is omitted, the value is to be read,
  /// otherwise it is to be set. Returns the current value.
  ///
  /// Calls the `getter` callback to obtain the value when
  /// responding to the service extension method being called.
  ///
  /// Calls the `setter` callback with the new value when the
  /// service extension method is called with a new value.
410 411
  ///
  /// {@macro flutter.foundation.bindingBase.registerServiceExtension}
412
  @protected
413 414
  void registerStringServiceExtension({
    @required String name,
415
    @required AsyncValueGetter<String> getter,
416
    @required AsyncValueSetter<String> setter,
417 418 419 420 421 422 423
  }) {
    assert(name != null);
    assert(getter != null);
    assert(setter != null);
    registerServiceExtension(
      name: name,
      callback: (Map<String, String> parameters) async {
424
        if (parameters.containsKey('value')) {
425
          await setter(parameters['value']);
426 427
          _postExtensionStateChangedEvent(name, await getter());
        }
428
        return <String, dynamic>{'value': await getter()};
429
      },
430 431 432
    );
  }

433 434 435 436 437 438 439 440 441
  /// Registers a service extension method with the given name (full name
  /// "ext.flutter.name").
  ///
  /// The given callback is called when the extension method is called. The
  /// callback must return a [Future] that either eventually completes to a
  /// return value in the form of a name/value map where the values can all be
  /// converted to JSON using `json.encode()` (see [JsonEncoder]), or fails. In
  /// case of failure, the failure is reported to the remote caller and is
  /// dumped to the logs.
442 443
  ///
  /// The returned map will be mutated.
444 445 446 447 448 449 450 451 452
  ///
  /// {@template flutter.foundation.bindingBase.registerServiceExtension}
  /// A registered service extension can only be activated if the vm-service
  /// is included in the build, which only happens in debug and profile mode.
  /// Although a service extension cannot be used in release mode its code may
  /// still be included in the Dart snapshot and blow up binary size if it is
  /// not wrapped in a guard that allows the tree shaker to remove it (see
  /// sample code below).
  ///
453
  /// {@tool sample}
454
  /// The following code registers a service extension that is only included in
455
  /// debug builds.
456 457
  ///
  /// ```dart
458 459 460 461 462 463
  /// void myRegistrationFunction() {
  ///   assert(() {
  ///     // Register your service extension here.
  ///     return true;
  ///   }());
  /// }
464
  /// ```
465
  /// {@end-tool}
466
  ///
467
  /// {@tool sample}
468
  /// A service extension registered with the following code snippet is
469
  /// available in debug and profile mode.
470 471
  ///
  /// ```dart
472 473 474 475 476 477
  /// void myRegistrationFunction() {
  ///   // kReleaseMode is defined in the 'flutter/foundation.dart' package.
  ///   if (!kReleaseMode) {
  ///     // Register your service extension here.
  ///   }
  /// }
478
  /// ```
479
  /// {@end-tool}
480 481 482
  ///
  /// Both guards ensure that Dart's tree shaker can remove the code for the
  /// service extension in release builds.
483
  /// {@endtemplate}
484
  @protected
485
  void registerServiceExtension({
486
    @required String name,
487
    @required ServiceExtensionCallback callback,
488 489 490 491 492 493
  }) {
    assert(name != null);
    assert(callback != null);
    final String methodName = 'ext.flutter.$name';
    developer.registerExtension(methodName, (String method, Map<String, String> parameters) async {
      assert(method == methodName);
494 495 496 497 498
      assert(() {
        if (debugInstrumentationEnabled)
          debugPrint('service extension method received: $method($parameters)');
        return true;
      }());
499 500 501 502 503 504 505 506 507 508 509

      // VM service extensions are handled as "out of band" messages by the VM,
      // which means they are handled at various times, generally ASAP.
      // Notably, this includes being handled in the middle of microtask loops.
      // While this makes sense for some service extensions (e.g. "dump current
      // stack trace", which explicitly doesn't want to wait for a loop to
      // complete), Flutter extensions need not be handled with such high
      // priority. Further, handling them with such high priority exposes us to
      // the possibility that they're handled in the middle of a frame, which
      // breaks many assertions. As such, we ensure they we run the callbacks
      // on the outer event loop here.
510
      await debugInstrumentAction<void>('Wait for outer event loop', () {
511
        return Future<void>.delayed(Duration.zero);
512
      });
513

514 515
      dynamic caughtException;
      StackTrace caughtStack;
516
      Map<String, dynamic> result;
517 518 519 520 521 522 523 524 525
      try {
        result = await callback(parameters);
      } catch (exception, stack) {
        caughtException = exception;
        caughtStack = stack;
      }
      if (caughtException == null) {
        result['type'] = '_extensionType';
        result['method'] = method;
526
        return developer.ServiceExtensionResponse.result(json.encode(result));
527
      } else {
528
        FlutterError.reportError(FlutterErrorDetails(
529 530
          exception: caughtException,
          stack: caughtStack,
531
          context: ErrorDescription('during a service extension callback for "$method"'),
532
        ));
533
        return developer.ServiceExtensionResponse.error(
534
          developer.ServiceExtensionResponse.extensionError,
535
          json.encode(<String, String>{
536 537
            'exception': caughtException.toString(),
            'stack': caughtStack.toString(),
538
            'method': method,
539
          }),
540 541 542 543 544
        );
      }
    });
  }

545 546 547
  @override
  String toString() => '<$runtimeType>';
}
548 549

/// Terminate the Flutter application.
550
Future<void> _exitApplication() async {
551 552
  exit(0);
}