registerServiceExtension method

  1. @protected
void registerServiceExtension ({@required String name, @required ServiceExtensionCallback callback })
@protected

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.

The returned map will be mutated.

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).

{@inject-html}

{@end-inject-html}The following code registers a service extension that is only included in debug builds.{@inject-html}
void myRegistrationFunction() {
  assert(() {
    // Register your service extension here.
    return true;
  }());
}
{@end-inject-html}

{@inject-html}

{@end-inject-html}A service extension registered with the following code snippet is available in debug and profile mode.{@inject-html}
void myRegistrationFunction() {
  // kReleaseMode is defined in the 'flutter/foundation.dart' package.
  if (!kReleaseMode) {
    // Register your service extension here.
  }
}
{@end-inject-html}

Both guards ensure that Dart's tree shaker can remove the code for the service extension in release builds.

Implementation

@protected
void registerServiceExtension({
  @required String name,
  @required ServiceExtensionCallback callback,
}) {
  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);
    assert(() {
      if (debugInstrumentationEnabled)
        debugPrint('service extension method received: $method($parameters)');
      return true;
    }());

    // 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.
    await debugInstrumentAction<void>('Wait for outer event loop', () {
      return Future<void>.delayed(Duration.zero);
    });

    dynamic caughtException;
    StackTrace caughtStack;
    Map<String, dynamic> result;
    try {
      result = await callback(parameters);
    } catch (exception, stack) {
      caughtException = exception;
      caughtStack = stack;
    }
    if (caughtException == null) {
      result['type'] = '_extensionType';
      result['method'] = method;
      return developer.ServiceExtensionResponse.result(json.encode(result));
    } else {
      FlutterError.reportError(FlutterErrorDetails(
        exception: caughtException,
        stack: caughtStack,
        context: ErrorDescription('during a service extension callback for "$method"'),
      ));
      return developer.ServiceExtensionResponse.error(
        developer.ServiceExtensionResponse.extensionError,
        json.encode(<String, String>{
          'exception': caughtException.toString(),
          'stack': caughtStack.toString(),
          'method': method,
        }),
      );
    }
  });
}