refactor(compiler): add more deferred validations (#51262)

Adds validations for the following invalid deferred block structures:
* Duplicated triggers.
* Multiple `minimum` parameters on `placeholder` and `loading` blocks.
* Multiple `after` parameters on `loading` blocks.

PR Close #51262
This commit is contained in:
Kristiyan Kostadinov 2023-08-03 14:30:39 +02:00 committed by Dylan Hunn
parent d11548f2ef
commit 1045abd3c8
3 changed files with 58 additions and 4 deletions

View file

@ -112,6 +112,10 @@ function parsePlaceholderBlock(ast: html.Block, visitor: html.Visitor): t.Deferr
for (const param of ast.parameters) {
if (MINIMUM_PARAMETER_PATTERN.test(param.expression)) {
if (minimumTime != null) {
throw new Error(`Placeholder block can only have one "minimum" parameter`);
}
const parsedTime =
parseDeferredTime(param.expression.slice(getTriggerParametersStart(param.expression)));
@ -137,6 +141,10 @@ function parseLoadingBlock(ast: html.Block, visitor: html.Visitor): t.DeferredBl
for (const param of ast.parameters) {
if (AFTER_PARAMETER_PATTERN.test(param.expression)) {
if (afterTime != null) {
throw new Error(`Loading block can only have one "after" parameter`);
}
const parsedTime =
parseDeferredTime(param.expression.slice(getTriggerParametersStart(param.expression)));
@ -146,6 +154,10 @@ function parseLoadingBlock(ast: html.Block, visitor: html.Visitor): t.DeferredBl
afterTime = parsedTime;
} else if (MINIMUM_PARAMETER_PATTERN.test(param.expression)) {
if (minimumTime != null) {
throw new Error(`Loading block can only have one "minimum" parameter`);
}
const parsedTime =
parseDeferredTime(param.expression.slice(getTriggerParametersStart(param.expression)));

View file

@ -51,7 +51,7 @@ export function parseWhenTrigger(
const start = getTriggerParametersStart(expression, whenIndex + 1);
const parsed = bindingParser.parseBinding(
expression.slice(start), false, sourceSpan, sourceSpan.start.offset + start);
trackTrigger('when', triggers, new t.BoundDeferredTrigger(parsed, sourceSpan));
trackTrigger('when', triggers, errors, new t.BoundDeferredTrigger(parsed, sourceSpan));
}
}
@ -243,7 +243,7 @@ class OnTriggerParser {
}
private trackTrigger(name: keyof t.DeferredBlockTriggers, trigger: t.DeferredTrigger): void {
trackTrigger(name, this.triggers, trigger);
trackTrigger(name, this.triggers, this.errors, trigger);
}
private error(token: Token, message: string): void {
@ -259,9 +259,13 @@ class OnTriggerParser {
/** Adds a trigger to a map of triggers. */
function trackTrigger(
name: keyof t.DeferredBlockTriggers, allTriggers: t.DeferredBlockTriggers,
name: keyof t.DeferredBlockTriggers, allTriggers: t.DeferredBlockTriggers, errors: ParseError[],
trigger: t.DeferredTrigger) {
allTriggers[name] = trigger as any;
if (allTriggers[name]) {
errors.push(new ParseError(trigger.sourceSpan, `Duplicate "${name}" trigger is not allowed`));
} else {
allTriggers[name] = trigger as any;
}
}
function createIdleTrigger(

View file

@ -1096,6 +1096,44 @@ describe('R3 template transform', () => {
expectDeferredError('{#defer on viewport(a, b)}hello{/defer}')
.toThrowError(/"viewport" trigger can only have zero or one parameters/);
});
it('should report duplicate when triggers', () => {
expectDeferredError('{#defer when isVisible(); when somethingElse()}hello{/defer}')
.toThrowError(/Duplicate "when" trigger is not allowed/);
});
it('should report duplicate on triggers', () => {
expectDeferredError('{#defer on idle; when isVisible(); on timer(10), idle}hello{/defer}')
.toThrowError(/Duplicate "idle" trigger is not allowed/);
});
it('should report duplicate prefetch when triggers', () => {
expectDeferredError(
'{#defer prefetch when isVisible(); prefetch when somethingElse()}hello{/defer}')
.toThrowError(/Duplicate "when" trigger is not allowed/);
});
it('should report duplicate prefetch on triggers', () => {
expectDeferredError(
'{#defer prefetch on idle; prefetch when isVisible(); prefetch on timer(10), idle}hello{/defer}')
.toThrowError(/Duplicate "idle" trigger is not allowed/);
});
it('should report multiple minimum parameters on a placeholder block', () => {
expectDeferredError(
'{#defer}hello{:placeholder minimum 1s; minimum 500ms}placeholder{/defer}')
.toThrowError(/Placeholder block can only have one "minimum" parameter/);
});
it('should report multiple minimum parameters on a loading block', () => {
expectDeferredError('{#defer}hello{:loading minimum 1s; minimum 500ms}loading{/defer}')
.toThrowError(/Loading block can only have one "minimum" parameter/);
});
it('should report multiple after parameters on a loading block', () => {
expectDeferredError('{#defer}hello{:loading after 1s; after 500ms}loading{/defer}')
.toThrowError(/Loading block can only have one "after" parameter/);
});
});
});
});