Skip to content

Commit b9ae32e

Browse files
authored
Rename serialization methods in DevTools to meet recommended standard. (#7584)
1 parent bd88eb8 commit b9ae32e

38 files changed

+126
-121
lines changed

packages/devtools_app/lib/src/example/conditional_screen.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ class ExampleController extends DisposableController
9191
} else {
9292
await maybeLoadOfflineData(
9393
ExampleConditionalScreen.id,
94-
createData: (json) => ExampleScreenData.parse(json),
94+
createData: (json) => ExampleScreenData.fromJson(json),
9595
shouldLoad: (data) => data.title.isNotEmpty,
9696
);
9797
}
@@ -116,7 +116,7 @@ class ExampleController extends DisposableController
116116
class ExampleScreenData {
117117
ExampleScreenData(this.title);
118118

119-
factory ExampleScreenData.parse(Map<String, Object?> json) {
119+
factory ExampleScreenData.fromJson(Map<String, Object?> json) {
120120
return ExampleScreenData(json[_titleKey] as String);
121121
}
122122

packages/devtools_app/lib/src/screens/debugger/span_parser.dart

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ class Grammar {
4343
return Grammar._(
4444
name: json['name'] as String,
4545
scopeName: json['scopeName'] as String,
46-
topLevelMatcher: GrammarMatcher.parse(json),
46+
topLevelMatcher: GrammarMatcher.fromJson(json),
4747
repository: Repository.build(json),
4848
);
4949
}
@@ -168,7 +168,7 @@ class Repository {
168168
return;
169169
}
170170
for (final subRepo in repositoryJson.keys) {
171-
matchers[subRepo] = GrammarMatcher.parse(repositoryJson[subRepo]!);
171+
matchers[subRepo] = GrammarMatcher.fromJson(repositoryJson[subRepo]!);
172172
}
173173
}
174174

@@ -183,7 +183,7 @@ class Repository {
183183
}
184184

185185
abstract class GrammarMatcher {
186-
factory GrammarMatcher.parse(Map<String, Object?> json) {
186+
factory GrammarMatcher.fromJson(Map<String, Object?> json) {
187187
if (_IncludeMatcher.isType(json)) {
188188
return _IncludeMatcher(json['include'] as String);
189189
} else if (_SimpleMatcher.isType(json)) {
@@ -237,7 +237,7 @@ abstract class GrammarMatcher {
237237
scanner.substring(0, captureEndLocation.position),
238238
position: captureStartLocation.position,
239239
);
240-
GrammarMatcher.parse(capture)
240+
GrammarMatcher.fromJson(capture)
241241
.scan(grammar, captureScanner, scopeStack);
242242
}
243243

@@ -302,7 +302,7 @@ class _MultilineMatcher extends GrammarMatcher {
302302
: RegExp(json['while'] as String, multiLine: true),
303303
patterns = (json['patterns'] as List<Object?>?)
304304
?.cast<Map<String, Object?>>()
305-
.map((e) => GrammarMatcher.parse(e))
305+
.map((e) => GrammarMatcher.fromJson(e))
306306
.toList()
307307
.cast<GrammarMatcher>(),
308308
super._(json);
@@ -520,7 +520,7 @@ class _PatternMatcher extends GrammarMatcher {
520520
_PatternMatcher(Map<String, Object?> json)
521521
: patterns = (json['patterns'] as List<Object?>?)
522522
?.cast<Map<String, Object?>>()
523-
.map((e) => GrammarMatcher.parse(e))
523+
.map((e) => GrammarMatcher.fromJson(e))
524524
.toList()
525525
.cast<GrammarMatcher>(),
526526
super._(json);

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ class MemoryController extends DisposableController
9797
assert(connectedDiff == null && connectedProfile == null);
9898
await maybeLoadOfflineData(
9999
ScreenMetaData.memory.id,
100-
createData: (json) => OfflineMemoryData.parse(json),
100+
createData: (json) => OfflineMemoryData.fromJson(json),
101101
shouldLoad: (data) => true,
102102
);
103103
// [maybeLoadOfflineData] will be a noop if there is no offline data for the memory screen,
@@ -147,7 +147,7 @@ class MemoryController extends DisposableController
147147
chart,
148148
profile.classFilter.value,
149149
selectedTab: selectedFeatureTabIndex,
150-
).prepareForOffline(),
150+
).toJson(),
151151
);
152152

153153
@override

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ class OfflineMemoryData {
2626

2727
// TODO(polina-c): use an extension type for the Json parsing, https://github.com/flutter/devtools/issues/6972
2828
// https://github.com/flutter/devtools/pull/7572#discussion_r1563102256
29-
factory OfflineMemoryData.parse(Map<String, dynamic> json) {
29+
factory OfflineMemoryData.fromJson(Map<String, dynamic> json) {
3030
Map<String, dynamic> item(String key) =>
3131
json[key] as Map<String, dynamic>? ?? {};
3232
return OfflineMemoryData(
33-
DiffPaneController.parse(item(_Json.diffData)),
34-
ProfilePaneController.parse(item(_Json.profileData)),
35-
MemoryChartPaneController.parse(item(_Json.chartData)),
36-
ClassFilter.parse(item(_Json.classFilter)),
33+
DiffPaneController.fromJson(item(_Json.diffData)),
34+
ProfilePaneController.fromJson(item(_Json.profileData)),
35+
MemoryChartPaneController.fromJson(item(_Json.chartData)),
36+
ClassFilter.fromJson(item(_Json.classFilter)),
3737
selectedTab: json[_Json.selectedTab] as int? ?? 0,
3838
);
3939
}
@@ -45,13 +45,13 @@ class OfflineMemoryData {
4545
final ProfilePaneController profile;
4646
final MemoryChartPaneController chart;
4747

48-
Map<String, dynamic> prepareForOffline() {
48+
Map<String, dynamic> toJson() {
4949
return {
5050
_Json.selectedTab: selectedTab,
51-
_Json.diffData: diff.prepareForOffline(),
52-
_Json.profileData: profile.prepareForOffline(),
53-
_Json.chartData: chart.prepareForOffline(),
54-
_Json.classFilter: profile.classFilter.value.prepareForOffline(),
51+
_Json.diffData: diff.toJson(),
52+
_Json.profileData: profile.toJson(),
53+
_Json.chartData: chart.toJson(),
54+
_Json.classFilter: profile.classFilter.value.toJson(),
5555
};
5656
}
5757
}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ class MemoryChartPaneController extends DisposableController
8383
unawaited(_init());
8484
}
8585

86-
factory MemoryChartPaneController.parse(Map<String, dynamic> map) {
86+
factory MemoryChartPaneController.fromJson(Map<String, dynamic> map) {
8787
// TODO(polina-c): implement, https://github.com/flutter/devtools/issues/6972
8888
return MemoryChartPaneController(
8989
DevToolsMode.offlineData,
@@ -110,7 +110,7 @@ class MemoryChartPaneController extends DisposableController
110110
);
111111
}
112112

113-
Map<String, dynamic> prepareForOffline() {
113+
Map<String, dynamic> toJson() {
114114
// TODO(polina-c): implement, https://github.com/flutter/devtools/issues/6972
115115
return {};
116116
}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ import 'item_controller.dart';
3131
class DiffPaneController extends DisposableController {
3232
DiffPaneController({required this.loader});
3333

34-
factory DiffPaneController.parse(Map<String, dynamic> map) {
34+
factory DiffPaneController.fromJson(Map<String, dynamic> map) {
3535
// TODO(polina-c): implement, https://github.com/flutter/devtools/issues/6972
3636
return DiffPaneController(loader: null);
3737
}
3838

39-
Map<String, dynamic> prepareForOffline() {
39+
Map<String, dynamic> toJson() {
4040
// TODO(polina-c): implement, https://github.com/flutter/devtools/issues/6972
4141
return {};
4242
}

packages/devtools_app/lib/src/screens/memory/panes/profile/profile_pane_controller.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ class ProfilePaneController extends DisposableController
1717
with AutoDisposeControllerMixin {
1818
ProfilePaneController();
1919

20-
factory ProfilePaneController.parse(Map<String, dynamic> map) {
20+
factory ProfilePaneController.fromJson(Map<String, dynamic> map) {
2121
// TODO(polina-c): implement, https://github.com/flutter/devtools/issues/6972
2222
return ProfilePaneController();
2323
}
2424

25-
Map<String, dynamic> prepareForOffline() {
25+
Map<String, dynamic> toJson() {
2626
// TODO(polina-c): implement, https://github.com/flutter/devtools/issues/6972
2727
return {};
2828
}

packages/devtools_app/lib/src/screens/memory/shared/heap/class_filter.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ class ClassFilter {
6464
only: null,
6565
);
6666

67-
factory ClassFilter.parse(Map<String, dynamic> json) {
67+
factory ClassFilter.fromJson(Map<String, dynamic> json) {
6868
final type = json[_Json.type] as String?;
6969
return ClassFilter(
7070
filterType:
@@ -77,7 +77,7 @@ class ClassFilter {
7777

7878
// TODO: use an extension type for the Json parsing, https://github.com/flutter/devtools/issues/6972
7979
// https://github.com/flutter/devtools/pull/7572#discussion_r1563130198
80-
Map<String, dynamic> prepareForOffline() {
80+
Map<String, dynamic> toJson() {
8181
return {
8282
_Json.type: filterType.name,
8383
_Json.except: except,

packages/devtools_app/lib/src/screens/performance/panes/controls/enhance_tracing/enhance_tracing_controller.dart

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,8 @@ class EnhanceTracingController extends DisposableController
5858
(event) {
5959
if (event.extensionKind == 'Flutter.Frame' &&
6060
_firstLiveFrameId == null) {
61-
_firstLiveFrameId = FlutterFrame.parse(event.extensionData!.data).id;
61+
_firstLiveFrameId =
62+
FlutterFrame.fromJson(event.extensionData!.data).id;
6263
// See https://github.com/dart-lang/linter/issues/3801
6364
// ignore: discarded_futures
6465
unawaited(_firstFrameEventSubscription!.cancel());

packages/devtools_app/lib/src/screens/performance/panes/flutter_frames/flutter_frame_model.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ class FlutterFrame {
2323
required this.vsyncOverheadTime,
2424
});
2525

26-
factory FlutterFrame.parse(Map<String, dynamic> json) {
26+
factory FlutterFrame.fromJson(Map<String, dynamic> json) {
2727
final timeStart = Duration(microseconds: json[startTimeKey]!);
2828
final timeEnd = timeStart + Duration(microseconds: json[elapsedKey]!);
2929
final frameTime = TimeRange()
@@ -175,7 +175,7 @@ class FlutterFrame {
175175
}
176176

177177
FlutterFrame shallowCopy() {
178-
return FlutterFrame.parse(json);
178+
return FlutterFrame.fromJson(json);
179179
}
180180
}
181181

packages/devtools_app/lib/src/screens/performance/panes/raster_stats/raster_stats_controller.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class RasterStatsController extends PerformanceFeatureController {
3737
try {
3838
final response = await serviceConnection.renderFrameWithRasterStats;
3939
final json = response?.json ?? <String, Object?>{};
40-
final rasterStats = RasterStats.parse(json);
40+
final rasterStats = RasterStats.fromJson(json);
4141
setData(rasterStats);
4242
} catch (e, st) {
4343
_log.shout('Error collecting raster stats: $e', e, st);

packages/devtools_app/lib/src/screens/performance/panes/raster_stats/raster_stats_model.dart

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ class RasterStats {
1515
required this.selectedSnapshot,
1616
});
1717

18-
factory RasterStats.parse(Map<String, Object?> json) {
18+
factory RasterStats.fromJson(Map<String, Object?> json) {
1919
Size? originalFrameSize;
2020
final originalWidth = json[_frameWidthKey] as num?;
2121
final originalHeight = json[_frameHeightKey] as num?;
@@ -37,7 +37,7 @@ class RasterStats {
3737
final snapshots = <LayerSnapshot>[];
3838
var totalRasterTime = Duration.zero;
3939
for (final snapshotJson in snapshotsFromJson) {
40-
final layerSnapshot = LayerSnapshot.parse(snapshotJson);
40+
final layerSnapshot = LayerSnapshot.fromJson(snapshotJson);
4141
snapshots.add(layerSnapshot);
4242
totalRasterTime += layerSnapshot.duration;
4343
if (layerSnapshot.id == selectedId) {
@@ -105,7 +105,7 @@ class LayerSnapshot {
105105
required this.bytes,
106106
});
107107

108-
factory LayerSnapshot.parse(Map<String, Object?> json) {
108+
factory LayerSnapshot.fromJson(Map<String, Object?> json) {
109109
final id = json[_layerIdKey] as int;
110110
final dur = Duration(microseconds: json[_durationKey] as int);
111111
final size = Size(

packages/devtools_app/lib/src/screens/performance/panes/rebuild_stats/rebuild_stats_model.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ class LocationMap {
175175
class RebuildCountModel {
176176
RebuildCountModel();
177177

178-
RebuildCountModel.parse(Map<String, Object?> json) {
178+
RebuildCountModel.fromJson(Map<String, Object?> json) {
179179
if (json.isEmpty) return;
180180
locationMap.processLocationMap(json[_locationsKey] as Map<String, Object?>);
181181
final frames =

packages/devtools_app/lib/src/screens/performance/performance_controller.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ class PerformanceController extends DisposableController
125125
.serviceManager.service!.onExtensionEventWithHistorySafe
126126
.listen((event) {
127127
if (event.extensionKind == 'Flutter.Frame') {
128-
final frame = FlutterFrame.parse(event.extensionData!.data);
128+
final frame = FlutterFrame.fromJson(event.extensionData!.data);
129129
enhanceTracingController.assignStateForFrame(frame);
130130
flutterFramesController.addFrame(frame);
131131
} else if (event.extensionKind == 'Flutter.RebuiltWidgets' &&
@@ -149,7 +149,7 @@ class PerformanceController extends DisposableController
149149
PerformanceScreen.id,
150150
// TODO(kenz): make sure DevTools exports can be loaded into the full
151151
// Perfetto trace viewer (ui.perfetto.dev).
152-
createData: (json) => OfflinePerformanceData.parse(json),
152+
createData: (json) => OfflinePerformanceData.fromJson(json),
153153
shouldLoad: (data) => !data.isEmpty,
154154
);
155155
}

packages/devtools_app/lib/src/screens/performance/performance_model.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ class OfflinePerformanceData {
2323
double? displayRefreshRate,
2424
}) : displayRefreshRate = displayRefreshRate ?? defaultRefreshRate;
2525

26-
factory OfflinePerformanceData.parse(Map<String, Object?> json_) {
26+
factory OfflinePerformanceData.fromJson(Map<String, Object?> json_) {
2727
final json = _PerformanceDataJson(json_);
2828

2929
final selectedFrameId = json.selectedFrameId;
@@ -83,7 +83,7 @@ extension type _PerformanceDataJson(Map<String, Object?> json) {
8383
RasterStats? get rasterStats {
8484
final raw = (json[OfflinePerformanceData.rasterStatsKey] as Map? ?? {})
8585
.cast<String, Object>();
86-
return raw.isNotEmpty ? RasterStats.parse(raw) : null;
86+
return raw.isNotEmpty ? RasterStats.fromJson(raw) : null;
8787
}
8888

8989
int? get selectedFrameId =>
@@ -93,7 +93,7 @@ extension type _PerformanceDataJson(Map<String, Object?> json) {
9393
(json[OfflinePerformanceData.flutterFramesKey] as List? ?? [])
9494
.cast<Map>()
9595
.map((f) => f.cast<String, dynamic>())
96-
.map((f) => FlutterFrame.parse(f))
96+
.map((f) => FlutterFrame.fromJson(f))
9797
.toList();
9898

9999
double get displayRefreshRate =>
@@ -105,7 +105,7 @@ extension type _PerformanceDataJson(Map<String, Object?> json) {
105105
final raw =
106106
(json[OfflinePerformanceData.rebuildCountModelKey] as Map? ?? {})
107107
.cast<String, dynamic>();
108-
return raw.isNotEmpty ? RebuildCountModel.parse(raw) : null;
108+
return raw.isNotEmpty ? RebuildCountModel.fromJson(raw) : null;
109109
}
110110
}
111111

packages/devtools_app/lib/src/screens/profiler/cpu_profile_model.dart

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ class CpuProfileData {
168168
_cpuProfileRoot = CpuStackFrame.root(profileMetaData);
169169
}
170170

171-
factory CpuProfileData.parse(Map<String, dynamic> json_) {
171+
factory CpuProfileData.fromJson(Map<String, dynamic> json_) {
172172
final json = _CpuProfileDataJson(json_);
173173
final profileMetaData = CpuProfileMetaData(
174174
sampleCount: json.sampleCount ?? 0,
@@ -529,7 +529,7 @@ class CpuProfileData {
529529
);
530530
}
531531

532-
factory CpuProfileData.empty() => CpuProfileData.parse({});
532+
factory CpuProfileData.empty() => CpuProfileData.fromJson({});
533533

534534
/// Generates [CpuProfileData] from the provided [CpuSamples].
535535
///
@@ -586,7 +586,7 @@ class CpuProfileData {
586586

587587
await _addPackageUrisToTraceObject(isolateId, traceObject);
588588

589-
return CpuProfileData.parse(traceObject);
589+
return CpuProfileData.fromJson(traceObject);
590590
}
591591

592592
/// Helper function for determining and updating the
@@ -769,7 +769,7 @@ extension type _CpuProfileDataJson(Map<String, dynamic> json) {
769769
(json[CpuProfileData._traceEventsKey] as List?)
770770
?.cast<Map>()
771771
.map((trace) => trace.cast<String, Object?>())
772-
.map((trace) => CpuSampleEvent.parse(trace))
772+
.map((trace) => CpuSampleEvent.fromJson(trace))
773773
.toList()
774774
.cast<CpuSampleEvent>();
775775
}
@@ -809,7 +809,7 @@ class CpuSampleEvent extends ChromeTraceEvent {
809809
required Map<String, dynamic> traceJson,
810810
}) : super(traceJson);
811811

812-
factory CpuSampleEvent.parse(Map<String, dynamic> traceJson) {
812+
factory CpuSampleEvent.fromJson(Map<String, dynamic> traceJson) {
813813
final leafId = traceJson[CpuProfileData.stackFrameIdKey];
814814
final args =
815815
(traceJson[ChromeTraceEvent.argsKey] as Map?)?.cast<String, Object?>();
@@ -913,7 +913,7 @@ class CpuStackFrame extends TreeNode<CpuStackFrame>
913913

914914
final String? parentId;
915915

916-
/// The set of ids for all ancesctors of this [CpuStackFrame].
916+
/// The set of ids for all ancestors of this [CpuStackFrame].
917917
///
918918
/// This is late and final, so it will only be created once for performance
919919
/// reasons. This method should only be called when the [CpuStackFrame] is

packages/devtools_app/lib/src/screens/profiler/profiler_screen_controller.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ class ProfilerScreenController extends DisposableController
8080
} else {
8181
await maybeLoadOfflineData(
8282
ProfilerScreen.id,
83-
createData: (json) => CpuProfileData.parse(json),
83+
createData: (json) => CpuProfileData.fromJson(json),
8484
shouldLoad: (data) => !data.isEmpty,
8585
);
8686
}

0 commit comments

Comments
 (0)