Skip to content

Commit 73c2506

Browse files
committed
[csslib] Preserve forward-referenced mixins and clarify limit errors
- Keep forward-referenced and undefined declaration `@include` nodes intact during mixin definition analysis, and allocate `<TreeNode>[]` in `_Parser.processMarginsDeclarations()` so `@include` inside `@page` does not throw a `TypeError`. - Report distinct error messages for circular `@include`, max depth (`64`), and max expansions (`4096`) in `@include` and `@extend`. - Track per-selector ancestor chains in `InheritExtends` so sibling selectors in a selector group match `main`.
1 parent 034c522 commit 73c2506

3 files changed

Lines changed: 150 additions & 27 deletions

File tree

‎pkgs/csslib/lib/parser.dart‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1281,7 +1281,7 @@ class _Parser {
12811281

12821282
_eat(TokenKind.LBRACE);
12831283

1284-
var decls = <Declaration>[];
1284+
var decls = <TreeNode>[];
12851285
var dartStyles =
12861286
<DartStyleExpression>[]; // List of latest styles exposed to Dart.
12871287

‎pkgs/csslib/lib/src/analyzer.dart‎

Lines changed: 60 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,31 @@ const int _maxExpansionDepth = 64;
1111
/// `@extend` group, or `Expressions` list during `var()` polyfill resolution.
1212
const int _maxExpansions = 4096;
1313

14+
bool _checkIncludeLimits(
15+
Messages messages,
16+
String name,
17+
SourceSpan? span,
18+
Set<String> activeMixins,
19+
int totalExpansions,
20+
int stepCost,
21+
) {
22+
if (activeMixins.contains(name)) {
23+
messages.error('Circular @include for $name', span);
24+
return false;
25+
}
26+
if (activeMixins.length >= _maxExpansionDepth) {
27+
messages.error(
28+
'@include depth exceeded $_maxExpansionDepth for $name', span);
29+
return false;
30+
}
31+
if (totalExpansions + stepCost > _maxExpansions) {
32+
messages.error(
33+
'@include expansions exceeded $_maxExpansions for $name', span);
34+
return false;
35+
}
36+
return true;
37+
}
38+
1439
// TODO(terry): Add optimizing phase to remove duplicated selectors in the same
1540
// selector group (e.g., .btn, .btn { color: red; }). Also, look
1641
// at simplifying selectors expressions too (much harder).
@@ -489,10 +514,8 @@ class TopLevelIncludes extends Visitor {
489514
final name = node.name;
490515
final rules = mixinDef.rulesets;
491516
final stepCost = math.max(1, rules.length);
492-
if (_activeMixins.contains(name) ||
493-
_activeMixins.length >= _maxExpansionDepth ||
494-
_totalExpansions + stepCost > _maxExpansions) {
495-
_messages.error('Circular or too deep @include for $name', node.span);
517+
if (!_checkIncludeLimits(_messages, name, node.span, _activeMixins,
518+
_totalExpansions, stepCost)) {
496519
return const <TreeNode>[];
497520
}
498521
_activeMixins.add(name);
@@ -530,9 +553,7 @@ class TopLevelIncludes extends Visitor {
530553
@override
531554
void visitIncludeDirective(IncludeDirective node) {
532555
final currDef = this.currDef;
533-
if (currDef is MixinRulesetDirective && node.name == currDef.name) {
534-
currDef.rulesets.removeWhere((entry) => entry == node);
535-
} else if (map.containsKey(node.name)) {
556+
if (map.containsKey(node.name)) {
536557
var mixinDef = map[node.name];
537558
if (mixinDef is MixinRulesetDirective) {
538559
final targetList = currDef is MixinRulesetDirective
@@ -806,11 +827,8 @@ class DeclarationIncludes extends Visitor {
806827
if (_activeMixins.isEmpty) _totalExpansions = 0;
807828
final stepCost = math.max(1, estimatedCount);
808829
final targetRoot = currDeclGroup ?? _styleSheet!;
809-
if (_activeMixins.contains(mixinName) ||
810-
_activeMixins.length >= _maxExpansionDepth ||
811-
_totalExpansions + stepCost > _maxExpansions) {
812-
_messages.error(
813-
'Circular or too deep @include for $mixinName', node.span);
830+
if (!_checkIncludeLimits(_messages, mixinName, node.span, _activeMixins,
831+
_totalExpansions, stepCost)) {
814832
_IncludeReplacer.replace(targetRoot, node, const <TreeNode>[]);
815833
return;
816834
}
@@ -879,9 +897,6 @@ class DeclarationIncludes extends Visitor {
879897
var mixinDef = map[node.include.name];
880898
if (mixinDef == null) {
881899
_messages.warning('Undefined mixin ${node.include.name}', node.span);
882-
if (currDeclGroup != null) {
883-
_IncludeReplacer.replace(currDeclGroup!, node, const <TreeNode>[]);
884-
}
885900
} else if (mixinDef is MixinRulesetDirective) {
886901
if (!_allIncludes(mixinDef.rulesets) && currDeclGroup != null) {
887902
_IncludeReplacer.replace(currDeclGroup!, node, const <TreeNode>[]);
@@ -1133,13 +1148,25 @@ class InheritExtends extends Visitor {
11331148
static String _selectorText(Selector selector) =>
11341149
(CssPrinter()..visitSelector(selector)).toString();
11351150

1151+
static bool _hasCycleInChain(
1152+
Selector selector,
1153+
String candidateText,
1154+
Map<Selector, Selector> parents,
1155+
Map<Selector, String> texts,
1156+
) {
1157+
for (Selector? curr = selector; curr != null; curr = parents[curr]) {
1158+
if ((texts[curr] ??= _selectorText(curr)) == candidateText) return true;
1159+
}
1160+
return false;
1161+
}
1162+
11361163
static Selector? _deriveSelector(
11371164
SelectorGroup group,
11381165
Selector selectors,
11391166
SelectorGroup match,
11401167
int index,
1141-
Map<String, int> seenDepth,
1142-
int depth, {
1168+
Map<Selector, Selector> parents,
1169+
Map<Selector, String> texts, {
11431170
required bool isLastNone,
11441171
}) {
11451172
if (match == group || match.selectors.isEmpty) return null;
@@ -1164,16 +1191,15 @@ class InheritExtends extends Visitor {
11641191
derived = newSelectors;
11651192
}
11661193
final derivedText = _selectorText(derived);
1167-
if ((seenDepth[derivedText] ?? depth) < depth) return null;
1168-
seenDepth[derivedText] = depth;
1194+
if (_hasCycleInChain(selectors, derivedText, parents, texts)) return null;
1195+
texts[derived] = derivedText;
11691196
return derived;
11701197
}
11711198

11721199
@override
11731200
void visitSelectorGroup(SelectorGroup node) {
1174-
final seenDepth = <String, int>{
1175-
for (final s in node.selectors) _selectorText(s): 0,
1176-
};
1201+
final parents = <Selector, Selector>{};
1202+
final texts = <Selector, String>{};
11771203
final depths = <Selector, int>{};
11781204
var expansions = 0;
11791205
for (var selectorsIndex = 0;
@@ -1200,18 +1226,26 @@ class InheritExtends extends Visitor {
12001226
selectors,
12011227
match,
12021228
index,
1203-
seenDepth,
1204-
depth,
1229+
parents,
1230+
texts,
12051231
isLastNone: isLastNone,
12061232
);
12071233
isLastNone = false;
12081234
if (derived == null) continue;
1209-
if (depth > _maxExpansionDepth || expansions >= _maxExpansions) {
1210-
_messages.error('Maximum @extend depth reached', node.span);
1235+
if (depth > _maxExpansionDepth) {
1236+
_messages.error(
1237+
'@extend depth exceeded $_maxExpansionDepth', node.span);
1238+
super.visitSelectorGroup(node);
1239+
return;
1240+
}
1241+
if (expansions >= _maxExpansions) {
1242+
_messages.error(
1243+
'@extend expansions exceeded $_maxExpansions', node.span);
12111244
super.visitSelectorGroup(node);
12121245
return;
12131246
}
12141247
expansions++;
1248+
parents[derived] = selectors;
12151249
depths[derived] = depth;
12161250
node.selectors.add(derived);
12171251
}

‎pkgs/csslib/test/error_test.dart‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -688,5 +688,94 @@ void main() {
688688
expect(varOut, isNot(contains('var(')));
689689
expect('margin: 1px 2px'.allMatches(varOut), hasLength(varRules));
690690
});
691+
692+
test(
693+
'forward-referenced declaration mixins, @page @include, '
694+
'sibling @extend, and distinct limit messages', () {
695+
final forwardDeclErrors = <Message>[];
696+
final forwardDeclOut = prettyPrint(
697+
compile(
698+
'@mixin d1 { color: red; @include d2; }\n'
699+
'@mixin d2 { width: 1px; }\n'
700+
'.a { @include d1; }',
701+
errors: forwardDeclErrors,
702+
),
703+
);
704+
expect(
705+
forwardDeclErrors.where((m) => m.level == MessageLevel.severe),
706+
isEmpty,
707+
);
708+
expect(forwardDeclOut, contains('color: #f00'));
709+
expect(forwardDeclOut, contains('width: 1px'));
710+
711+
final undefIncludeOut = prettyPrint(
712+
compileCss('div { @include nope; color: red; }', opts: options),
713+
);
714+
expect(undefIncludeOut, contains('@include nope'));
715+
716+
_exerciseAllEntryPoints('@page { @include nope; }');
717+
_exerciseAllEntryPoints('@page { @include ; }');
718+
_exerciseAllEntryPoints('@mixin d { color: red; } @page { @include d; }');
719+
final pageIncludeOut = prettyPrint(
720+
compileCss(
721+
'@mixin d { color: red; } @page { @include d; }',
722+
opts: options,
723+
),
724+
);
725+
expect(pageIncludeOut, contains('color: #f00'));
726+
727+
final siblingExtendOut = prettyPrint(
728+
compileCss('.a, .b { color: red; } .b { @extend .a; }', opts: options),
729+
);
730+
expect(siblingExtendOut, contains('.a, .b, .b {'));
731+
732+
final circularErrors = <Message>[];
733+
compileCss(
734+
'@mixin cyc { color: red; @include cyc; } .a { @include cyc; }',
735+
errors: circularErrors,
736+
opts: options,
737+
);
738+
expect(
739+
circularErrors.map((e) => e.message),
740+
contains('Circular @include for cyc'),
741+
);
742+
743+
final deepIncludeErrors = <Message>[];
744+
final deepIncludeCss = [
745+
for (var i = 0; i < 66; i++)
746+
'@mixin d$i { color: red; @include d${i + 1}; }',
747+
'@mixin d66 { color: blue; }',
748+
'.a { @include d0; }',
749+
].join('\n');
750+
compile(deepIncludeCss, errors: deepIncludeErrors);
751+
expect(
752+
deepIncludeErrors.map((e) => e.message),
753+
contains('@include depth exceeded 64 for d64'),
754+
);
755+
756+
final manyIncludeErrors = <Message>[];
757+
final manyIncludeCss = [
758+
'@mixin m0 { .x { color: red; } }',
759+
for (var i = 1; i <= 14; i++)
760+
'@mixin m$i { @include m${i - 1}; @include m${i - 1}; }',
761+
'@include m14;',
762+
].join('\n');
763+
compileCss(manyIncludeCss, errors: manyIncludeErrors, opts: options);
764+
expect(
765+
manyIncludeErrors.map((e) => e.message),
766+
contains(startsWith('@include expansions exceeded 4096 for ')),
767+
);
768+
769+
final deepExtendErrors = <Message>[];
770+
final deepExtendCss = [
771+
'.s0 { color: red; }',
772+
for (var i = 1; i <= 70; i++) '.s$i { @extend .s${i - 1}; }',
773+
].join('\n');
774+
compileCss(deepExtendCss, errors: deepExtendErrors, opts: options);
775+
expect(
776+
deepExtendErrors.map((e) => e.message),
777+
contains('@extend depth exceeded 64'),
778+
);
779+
});
691780
});
692781
}

0 commit comments

Comments
 (0)