Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .chronus/changes/fix-sym-node-undefined-2026-5-6-18-23-0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
changeKind: fix
packages:
- "@typespec/compiler"
---

Fix `Sym.node` type to be `Node | undefined` and update `getSymNode` return type to accurately reflect that it may return `undefined` for symbols created without a node (e.g. the built-in `null` symbol). Update all callers to correctly handle the `undefined` case.
2 changes: 1 addition & 1 deletion packages/compiler/src/core/binder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -705,6 +705,6 @@ export function createSymbol(
* If a declaration symbol get the first one `.declarations[0]`
* Otherwise get `.node`
*/
export function getSymNode(sym: Sym): Node {
export function getSymNode(sym: Sym): Node | undefined {
return sym.flags & SymbolFlags.Declaration ? sym.declarations[0] : sym.node;
}
21 changes: 15 additions & 6 deletions packages/compiler/src/core/checker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -682,15 +682,19 @@ export function createChecker(program: Program, resolver: NameResolver): Checker
*/
function checkMemberSym(ctx: CheckContext, sym: Sym): Type {
const symbolLinks = getSymbolLinks(sym);
const memberContainer = getTypeForNode(getSymNode(sym.parent!), ctx);
const parentNode = getSymNode(sym.parent!);
compilerAssert(parentNode, "Expected member container parent symbol to have a node");
const memberContainer = getTypeForNode(parentNode, ctx);
const type = symbolLinks.declaredType ?? symbolLinks.type;

if (type) {
return type;
} else {
const memberNode = getSymNode(sym);
compilerAssert(memberNode, "Expected member symbol to have a node");
return checkMember(
ctx,
getSymNode(sym) as MemberNode,
memberNode as MemberNode,
memberContainer as MemberContainerType,
)!;
}
Expand Down Expand Up @@ -1737,6 +1741,7 @@ export function createChecker(program: Program, resolver: NameResolver): Checker
compilerAssert(sym.type, `Expected late bound symbol to have type`);
return sym.type;
} else if (sym.flags & SymbolFlags.TemplateParameter) {
compilerAssert(symNode, "Expected template parameter symbol to have a node");
const mapped = checkTemplateParameterDeclaration(
ctx,
symNode as TemplateParameterDeclarationNode,
Expand All @@ -1752,6 +1757,7 @@ export function createChecker(program: Program, resolver: NameResolver): Checker
baseType = checkMemberSym(ctx, sym);
} else {
// don't have a cached type for this symbol, so go grab it and cache it
compilerAssert(symNode, "Expected symbol to have a node to resolve type");
baseType = getTypeForNode(symNode, ctx);
symbolLinks.type = baseType;
}
Expand Down Expand Up @@ -3605,8 +3611,8 @@ export function createChecker(program: Program, resolver: NameResolver): Checker
return undefined;
}

function getMemberKindName(node: Node) {
switch (node.kind) {
function getMemberKindName(node: Node | undefined) {
switch (node?.kind) {
case SyntaxKind.ModelStatement:
case SyntaxKind.ModelExpression:
return "Model";
Expand All @@ -3631,6 +3637,7 @@ export function createChecker(program: Program, resolver: NameResolver): Checker
*/
function getAliasedSymbol(ctx: CheckContext, aliasSymbol: Sym): Sym | undefined {
const node = getSymNode(aliasSymbol);
compilerAssert(node, "Expected alias symbol to have a node");
const links = resolver.getSymbolLinks(aliasSymbol);
if (!links.aliasResolutionIsTemplate) {
return links.aliasedSymbol ?? resolver.getNodeLinks(node).resolvedSymbol;
Expand Down Expand Up @@ -6036,7 +6043,8 @@ export function createChecker(program: Program, resolver: NameResolver): Checker
}),
);
} else if (links.finalSymbol?.flags && links.finalSymbol.flags & SymbolFlags.Alias) {
const aliasNode: AliasStatementNode = getSymNode(links.finalSymbol) as AliasStatementNode;
const aliasNode = getSymNode(links.finalSymbol) as AliasStatementNode | undefined;
compilerAssert(aliasNode, "Expected alias symbol to have a node");

program.reportDiagnostic(
createDiagnostic({
Expand Down Expand Up @@ -7653,7 +7661,8 @@ function createFunctionContext(program: Program, fnCall: CallExpressionNode): Fu
};
}

function isTemplatedNode(node: Node): node is TemplateableNode {
function isTemplatedNode(node: Node | undefined): node is TemplateableNode {
if (node === undefined) return false;
return "templateParameters" in node && node.templateParameters.length > 0;
}

Expand Down
9 changes: 7 additions & 2 deletions packages/compiler/src/core/name-resolver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -715,6 +715,10 @@ export function createResolver(program: Program): NameResolver {
function resolveMetaMemberByName(baseSym: Sym, sv: string): ResolutionResult {
const baseNode = getSymNode(baseSym);

if (!baseNode) {
return failedResult(ResolutionResultFlags.NotFound);
}

const prototype = metaTypePrototypes.get(baseNode.kind);

if (!prototype) {
Expand Down Expand Up @@ -1322,8 +1326,9 @@ export function createResolver(program: Program): NameResolver {
// model properties
const modelPropertyPrototype: TypePrototype = new Map();
modelPropertyPrototype.set("type", (baseSym) => {
const node = baseSym.node as ModelPropertyNode;
return resolveExpression(node.value);
const node = getSymNode(baseSym);
compilerAssert(node, "Expected model property symbol to have a node");
return resolveExpression((node as ModelPropertyNode).value);
});
nodeInterfaces.set(SyntaxKind.ModelProperty, modelPropertyPrototype);

Expand Down
3 changes: 2 additions & 1 deletion packages/compiler/src/core/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -847,8 +847,9 @@ export interface Sym {

/**
* Node which resulted in this symbol, present if SymbolFlags.Declaration is not set.
* May be undefined if the symbol was created without a node (e.g. built-in symbols like `null`).
*/
readonly node: Node;
readonly node: Node | undefined;

/**
* The name of the symbol
Expand Down
Loading