Skip to content

Commit b88982b

Browse files
authored
[record_use] Normalize definitions in JSON (dart-lang#3109)
Move the definitions into their own toplevel index. Towards: * dart-lang#2867 Implementation follows the design from: * dart-lang#3106
1 parent f36ecbf commit b88982b

43 files changed

Lines changed: 799 additions & 593 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎pkgs/record_use/doc/schema/record_use.schema.json‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -404,6 +404,12 @@
404404
"RecordedUses": {
405405
"type": "object",
406406
"properties": {
407+
"definitions": {
408+
"type": "array",
409+
"items": {
410+
"$ref": "#/definitions/Definition"
411+
}
412+
},
407413
"constants": {
408414
"type": "array",
409415
"items": {
@@ -445,8 +451,8 @@
445451
"$ref": "#/definitions/Call"
446452
}
447453
},
448-
"definition": {
449-
"$ref": "#/definitions/Definition"
454+
"definition_index": {
455+
"type": "integer"
450456
},
451457
"instances": {
452458
"type": "array",
@@ -456,7 +462,7 @@
456462
}
457463
},
458464
"required": [
459-
"definition"
465+
"definition_index"
460466
]
461467
}
462468
}

‎pkgs/record_use/lib/src/recordings.dart‎

Lines changed: 49 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -66,15 +66,14 @@ Error: $e
6666
}
6767

