Serialization for diff and profile tabs.

packages/devtools_app/lib/src/screens/memory/framework/offline_data/offline_data.dart

@@ -2,17 +2,21 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+import 'package:devtools_shared/devtools_shared.dart';
+import 'package:meta/meta.dart';
+
 import '../../panes/chart/controller/chart_data.dart';
 import '../../panes/diff/controller/diff_pane_controller.dart';
 import '../../panes/profile/profile_pane_controller.dart';
 import '../../shared/heap/class_filter.dart';
 
-class _Json {
- static const selectedTab = 'selectedTab';
- static const classFilter = 'classFilter';
- static const diffData = 'diffData';
- static const profileData = 'profileData';
- static const chartData = 'chartData';
+@visibleForTesting
+enum Json {
+ selectedTab,
+ classFilter,
+ diffData,
+ profileData,
+ chartData;
 }
 
 class OfflineMemoryData {
@@ -25,31 +29,38 @@ class OfflineMemoryData {
  });
 
  factory OfflineMemoryData.fromJson(Map<String, dynamic> json) {
- Map<String, dynamic> item(String key) =>
- json[key] as Map<String, dynamic>? ?? {};
  return OfflineMemoryData(
- DiffPaneController.fromJson(item(_Json.diffData)),
- ProfilePaneController.fromJson(item(_Json.profileData)),
- ChartData.fromJson(item(_Json.chartData)),
- ClassFilter.fromJson(item(_Json.classFilter)),
- selectedTab: json[_Json.selectedTab] as int? ?? 0,
+ deserialize<DiffPaneController>(
+ json[Json.diffData.name],
+ DiffPaneController.fromJson,
+ ),
+ deserialize<ProfilePaneController>(
+ json[Json.profileData.name],
+ ProfilePaneController.fromJson,
+ ),
+ deserialize<ChartData>(json[Json.chartData.name], ChartData.fromJson),
+ deserialize<ClassFilter>(
+ json[Json.classFilter.name],
+ ClassFilter.fromJson,
+ ),
+ selectedTab: json[Json.selectedTab.name] as int? ?? 0,
  );
  }
 
+ Map<String, dynamic> toJson() {
+ return {
+ Json.selectedTab.name: selectedTab,
+ Json.diffData.name: diff,
+ Json.profileData.name: profile,
+ Json.chartData.name: chart,
+ Json.classFilter.name: filter,
+ };
+ }
+
  final int selectedTab;
  final ClassFilter filter; // filter is shared between tabs, so it's here
 
  final DiffPaneController diff;
  final ProfilePaneController profile;
  final ChartData chart;
-
- Map<String, dynamic> toJson() {
- return {
- _Json.selectedTab: selectedTab,
- _Json.diffData: diff.toJson(),
- _Json.profileData: profile.toJson(),
- _Json.chartData: chart.toJson(),
- _Json.classFilter: profile.classFilter.value.toJson(),
- };
- }
 }

packages/devtools_app/lib/src/screens/memory/panes/chart/controller/chart_data.dart

@@ -2,17 +2,19 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+import 'package:devtools_shared/devtools_shared.dart';
 import 'package:flutter/foundation.dart';
 
 import '../../../../../shared/primitives/simple_items.dart';
 import '../../../shared/primitives/memory_timeline.dart';
 import '../data/primitives.dart';
 
