From 59e4770a512038f795680383f4854f7d1e79b375 Mon Sep 17 00:00:00 2001 From: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com> Date: Mon, 17 Sep 2018 16:06:17 -0700 Subject: [PATCH] Fix enum tag circular references (#27161) * Fix enum tag circular references Also, don't try to resolve enum tag types in Typescript. * Improve comment --- src/compiler/checker.ts | 18 +++++++++++++++--- src/compiler/diagnosticMessages.json | 4 ++++ src/compiler/types.ts | 1 + .../enumTagCircularReference.errors.txt | 9 +++++++++ .../reference/enumTagCircularReference.symbols | 6 ++++++ .../reference/enumTagCircularReference.types | 8 ++++++++ .../jsdoc/enumTagCircularReference.ts | 7 +++++++ 7 files changed, 50 insertions(+), 3 deletions(-) create mode 100644 tests/baselines/reference/enumTagCircularReference.errors.txt create mode 100644 tests/baselines/reference/enumTagCircularReference.symbols create mode 100644 tests/baselines/reference/enumTagCircularReference.types create mode 100644 tests/cases/conformance/jsdoc/enumTagCircularReference.ts diff --git a/src/compiler/checker.ts b/src/compiler/checker.ts index 6d400b99e8a..8472be7b77c 100644 --- a/src/compiler/checker.ts +++ b/src/compiler/checker.ts @@ -640,7 +640,7 @@ namespace ts { const identityRelation = createMap(); const enumRelation = createMap(); - type TypeSystemEntity = Symbol | Type | Signature; + type TypeSystemEntity = Node | Symbol | Type | Signature; const enum TypeSystemPropertyName { Type, @@ -648,6 +648,7 @@ namespace ts { DeclaredType, ResolvedReturnType, ImmediateBaseConstraint, + EnumTagType, } const enum CheckMode { @@ -4475,6 +4476,8 @@ namespace ts { switch (propertyName) { case TypeSystemPropertyName.Type: return !!getSymbolLinks(target).type; + case TypeSystemPropertyName.EnumTagType: + return !!(getNodeLinks(target as JSDocEnumTag).resolvedEnumType); case TypeSystemPropertyName.DeclaredType: return !!getSymbolLinks(target).declaredType; case TypeSystemPropertyName.ResolvedBaseConstructorType: @@ -8252,9 +8255,18 @@ namespace ts { } // JS are 'string' or 'number', not an enum type. - const enumTag = symbol.valueDeclaration && getJSDocEnumTag(symbol.valueDeclaration); + const enumTag = isInJSFile(node) && symbol.valueDeclaration && getJSDocEnumTag(symbol.valueDeclaration); if (enumTag) { - return enumTag.typeExpression ? getTypeFromTypeNode(enumTag.typeExpression) : errorType; + const links = getNodeLinks(enumTag); + if (!pushTypeResolution(enumTag, TypeSystemPropertyName.EnumTagType)) { + return errorType; + } + let type = enumTag.typeExpression ? getTypeFromTypeNode(enumTag.typeExpression) : errorType; + if (!popTypeResolution()) { + type = errorType; + error(node, Diagnostics.Enum_type_0_circularly_references_itself, symbolToString(symbol)); + } + return (links.resolvedEnumType = type); } // Get type from reference to named type that cannot be generic (enum or type parameter) diff --git a/src/compiler/diagnosticMessages.json b/src/compiler/diagnosticMessages.json index 42c594c19b0..d083c475bc2 100644 --- a/src/compiler/diagnosticMessages.json +++ b/src/compiler/diagnosticMessages.json @@ -2112,6 +2112,10 @@ "category": "Error", "code": 2585 }, + "Enum type '{0}' circularly references itself.": { + "category": "Error", + "code": 2586 + }, "JSX element attributes type '{0}' may not be a union type.": { "category": "Error", "code": 2600 diff --git a/src/compiler/types.ts b/src/compiler/types.ts index 03a5d2b9ce7..df0396b172d 100644 --- a/src/compiler/types.ts +++ b/src/compiler/types.ts @@ -3676,6 +3676,7 @@ namespace ts { export interface NodeLinks { flags: NodeCheckFlags; // Set of flags specific to Node resolvedType?: Type; // Cached type of type node + resolvedEnumType?: Type; // Cached constraint type from enum jsdoc tag resolvedSignature?: Signature; // Cached signature of signature node or call expression resolvedSignatures?: Map; // Cached signatures of jsx node resolvedSymbol?: Symbol; // Cached name resolution result diff --git a/tests/baselines/reference/enumTagCircularReference.errors.txt b/tests/baselines/reference/enumTagCircularReference.errors.txt new file mode 100644 index 00000000000..f876b5a33da --- /dev/null +++ b/tests/baselines/reference/enumTagCircularReference.errors.txt @@ -0,0 +1,9 @@ +tests/cases/conformance/jsdoc/bug27142.js(1,12): error TS2586: Enum type 'E' circularly references itself. + + +==== tests/cases/conformance/jsdoc/bug27142.js (1 errors) ==== + /** @enum {E} */ + ~ +!!! error TS2586: Enum type 'E' circularly references itself. + const E = { x: 0 }; + \ No newline at end of file diff --git a/tests/baselines/reference/enumTagCircularReference.symbols b/tests/baselines/reference/enumTagCircularReference.symbols new file mode 100644 index 00000000000..e3c594ac9d1 --- /dev/null +++ b/tests/baselines/reference/enumTagCircularReference.symbols @@ -0,0 +1,6 @@ +=== tests/cases/conformance/jsdoc/bug27142.js === +/** @enum {E} */ +const E = { x: 0 }; +>E : Symbol(E, Decl(bug27142.js, 1, 5)) +>x : Symbol(x, Decl(bug27142.js, 1, 11)) + diff --git a/tests/baselines/reference/enumTagCircularReference.types b/tests/baselines/reference/enumTagCircularReference.types new file mode 100644 index 00000000000..32039379f5e --- /dev/null +++ b/tests/baselines/reference/enumTagCircularReference.types @@ -0,0 +1,8 @@ +=== tests/cases/conformance/jsdoc/bug27142.js === +/** @enum {E} */ +const E = { x: 0 }; +>E : { x: number; } +>{ x: 0 } : { x: number; } +>x : number +>0 : 0 + diff --git a/tests/cases/conformance/jsdoc/enumTagCircularReference.ts b/tests/cases/conformance/jsdoc/enumTagCircularReference.ts new file mode 100644 index 00000000000..c4015b70985 --- /dev/null +++ b/tests/cases/conformance/jsdoc/enumTagCircularReference.ts @@ -0,0 +1,7 @@ +// @noEmit: true +// @allowJs: true +// @checkJs: true +// @Filename: bug27142.js + +/** @enum {E} */ +const E = { x: 0 };