Add assertions for bad symbol declaration (microsoft#21837)

Andy · web-flow · commit 171b68c9e75e · 2018-02-09T14:08:56.000-08:00
* Add assertions for bad symbol declaration

* Fix lint
diff --git a/src/compiler/checker.ts b/src/compiler/checker.ts
@@ -4406,7 +4406,7 @@ namespace ts {
                     type = getWidenedTypeForVariableLikeDeclaration(declaration, /*reportErrors*/ true);
                 }
                 else {
-                    Debug.fail("Unhandled declaration kind! " + (ts as any).SyntaxKind[declaration.kind]);
+                    Debug.fail("Unhandled declaration kind! " + Debug.showSyntaxKind(declaration));
                 }
 
                 if (!popTypeResolution()) {
@@ -20682,7 +20682,7 @@ namespace ts {
                     case SyntaxKind.ImportSpecifier: // https://github.com/Microsoft/TypeScript/pull/7591
                         return DeclarationSpaces.ExportValue;
                     default:
-                        Debug.fail((ts as any).SyntaxKind[d.kind]);
+                        Debug.fail(Debug.showSyntaxKind(d));
                 }
             }
         }
diff --git a/src/compiler/core.ts b/src/compiler/core.ts
@@ -1466,7 +1466,7 @@ namespace ts {
         if (value !== undefined && test(value)) return value;
 
         if (value && typeof (value as any).kind === "number") {
-            Debug.fail(`Invalid cast. The supplied ${(ts as any).SyntaxKind[(value as any).kind]} did not pass the test '${Debug.getFunctionName(test)}'.`);
+            Debug.fail(`Invalid cast. The supplied ${Debug.showSyntaxKind(value as any as Node)} did not pass the test '${Debug.getFunctionName(test)}'.`);
         }
         else {
             Debug.fail(`Invalid cast. The supplied value did not pass the test '${Debug.getFunctionName(test)}'.`);
@@ -2925,6 +2925,25 @@ namespace ts {
                 return match ? match[1] : "";
             }
         }
+
+        export function showSymbol(symbol: Symbol): string {
+            return `{ flags: ${showFlags(symbol.flags, (ts as any).SymbolFlags)}; declarations: ${map(symbol.declarations, showSyntaxKind)} }`;
+        }
+
+        function showFlags(flags: number, flagsEnum: { [flag: number]: string }): string {
+            const out = [];
+            for (let pow = 0; pow <= 30; pow++) {
+                const n = 1 << pow;
+                if (flags & n) {
+                    out.push(flagsEnum[n]);
+                }
+            }
+            return out.join("|");
+        }
+
+        export function showSyntaxKind(node: Node): string {
+            return (ts as any).SyntaxKind[node.kind];
+        }
     }
 
     /** Remove an item from an array, moving everything to its right one space left. */
diff --git a/src/services/findAllReferences.ts b/src/services/findAllReferences.ts
@@ -416,10 +416,16 @@ namespace ts.FindAllReferences.Core {
         }
 
         // If the symbol is declared as part of a declaration like `{ type: "a" } | { type: "b" }`, use the property on the union type to get more references.
-        return firstDefined(symbol.declarations, decl =>
-            isTypeLiteralNode(decl.parent) && isUnionTypeNode(decl.parent.parent)
+        return firstDefined(symbol.declarations, decl => {
+            if (!decl.parent) {
+                // Assertions for GH#21814. We should be handling SourceFile symbols in `getReferencedSymbolsForModule` instead of getting here.
+                Debug.assert(decl.kind === SyntaxKind.SourceFile);
+                Debug.fail(`Unexpected symbol at ${Debug.showSyntaxKind(node)}: ${Debug.showSymbol(symbol)}`);
+            }
+            return isTypeLiteralNode(decl.parent) && isUnionTypeNode(decl.parent.parent)
                 ? checker.getPropertyOfType(checker.getTypeFromTypeNode(decl.parent.parent), symbol.name)
-                : undefined) || symbol;
+                : undefined;
+        }) || symbol;
     }
 
     /**
diff --git a/src/services/importTracker.ts b/src/services/importTracker.ts
@@ -517,29 +517,12 @@ namespace ts.FindAllReferences {
                 const sym = useLhsSymbol ? checker.getSymbolAtLocation(cast(node.left, isPropertyAccessExpression).name) : symbol;
                 // Better detection for GH#20803
                 if (sym && !(checker.getMergedSymbol(sym.parent).flags & SymbolFlags.Module)) {
-                    Debug.fail(`Special property assignment kind does not have a module as its parent. Assignment is ${showSymbol(sym)}, parent is ${showSymbol(sym.parent)}`);
+                    Debug.fail(`Special property assignment kind does not have a module as its parent. Assignment is ${Debug.showSymbol(sym)}, parent is ${Debug.showSymbol(sym.parent)}`);
                 }
                 return sym && exportInfo(sym, kind);
             }
         }
 
-        function showSymbol(s: Symbol): string {
-            const decls = s.declarations.map(d => (ts as any).SyntaxKind[d.kind]).join(",");
-            const flags = showFlags(s.flags, (ts as any).SymbolFlags);
-            return `{ declarations: ${decls}, flags: ${flags} }`;
-        }
-
-        function showFlags(f: number, flags: any) {
-            const out = [];
-            for (let pow = 0; pow <= 30; pow++) {
-                const n = 1 << pow;
-                if (f & n) {
-                    out.push(flags[n]);
-                }
-            }
-            return out.join("|");
-        }
-
         function getImport(): ImportedSymbol | undefined {
             const isImport = isNodeImport(node);
             if (!isImport) return undefined;

Original file line number	Diff line number	Diff line change
`@@ -4406,7 +4406,7 @@ namespace ts {`
`4406`	`4406`	`type = getWidenedTypeForVariableLikeDeclaration(declaration, /reportErrors/ true);`
`4407`	`4407`	`}`
`4408`	`4408`	`else {`
`4409`		`- Debug.fail("Unhandled declaration kind! " + (ts as any).SyntaxKind[declaration.kind]);`
	`4409`	`+ Debug.fail("Unhandled declaration kind! " + Debug.showSyntaxKind(declaration));`
`4410`	`4410`	`}`
`4411`	`4411`
`4412`	`4412`	`if (!popTypeResolution()) {`
`@@ -20682,7 +20682,7 @@ namespace ts {`
`20682`	`20682`	`case SyntaxKind.ImportSpecifier: // https://github.com/Microsoft/TypeScript/pull/7591`
`20683`	`20683`	`return DeclarationSpaces.ExportValue;`
`20684`	`20684`	`default:`
`20685`		`- Debug.fail((ts as any).SyntaxKind[d.kind]);`
	`20685`	`+ Debug.fail(Debug.showSyntaxKind(d));`
`20686`	`20686`	`}`
`20687`	`20687`	`}`
`20688`	`20688`	`}`