-class _Json {
- static const isDeviceAndroid = 'isAndroid';
- static const timeline = 'timeline';
- static const interval = 'interval';
- static const isLegendVisible = 'isLegendVisible';
+@visibleForTesting
+enum Json {
+ isDeviceAndroid,
+ timeline,
+ interval,
+ isLegendVisible;
 }
 
 /// Chart data, that should be saved when transferred to offline data mode.
@@ -40,22 +42,24 @@ class ChartData {
  factory ChartData.fromJson(Map<String, dynamic> json) {
  final result = ChartData(
  mode: ControllerCreationMode.offlineData,
- isDeviceAndroid: json[_Json.isDeviceAndroid] as bool? ?? false,
- timeline:
- MemoryTimeline.fromJson(json[_Json.timeline] as Map<String, dynamic>),
- interval: ChartInterval.byName(json[_Json.interval]) ??
+ isDeviceAndroid: json[Json.isDeviceAndroid.name] as bool? ?? false,
+ timeline: deserialize<MemoryTimeline>(
+ json[Json.timeline.name],
+ MemoryTimeline.fromJson,
+ ),
+ interval: ChartInterval.byName(json[Json.interval.name]) ??
  ChartInterval.theDefault,
- isLegendVisible: json[_Json.isLegendVisible] as bool?,
+ isLegendVisible: json[Json.isLegendVisible.name] as bool?,
  );
  return result;
  }
 
  Map<String, dynamic> toJson() {
  return {
- _Json.isDeviceAndroid: isDeviceAndroid ?? false,
- _Json.timeline: timeline.toJson(),
- _Json.interval: displayInterval.name,
- _Json.isLegendVisible: isLegendVisible.value,
+ Json.isDeviceAndroid.name: isDeviceAndroid ?? false,
+ Json.timeline.name: timeline,
+ Json.interval.name: displayInterval.name,
+ Json.isLegendVisible.name: isLegendVisible.value,
  };
  }
 

packages/devtools_app/lib/src/screens/memory/panes/chart/controller/charts/event_chart_controller.dart

@@ -283,7 +283,7 @@ class EventChartController extends ChartController {
  final data = chart_trace.DataAggregate(
  sample.timestamp,
  _Sizes.extensions,
- (events.extensionEvents?.theEvents ?? []).length,
+ (events.extensionEvents?.events ?? []).length,
  );
  addDataToTrace(_EventsTraceName.extensionEvents.index, data);
  }

packages/devtools_app/lib/src/screens/memory/panes/chart/data/charts.dart

@@ -238,7 +238,7 @@ class ChartsValues {
 
  if (eventInfo.hasExtensionEvents) {
  final events = <Map<String, Object>>[];
- for (ExtensionEvent event in eventInfo.extensionEvents?.theEvents ?? []) {
+ for (ExtensionEvent event in eventInfo.extensionEvents?.events ?? []) {
  if (event.customEventName != null) {
  events.add(
  {

packages/devtools_app/lib/src/screens/memory/panes/diff/controller/diff_pane_controller.dart

@@ -7,6 +7,7 @@ import 'dart:math';
 
 import 'package:collection/collection.dart';
 import 'package:devtools_app_shared/utils.dart';
+import 'package:devtools_shared/devtools_shared.dart';
 import 'package:flutter/foundation.dart';
 
 import '../../../../../shared/analytics/analytics.dart' as ga;
@@ -26,19 +27,66 @@ import '../data/csv.dart';
 import '../data/heap_diff_data.dart';
 import '../data/heap_diff_store.dart';
 import 'class_data.dart';
-import 'item_controller.dart';
+import 'snapshot_item.dart';
+
+@visibleForTesting
+enum Json {
+ snapshots,
+ diffWith;
+}
 
 class DiffPaneController extends DisposableController {
- DiffPaneController({required this.loader});
+ DiffPaneController({
+ required this.loader,
+ List<SnapshotDataItem>? snapshots,
+ }) {
+ if (snapshots != null) {
+ core._snapshots.addAll(snapshots);
+ }
+ derived._updateValues();
+ }
 
  factory DiffPaneController.fromJson(Map<String, dynamic> json) {
- // TODO(polina-c): implement, https://github.com/flutter/devtools/issues/6972
- return DiffPaneController(loader: null);
+ final snapshots = (json[Json.snapshots.name] as List)
+ .map((e) => deserialize<SnapshotDataItem>(e, SnapshotDataItem.fromJson))
+ .toList();
+
+ final diffWith =
+ (json[Json.diffWith.name] as List).map((e) => e as int?).toList();
+
+ assert(snapshots.length == diffWith.length);
+
+ for (var i = 0; i < snapshots.length; i++) {
+ final diffIndex = diffWith[i];
+ if (diffIndex != null) {
+ snapshots[i].diffWith.value = snapshots[diffIndex];
+ }
+ }
+
+ return DiffPaneController(
+ loader: null,
+ snapshots: snapshots,
+ );
  }
 
  Map<String, dynamic> toJson() {
- // TODO(polina-c): implement, https://github.com/flutter/devtools/issues/6972
- return {};
+ final snapshots = core.snapshots.value
+ .whereType<SnapshotDataItem>()
+ .where((s) => s.heap != null)
+ .toList();
+
+ final snapshotToIndex =
+ snapshots.asMap().map((index, item) => MapEntry(item, index));
+
+ final diffWithIndices = snapshots.map((item) {
+ final diffWith = item.diffWith.value;
+ return diffWith == null ? null : snapshotToIndex[diffWith];
+ }).toList();
+
+ return {
+ Json.snapshots.name: snapshots,
+ Json.diffWith.name: diffWithIndices,
+ };
  }
 
  final HeapGraphLoader? loader;
@@ -315,7 +363,7 @@ class DerivedData extends DisposableController with AutoDisposeControllerMixin {
  var diffHidden = true;
  var details = 'no data';
  final item = selectedItem.value;
- if (item is SnapshotDataItem && item.hasData) {
+ if (item is SnapshotDataItem && item.isProcessed) {
  diffHidden = item.diffWith.value == null;
  singleHidden = !diffHidden;
  details = diffHidden ? 'single' : 'diff';
@@ -330,8 +378,14 @@ class DerivedData extends DisposableController with AutoDisposeControllerMixin {
  assert(classesTableDiff.selection.value == null, details);
  }
 
- assert((singleClassesToShow.value == null) == singleHidden, details);
- assert((diffClassesToShow.value == null) == diffHidden, details);
+ assert(
+ (singleClassesToShow.value == null) == singleHidden,
+ '$details, ${singleClassesToShow.value}, $singleHidden',
+ );
+ assert(
+ (diffClassesToShow.value == null) == diffHidden,
+ '$details, ${singleClassesToShow.value}, $singleHidden',
+ );
 
  return true;
  }());

packages/devtools_app/lib/src/screens/memory/panes/diff/controller/item_controller.dart → packages/devtools_app/lib/src/screens/memory/panes/diff/controller/snapshot_item.dart

@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+import 'dart:async';
+
 import 'package:devtools_app_shared/utils.dart';
 import 'package:flutter/foundation.dart';
 
@@ -11,34 +13,58 @@ import '../../../../../shared/memory/heap_graph_loader.dart';
 abstract class SnapshotItem extends DisposableController {
  /// Number to show with auto-generated names that may be non unique, like isolate name.
  int? get displayNumber;
-
- ValueListenable<bool> get isProcessing => _isProcessing;
- final _isProcessing = ValueNotifier<bool>(false);
-
- /// If true, the item contains data, that can be compared and analyzed.
- bool get hasData;
-
- @override
- void dispose() {
- _isProcessing.dispose();
- super.dispose();
- }
 }
 
 class SnapshotDocItem extends SnapshotItem {
  @override
  int? get displayNumber => null;
+}
 
- @override
- bool get hasData => false;
+@visibleForTesting
+enum Json {
+ defaultName,
+ displayNumber,
+ chunks,
+ created,
+ nameOverride;
 }
 
 class SnapshotDataItem extends SnapshotItem implements RenamableItem {
  SnapshotDataItem({
- this.displayNumber,
  required this.defaultName,
- }) {
- _isProcessing.value = true;
+ this.displayNumber,
+ this.nameOverride,
+ });
+
+ factory SnapshotDataItem.fromJson(Map<String, dynamic> json) {
+ final result = SnapshotDataItem(
+ displayNumber: json[Json.displayNumber.name] as int?,
+ defaultName: json[Json.defaultName.name] as String? ?? 'no name',
+ nameOverride: json[Json.nameOverride.name] as String?,
+ );
+
+ final chunks = json[Json.chunks.name] as List<ByteData>?;
+ if (chunks == null) return result;
+
+ final loader = HeapGraphLoaderFromChunks(
+ chunks: chunks,
+ created: json[Json.created.name] as DateTime? ?? DateTime.now(),
+ );
+
+ // Start the loading process, that will result in progress indicator in UI.
+ unawaited(result.loadHeap(loader));
+
+ return result;
+ }
+
+ Map<String, dynamic> toJson() {
+ return {
+ Json.defaultName.name: defaultName,
+ Json.displayNumber.name: displayNumber,
+ Json.nameOverride.name: nameOverride,
+ Json.chunks.name: _heap?.graph.toChunks(),
+ Json.created.name: _heap?.created,
+ };
  }
 
  HeapData? get heap => _heap;
@@ -50,14 +76,12 @@ class SnapshotDataItem extends SnapshotItem implements RenamableItem {
  @override
  final int? displayNumber;
 
- @override
- bool get hasData => _heap != null;
-
  Future<void> loadHeap(HeapGraphLoader loader) async {
  assert(_heap == null);
  final (graph, created) = await loader.load();
- _heap = await HeapData.calculate(graph, created);
- _isProcessing.value = false;
+ _heap = HeapData(graph, created: created);
+ await _heap!.calculate;
+ _processed.complete();
  }
 
  @override
@@ -71,6 +95,10 @@ class SnapshotDataItem extends SnapshotItem implements RenamableItem {
  '$defaultName${displayNumber == null ? '' : '-$displayNumber'}';
 
  int? get totalSize => _heap?.footprint?.reachable;
+
+ Future<void> get process => _processed.future;
+ final _processed = Completer<void>();
+ bool get isProcessed => _processed.isCompleted;
 }
 
 abstract class RenamableItem {