6868
factory Recordings._fromSyntax(RecordedUsesSyntax syntax) {
69-
final context = _deserializeConstants(syntax);
69+
final definitionContext = _deserializeDefinitions(syntax);
70+
final context = _deserializeConstants(syntax, definitionContext);
7071

7172
final callsForDefinition = <Definition, List<CallReference>>{};
7273
final instancesForDefinition = <Definition, List<InstanceReference>>{};
7374

7475
for (final recordingSyntax in syntax.recordings ?? <RecordingSyntax>[]) {
75-
final definition = DefinitionProtected.fromSyntax(
76-
recordingSyntax.definition,
77-
);
76+
final definition = context.definitions[recordingSyntax.definitionIndex];
7877
if (recordingSyntax.calls case final callSyntaxes?) {
7978
final callReferences = callSyntaxes
8079
.map<CallReference>(
@@ -110,15 +109,29 @@ Error: $e
110109
);
111110
}
112111

112+
static DefinitionDeserializationContext _deserializeDefinitions(
113+
RecordedUsesSyntax syntax,
114+
) {
115+
final definitions = <Definition>[];
116+
for (final definitionSyntax in syntax.definitions ?? <DefinitionSyntax>[]) {
117+
definitions.add(DefinitionProtected.fromSyntax(definitionSyntax));
118+
}
119+
return DefinitionDeserializationContext(definitions);
120+
}
121+
113122
static DeserializationContext _deserializeConstants(
114123
RecordedUsesSyntax syntax,
124+
DefinitionDeserializationContext definitionContext,
115125
) {
116126
final constants = <Constant>[];
117127
// Create a context that includes an empty list for the constants. This
118128
// list will be populated by [_deserializeConstants], providing the
119129
// self-referential access needed to resolve recursive constants (e.g.
120130
// list and map constants).
121-
final context = DeserializationContext(constants);
131+
final context = DeserializationContext.fromPrevious(
132+
definitionContext,
133+
constants,
134+
);
122135
for (final constantSyntax in syntax.constants ?? <ConstantSyntax>[]) {
123136
final constant = ConstantProtected.fromSyntax(constantSyntax, context);
124137
if (!constants.contains(constant)) {
@@ -135,19 +148,19 @@ Error: $e
135148

136149
RecordedUsesSyntax _toSyntax() {
137150
final allConstants = _collectConstants();
138-
final (context, constantSyntax) = _serializeConstants(allConstants);
151+
final definitionContext = _serializeDefinitions(allConstants);
152+
final (context, constantSyntax) = _serializeConstants(
153+
allConstants,
154+
definitionContext,
155+
);
139156

140157
final recordings = <RecordingSyntax>[];
141-
final allDefinitions = {
142-
...calls.keys,
143-
...instances.keys,
144-
};
145-
for (final definition in allDefinitions) {
158+
for (final definition in context.definitions.keys) {
146159
final callsForDefinition = calls[definition];
147160
final instancesForDefinition = instances[definition];
148161
recordings.add(
149162
RecordingSyntax(
150-
definition: definition.toSyntax(),
163+
definitionIndex: context.definitions[definition]!,
151164
calls: callsForDefinition
152165
?.map((call) => call.toSyntax(context))
153166
.toList(),
@@ -161,6 +174,13 @@ Error: $e
161174
return RecordedUsesSyntax(
162175
metadata: metadata.toSyntax(),
163176
constants: constantSyntax.isEmpty ? null : constantSyntax,
177+
definitions: context.definitions.isEmpty
178+
? null
179+
: context.definitions.keys
180+
.map(
181+
(definition) => definition.toSyntax(),
182+
)
183+
.toList(),
164184
recordings: recordings.isEmpty ? null : recordings,
165185
);
166186
}
@@ -204,11 +224,27 @@ Error: $e
204224
),
205225
}.flatten().toList();
206226

227+
DefinitionSerializationContext _serializeDefinitions(
228+
List<Constant> allConstants,
229+
) {
230+
final allDefinitions = {
231+
...calls.keys,
232+
...instances.keys,
233+
}.toList();
234+
return DefinitionSerializationContext(
235+
allDefinitions.asMapToIndices,
236+
);
237+
}
238+
207239
(SerializationContext, List<ConstantSyntax>) _serializeConstants(
208240
List<Constant> allConstants,
241+
DefinitionSerializationContext definitionContext,
209242
) {
210243
final constantsMap = allConstants.asMapToIndices;
211-
final context = SerializationContext(constantsMap);
244+
final context = SerializationContext.fromPrevious(
245+
definitionContext,
246+
constantsMap,
247+
);
212248
final constantSyntax = [
213249
for (final constant in allConstants) constant.toSyntax(context),
214250
];

‎pkgs/record_use/lib/src/serialization_context.dart‎

Lines changed: 36 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,38 +29,64 @@
2929
/// The order of operations ensures that all dependencies are available at each
3030
/// step:
3131
///
32-
/// 1. **Constants**: [Constant] objects are deserialized from or serialized
33-
/// to the [RecordedUsesSyntax.constants] pool first.
34-
/// 2. **Recordings**: [Recordings] are (de)serialized last from or to
35-
/// [RecordedUsesSyntax.recordings] as they depend on [Constant]s.
32+
/// 1. **Definitions**: [Definition] objects are deserialized from or
33+
/// serialized to the [RecordedUsesSyntax.definitions] pool first.
34+
/// 2. **Constants**: [Constant] objects are (de)serialized from or serialized
35+
/// to the [RecordedUsesSyntax.constants] pool second. They may contain
36+
/// references to the definitions pool (e.g. for [InstanceConstant]) and the
37+
/// constants pool (for recursive collections).
38+
/// 3. **Recordings**: [Recordings] are (de)serialized last from or to
39+
/// [RecordedUsesSyntax.recordings] as they depend on [Constant]s and
40+
/// [Definition]s.
3641
// TODO(https://github.com/dart-lang/native/issues/2979): Add a pool for
3742
// loading units.
38-
// TODO(https://github.com/dart-lang/native/issues/2867): Add a pool for
39-
// definitions.
4043
library;
4144

4245
import 'package:meta/meta.dart';
4346

4447
import 'constant.dart';
48+
import 'definition.dart';
4549
import 'recordings.dart';
4650
import 'syntax.g.dart';
4751

52+
/// Context providing access to the [Definition] pool during deserialization.
53+
@immutable
54+
base class DefinitionDeserializationContext {
55+
final List<Definition> definitions;
56+
57+
const DefinitionDeserializationContext(this.definitions);
58+
}
59+
4860
/// The final deserialization state where all pools are resolved.
4961
@immutable
50-
final class DeserializationContext {
62+
final class DeserializationContext extends DefinitionDeserializationContext {
5163
/// The mapping from the unique integer index in
5264
/// [RecordedUsesSyntax.constants] to the semantic [Constant]s.
5365
final List<Constant> constants;
5466

55-
const DeserializationContext(this.constants);
67+
DeserializationContext.fromPrevious(
68+
DefinitionDeserializationContext previous,
69+
this.constants,
70+
) : super(previous.definitions);
71+
}
72+
73+
/// Context providing access to the [Definition] index map during serialization.
74+
@immutable
75+
base class DefinitionSerializationContext {
76+
final Map<Definition, int> definitions;
77+
78+
const DefinitionSerializationContext(this.definitions);
5679
}
5780

5881
/// The final serialization state where all index maps are available.
5982
@immutable
60-
final class SerializationContext {
83+
final class SerializationContext extends DefinitionSerializationContext {
6184
/// The mapping from semantic [Constant] objects to their unique integer index
6285
/// within the constants pool ([RecordedUsesSyntax.constants]).
6386
final Map<Constant, int> constants;
6487

65-
const SerializationContext(this.constants);
88+
SerializationContext.fromPrevious(
89+
DefinitionSerializationContext previous,
90+
this.constants,
91+
) : super(previous.definitions);
6692
}

‎pkgs/record_use/lib/src/syntax.g.dart‎

Lines changed: 45 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1065,11 +1065,13 @@ class RecordedUsesSyntax extends JsonObjectSyntax {
10651065

10661066
RecordedUsesSyntax({
10671067
List<ConstantSyntax>? constants,
1068+
List<DefinitionSyntax>? definitions,
10681069
required MetadataSyntax metadata,
10691070
List<RecordingSyntax>? recordings,
10701071
super.path = const [],
10711072
}) : super() {
10721073
_constants = constants;
1074+
_definitions = definitions;
10731075
_metadata = metadata;
10741076
_recordings = recordings;
10751077
json.sortOnKey();
@@ -1109,6 +1111,40 @@ class RecordedUsesSyntax extends JsonObjectSyntax {
11091111
return [for (final element in elements) ...element.validate()];
11101112
}
11111113

1114+
List<DefinitionSyntax>? get definitions {
1115+
final jsonValue = _reader.optionalList('definitions');
1116+
if (jsonValue == null) return null;
1117+
return [
1118+
for (final (index, element) in jsonValue.indexed)
1119+
DefinitionSyntax.fromJson(
1120+
element as Map<String, Object?>,
1121+
path: [...path, 'definitions', index],
1122+
),
1123+
];
1124+
}
1125+
1126+
set _definitions(List<DefinitionSyntax>? value) {
1127+
if (value == null) {
1128+
json.remove('definitions');
1129+
} else {
1130+
json['definitions'] = [for (final item in value) item.json];
1131+
}
1132+
}
1133+
1134+
List<String> _validateDefinitions() {
1135+
final listErrors = _reader.validateOptionalList<Map<String, Object?>>(
1136+
'definitions',
1137+
);
1138+
if (listErrors.isNotEmpty) {
1139+
return listErrors;
1140+
}
1141+
final elements = definitions;
1142+
if (elements == null) {
1143+
return [];
1144+
}
1145+
return [for (final element in elements) ...element.validate()];
1146+
}
1147+
11121148
MetadataSyntax get metadata {
11131149
final jsonValue = _reader.map$('metadata');
11141150
return MetadataSyntax.fromJson(jsonValue, path: [...path, 'metadata']);
@@ -1164,6 +1200,7 @@ class RecordedUsesSyntax extends JsonObjectSyntax {
11641200
List<String> validate() => [
11651201
...super.validate(),
11661202
..._validateConstants(),
1203+
..._validateDefinitions(),
11671204
..._validateMetadata(),
11681205
..._validateRecordings(),
11691206
];
@@ -1180,12 +1217,12 @@ class RecordingSyntax extends JsonObjectSyntax {
11801217

11811218
RecordingSyntax({
11821219
List<CallSyntax>? calls,
1183-
required DefinitionSyntax definition,
1220+
required int definitionIndex,
11841221
List<InstanceSyntax>? instances,
11851222
super.path = const [],
11861223
}) : super() {
11871224
_calls = calls;
1188-
_definition = definition;
1225+
_definitionIndex = definitionIndex;
11891226
_instances = instances;
11901227
json.sortOnKey();
11911228
}
@@ -1224,22 +1261,14 @@ class RecordingSyntax extends JsonObjectSyntax {
12241261
return [for (final element in elements) ...element.validate()];
12251262
}
12261263

1227-
DefinitionSyntax get definition {
1228-
final jsonValue = _reader.map$('definition');
1229-
return DefinitionSyntax.fromJson(jsonValue, path: [...path, 'definition']);
1230-
}
1264+
int get definitionIndex => _reader.get<int>('definition_index');
12311265

1232-
set _definition(DefinitionSyntax value) {
1233-
json['definition'] = value.json;
1266+
set _definitionIndex(int value) {
1267+
json.setOrRemove('definition_index', value);
12341268
}
12351269

1236-
List<String> _validateDefinition() {
1237-
final mapErrors = _reader.validate<Map<String, Object?>>('definition');
1238-
if (mapErrors.isNotEmpty) {
1239-
return mapErrors;
1240-
}
1241-
return definition.validate();
1242-
}
1270+
List<String> _validateDefinitionIndex() =>
1271+
_reader.validate<int>('definition_index');
12431272

12441273
List<InstanceSyntax>? get instances {
12451274
final jsonValue = _reader.optionalList('instances');
@@ -1279,7 +1308,7 @@ class RecordingSyntax extends JsonObjectSyntax {
12791308
List<String> validate() => [
12801309
...super.validate(),
12811310
..._validateCalls(),
1282-
..._validateDefinition(),
1311+
..._validateDefinitionIndex(),
12831312
..._validateInstances(),
12841313
];
12851314

‎pkgs/record_use/test/json_schema/schema_test.dart‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -77,30 +77,30 @@ List<SchemaTestField> recordUseFields = [
7777
// Note the value for 'Instance' is optional because an empty map is
7878
// omitted. Also, Null has no value field.
7979
],
80-
(['recordings'], expectOptionalFieldMissing),
81-
(['recordings', 0, 'definition'], expectRequiredFieldMissing),
82-
(['recordings', 0, 'definition', 'uri'], expectRequiredFieldMissing),
83-
(['recordings', 0, 'definition', 'path'], expectRequiredFieldMissing),
84-
(['recordings', 0, 'definition', 'path', 0], expectOptionalFieldMissing),
80+
(['definitions'], expectOptionalFieldMissing),
81+
(['definitions', 0, 'uri'], expectRequiredFieldMissing),
82+
(['definitions', 0, 'path'], expectRequiredFieldMissing),
83+
(['definitions', 0, 'path', 0], expectOptionalFieldMissing),
8584
(
86-
['recordings', 0, 'definition', 'path', 0, 'name'],
85+
['definitions', 0, 'path', 0, 'name'],
8786
expectRequiredFieldMissing,
8887
),
8988
(
90-
['recordings', 0, 'definition', 'path', 0, 'kind'],
89+
['definitions', 0, 'path', 0, 'kind'],
9190
expectOptionalFieldMissing,
9291
),
9392
(
9493
[
95-
'recordings',
94+
'definitions',
9695
0,
97-
'definition',
9896
'path',
9997
0,
10098
'disambiguators',
10199
],
102100
expectOptionalFieldMissing,
103101
),
102+
(['recordings'], expectOptionalFieldMissing),
103+
(['recordings', 0, 'definition_index'], expectRequiredFieldMissing),
104104

105105
// TODO(https://github.com/dart-lang/native/issues/1093): Whether calls or
106106
// instances is required depends on whether the definition is a class or

‎pkgs/record_use/test/json_schema/uri_pattern_test.dart‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,9 @@ void main() {
2727

2828
test('JSON schema validation fails for non-package URI', () {
2929
final json = recordedUses.toJson();
30-
// Modify the first recording's definition URI to be invalid.
31-
final recordings = json['recordings'] as List;
32-
final recording = recordings[0] as Map;
33-
final definition = recording['definition'] as Map;
30+
// Modify the first definition's URI to be invalid.
31+
final definitions = json['definitions'] as List;
32+
final definition = definitions[0] as Map;
3433
definition['uri'] = 'dart:core'; // Should start with package:
3534

3635
final result = schema.validate(json);

0 commit comments

Comments
 (0)