Do not report multiple diagnostics per signature.

sandersn · sandersn · commit 0436cfca16f5 · 2019-06-26T12:56:14.000-07:00
If there are multiple diagnostics per signature, choose the signature
with the fewer diagnostics to report. If there are more than one with
the minimum, choose the latest in the overload set.
diff --git a/src/compiler/checker.ts b/src/compiler/checker.ts
@@ -21632,19 +21632,29 @@ namespace ts {
                         }
                     }
                     else {
-                        const related: DiagnosticRelatedInformation[] = [];
+                        const allDiagnostics: DiagnosticRelatedInformation[][] = [];
+                        let max = 0;
+                        let min = Number.MAX_VALUE;
+                        let minIndex = 0;
                         let i = 0;
                         for (const c of candidatesForArgumentError) {
-                            i++;
-                            const chain = () => chainDiagnosticMessages(/*details*/ undefined, Diagnostics.Overload_0_of_1_2_gave_the_following_error, i, candidates.length, signatureToString(c));
+                            const chain = () => chainDiagnosticMessages(/*details*/ undefined, Diagnostics.Overload_0_of_1_2_gave_the_following_error, i + 1, candidates.length, signatureToString(c));
                             const diags = getSignatureApplicabilityError(node, args, c, assignableRelation, CheckMode.Normal, /*reportErrors*/ true, chain);
                             if (diags) {
-                                related.push(...diags);
+                                if (diags.length <= min) {
+                                    min = diags.length;
+                                    minIndex = i;
+                                }
+                                max = Math.max(max, diags.length);
+                                allDiagnostics.push(diags);
                             }
                             else {
                                 Debug.fail("No error for 3 or fewer overload signatures");
                             }
+                            i++;
                         }
+
+                        const related = max > 1 ? allDiagnostics[minIndex] : flatten(allDiagnostics);
                         diagnostics.add(createDiagnosticForNodeFromMessageChain(node, chainDiagnosticMessages(/*details*/ undefined, Diagnostics.No_overload_matches_this_call), related));
                     }
                 }
