Skip to content

Commit 8c3f3ec

Browse files
authored
[record_use] Deterministic serialization order (dart-lang#3156)
1 parent 4224cf5 commit 8c3f3ec

22 files changed

Lines changed: 680 additions & 469 deletions

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

Lines changed: 251 additions & 71 deletions
Large diffs are not rendered by default.

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

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,11 @@ class Definition {
6868
);
6969

7070
/// Canonicalizes the children of this [Definition].
71-
Definition _canonicalizeChildren(CanonicalizationContext context) => this;
71+
Definition _canonicalizeChildren(CanonicalizationContext context) =>
72+
Definition(
73+
library,
74+
[for (final name in path) name._canonicalizeChildren(context)],
75+
);
7276

7377
/// The parent, if it exists.
7478
Definition? get parent => path.length > 1
@@ -137,6 +141,18 @@ class Name {
137141
this.disambiguators = const {},
138142
});
139143

144+
Name _canonicalizeChildren(CanonicalizationContext context) {
145+
if (disambiguators.isEmpty) return this;
146+
return Name(
147+
name,
148+
kind: kind,
149+
disambiguators: Set.from(
150+
disambiguators.toList()
151+
..sort((a, b) => a.toString().compareTo(b.toString())),
152+
),
153+
);
154+
}
155+
140156
@override
141157
bool operator ==(Object other) {
142158
if (identical(this, other)) return true;

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

Lines changed: 44 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -127,17 +127,17 @@ Error: $e
127127
final newCalls = <Definition, List<CallReference>>{};
128128
for (final entry in calls.entries) {
129129
final definition = context.canonicalizeDefinition(entry.key);
130-
final references = entry.value
131-
.map((r) => r.canonicalizeChildren(context))
132-
.toList();
130+
final references = [
131+
for (final r in entry.value) r.canonicalizeChildren(context),
132+
];
133133
newCalls.putIfAbsent(definition, () => []).addAll(references);
134134
}
135135
final newInstances = <Definition, List<InstanceReference>>{};
136136
for (final entry in instances.entries) {
137137
final definition = context.canonicalizeDefinition(entry.key);
138-
final references = entry.value
139-
.map((r) => r.canonicalizeChildren(context))
140-
.toList();
138+
final references = [
139+
for (final r in entry.value) r.canonicalizeChildren(context),
140+
];
141141
newInstances.putIfAbsent(definition, () => []).addAll(references);
142142
}
143143
return Recordings(
@@ -205,27 +205,42 @@ Error: $e
205205
final canonContext = CanonicalizationContext();
206206
final canon = _canonicalizeChildren(canonContext);
207207

208+
final sortedLoadingUnits = canonContext.loadingUnits.toList()
209+
..sort((a, b) => a.name.compareTo(b.name));
210+
final sortedDefinitions = canonContext.definitions.toList()
211+
..sort((a, b) => a.toString().compareTo(b.toString()));
212+
final sortedConstants = canonContext.constants.toList()
213+
..sort((a, b) => a.compareTo(b));
214+
208215
final context = SerializationContext(
209-
loadingUnits: canonContext.loadingUnits.asMapToIndices,
210-
definitions: canonContext.definitions.asMapToIndices,
211-
constants: canonContext.constants.asMapToIndices,
216+
loadingUnits: sortedLoadingUnits.asMapToIndices,
217+
definitions: sortedDefinitions.asMapToIndices,
218+
constants: sortedConstants.asMapToIndices,
212219
);
213220

214221
final callRecordings = <CallRecordingSyntax>[];
215-
for (final entry in canon.calls.entries) {
222+
for (final definition in context.definitions.keys) {
223+
final callsForDefinition = canon.calls[definition];
224+
if (callsForDefinition == null || callsForDefinition.isEmpty) continue;
216225
callRecordings.add(
217226
CallRecordingSyntax(
218-
definitionIndex: context.definitions[entry.key]!,
219-
uses: entry.value.map((call) => call.toSyntax(context)).toList(),
227+
definitionIndex: context.definitions[definition]!,
228+
uses: callsForDefinition
229+
.map((call) => call.toSyntax(context))
230+
.toList(),
220231
),
221232
);
222233
}
223234
final instanceRecordings = <InstanceRecordingSyntax>[];
224-
for (final entry in canon.instances.entries) {
235+
for (final definition in context.definitions.keys) {
236+
final instancesForDefinition = canon.instances[definition];
237+
if (instancesForDefinition == null || instancesForDefinition.isEmpty) {
238+
continue;
239+
}
225240
instanceRecordings.add(
226241
InstanceRecordingSyntax(
227-
definitionIndex: context.definitions[entry.key]!,
228-
uses: entry.value
242+
definitionIndex: context.definitions[definition]!,
243+
uses: instancesForDefinition
229244
.map((instance) => instance.toSyntax(context))
230245
.toList(),
231246
),
@@ -241,23 +256,23 @@ Error: $e
241256

242257
return RecordedUsesSyntax(
243258
metadata: metadata.toSyntax(),
244-
constants: canonContext.constants.isEmpty
259+
constants: sortedConstants.isEmpty
245260
? null
246-
: canonContext.constants
247-
.map((constant) => constant.toSyntax(context))
248-
.toList(),
249-
loadingUnits: canonContext.loadingUnits.isEmpty
261+
: [
262+
for (final constant in sortedConstants)
263+
constant.toSyntax(context),
264+
],
265+
loadingUnits: sortedLoadingUnits.isEmpty
250266
? null
251-
: canonContext.loadingUnits
252-
.map((unit) => LoadingUnitSyntax(name: unit.name))
253-
.toList(),
254-
definitions: context.definitions.isEmpty
267+
: [
268+
for (final unit in sortedLoadingUnits)
269+
LoadingUnitSyntax(name: unit.name),
270+
],
271+
definitions: sortedDefinitions.isEmpty
255272
? null
256-
: context.definitions.keys
257-
.map(
258-
(definition) => definition.toSyntax(),
259-
)
260-
.toList(),
273+
: [
274+
for (final definition in sortedDefinitions) definition.toSyntax(),
275+
],
261276
uses: uses,
262277
);
263278
}

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

Lines changed: 67 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -178,26 +178,25 @@ final class CallWithArguments extends CallReference {
178178
});
179179

180180
@override
181-
Reference _canonicalizeChildren(CanonicalizationContext context) =>
182-
CallWithArguments(
183-
loadingUnits: loadingUnits
184-
.map((u) => context.canonicalizeLoadingUnit(u))
185-
.toList(),
186-
receiver: receiver != null
187-
? context.canonicalizeConstant(receiver!)
188-
: null,
189-
positionalArguments: positionalArguments
190-
.map((c) => context.canonicalizeConstant(c))
191-
.toList(),
192-
namedArguments: Map.fromEntries(
193-
namedArguments.entries.map(
194-
(e) => MapEntry(
195-
e.key,
196-
context.canonicalizeConstant(e.value),
197-
),
198-
),
199-
),
200-
);
181+
Reference _canonicalizeChildren(CanonicalizationContext context) {
182+
final sortedNamedArgs = namedArguments.entries.toList()
183+
..sort((a, b) => a.key.compareTo(b.key));
184+
return CallWithArguments(
185+
loadingUnits: [
186+
for (final u in loadingUnits) context.canonicalizeLoadingUnit(u),
187+
],
188+
receiver: receiver != null
189+
? context.canonicalizeConstant(receiver!)
190+
: null,
191+
positionalArguments: [
192+
for (final c in positionalArguments) context.canonicalizeConstant(c),
193+
],
194+
namedArguments: {
195+
for (final e in sortedNamedArgs)
196+
e.key: context.canonicalizeConstant(e.value),
197+
},
198+
);
199+
}
201200

202201
@override
203202
WithArgumentsCallSyntax _toSyntax(SerializationContext context) {
@@ -207,15 +206,16 @@ final class CallWithArguments extends CallReference {
207206
}
208207

209208
return WithArgumentsCallSyntax(
210-
loadingUnitIndices: loadingUnits
211-
.map((unit) => context.loadingUnits[unit]!)
212-
.toList(),
209+
loadingUnitIndices: [
210+
for (final unit in loadingUnits) context.loadingUnits[unit]!,
211+
],
213212
named: namedArgs.isNotEmpty ? namedArgs : null,
214213
positional: positionalArguments.isEmpty
215214
? null
216-
: positionalArguments
217-
.map((argument) => context.constants[argument]!)
218-
.toList(),
215+
: [
216+
for (final argument in positionalArguments)
217+
context.constants[argument]!,
218+
],
219219
receiver: receiver != null ? context.constants[receiver!] : null,
220220
);
221221
}
@@ -326,9 +326,9 @@ final class CallTearoff extends CallReference {
326326
@override
327327
Reference _canonicalizeChildren(CanonicalizationContext context) =>
328328
CallTearoff(
329-
loadingUnits: loadingUnits
330-
.map((u) => context.canonicalizeLoadingUnit(u))
331-
.toList(),
329+
loadingUnits: [
330+
for (final u in loadingUnits) context.canonicalizeLoadingUnit(u),
331+
],
332332
receiver: receiver != null
333333
? context.canonicalizeConstant(receiver!)
334334
: null,
@@ -337,9 +337,9 @@ final class CallTearoff extends CallReference {
337337
@override
338338
TearoffCallSyntax _toSyntax(SerializationContext context) =>
339339
TearoffCallSyntax(
340-
loadingUnitIndices: loadingUnits
341-
.map((unit) => context.loadingUnits[unit]!)
342-
.toList(),
340+
loadingUnitIndices: [
341+
for (final unit in loadingUnits) context.loadingUnits[unit]!,
342+
],
343343
receiver: receiver != null ? context.constants[receiver!] : null,
344344
);
345345

@@ -459,9 +459,9 @@ final class InstanceConstantReference extends InstanceReference {
459459
@override
460460
Reference _canonicalizeChildren(CanonicalizationContext context) =>
461461
InstanceConstantReference(
462-
loadingUnits: loadingUnits
463-
.map((u) => context.canonicalizeLoadingUnit(u))
464-
.toList(),
462+
loadingUnits: [
463+
for (final u in loadingUnits) context.canonicalizeLoadingUnit(u),
464+
],
465465
instanceConstant:
466466
context.canonicalizeConstant(instanceConstant) as Constant,
467467
);
@@ -470,9 +470,9 @@ final class InstanceConstantReference extends InstanceReference {
470470
ConstantInstanceSyntax _toSyntax(SerializationContext context) =>
471471
ConstantInstanceSyntax(
472472
constantIndex: context.constants[instanceConstant]!,
473-
loadingUnitIndices: loadingUnits
474-
.map((unit) => context.loadingUnits[unit]!)
475-
.toList(),
473+
loadingUnitIndices: [
474+
for (final unit in loadingUnits) context.loadingUnits[unit]!,
475+
],
476476
);
477477

478478
@override
@@ -534,23 +534,22 @@ final class InstanceCreationReference extends InstanceReference {
534534
});
535535

536536
@override
537-
Reference _canonicalizeChildren(CanonicalizationContext context) =>
538-
InstanceCreationReference(
539-
loadingUnits: loadingUnits
540-
.map((u) => context.canonicalizeLoadingUnit(u))
541-
.toList(),
542-
positionalArguments: positionalArguments
543-
.map((c) => context.canonicalizeConstant(c))
544-
.toList(),
545-
namedArguments: Map.fromEntries(
546-
namedArguments.entries.map(
547-
(e) => MapEntry(
548-
e.key,
549-
context.canonicalizeConstant(e.value),
550-
),
551-
),
552-
),
553-
);
537+
Reference _canonicalizeChildren(CanonicalizationContext context) {
538+
final sortedNamedArgs = namedArguments.entries.toList()
539+
..sort((a, b) => a.key.compareTo(b.key));
540+
return InstanceCreationReference(
541+
loadingUnits: [
542+
for (final u in loadingUnits) context.canonicalizeLoadingUnit(u),
543+
],
544+
positionalArguments: [
545+
for (final c in positionalArguments) context.canonicalizeConstant(c),
546+
],
547+
namedArguments: {
548+
for (final e in sortedNamedArgs)
549+
e.key: context.canonicalizeConstant(e.value),
550+
},
551+
);
552+
}
554553

555554
@override
556555
CreationInstanceSyntax _toSyntax(SerializationContext context) {
@@ -560,15 +559,16 @@ final class InstanceCreationReference extends InstanceReference {
560559
}
561560

562561
return CreationInstanceSyntax(
563-
loadingUnitIndices: loadingUnits
564-
.map((unit) => context.loadingUnits[unit]!)
565-
.toList(),
562+
loadingUnitIndices: [
563+
for (final unit in loadingUnits) context.loadingUnits[unit]!,
564+
],
566565
named: namedArgs.isNotEmpty ? namedArgs : null,
567566
positional: positionalArguments.isEmpty
568567
? null
569-
: positionalArguments
570-
.map((argument) => context.constants[argument]!)
571-
.toList(),
568+
: [
569+
for (final argument in positionalArguments)
570+
context.constants[argument]!,
571+
],
572572
);
573573
}
574574

@@ -664,17 +664,17 @@ final class ConstructorTearoffReference extends InstanceReference {
664664
@override
665665
Reference _canonicalizeChildren(CanonicalizationContext context) =>
666666
ConstructorTearoffReference(
667-
loadingUnits: loadingUnits
668-
.map((u) => context.canonicalizeLoadingUnit(u))
669-
.toList(),
667+
loadingUnits: [
668+
for (final u in loadingUnits) context.canonicalizeLoadingUnit(u),
669+
],
670670
);
671671

672672
@override
673673
TearoffInstanceSyntax _toSyntax(SerializationContext context) =>
674674
TearoffInstanceSyntax(
675-
loadingUnitIndices: loadingUnits
676-
.map((unit) => context.loadingUnits[unit]!)
677-
.toList(),
675+
loadingUnitIndices: [
676+
for (final unit in loadingUnits) context.loadingUnits[unit]!,
677+
],
678678
);
679679

680680
@override

0 commit comments

Comments
 (0)