Skip to content

Commit dbcba1d

Browse files
authored
[record_use] Filter out nested constants from other packages (dart-lang#3167)
1 parent 754c69d commit dbcba1d

4 files changed

Lines changed: 324 additions & 2 deletions

File tree

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

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,14 @@ sealed class MaybeConstant {
3131
/// Canonicalizes this [MaybeConstant].
3232
MaybeConstant _canonicalizeChildren(CanonicalizationContext context);
3333

34+
/// Returns a new [MaybeConstant] that only contains information allowed
35+
/// by the provided criteria.
36+
///
37+
/// If [definitionPackageName] is provided, constants that are instances of
38+
/// classes or enums from other packages are replaced with an
39+
/// [UnsupportedConstant].
40+
MaybeConstant _filter({String? definitionPackageName});
41+
3442
/// Compares this [MaybeConstant] with [other] for stable sorting.
3543
int _compareTo(MaybeConstant other) {
3644
if (identical(this, other)) return 0;
@@ -200,6 +208,9 @@ final class NonConstant extends MaybeConstant {
200208
@override
201209
MaybeConstant _canonicalizeChildren(CanonicalizationContext context) => this;
202210

211+
@override
212+
MaybeConstant _filter({String? definitionPackageName}) => this;
213+
203214
@override
204215
int get hashCode => 0x4e6f6e43;
205216

@@ -234,6 +245,9 @@ abstract class Constant extends MaybeConstant {
234245
@override
235246
Constant _canonicalizeChildren(CanonicalizationContext context);
236247

248+
@override
249+
Constant _filter({String? definitionPackageName});
250+
237251
@override
238252
@visibleForTesting
239253
bool semanticEquals(
@@ -274,6 +288,9 @@ final class NullConstant extends Constant {
274288
@override
275289
Constant _canonicalizeChildren(CanonicalizationContext context) => this;
276290

291+
@override
292+
Constant _filter({String? definitionPackageName}) => this;
293+
277294
@override
278295
int get hashCode => 0x4e756c6c;
279296

@@ -318,6 +335,9 @@ final class UnsupportedConstant extends Constant {
318335
@override
319336
Constant _canonicalizeChildren(CanonicalizationContext context) => this;
320337

338+
@override
339+
Constant _filter({String? definitionPackageName}) => this;
340+
321341
@override
322342
int get hashCode => message.hashCode;
323343

@@ -363,6 +383,9 @@ final class BoolConstant extends Constant {
363383
@override
364384
Constant _canonicalizeChildren(CanonicalizationContext context) => this;
365385

386+
@override
387+
Constant _filter({String? definitionPackageName}) => this;
388+
366389
@override
367390
bool operator ==(Object other) =>
368391
other is BoolConstant && other.value == value;
@@ -410,6 +433,9 @@ final class IntConstant extends Constant {
410433
@override
411434
Constant _canonicalizeChildren(CanonicalizationContext context) => this;
412435

436+
@override
437+
Constant _filter({String? definitionPackageName}) => this;
438+
413439
@override
414440
bool operator ==(Object other) =>
415441
other is IntConstant && other.value == value;
@@ -454,6 +480,9 @@ final class StringConstant extends Constant {
454480
@override
455481
Constant _canonicalizeChildren(CanonicalizationContext context) => this;
456482

483+
@override
484+
Constant _filter({String? definitionPackageName}) => this;
485+
457486
@override
458487
bool operator ==(Object other) =>
459488
other is StringConstant && other.value == value;
@@ -503,6 +532,9 @@ final class SymbolConstant extends Constant {
503532
@override
504533
Constant _canonicalizeChildren(CanonicalizationContext context) => this;
505534

535+
@override
536+
Constant _filter({String? definitionPackageName}) => this;
537+
506538
@override
507539
bool operator ==(Object other) =>
508540
other is SymbolConstant &&
@@ -574,6 +606,12 @@ final class ListConstant extends Constant {
574606
for (final c in value) context.canonicalizeConstant(c) as Constant,
575607
]);
576608

609+
@override
610+
Constant _filter({String? definitionPackageName}) => ListConstant([
611+
for (final c in value)
612+
c._filter(definitionPackageName: definitionPackageName),
613+
]);
614+
577615
@override
578616
bool operator ==(Object other) {
579617
if (identical(this, other)) return true;
@@ -672,6 +710,15 @@ final class MapConstant extends Constant {
672710
return MapConstant(canonEntries);
673711
}
674712

713+
@override
714+
Constant _filter({String? definitionPackageName}) => MapConstant([
715+
for (final entry in entries)
716+
MapEntry(
717+
entry.key._filter(definitionPackageName: definitionPackageName),
718+
entry.value._filter(definitionPackageName: definitionPackageName),
719+
),
720+
]);
721+
675722
@override
676723
bool operator ==(Object other) {
677724
if (identical(this, other)) return true;
@@ -816,6 +863,25 @@ final class InstanceConstant extends Constant {
816863
);
817864
}
818865

866+
@override
867+
Constant _filter({String? definitionPackageName}) {
868+
if (definitionPackageName != null &&
869+
!definition.library.startsWith('package:$definitionPackageName/')) {
870+
return UnsupportedConstant(
871+
'Instance of $definition from other package is not supported.',
872+
);
873+
}
874+
return InstanceConstant(
875+
definition: definition,
876+
fields: fields.map(
877+
(key, value) => MapEntry(
878+
key,
879+
value._filter(definitionPackageName: definitionPackageName),
880+
),
881+
),
882+
);
883+
}
884+
819885
@override
820886
int get _orderingTypePriority => 11;
821887

@@ -958,6 +1024,27 @@ final class EnumConstant extends Constant {
9581024
);
9591025
}
9601026

1027+
@override
1028+
Constant _filter({String? definitionPackageName}) {
1029+
if (definitionPackageName != null &&
1030+
!definition.library.startsWith('package:$definitionPackageName/')) {
1031+
return UnsupportedConstant(
1032+
'Instance of $definition from other package is not supported.',
1033+
);
1034+
}
1035+
return EnumConstant(
1036+
definition: definition,
1037+
index: index,
1038+
name: name,
1039+
fields: fields.map(
1040+
(key, value) => MapEntry(
1041+
key,
1042+
value._filter(definitionPackageName: definitionPackageName),
1043+
),
1044+
),
1045+
);
1046+
}
1047+
9611048
@override
9621049
int get _orderingTypePriority => 10;
9631050

@@ -1097,6 +1184,20 @@ final class RecordConstant extends Constant {
10971184
);
10981185
}
10991186

1187+
@override
1188+
Constant _filter({String? definitionPackageName}) => RecordConstant(
1189+
positional: [
1190+
for (final c in positional)
1191+
c._filter(definitionPackageName: definitionPackageName),
1192+
],
1193+
named: named.map(
1194+
(key, value) => MapEntry(
1195+
key,
1196+
value._filter(definitionPackageName: definitionPackageName),
1197+
),
1198+
),
1199+
);
1200+
11001201
@override
11011202
int get _orderingTypePriority => 9;
11021203

@@ -1170,6 +1271,9 @@ extension MaybeConstantProtected on MaybeConstant {
11701271
MaybeConstant canonicalizeChildren(CanonicalizationContext context) =>
11711272
_canonicalizeChildren(context);
11721273

1274+
MaybeConstant filter({String? definitionPackageName}) =>
1275+
_filter(definitionPackageName: definitionPackageName);
1276+
11731277
int compareTo(MaybeConstant other) => _compareTo(other);
11741278

11751279
static MaybeConstant fromSyntax(

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

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -505,12 +505,20 @@ Error: $e
505505

506506
final newCallsForDefinition = {
507507
for (final entry in calls.entries)
508-
if (belongsToPackage(entry.key)) entry.key: entry.value,
508+
if (belongsToPackage(entry.key))
509+
entry.key: [
510+
for (final call in entry.value)
511+
call.filter(definitionPackageName: definitionPackageName),
512+
],
509513
};
510514

511515
final newInstancesForDefinition = {
512516
for (final entry in instances.entries)
513-
if (belongsToPackage(entry.key)) entry.key: entry.value,
517+
if (belongsToPackage(entry.key))
518+
entry.key: [
519+
for (final instance in entry.value)
520+
instance.filter(definitionPackageName: definitionPackageName),
521+
],
514522
};
515523

516524
return Recordings(

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

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ sealed class Reference {
2727
/// Canonicalizes this [Reference].
2828
Reference _canonicalizeChildren(CanonicalizationContext context);
2929

30+
/// Returns a new [Reference] that only contains information allowed
31+
/// by the provided criteria.
32+
Reference _filter({String? definitionPackageName});
33+
3034
@override
3135
bool operator ==(Object other) {
3236
if (identical(this, other)) return true;
@@ -116,6 +120,9 @@ sealed class CallReference extends Reference {
116120

117121
CallSyntax _toSyntax(SerializationContext context);
118122

123+
@override
124+
CallReference _filter({String? definitionPackageName});
125+
119126
/// Compares this [CallWithArguments] with [other] for semantic equality.
120127
///
121128
/// If [allowTearoffToStaticPromotion] is true, this may be equal to a
@@ -198,6 +205,22 @@ final class CallWithArguments extends CallReference {
198205
);
199206
}
200207

208+
@override
209+
CallReference _filter({String? definitionPackageName}) => CallWithArguments(
210+
loadingUnits: loadingUnits,
211+
receiver: receiver?.filter(definitionPackageName: definitionPackageName),
212+
positionalArguments: [
213+
for (final c in positionalArguments)
214+
c.filter(definitionPackageName: definitionPackageName),
215+
],
216+
namedArguments: namedArguments.map(
217+
(key, value) => MapEntry(
218+
key,
219+
value.filter(definitionPackageName: definitionPackageName),
220+
),
221+
),
222+
);
223+
201224
@override
202225
WithArgumentsCallSyntax _toSyntax(SerializationContext context) {
203226
final namedArgs = <String, int>{};
@@ -334,6 +357,12 @@ final class CallTearoff extends CallReference {
334357
: null,
335358
);
336359

360+
@override
361+
CallReference _filter({String? definitionPackageName}) => CallTearoff(
362+
loadingUnits: loadingUnits,
363+
receiver: receiver?.filter(definitionPackageName: definitionPackageName),
364+
);
365+
337366
@override
338367
TearoffCallSyntax _toSyntax(SerializationContext context) =>
339368
TearoffCallSyntax(
@@ -433,6 +462,9 @@ sealed class InstanceReference extends Reference {
433462

434463
InstanceSyntax _toSyntax(SerializationContext context);
435464

465+
@override
466+
InstanceReference _filter({String? definitionPackageName});
467+
436468
/// Compares this [InstanceReference] with [other] for semantic equality.
437469
///
438470
/// The loading unit can be mapped with [loadingUnitMapping].
@@ -466,6 +498,17 @@ final class InstanceConstantReference extends InstanceReference {
466498
context.canonicalizeConstant(instanceConstant) as Constant,
467499
);
468500

501+
@override
502+
InstanceReference _filter({String? definitionPackageName}) =>
503+
InstanceConstantReference(
504+
loadingUnits: loadingUnits,
505+
instanceConstant:
506+
instanceConstant.filter(
507+
definitionPackageName: definitionPackageName,
508+
)
509+
as Constant,
510+
);
511+
469512
@override
470513
ConstantInstanceSyntax _toSyntax(SerializationContext context) =>
471514
ConstantInstanceSyntax(
@@ -551,6 +594,22 @@ final class InstanceCreationReference extends InstanceReference {
551594
);
552595
}
553596

597+
@override
598+
InstanceReference _filter({String? definitionPackageName}) =>
599+
InstanceCreationReference(
600+
loadingUnits: loadingUnits,
601+
positionalArguments: [
602+
for (final c in positionalArguments)
603+
c.filter(definitionPackageName: definitionPackageName),
604+
],
605+
namedArguments: namedArguments.map(
606+
(key, value) => MapEntry(
607+
key,
608+
value.filter(definitionPackageName: definitionPackageName),
609+
),
610+
),
611+
);
612+
554613
@override
555614
CreationInstanceSyntax _toSyntax(SerializationContext context) {
556615
final namedArgs = <String, int>{};
@@ -669,6 +728,9 @@ final class ConstructorTearoffReference extends InstanceReference {
669728
],
670729
);
671730

731+
@override
732+
InstanceReference _filter({String? definitionPackageName}) => this;
733+
672734
@override
673735
TearoffInstanceSyntax _toSyntax(SerializationContext context) =>
674736
TearoffInstanceSyntax(
@@ -711,6 +773,9 @@ final class ConstructorTearoffReference extends InstanceReference {
711773
extension ReferenceProtected on Reference {
712774
Reference canonicalizeChildren(CanonicalizationContext context) =>
713775
_canonicalizeChildren(context);
776+
777+
Reference filter({String? definitionPackageName}) =>
778+
_filter(definitionPackageName: definitionPackageName);
714779
}
715780

716781
/// Package private (protected) methods for [CallReference].
@@ -723,6 +788,9 @@ extension CallReferenceProtected on CallReference {
723788
CallReference canonicalizeChildren(CanonicalizationContext context) =>
724789
_canonicalizeChildren(context) as CallReference;
725790

791+
CallReference filter({String? definitionPackageName}) =>
792+
_filter(definitionPackageName: definitionPackageName);
793+
726794
static CallReference fromSyntax(
727795
CallSyntax syntax,
728796
DeserializationContext context,
@@ -739,6 +807,9 @@ extension InstanceReferenceProtected on InstanceReference {
739807
InstanceReference canonicalizeChildren(CanonicalizationContext context) =>
740808
_canonicalizeChildren(context) as InstanceReference;
741809

810+
InstanceReference filter({String? definitionPackageName}) =>
811+
_filter(definitionPackageName: definitionPackageName);
812+
742813
static InstanceReference fromSyntax(
743814
InstanceSyntax syntax,
744815
DeserializationContext context,

0 commit comments

Comments
 (0)