diff --git a/src/compiler/core.ts b/src/compiler/core.ts
@@ -600,6 +600,7 @@ namespace ts {
      *
      * @param array The array to flatten.
      */
+    export function flatten<T>(array: T[][]): T[];
     export function flatten<T>(array: ReadonlyArray<T | ReadonlyArray<T> | undefined>): T[];
     export function flatten<T>(array: ReadonlyArray<T | ReadonlyArray<T> | undefined> | undefined): T[] | undefined;
     export function flatten<T>(array: ReadonlyArray<T | ReadonlyArray<T> | undefined> | undefined): T[] | undefined {
diff --git a/src/compiler/diagnosticMessages.json b/src/compiler/diagnosticMessages.json
@@ -2625,14 +2625,6 @@
         "category": "Error",
         "code": 2755
     },
-    "The closest overload gave the following error.": {
-        "category": "Error",
-        "code": 2756
-    },
-    "The closest overload is declared here.": {
-        "category": "Error",
-        "code": 2757
-    },
     "The last overload gave the following error.": {
         "category": "Error",
         "code": 2758
diff --git a/src/compiler/utilities.ts b/src/compiler/utilities.ts
@@ -8092,7 +8092,7 @@ namespace ts {
             visitDirectory(basePath, combinePaths(currentDirectory, basePath), depth);
         }
 
-        return flatten<string>(results);
+        return flatten(results);
 
         function visitDirectory(path: string, absolutePath: string, depth: number | undefined) {
             const canonicalPath = toCanonical(realpath(absolutePath));
diff --git a/tests/baselines/reference/heterogeneousArrayAndOverloads.errors.txt b/tests/baselines/reference/heterogeneousArrayAndOverloads.errors.txt
@@ -15,11 +15,5 @@ tests/cases/compiler/heterogeneousArrayAndOverloads.ts(9,9): error TS2755: No ov
 !!! error TS2755: No overload matches this call.
 !!! related TS2760 tests/cases/compiler/heterogeneousArrayAndOverloads.ts:9:26: Overload 1 of 2, '(arg1: number[]): any', gave the following error.
   Type 'string' is not assignable to type 'number'.
-!!! related TS2760 tests/cases/compiler/heterogeneousArrayAndOverloads.ts:9:20: Overload 2 of 2, '(arg1: string[]): any', gave the following error.
-  Type 'number' is not assignable to type 'string'.
-!!! related TS2760 tests/cases/compiler/heterogeneousArrayAndOverloads.ts:9:23: Overload 2 of 2, '(arg1: string[]): any', gave the following error.
-  Type 'number' is not assignable to type 'string'.
-!!! related TS2760 tests/cases/compiler/heterogeneousArrayAndOverloads.ts:9:32: Overload 2 of 2, '(arg1: string[]): any', gave the following error.
-  Type 'number' is not assignable to type 'string'.
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -21632,19 +21632,29 @@ namespace ts {`
`21632`	`21632`	`}`
`21633`	`21633`	`}`
`21634`	`21634`	`else {`
`21635`		`- const related: DiagnosticRelatedInformation[] = [];`
	`21635`	`+ const allDiagnostics: DiagnosticRelatedInformation[][] = [];`
	`21636`	`+ let max = 0;`
	`21637`	`+ let min = Number.MAX_VALUE;`
	`21638`	`+ let minIndex = 0;`
`21636`	`21639`	`let i = 0;`
`21637`	`21640`	`for (const c of candidatesForArgumentError) {`
`21638`		`- i++;`
`21639`		`- const chain = () => chainDiagnosticMessages(/details/ undefined, Diagnostics.Overload_0_of_1_2_gave_the_following_error, i, candidates.length, signatureToString(c));`
	`21641`	`+ const chain = () => chainDiagnosticMessages(/details/ undefined, Diagnostics.Overload_0_of_1_2_gave_the_following_error, i + 1, candidates.length, signatureToString(c));`
`21640`	`21642`	`const diags = getSignatureApplicabilityError(node, args, c, assignableRelation, CheckMode.Normal, /reportErrors/ true, chain);`
`21641`	`21643`	`if (diags) {`
`21642`		`- related.push(...diags);`
	`21644`	`+ if (diags.length <= min) {`
	`21645`	`+ min = diags.length;`
	`21646`	`+ minIndex = i;`
	`21647`	`+ }`
	`21648`	`+ max = Math.max(max, diags.length);`
	`21649`	`+ allDiagnostics.push(diags);`
`21643`	`21650`	`}`
`21644`	`21651`	`else {`
`21645`	`21652`	`Debug.fail("No error for 3 or fewer overload signatures");`
`21646`	`21653`	`}`
	`21654`	`+ i++;`
`21647`	`21655`	`}`
	`21656`	`+`
	`21657`	`+ const related = max > 1 ? allDiagnostics[minIndex] : flatten(allDiagnostics);`
`21648`	`21658`	`diagnostics.add(createDiagnosticForNodeFromMessageChain(node, chainDiagnosticMessages(/details/ undefined, Diagnostics.No_overload_matches_this_call), related));`
`21649`	`21659`	`}`
`21650`	`21660`	`}`
Original file line number	Diff line number	Diff line change
`@@ -600,6 +600,7 @@ namespace ts {`
`600`	`600`	`*`
`601`	`601`	`* @param array The array to flatten.`
`602`	`602`	`*/`
	`603`	`+ export function flatten<T>(array: T[][]): T[];`
`603`	`604`	`export function flatten<T>(array: ReadonlyArray<T \| ReadonlyArray<T> \| undefined>): T[];`
`604`	`605`	`export function flatten<T>(array: ReadonlyArray<T \| ReadonlyArray<T> \| undefined> \| undefined): T[] \| undefined;`
`605`	`606`	`export function flatten<T>(array: ReadonlyArray<T \| ReadonlyArray<T> \| undefined> \| undefined): T[] \| undefined {`
Original file line number	Diff line number	Diff line change
`@@ -8092,7 +8092,7 @@ namespace ts {`
`8092`	`8092`	`visitDirectory(basePath, combinePaths(currentDirectory, basePath), depth);`
`8093`	`8093`	`}`
`8094`	`8094`
`8095`		`- return flatten<string>(results);`
	`8095`	`+ return flatten(results);`
`8096`	`8096`
`8097`	`8097`	`function visitDirectory(path: string, absolutePath: string, depth: number \| undefined) {`
`8098`	`8098`	`const canonicalPath = toCanonical(realpath(absolutePath));`
Original file line number	Diff line number	Diff line change
`@@ -15,11 +15,5 @@ tests/cases/compiler/heterogeneousArrayAndOverloads.ts(9,9): error TS2755: No ov`
`15`	`15`	`!!! error TS2755: No overload matches this call.`
`16`	`16`	`!!! related TS2760 tests/cases/compiler/heterogeneousArrayAndOverloads.ts:9:26: Overload 1 of 2, '(arg1: number[]): any', gave the following error.`
`17`	`17`	`Type 'string' is not assignable to type 'number'.`
`18`		`-!!! related TS2760 tests/cases/compiler/heterogeneousArrayAndOverloads.ts:9:20: Overload 2 of 2, '(arg1: string[]): any', gave the following error.`
`19`		`- Type 'number' is not assignable to type 'string'.`
`20`		`-!!! related TS2760 tests/cases/compiler/heterogeneousArrayAndOverloads.ts:9:23: Overload 2 of 2, '(arg1: string[]): any', gave the following error.`
`21`		`- Type 'number' is not assignable to type 'string'.`
`22`		`-!!! related TS2760 tests/cases/compiler/heterogeneousArrayAndOverloads.ts:9:32: Overload 2 of 2, '(arg1: string[]): any', gave the following error.`
`23`		`- Type 'number' is not assignable to type 'string'.`
`24`	`18`	`}`
`25`	`19`	`}`