Fixes binding well known symbol assignment via element access (#33687)

andrewbranch · weswigham · commit 7be7cba05079 · 2019-09-30T16:14:07.000-07:00
* Fix binding well-known symbols by element access

* Add navigationBar test

* Revert settings.json change

* Accept baselines

* Actually make it bind

* Accept API baselines

* Dont use internal name in API
diff --git a/src/compiler/binder.ts b/src/compiler/binder.ts
@@ -344,6 +344,9 @@ namespace ts {
                     Debug.assert(isWellKnownSymbolSyntactically(nameExpression));
                     return getPropertyNameForKnownSymbolName(idText((<PropertyAccessExpression>nameExpression).name));
                 }
+                if (isWellKnownSymbolSyntactically(name)) {
+                    return getPropertyNameForKnownSymbolName(idText(name.name));
+                }
                 return isPropertyNameLiteral(name) ? getEscapedTextOfIdentifierOrLiteral(name) : undefined;
             }
             switch (node.kind) {
diff --git a/src/compiler/types.ts b/src/compiler/types.ts
@@ -820,7 +820,14 @@ namespace ts {
 
     export type PropertyName = Identifier | StringLiteral | NumericLiteral | ComputedPropertyName;
 
-    export type DeclarationName = Identifier | StringLiteralLike | NumericLiteral | ComputedPropertyName | ElementAccessExpression | BindingPattern;
+    export type DeclarationName =
+        | Identifier
+        | StringLiteralLike
+        | NumericLiteral
+        | ComputedPropertyName
+        | ElementAccessExpression
+        | BindingPattern
+        | EntityNameExpression;
 
     export interface Declaration extends Node {
         _declarationBrand: any;
@@ -1886,13 +1893,17 @@ namespace ts {
         | CallChainRoot
         ;
 
+    /** @internal */
+    export interface WellKnownSymbolExpression extends PropertyAccessExpression {
+        expression: Identifier & { escapedText: "Symbol" };
+    }
     /** @internal */
     export type BindableObjectDefinePropertyCall = CallExpression & { arguments: { 0: BindableStaticNameExpression, 1: StringLiteralLike | NumericLiteral, 2: ObjectLiteralExpression } };
     /** @internal */
     export type BindableStaticNameExpression = EntityNameExpression | BindableStaticElementAccessExpression;
     /** @internal */
     export type LiteralLikeElementAccessExpression = ElementAccessExpression & Declaration & {
-        argumentExpression: StringLiteralLike | NumericLiteral;
+        argumentExpression: StringLiteralLike | NumericLiteral | WellKnownSymbolExpression;
     };
     /** @internal */
     export type BindableStaticElementAccessExpression = LiteralLikeElementAccessExpression & {
diff --git a/src/compiler/utilities.ts b/src/compiler/utilities.ts
@@ -2075,7 +2075,9 @@ namespace ts {
     }
 
     export function isLiteralLikeElementAccess(node: Node): node is LiteralLikeElementAccessExpression {
-        return isElementAccessExpression(node) && isStringOrNumericLiteralLike(node.argumentExpression);
+        return isElementAccessExpression(node) && (
+            isStringOrNumericLiteralLike(node.argumentExpression) ||
+            isWellKnownSymbolSyntactically(node.argumentExpression));
     }
 
     export function isBindableStaticAccessExpression(node: Node, excludeThisKeyword?: boolean): node is BindableStaticAccessExpression {
@@ -2908,7 +2910,7 @@ namespace ts {
      *    Symbol.name
      * where Symbol is literally the word "Symbol", and name is any identifierName
      */
-    export function isWellKnownSymbolSyntactically(node: Expression): boolean {
+    export function isWellKnownSymbolSyntactically(node: Node): node is WellKnownSymbolExpression {
         return isPropertyAccessExpression(node) && isESSymbolIdentifier(node.expression);
     }
 
diff --git a/src/services/navigationBar.ts b/src/services/navigationBar.ts
@@ -136,7 +136,7 @@ namespace ts.NavigationBar {
         for (let i = 0; i < depth; i++) endNode();
     }
     function startNestedNodes(targetNode: Node, entityName: BindableStaticNameExpression) {
-        const names: PropertyNameLiteral[] = [];
+        const names: (PropertyNameLiteral | WellKnownSymbolExpression)[] = [];
         while (!isPropertyNameLiteral(entityName)) {
             const name = getNameOrArgument(entityName);
             const nameText = getElementOrPropertyAccessName(entityName);
@@ -334,7 +334,7 @@ namespace ts.NavigationBar {
                             assignmentTarget;
 
                         let depth = 0;
-                        let className: PropertyNameLiteral;
+                        let className: PropertyNameLiteral | WellKnownSymbolExpression;
                         // If we see a prototype assignment, start tracking the target as a class
                         // This is only done for simple classes not nested assignments.
                         if (isIdentifier(prototypeAccess.expression)) {
diff --git a/tests/baselines/reference/api/tsserverlibrary.d.ts b/tests/baselines/reference/api/tsserverlibrary.d.ts
@@ -549,7 +549,7 @@ declare namespace ts {
     }
     export type EntityName = Identifier | QualifiedName;
     export type PropertyName = Identifier | StringLiteral | NumericLiteral | ComputedPropertyName;
-    export type DeclarationName = Identifier | StringLiteralLike | NumericLiteral | ComputedPropertyName | ElementAccessExpression | BindingPattern;
+    export type DeclarationName = Identifier | StringLiteralLike | NumericLiteral | ComputedPropertyName | ElementAccessExpression | BindingPattern | EntityNameExpression;
     export interface Declaration extends Node {
         _declarationBrand: any;
     }
diff --git a/tests/baselines/reference/api/typescript.d.ts b/tests/baselines/reference/api/typescript.d.ts
@@ -549,7 +549,7 @@ declare namespace ts {
     }
     export type EntityName = Identifier | QualifiedName;
     export type PropertyName = Identifier | StringLiteral | NumericLiteral | ComputedPropertyName;
-    export type DeclarationName = Identifier | StringLiteralLike | NumericLiteral | ComputedPropertyName | ElementAccessExpression | BindingPattern;
+    export type DeclarationName = Identifier | StringLiteralLike | NumericLiteral | ComputedPropertyName | ElementAccessExpression | BindingPattern | EntityNameExpression;
     export interface Declaration extends Node {
         _declarationBrand: any;
     }
diff --git a/tests/baselines/reference/wellKnownSymbolExpando.symbols b/tests/baselines/reference/wellKnownSymbolExpando.symbols
@@ -0,0 +1,10 @@
+=== tests/cases/compiler/wellKnownSymbolExpando.ts ===
+function f() {}
+>f : Symbol(f, Decl(wellKnownSymbolExpando.ts, 0, 0), Decl(wellKnownSymbolExpando.ts, 0, 15))
+
+f[Symbol.iterator] = function() {}
+>f : Symbol(f, Decl(wellKnownSymbolExpando.ts, 0, 0), Decl(wellKnownSymbolExpando.ts, 0, 15))
+>Symbol.iterator : Symbol(SymbolConstructor.iterator, Decl(lib.es2015.iterable.d.ts, --, --))
+>Symbol : Symbol(Symbol, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.symbol.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --), Decl(lib.es2019.symbol.d.ts, --, --))
+>iterator : Symbol(SymbolConstructor.iterator, Decl(lib.es2015.iterable.d.ts, --, --))
+
diff --git a/tests/baselines/reference/wellKnownSymbolExpando.types b/tests/baselines/reference/wellKnownSymbolExpando.types
@@ -0,0 +1,13 @@
+=== tests/cases/compiler/wellKnownSymbolExpando.ts ===
+function f() {}
+>f : typeof f
+
+f[Symbol.iterator] = function() {}
+>f[Symbol.iterator] = function() {} : () => void
+>f[Symbol.iterator] : () => void
+>f : typeof f
+>Symbol.iterator : symbol
+>Symbol : SymbolConstructor
+>iterator : symbol
+>function() {} : () => void
+
diff --git a/tests/cases/compiler/wellKnownSymbolExpando.ts b/tests/cases/compiler/wellKnownSymbolExpando.ts
@@ -0,0 +1,5 @@
+// @noEmit: true
+// @target: esnext
+
+function f() {}
+f[Symbol.iterator] = function() {}
diff --git a/tests/cases/fourslash/navigationBarWellKnownSymbolExpando.ts b/tests/cases/fourslash/navigationBarWellKnownSymbolExpando.ts
@@ -0,0 +1,53 @@
+/// <reference path="fourslash.ts"/>
+
+////function f() {}
+////f[Symbol.iterator] = function() {}
+
+verify.navigationTree({
+  "text": "<global>",
+  "kind": "script",
+  "childItems": [
+    {
+      "text": "f",
+      "kind": "class",
+      "childItems": [
+        {
+          "text": "constructor",
+          "kind": "constructor"
+        },
+        {
+          "text": "[Symbol.iterator]",
+          "kind": "function"
+        }
+      ]
+    }
+  ]
+});
+
+verify.navigationBar([
+  {
+    "text": "<global>",
+    "kind": "script",
+    "childItems": [
+      {
+        "text": "f",
+        "kind": "class"
+      }
+    ]
+  },
+  {
+    "text": "f",
+    "kind": "class",
+    "childItems": [
+      {
+        "text": "constructor",
+        "kind": "constructor"
+      },
+      {
+        "text": "[Symbol.iterator]",
+        "kind": "function"
+      }
+    ],
+    "indent": 1
+  }
+]);

Original file line number	Diff line number	Diff line change
`@@ -344,6 +344,9 @@ namespace ts {`
`344`	`344`	`Debug.assert(isWellKnownSymbolSyntactically(nameExpression));`
`345`	`345`	`return getPropertyNameForKnownSymbolName(idText((<PropertyAccessExpression>nameExpression).name));`
`346`	`346`	`}`
	`347`	`+ if (isWellKnownSymbolSyntactically(name)) {`
	`348`	`+ return getPropertyNameForKnownSymbolName(idText(name.name));`
	`349`	`+ }`
`347`	`350`	`return isPropertyNameLiteral(name) ? getEscapedTextOfIdentifierOrLiteral(name) : undefined;`
`348`	`351`	`}`
`349`	`352`	`switch (node.kind) {`
Original file line number	Diff line number	Diff line change
`@@ -2075,7 +2075,9 @@ namespace ts {`
`2075`	`2075`	`}`
`2076`	`2076`
`2077`	`2077`	`export function isLiteralLikeElementAccess(node: Node): node is LiteralLikeElementAccessExpression {`
`2078`		`- return isElementAccessExpression(node) && isStringOrNumericLiteralLike(node.argumentExpression);`
	`2078`	`+ return isElementAccessExpression(node) && (`
	`2079`	`+ isStringOrNumericLiteralLike(node.argumentExpression) \|\|`
	`2080`	`+ isWellKnownSymbolSyntactically(node.argumentExpression));`
`2079`	`2081`	`}`
`2080`	`2082`
`2081`	`2083`	`export function isBindableStaticAccessExpression(node: Node, excludeThisKeyword?: boolean): node is BindableStaticAccessExpression {`
`@@ -2908,7 +2910,7 @@ namespace ts {`
`2908`	`2910`	`* Symbol.name`
`2909`	`2911`	`* where Symbol is literally the word "Symbol", and name is any identifierName`
`2910`	`2912`	`*/`
`2911`		`- export function isWellKnownSymbolSyntactically(node: Expression): boolean {`
	`2913`	`+ export function isWellKnownSymbolSyntactically(node: Node): node is WellKnownSymbolExpression {`
`2912`	`2914`	`return isPropertyAccessExpression(node) && isESSymbolIdentifier(node.expression);`
`2913`	`2915`	`}`
`2914`	`2916`
Original file line number	Diff line number	Diff line change
`@@ -549,7 +549,7 @@ declare namespace ts {`
`549`	`549`	`}`
`550`	`550`	`export type EntityName = Identifier \| QualifiedName;`
`551`	`551`	`export type PropertyName = Identifier \| StringLiteral \| NumericLiteral \| ComputedPropertyName;`
`552`		`- export type DeclarationName = Identifier \| StringLiteralLike \| NumericLiteral \| ComputedPropertyName \| ElementAccessExpression \| BindingPattern;`
	`552`	`+ export type DeclarationName = Identifier \| StringLiteralLike \| NumericLiteral \| ComputedPropertyName \| ElementAccessExpression \| BindingPattern \| EntityNameExpression;`
`553`	`553`	`export interface Declaration extends Node {`
`554`	`554`	`_declarationBrand: any;`
`555`	`555`	`}`