Skip to content

Commit 4cd732b

Browse files
authored
Scaffold view metrics overrides (flutter#192764)
Scaffolding for `DebugViewMetricsOverride`, `DebugViewPadding`, `debugViewMetricsOverrides`, and the `ext.flutter.viewMetricsOverride` service extension. Part of flutter/devtools#9893 Implements Option 2 in https://flutter.dev/go/view-metrics-overrides.
1 parent b535b37 commit 4cd732b

5 files changed

Lines changed: 1919 additions & 3 deletions

File tree

‎packages/flutter/lib/src/foundation/binding.dart‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -648,6 +648,11 @@ abstract class BindingBase {
648648
};
649649
},
650650
);
651+
652+
registerServiceExtension(
653+
name: FoundationServiceExtensions.viewMetricsOverride.name,
654+
callback: _debugHandleViewMetricsOverrideServiceExtension,
655+
);
651656
return true;
652657
}());
653658
assert(() {
@@ -656,6 +661,91 @@ abstract class BindingBase {
656661
}());
657662
}
658663

664+
// The parameters of the `ext.flutter.viewMetricsOverride` service extension,
665+
// which [FoundationServiceExtensions.viewMetricsOverride] documents.
666+
static const String _viewIdParameter = 'viewId';
667+
static const String _overridesParameter = 'overrides';
668+
static const String _clearAllParameter = 'clearAll';
669+
670+
/// Implements the `ext.flutter.viewMetricsOverride` service extension.
671+
///
672+
/// See [FoundationServiceExtensions.viewMetricsOverride] for the parameters,
673+
/// the reply, and the event it posts.
674+
Future<Map<String, Object?>> _debugHandleViewMetricsOverrideServiceExtension(
675+
Map<String, String> parameters,
676+
) async {
677+
if (parameters[_clearAllParameter] == 'true') {
678+
if (debugClearViewMetricsOverrides()) {
679+
_postViewMetricsOverrideStateChangedEvent();
680+
}
681+
return _viewMetricsOverrideResult();
682+
}
683+
684+
final String? rawViewId = parameters[_viewIdParameter];
685+
final String? rawOverrides = parameters[_overridesParameter];
686+
if (rawViewId == null) {
687+
if (rawOverrides != null) {
688+
throw const FormatException(
689+
'The $_viewIdParameter parameter is required when $_overridesParameter is provided.',
690+
);
691+
}
692+
return _viewMetricsOverrideResult();
693+
}
694+
final int? viewId = int.tryParse(rawViewId);
695+
if (viewId == null || viewId < 0) {
696+
throw FormatException(
697+
'The $_viewIdParameter parameter must be a non-negative integer, got "$rawViewId".',
698+
);
699+
}
700+
701+
if (rawOverrides != null) {
702+
// DebugViewMetricsOverride.fromJson throws a FormatException on a
703+
// malformed payload, which the service extension machinery reports back
704+
// to the caller as an error rather than silently applying part of it.
705+
final DebugViewMetricsOverride override = switch (json.decode(rawOverrides)) {
706+
final Map<Object?, Object?> decoded => DebugViewMetricsOverride.fromJson(decoded),
707+
_ => throw const FormatException(
708+
'The $_overridesParameter parameter must be a JSON object.',
709+
),
710+
};
711+
if (debugSetViewMetricsOverride(viewId, override)) {
712+
_postViewMetricsOverrideStateChangedEvent();
713+
}
714+
}
715+
716+
return _viewMetricsOverrideResult();
717+
}
718+
719+
// The reply to every `ext.flutter.viewMetricsOverride` call, as documented on
720+
// [FoundationServiceExtensions.viewMetricsOverride].
721+
//
722+
// Built after the change has been applied, so that the reply describes the
723+
// registry as it stands once the call is done.
724+
Map<String, Object?> _viewMetricsOverrideResult() {
725+
return <String, Object?>{'overrides': _viewMetricsOverridesWithStringKeys()};
726+
}
727+
728+
// [debugViewMetricsOverrides] with its view ids stringified, because
729+
// json.encode accepts only String keys. It calls toJson on the values itself.
730+
// Both the reply and the event carry this map.
731+
Map<String, DebugViewMetricsOverride> _viewMetricsOverridesWithStringKeys() {
732+
return <String, DebugViewMetricsOverride>{
733+
for (final MapEntry<int, DebugViewMetricsOverride> entry in debugViewMetricsOverrides.entries)
734+
'${entry.key}': entry.value,
735+
};
736+
}
737+
738+
// The whole of [debugViewMetricsOverrides], rather than the entry that
739+
// changed, because one event then describes the state of the extension for a
740+
// client that missed the ones before it — including the clearAll that leaves
741+
// no entry to report.
742+
void _postViewMetricsOverrideStateChangedEvent() {
743+
_postExtensionStateChangedEvent(
744+
FoundationServiceExtensions.viewMetricsOverride.name,
745+
_viewMetricsOverridesWithStringKeys(),
746+
);
747+
}
748+
659749
/// Whether [lockEvents] is currently locking events.
660750
///
661751
/// Binding subclasses that fire events should check this first, and if it is

0 commit comments

Comments
 (0)