From 563593b8be8aa20a1e631c2c9b52b7b4208b9e01 Mon Sep 17 00:00:00 2001 From: Wesley Wigham Date: Thu, 14 Mar 2019 17:10:42 -0700 Subject: [PATCH] Enable better error spans for async functions (#30413) --- src/compiler/checker.ts | 2 +- ...ctionReturnExpressionErrorSpans.errors.txt | 31 ++++++++ ...asyncFunctionReturnExpressionErrorSpans.js | 74 +++++++++++++++++++ ...FunctionReturnExpressionErrorSpans.symbols | 42 +++++++++++ ...ncFunctionReturnExpressionErrorSpans.types | 44 +++++++++++ ...asyncFunctionReturnExpressionErrorSpans.ts | 21 ++++++ 6 files changed, 213 insertions(+), 1 deletion(-) create mode 100644 tests/baselines/reference/asyncFunctionReturnExpressionErrorSpans.errors.txt create mode 100644 tests/baselines/reference/asyncFunctionReturnExpressionErrorSpans.js create mode 100644 tests/baselines/reference/asyncFunctionReturnExpressionErrorSpans.symbols create mode 100644 tests/baselines/reference/asyncFunctionReturnExpressionErrorSpans.types create mode 100644 tests/cases/compiler/asyncFunctionReturnExpressionErrorSpans.ts diff --git a/src/compiler/checker.ts b/src/compiler/checker.ts index 5d48697610..0b1e11db82 100644 --- a/src/compiler/checker.ts +++ b/src/compiler/checker.ts @@ -26911,7 +26911,7 @@ namespace ts { // If the function has a return type, but promisedType is // undefined, an error will be reported in checkAsyncFunctionReturnType // so we don't need to report one here. - checkTypeAssignableTo(awaitedType, promisedType, node); + checkTypeAssignableToAndOptionallyElaborate(awaitedType, promisedType, node, node.expression); } } else { diff --git a/tests/baselines/reference/asyncFunctionReturnExpressionErrorSpans.errors.txt b/tests/baselines/reference/asyncFunctionReturnExpressionErrorSpans.errors.txt new file mode 100644 index 0000000000..ed65a0d367 --- /dev/null +++ b/tests/baselines/reference/asyncFunctionReturnExpressionErrorSpans.errors.txt @@ -0,0 +1,31 @@ +tests/cases/compiler/asyncFunctionReturnExpressionErrorSpans.ts(11,28): error TS2705: An async function or method in ES5/ES3 requires the 'Promise' constructor. Make sure you have a declaration for the 'Promise' constructor or include 'ES2015' in your `--lib` option. +tests/cases/compiler/asyncFunctionReturnExpressionErrorSpans.ts(16,21): error TS2322: Type 'number' is not assignable to type 'string'. + + +==== tests/cases/compiler/asyncFunctionReturnExpressionErrorSpans.ts (2 errors) ==== + interface Foo { + bar: { + baz: { + inner: { + thing: string + } + } + } + } + + async function asyncFoo(): Promise { + ~~~~~~~~~~~~ +!!! error TS2705: An async function or method in ES5/ES3 requires the 'Promise' constructor. Make sure you have a declaration for the 'Promise' constructor or include 'ES2015' in your `--lib` option. + return { + bar: { + baz: { + inner: { + thing: 1 + ~~~~~ +!!! error TS2322: Type 'number' is not assignable to type 'string'. +!!! related TS6500 tests/cases/compiler/asyncFunctionReturnExpressionErrorSpans.ts:5:17: The expected type comes from property 'thing' which is declared here on type '{ thing: string; }' + } + } + } + } + } \ No newline at end of file diff --git a/tests/baselines/reference/asyncFunctionReturnExpressionErrorSpans.js b/tests/baselines/reference/asyncFunctionReturnExpressionErrorSpans.js new file mode 100644 index 0000000000..d60a7df66d --- /dev/null +++ b/tests/baselines/reference/asyncFunctionReturnExpressionErrorSpans.js @@ -0,0 +1,74 @@ +//// [asyncFunctionReturnExpressionErrorSpans.ts] +interface Foo { + bar: { + baz: { + inner: { + thing: string + } + } + } +} + +async function asyncFoo(): Promise { + return { + bar: { + baz: { + inner: { + thing: 1 + } + } + } + } +} + +//// [asyncFunctionReturnExpressionErrorSpans.js] +var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { + return new (P || (P = Promise))(function (resolve, reject) { + function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } + function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } + function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); } + step((generator = generator.apply(thisArg, _arguments || [])).next()); + }); +}; +var __generator = (this && this.__generator) || function (thisArg, body) { + var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g; + return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g; + function verb(n) { return function (v) { return step([n, v]); }; } + function step(op) { + if (f) throw new TypeError("Generator is already executing."); + while (_) try { + if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t; + if (y = 0, t) op = [op[0] & 2, t.value]; + switch (op[0]) { + case 0: case 1: t = op; break; + case 4: _.label++; return { value: op[1], done: false }; + case 5: _.label++; y = op[1]; op = [0]; continue; + case 7: op = _.ops.pop(); _.trys.pop(); continue; + default: + if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; } + if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; } + if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; } + if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; } + if (t[2]) _.ops.pop(); + _.trys.pop(); continue; + } + op = body.call(thisArg, _); + } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; } + if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true }; + } +}; +function asyncFoo() { + return __awaiter(this, void 0, void 0, function () { + return __generator(this, function (_a) { + return [2 /*return*/, { + bar: { + baz: { + inner: { + thing: 1 + } + } + } + }]; + }); + }); +} diff --git a/tests/baselines/reference/asyncFunctionReturnExpressionErrorSpans.symbols b/tests/baselines/reference/asyncFunctionReturnExpressionErrorSpans.symbols new file mode 100644 index 0000000000..de580b6b97 --- /dev/null +++ b/tests/baselines/reference/asyncFunctionReturnExpressionErrorSpans.symbols @@ -0,0 +1,42 @@ +=== tests/cases/compiler/asyncFunctionReturnExpressionErrorSpans.ts === +interface Foo { +>Foo : Symbol(Foo, Decl(asyncFunctionReturnExpressionErrorSpans.ts, 0, 0)) + + bar: { +>bar : Symbol(Foo.bar, Decl(asyncFunctionReturnExpressionErrorSpans.ts, 0, 15)) + + baz: { +>baz : Symbol(baz, Decl(asyncFunctionReturnExpressionErrorSpans.ts, 1, 10)) + + inner: { +>inner : Symbol(inner, Decl(asyncFunctionReturnExpressionErrorSpans.ts, 2, 14)) + + thing: string +>thing : Symbol(thing, Decl(asyncFunctionReturnExpressionErrorSpans.ts, 3, 20)) + } + } + } +} + +async function asyncFoo(): Promise { +>asyncFoo : Symbol(asyncFoo, Decl(asyncFunctionReturnExpressionErrorSpans.ts, 8, 1)) +>Promise : Symbol(Promise, Decl(lib.es5.d.ts, --, --)) +>Foo : Symbol(Foo, Decl(asyncFunctionReturnExpressionErrorSpans.ts, 0, 0)) + + return { + bar: { +>bar : Symbol(bar, Decl(asyncFunctionReturnExpressionErrorSpans.ts, 11, 12)) + + baz: { +>baz : Symbol(baz, Decl(asyncFunctionReturnExpressionErrorSpans.ts, 12, 14)) + + inner: { +>inner : Symbol(inner, Decl(asyncFunctionReturnExpressionErrorSpans.ts, 13, 18)) + + thing: 1 +>thing : Symbol(thing, Decl(asyncFunctionReturnExpressionErrorSpans.ts, 14, 24)) + } + } + } + } +} diff --git a/tests/baselines/reference/asyncFunctionReturnExpressionErrorSpans.types b/tests/baselines/reference/asyncFunctionReturnExpressionErrorSpans.types new file mode 100644 index 0000000000..63dd0aa3b1 --- /dev/null +++ b/tests/baselines/reference/asyncFunctionReturnExpressionErrorSpans.types @@ -0,0 +1,44 @@ +=== tests/cases/compiler/asyncFunctionReturnExpressionErrorSpans.ts === +interface Foo { + bar: { +>bar : { baz: { inner: { thing: string; }; }; } + + baz: { +>baz : { inner: { thing: string; }; } + + inner: { +>inner : { thing: string; } + + thing: string +>thing : string + } + } + } +} + +async function asyncFoo(): Promise { +>asyncFoo : () => Promise + + return { +>{ bar: { baz: { inner: { thing: 1 } } } } : { bar: { baz: { inner: { thing: number; }; }; }; } + + bar: { +>bar : { baz: { inner: { thing: number; }; }; } +>{ baz: { inner: { thing: 1 } } } : { baz: { inner: { thing: number; }; }; } + + baz: { +>baz : { inner: { thing: number; }; } +>{ inner: { thing: 1 } } : { inner: { thing: number; }; } + + inner: { +>inner : { thing: number; } +>{ thing: 1 } : { thing: number; } + + thing: 1 +>thing : number +>1 : 1 + } + } + } + } +} diff --git a/tests/cases/compiler/asyncFunctionReturnExpressionErrorSpans.ts b/tests/cases/compiler/asyncFunctionReturnExpressionErrorSpans.ts new file mode 100644 index 0000000000..3a2a64b7b2 --- /dev/null +++ b/tests/cases/compiler/asyncFunctionReturnExpressionErrorSpans.ts @@ -0,0 +1,21 @@ +interface Foo { + bar: { + baz: { + inner: { + thing: string + } + } + } +} + +async function asyncFoo(): Promise { + return { + bar: { + baz: { + inner: { + thing: 1 + } + } + } + } +} \ No newline at end of file