Parser throws on tuple `@type` tags and `= {}` initializers, and silently drops unresolvable types
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 68/100
- Tipo di issue
- Bug
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- typescript
- Ambito
- tooling
Direzione di ricerca
Inizia in src/parsers/script-parser.ts, in extractAttributes(), raggiunto tramite parseAttributes(), e riproduci i tre snippet con i tipi playcanvas caricati come descritto in test/utils.ts. Segui i percorsi ParsingError adiacenti e aggiungi una copertura di regressione per i tipi tupla, gli inizializzatori di oggetti vuoti e i riferimenti @type non risolti. Il lavoro è completato quando questi casi non causano più un’interruzione né scompaiono silenziosamente e gli attributi validi continuano a essere analizzati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Found while investigating a forum report about the Interface Attribute Arrays docs example (docs fix: playcanvas/developer-site#1200). Interface arrays themselves work correctly — these are three separate robustness problems I hit while narrowing it down.
All three reproduce on main (fa36853, v1.11.0) through parseAttributes(), with the playcanvas types loaded as in test/utils.ts. Each snippet below is a complete script file.
1. TypeError when @type is a tuple
import { Script } from 'playcanvas';
class GameLogic extends Script {
static scriptName = 'gameLogic';
/**
* @attribute
* @type {[number]}
*/
values;
}
export { GameLogic };
TypeError: Cannot read properties of undefined (reading 'declarations')
at ScriptParser.extractAttributes
at JSDocParser.parseAttributes
src/parsers/script-parser.ts:497-498:
const symbol = type.aliasSymbol || type.symbol;
const typeNode = (symbol?.valueDeclaration || symbol.declarations?.[0]) as InternalNode;
A tuple type has no symbol, so symbol?.valueDeclaration is undefined and the second term dereferences undefined. symbol?.declarations?.[0] would fall through to the if (!typeNode) continue guard on the next line. Same for @type {[number, number]}.
2. TypeError when an attribute is initialized with an empty object literal
import { Script } from 'playcanvas';
class GameLogic extends Script {
static scriptName = 'gameLogic';
/**
* @attribute
*/
data = {};
}
export { GameLogic };
TypeError: undefined is not iterable (cannot read property Symbol(Symbol.iterator))
at Array.from (<anonymous>)
at ScriptParser.extractAttributes
at JSDocParser.parseAttributes
src/parsers/script-parser.ts:553-560:
const members: readonly ts.Node[] =
typeNode.members ??
typeNode.properties ??
Array.from(type.symbol.members as unknown as Iterable<[string, ts.Symbol]>).map(
(entry) => entry[1].declarations[0]
) ??
[];
For = {} both typeNode.members and typeNode.properties are nullish and type.symbol.members is undefined, so Array.from throws. Note the trailing ?? [] can never catch this, since the throw happens while evaluating the operand. data = { x: 1 } is fine — only the empty literal hits it.
This also fires for a member of an /** @interface */ class, e.g. data = {}; inside class Enemy.
Why 1 and 2 matter
Both throw out of extractAttributes, so the consumer gets no attributes and no diagnostics for the whole file instead of one error on the offending member. A half-written type annotation is a normal intermediate state while typing in the Editor's code editor, so these are easy to hit. Reporting a ParsingError for the member (as the neighbouring paths do) would keep the rest of the script parsing.
3. An unresolvable @type is dropped silently
import { Script } from 'playcanvas';
class GameLogic extends Script {
static scriptName = 'gameLogic';
/**
* @attribute
* @type {Enemy[]}
*/
enemies;
}
export { GameLogic };
With Enemy undefined (not declared, not imported, or a typo), parseAttributes() returns no attribute and no error; getAttributes() doesn't list the member either. Non-array @type {Enemy} behaves the same, as does @type {{}}.
The type resolves to TypeScript's error type, which has no symbol, so the if (!typeNode) continue at src/parsers/script-parser.ts:500 skips the member before any of the reporting paths below it run. An error type is detectable and could be reported with the existing "…" is not a valid attribute type message.
This is the one that makes a typo'd or missing Interface import hard to diagnose: the attribute just never appears in the Editor, with nothing in the editor's problem list to explain why.
- Lingua principale
- TypeScript
- Stelle
- 1
- Fork
- 2
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di playcanvas/attribute-parser
-
Dependency DashboardAperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 15/100
Tutte le issue di playcanvas/attribute-parser
Issue simili
-
Contrib indemnité de départ à la retraite : faire le pont avec le simulateur sur la page génériqueApertaP1
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
SocialGouv/code-du-travail-numerique#7561 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
kubernetes-sigs/headlamp#7950 ·
I maintainer di solito rispondono entro 3 giorni
-
README for cliForse già presa @Janvi-kapoor l’ha presa oggi. ApertaOSCI'26
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
GauravKarakoti/SecureFlow#1308 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
I maintainer di solito rispondono entro 1 giorno
-
documentation
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
vitest-dev/vitest#11577 ·
I maintainer di solito rispondono entro 1 giorno