development/flutter
development/flutter
1
0
Fork 0
mirror of https://github.com/flutter/flutter synced 2024-10-02 14:34:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add new WidgetInspector service extension: getRootWidgetTree (#150010)

Browse source 
The new service extension `getRootWidgetTree` can be used instead of the existing:

* `getRootWidgetSummaryTree` -->  use`getRootWidgetTree` with parameters `isSummaryTree=true`
* `getRootWidgetSummaryTreeWithPreviews` --> use `getRootWidgetTree` with parameters `isSummaryTree=true` and `withPreviews=true`

This new service extension will enable Flutter DevTools to combine the widget summary tree with the widget details tree by calling `getRootWidgetTree` with `isSummary=false` and `withPreviews=true`. 

Closes https://github.com/flutter/devtools/issues/7894
This commit is contained in:
Elliott Brooks 2024-06-11 22:15:34 -07:00 committed by GitHub
parent c5e5e0cc36
commit 1f93809ad2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 386 additions and 65 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
packages/flutter/lib/src/widgets/service_extensions.dart
View file

@ -366,6 +366,22 @@ enum WidgetInspectorServiceExtensions {
/// extension is registered.
getRootWidget,
/// Name of service extension that, when called, will return the
/// [DiagnosticsNode] data for the root [Element] of the widget tree.
///
/// If the parameter `isSummaryTree` is true, the tree will only include
/// [Element]s that were created by user code.
///
/// If the parameter `withPreviews` is true, text previews will be included
/// for [Element]s with a corresponding [RenderObject] of type
/// [RenderParagraph].
///
/// See also:
///
/// * [WidgetInspectorService.initServiceExtensions], where the service
/// extension is registered.
getRootWidgetTree,
/// Name of service extension that, when called, will return the
/// [DiagnosticsNode] data for the root [Element] of the summary tree, which
/// only includes [Element]s that were created by user code.

102
packages/flutter/lib/src/widgets/widget_inspector.dart
View file

@ -1255,6 +1255,11 @@ mixin WidgetInspectorService {
callback: _getRootWidgetSummaryTreeWithPreviews,
registerExtension: registerExtension,
);
registerServiceExtension(
name: WidgetInspectorServiceExtensions.getRootWidgetTree.name,
callback: _getRootWidgetTree,
registerExtension: registerExtension,
);
registerServiceExtension(
name: WidgetInspectorServiceExtensions.getDetailsSubtree.name,
callback: (Map<String, String> parameters) async {
@ -1951,42 +1956,93 @@ mixin WidgetInspectorService {
String groupName, {
Map<String, Object>? Function(DiagnosticsNode, InspectorSerializationDelegate)? addAdditionalPropertiesCallback,
}) {
return _nodeToJson(
WidgetsBinding.instance.rootElement?.toDiagnosticsNode(),
InspectorSerializationDelegate(
groupName: groupName,
subtreeDepth: 1000000,
summaryTree: true,
service: this,
addAdditionalPropertiesCallback: addAdditionalPropertiesCallback,
),
return _getRootWidgetTreeImpl(
groupName: groupName,
isSummaryTree: true,
withPreviews: false,
addAdditionalPropertiesCallback: addAdditionalPropertiesCallback,
);
}
Future<Map<String, Object?>> _getRootWidgetSummaryTreeWithPreviews(
Map<String, String> parameters,
) {
final String groupName = parameters['groupName']!;
final Map<String, Object?>? result = _getRootWidgetSummaryTree(
groupName,
addAdditionalPropertiesCallback: (DiagnosticsNode node, InspectorSerializationDelegate? delegate) {
final Map<String, Object> additionalJson = <String, Object>{};
final Object? value = node.value;
if (value is Element) {
final RenderObject? renderObject = value.renderObject;
if (renderObject is RenderParagraph) {
additionalJson['textPreview'] = renderObject.text.toPlainText();
}
}
return additionalJson;
},
final Map<String, Object?>? result = _getRootWidgetTreeImpl(
groupName: groupName,
isSummaryTree: true,
withPreviews: true,
);
return Future<Map<String, dynamic>>.value(<String, dynamic>{
'result': result,
});
}
Future<Map<String, Object?>> _getRootWidgetTree(
Map<String, String> parameters,
) {
final String groupName = parameters['groupName']!;
final bool isSummaryTree = parameters['isSummaryTree'] == 'true';
final bool withPreviews = parameters['withPreviews'] == 'true';
final Map<String, Object?>? result = _getRootWidgetTreeImpl(
groupName: groupName,
isSummaryTree: isSummaryTree,
withPreviews: withPreviews,
);
return Future<Map<String, dynamic>>.value(<String, dynamic>{
'result': result,
});
}
Map<String, Object?>? _getRootWidgetTreeImpl({
required String groupName,
required bool isSummaryTree,
required bool withPreviews,
Map<String, Object>? Function(
DiagnosticsNode, InspectorSerializationDelegate)?
addAdditionalPropertiesCallback,
}) {
final bool shouldAddAdditionalProperties =
addAdditionalPropertiesCallback != null || withPreviews;
// Combine the given addAdditionalPropertiesCallback with logic to add text
// previews as well (if withPreviews is true):
Map<String, Object>? combinedAddAdditionalPropertiesCallback(
DiagnosticsNode node,
InspectorSerializationDelegate delegate,
) {
final Map<String, Object> additionalPropertiesJson =
addAdditionalPropertiesCallback?.call(node, delegate) ??
<String, Object>{};
if (!withPreviews) {
return additionalPropertiesJson;
}
final Object? value = node.value;
if (value is Element) {
final RenderObject? renderObject = value.renderObject;
if (renderObject is RenderParagraph) {
additionalPropertiesJson['textPreview'] =
renderObject.text.toPlainText();
}
}
return additionalPropertiesJson;
}
return _nodeToJson(
WidgetsBinding.instance.rootElement?.toDiagnosticsNode(),
InspectorSerializationDelegate(
groupName: groupName,
subtreeDepth: 1000000,
summaryTree: isSummaryTree,
service: this,
addAdditionalPropertiesCallback: shouldAddAdditionalProperties
? combinedAddAdditionalPropertiesCallback
: null,
),
);
}
/// Returns a JSON representation of the subtree rooted at the
/// [DiagnosticsNode] object that `diagnosticsNodeId` references providing
/// information needed for the details subtree view.

2
packages/flutter/test/foundation/service_extensions_test.dart
View file

@ -166,7 +166,7 @@ void main() {
tearDownAll(() async {
// See widget_inspector_test.dart for tests of the ext.flutter.inspector
// service extensions included in this count.
int widgetInspectorExtensionCount = 28;
int widgetInspectorExtensionCount = 29;
if (WidgetInspectorService.instance.isWidgetCreationTracked()) {
// Some inspector extensions are only exposed if widget creation locations
// are tracked.

331
packages/flutter/test/widgets/widget_inspector_test.dart
View file

@ -1977,6 +1977,27 @@ class _TestWidgetInspectorService extends TestWidgetInspectorService {
))! as List<Object?>;
}
/// Returns whether the child was created by the local project.
bool wasCreatedByLocalProject(Map<String, Object?> childJson) {
return childJson['createdByLocalProject'] == true;
}
/// Returns whether the child has a description matching [description].
bool hasDescription(
Map<String, Object?> childJson, {
required String description,
}) {
return childJson['description'] == description;
}
/// Returns whether the child has a text preview matching [preview].
bool hasTextPreview(
Map<String, Object?> childJson, {
required String preview,
}) {
return childJson['textPreview'] == preview;
}
/// Verifies that the children from the JSON response are identical to
/// those from [WidgetInspectorServiceExtensions.getChildrenSummaryTree].
Future<void> verifyChildrenMatchOtherApi(Map<String, Object?> jsonResponse,
@ -2044,7 +2065,7 @@ class _TestWidgetInspectorService extends TestWidgetInspectorService {
// If the tree was requested with previews, then check that the
// child has the `textPreview` key:
if (checkForPreviews) {
expect(child['textPreview'], equals('c'));
expect(hasTextPreview(child, preview: 'c'), isTrue);
}
// Get the first child's first child's third child's children.
@ -2057,46 +2078,184 @@ class _TestWidgetInspectorService extends TestWidgetInspectorService {
expect(childrenFromOtherApi.length, equals(children.length));
}
testWidgets('ext.flutter.inspector.getRootWidgetSummaryTree',
bool allChildrenSatisfyCondition(Map<String, Object?> treeRoot,
{
required bool Function(Map<String, Object?> child) condition,
}) {
final List<Object?> children = childrenFromJsonResponse(treeRoot);
for (int childIdx = 0; childIdx < children.length; childIdx++) {
final Map<String, Object?> child =
children[childIdx]! as Map<String, Object?>;
if (!condition(child)) {
return false;
}
if (!allChildrenSatisfyCondition(child, condition: condition)) {
return false;
}
}
return true;
}
bool oneChildSatisfiesCondition(Map<String, Object?> treeRoot,
{
required bool Function(Map<String, Object?> child) condition,
}) {
final List<Object?> children = childrenFromJsonResponse(treeRoot);
for (int childIdx = 0; childIdx < children.length; childIdx++) {
final Map<String, Object?> child =
children[childIdx]! as Map<String, Object?>;
if (condition(child)) {
return true;
}
if (oneChildSatisfiesCondition(child, condition: condition)) {
return true;
}
}
return false;
}
/// Determines which API to call to get the summary tree.
String getExtensionApiToCall({
required bool useGetRootWidgetTreeApi,
required bool withPreviews,
}) {
if (useGetRootWidgetTreeApi) {
return WidgetInspectorServiceExtensions.getRootWidgetTree.name;
} else if (withPreviews) {
return WidgetInspectorServiceExtensions
.getRootWidgetSummaryTreeWithPreviews.name;
} else {
return WidgetInspectorServiceExtensions
.getRootWidgetSummaryTree.name;
}
}
/// Determines which parameters to use for the summary tree API call.
Map<String, String> getExtensionApiParams({
required bool useGetRootWidgetTreeApi,
required String groupName,
required bool withPreviews,
}) {
if (useGetRootWidgetTreeApi) {
return <String, String>{
'groupName': groupName,
'isSummaryTree': 'true',
'withPreviews': '$withPreviews',
};
} else if (withPreviews) {
return <String, String>{'groupName': groupName};
} else {
return <String, String>{'objectGroup': groupName};
}
}
for (final bool useGetRootWidgetTreeApi in <bool>[true, false]) {
final String extensionApiNoPreviews = getExtensionApiToCall(
useGetRootWidgetTreeApi: useGetRootWidgetTreeApi,
withPreviews: false,
);
final String extensionApiWithPreviews = getExtensionApiToCall(
useGetRootWidgetTreeApi: useGetRootWidgetTreeApi,
withPreviews: true,
);
testWidgets(
'summary tree using ext.flutter.inspector.$extensionApiNoPreviews',
(WidgetTester tester) async {
const String group = 'test-group';
await pumpWidgetTreeWithABC(tester);
final Element elementA = findElementABC('a');
final Map<String, dynamic> jsonA =
await selectedWidgetResponseForElement(elementA);
service.resetPubRootDirectories();
Map<String, Object?> rootJson = (await service.testExtension(
extensionApiNoPreviews,
getExtensionApiParams(
useGetRootWidgetTreeApi: useGetRootWidgetTreeApi,
groupName: group,
withPreviews: false,
),
))! as Map<String, Object?>;
// We haven't yet properly specified which directories are summary tree
// directories so we get an empty tree other than the root that is always
// included.
final Object? rootWidget =
service.toObject(rootJson['valueId']! as String);
expect(rootWidget, equals(WidgetsBinding.instance.rootElement));
final List<Object?> childrenJson =
rootJson['children']! as List<Object?>;
// There are no summary tree children.
expect(childrenJson.length, equals(0));
final Map<String, Object?> creationLocation =
verifyAndReturnCreationLocation(jsonA);
final String testFile = verifyAndReturnTestFile(creationLocation);
addPubRootDirectoryFor(testFile);
rootJson = (await service.testExtension(
extensionApiNoPreviews,
getExtensionApiParams(
useGetRootWidgetTreeApi: useGetRootWidgetTreeApi,
groupName: group,
withPreviews: false,
),
))! as Map<String, Object?>;
expect(
allChildrenSatisfyCondition(rootJson,
condition: wasCreatedByLocalProject,
),
isTrue,
);
await verifyChildrenMatchOtherApi(rootJson, group: group);
});
testWidgets(
'summary tree with previews using ext.flutter.inspector.$extensionApiWithPreviews',
(WidgetTester tester) async {
const String group = 'test-group';
await pumpWidgetTreeWithABC(tester);
final Element elementA = findElementABC('a');
final Map<String, dynamic> jsonA =
await selectedWidgetResponseForElement(elementA);
const String group = 'test-group';
service.resetPubRootDirectories();
Map<String, Object?> rootJson = (await service.testExtension(
WidgetInspectorServiceExtensions.getRootWidgetSummaryTree.name,
<String, String>{'objectGroup': group},
))! as Map<String, Object?>;
await pumpWidgetTreeWithABC(tester);
final Element elementA = findElementABC('a');
final Map<String, dynamic> jsonA =
await selectedWidgetResponseForElement(elementA);
// We haven't yet properly specified which directories are summary tree
// directories so we get an empty tree other than the root that is always
// included.
final Object? rootWidget =
service.toObject(rootJson['valueId']! as String);
expect(rootWidget, equals(WidgetsBinding.instance.rootElement));
final List<Object?> childrenJson =
rootJson['children']! as List<Object?>;
// There are no summary tree children.
expect(childrenJson.length, equals(0));
final Map<String, Object?> creationLocation =
verifyAndReturnCreationLocation(jsonA);
final String testFile = verifyAndReturnTestFile(creationLocation);
addPubRootDirectoryFor(testFile);
final Map<String, Object?> creationLocation =
verifyAndReturnCreationLocation(jsonA);
final String testFile = verifyAndReturnTestFile(creationLocation);
addPubRootDirectoryFor(testFile);
final Map<String, Object?> rootJson =
(await service.testExtension(
extensionApiWithPreviews,
getExtensionApiParams(
useGetRootWidgetTreeApi: useGetRootWidgetTreeApi,
groupName: group,
withPreviews: true,
),
))! as Map<String, Object?>;
rootJson = (await service.testExtension(
WidgetInspectorServiceExtensions.getRootWidgetSummaryTree.name,
<String, String>{'objectGroup': group},
))! as Map<String, Object?>;
await verifyChildrenMatchOtherApi(rootJson, group: group);
});
expect(
allChildrenSatisfyCondition(rootJson,
condition: wasCreatedByLocalProject,
),
isTrue,
);
await verifyChildrenMatchOtherApi(
rootJson,
group: group,
checkForPreviews: true,
);
});
}
testWidgets(
'ext.flutter.inspector.getRootWidgetSummaryTreeWithPreviews',
'full tree using ext.flutter.inspector.getRootWidgetTree',
(WidgetTester tester) async {
const String group = 'test-group';
@ -2111,15 +2270,105 @@ class _TestWidgetInspectorService extends TestWidgetInspectorService {
addPubRootDirectoryFor(testFile);
final Map<String, Object?> rootJson = (await service.testExtension(
WidgetInspectorServiceExtensions
.getRootWidgetSummaryTreeWithPreviews.name,
<String, String>{'groupName': group},
WidgetInspectorServiceExtensions.getRootWidgetTree.name,
<String, String>{
'groupName': group,
'isSummaryTree': 'false',
'withPreviews': 'false',
},
))! as Map<String, Object?>;
await verifyChildrenMatchOtherApi(
rootJson,
group: group,
checkForPreviews: true,
expect(
allChildrenSatisfyCondition(rootJson,
condition: wasCreatedByLocalProject,
),
isFalse,
);
expect(
oneChildSatisfiesCondition(rootJson, condition: (Map<String, Object?> child) {
return hasDescription(child, description: 'Text') &&
wasCreatedByLocalProject(child) &&
!hasTextPreview(child, preview: 'a');
},
),
isTrue,
);
expect(
oneChildSatisfiesCondition(rootJson, condition: (Map<String, Object?> child) {
return hasDescription(child, description: 'Text') &&
wasCreatedByLocalProject(child) &&
!hasTextPreview(child, preview: 'b');
},
),
isTrue,
);
expect(
oneChildSatisfiesCondition(rootJson, condition: (Map<String, Object?> child) {
return hasDescription(child, description: 'Text') &&
wasCreatedByLocalProject(child) &&
!hasTextPreview(child, preview: 'c');
},
),
isTrue,
);
});
testWidgets(
'full tree with previews using ext.flutter.inspector.getRootWidgetTree',
(WidgetTester tester) async {
const String group = 'test-group';
await pumpWidgetTreeWithABC(tester);
final Element elementA = findElementABC('a');
final Map<String, dynamic> jsonA =
await selectedWidgetResponseForElement(elementA);
final Map<String, Object?> creationLocation =
verifyAndReturnCreationLocation(jsonA);
final String testFile = verifyAndReturnTestFile(creationLocation);
addPubRootDirectoryFor(testFile);
final Map<String, Object?> rootJson = (await service.testExtension(
WidgetInspectorServiceExtensions.getRootWidgetTree.name,
<String, String>{
'groupName': group,
'isSummaryTree': 'false',
'withPreviews': 'true',
},
))! as Map<String, Object?>;
expect(
allChildrenSatisfyCondition(rootJson,
condition: wasCreatedByLocalProject,
),
isFalse,
);
expect(
oneChildSatisfiesCondition(rootJson, condition: (Map<String, Object?> child) {
return hasDescription(child, description: 'Text') &&
wasCreatedByLocalProject(child) &&
hasTextPreview(child, preview: 'a');
},
),
isTrue,
);
expect(
oneChildSatisfiesCondition(rootJson, condition: (Map<String, Object?> child) {
return hasDescription(child, description: 'Text') &&
wasCreatedByLocalProject(child) &&
hasTextPreview(child, preview: 'b');
},
),
isTrue,
);
expect(
oneChildSatisfiesCondition(rootJson, condition: (Map<String, Object?> child) {
return hasDescription(child, description: 'Text') &&
wasCreatedByLocalProject(child) &&
hasTextPreview(child, preview: 'c');
},
),
isTrue,
);
});
});