Fix #11396: Make error message referene Promise explicitly#11982

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mohamed Hegazy (mhegazy) merged 2 commits into from
Nov 2, 2016
Merged

Fix #11396: Make error message referene Promise explicitly #11982

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
859aa30
Simplify the checking for async function return type
mhegazy Nov 1, 2016
3435727
Fix https://github.com/Microsoft/TypeScript/issues/11396: Make error …
mhegazy Nov 1, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 51 additions & 80 deletions src/compiler/checker.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13073,7 +13073,7 @@ namespace ts {
function createPromiseReturnType(func: FunctionLikeDeclaration, promisedType: Type) {
const promiseType = createPromiseType(promisedType);
if (promiseType === emptyObjectType) {
error(func, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
error(func, Diagnostics.An_async_function_or_method_must_return_a_Promise_Make_sure_you_have_a_declaration_for_Promise_or_include_ES2015_in_your_lib_option);
return unknownType;
}

Expand DownExpand Up@@ -15515,36 +15515,6 @@ namespace ts {
}
}

/**
* Checks that the return type provided is an instantiation of the global Promise<T> type
* and returns the awaited type of the return type.
*
* @param returnType The return type of a FunctionLikeDeclaration
* @param location The node on which to report the error.
*/
function checkCorrectPromiseType(returnType: Type, location: Node, diagnostic: DiagnosticMessage, typeName?: string) {
if (returnType === unknownType) {
// The return type already had some other error, so we ignore and return
// the unknown type.
return unknownType;
}

const globalPromiseType = getGlobalPromiseType();
if (globalPromiseType === emptyGenericType
|| globalPromiseType === getTargetType(returnType)) {
// Either we couldn't resolve the global promise type, which would have already
// reported an error, or we could resolve it and the return type is a valid type
// reference to the global type. In either case, we return the awaited type for
// the return type.
return checkAwaitedType(returnType, location, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
}

// The promise type was not a valid type reference to the global promise type, so we
// report an error and return the unknown type.
error(location, diagnostic, typeName);
return unknownType;
}

/**
* Checks the return type of an async function to ensure it is a compatible
* Promise implementation.
Expand All@@ -15559,11 +15529,6 @@ namespace ts {
* @param node The signature to check
*/
function checkAsyncFunctionReturnType(node: FunctionLikeDeclaration): Type {
if (languageVersion >= ScriptTarget.ES2015) {
const returnType = getTypeFromTypeNode(node.type);
return checkCorrectPromiseType(returnType, node.type, Diagnostics.The_return_type_of_an_async_function_or_method_must_be_the_global_Promise_T_type);
}

// As part of our emit for an async function, we will need to emit the entity name of
// the return type annotation as an expression. To meet the necessary runtime semantics
// for __awaiter, we must also check that the type of the declaration (e.g. the static
Expand All@@ -15588,61 +15553,67 @@ namespace ts {
// then<U>(...): Promise<U>;
// }
//
const returnType = getTypeFromTypeNode(node.type);

// Always mark the type node as referenced if it points to a value
markTypeNodeAsReferenced(node.type);

const promiseConstructorName = getEntityNameFromTypeNode(node.type);
const promiseType = getTypeFromTypeNode(node.type);
if (promiseType === unknownType) {
if (!compilerOptions.isolatedModules) {
if (promiseConstructorName) {
error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
}
else {
error(node.type, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
}
if (languageVersion >= ScriptTarget.ES2015) {
if (returnType === unknownType) {
return unknownType;
}
const globalPromiseType = getGlobalPromiseType();
if (globalPromiseType !== emptyGenericType && globalPromiseType !== getTargetType(returnType)) {
// The promise type was not a valid type reference to the global promise type, so we
// report an error and return the unknown type.
error(node.type, Diagnostics.The_return_type_of_an_async_function_or_method_must_be_the_global_Promise_T_type);
return unknownType;
}
return unknownType;
}
else {
// Always mark the type node as referenced if it points to a value
markTypeNodeAsReferenced(node.type);

if (promiseConstructorName === undefined) {
error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, typeToString(promiseType));
return unknownType;
}
if (returnType === unknownType) {
return unknownType;
}

const promiseConstructorSymbol = resolveEntityName(promiseConstructorName, SymbolFlags.Value, /*ignoreErrors*/ true);
const promiseConstructorType = promiseConstructorSymbol ? getTypeOfSymbol(promiseConstructorSymbol) : unknownType;
if (promiseConstructorType === unknownType) {
error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
return unknownType;
}
const promiseConstructorName = getEntityNameFromTypeNode(node.type);
if (promiseConstructorName === undefined) {
error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, typeToString(returnType));
return unknownType;
}

const globalPromiseConstructorLikeType = getGlobalPromiseConstructorLikeType();
if (globalPromiseConstructorLikeType === emptyObjectType) {
// If we couldn't resolve the global PromiseConstructorLike type we cannot verify
// compatibility with __awaiter.
error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
return unknownType;
}
const promiseConstructorSymbol = resolveEntityName(promiseConstructorName, SymbolFlags.Value, /*ignoreErrors*/ true);
const promiseConstructorType = promiseConstructorSymbol ? getTypeOfSymbol(promiseConstructorSymbol) : unknownType;
if (promiseConstructorType === unknownType) {
error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
return unknownType;
}

if (!checkTypeAssignableTo(promiseConstructorType, globalPromiseConstructorLikeType, node.type,
Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value)) {
return unknownType;
}
const globalPromiseConstructorLikeType = getGlobalPromiseConstructorLikeType();
if (globalPromiseConstructorLikeType === emptyObjectType) {
// If we couldn't resolve the global PromiseConstructorLike type we cannot verify
// compatibility with __awaiter.
error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
return unknownType;
}

// Verify there is no local declaration that could collide with the promise constructor.
const rootName = promiseConstructorName && getFirstIdentifier(promiseConstructorName);
const collidingSymbol = getSymbol(node.locals, rootName.text, SymbolFlags.Value);
if (collidingSymbol) {
error(collidingSymbol.valueDeclaration, Diagnostics.Duplicate_identifier_0_Compiler_uses_declaration_1_to_support_async_functions,
rootName.text,
entityNameToString(promiseConstructorName));
return unknownType;
if (!checkTypeAssignableTo(promiseConstructorType, globalPromiseConstructorLikeType, node.type,
Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value)) {
return unknownType;
}

// Verify there is no local declaration that could collide with the promise constructor.
const rootName = promiseConstructorName && getFirstIdentifier(promiseConstructorName);
const collidingSymbol = getSymbol(node.locals, rootName.text, SymbolFlags.Value);
if (collidingSymbol) {
error(collidingSymbol.valueDeclaration, Diagnostics.Duplicate_identifier_0_Compiler_uses_declaration_1_to_support_async_functions,
rootName.text,
entityNameToString(promiseConstructorName));
return unknownType;
}
}

// Get and return the awaited type of the return type.
return checkAwaitedType(promiseType, node, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
return checkAwaitedType(returnType, node, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
}

/** Check a decorator */
Expand Down
4 changes: 4 additions & 0 deletions src/compiler/diagnosticMessages.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1967,6 +1967,10 @@
"category": "Error",
"code": 2696
},
"An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.": {
"category": "Error",
"code": 2697
},

"Import declaration '{0}' is using private name '{1}'.": {
"category": "Error",
Expand Down
4 changes: 2 additions & 2 deletions tests/baselines/reference/asyncFunctionNoReturnType.errors.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
error TS2318: Cannot find global type 'Promise'.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS1057: An async function or method must have a valid awaitable return type.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS2697: An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS7030: Not all code paths return a value.
tests/cases/compiler/asyncFunctionNoReturnType.ts(2,9): error TS2304: Cannot find name 'window'.
tests/cases/compiler/asyncFunctionNoReturnType.ts(3,9): error TS7030: Not all code paths return a value.
Expand All@@ -9,7 +9,7 @@ tests/cases/compiler/asyncFunctionNoReturnType.ts(3,9): error TS7030: Not all co
==== tests/cases/compiler/asyncFunctionNoReturnType.ts (4 errors) ====
async () => {
~~~~~~~~~~~~~
!!! error TS1057: An async function or method must have a valid awaitable return type.
!!! error TS2697: An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.
~~~~~~~~~~~~~
!!! error TS7030: Not all code paths return a value.
if (window)
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Fix #11396: Make error message referene Promise explicitly#11982

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Mohamed Hegazy (mhegazy)
merged 2 commits into

from

Nov 2, 2016
 Merged


Fix #11396: Make error message referene Promise explicitly
#11982
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
859aa30

Simplify the checking for async function return type


mhegazy Nov 1, 2016
3435727

Fix https://github.com/Microsoft/TypeScript/issues/11396: Make error …


mhegazy Nov 1, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


131 changes: 51 additions & 80 deletions
src/compiler/checker.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13073,7 +13073,7 @@ namespace ts {
 function createPromiseReturnType(func: FunctionLikeDeclaration, promisedType: Type) {
 const promiseType = createPromiseType(promisedType);
 if (promiseType === emptyObjectType) {
 error(func, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 error(func, Diagnostics.An_async_function_or_method_must_return_a_Promise_Make_sure_you_have_a_declaration_for_Promise_or_include_ES2015_in_your_lib_option);
 return unknownType;
 }

Expand DownExpand Up@@ -15515,36 +15515,6 @@ namespace ts {
 }
 }

 /**
 * Checks that the return type provided is an instantiation of the global Promise<T> type
 * and returns the awaited type of the return type.
 *
 * @param returnType The return type of a FunctionLikeDeclaration
 * @param location The node on which to report the error.
 */
 function checkCorrectPromiseType(returnType: Type, location: Node, diagnostic: DiagnosticMessage, typeName?: string) {
 if (returnType === unknownType) {
 // The return type already had some other error, so we ignore and return
 // the unknown type.
 return unknownType;
 }

 const globalPromiseType = getGlobalPromiseType();
 if (globalPromiseType === emptyGenericType
 || globalPromiseType === getTargetType(returnType)) {
 // Either we couldn't resolve the global promise type, which would have already
 // reported an error, or we could resolve it and the return type is a valid type
 // reference to the global type. In either case, we return the awaited type for
 // the return type.
 return checkAwaitedType(returnType, location, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }

 // The promise type was not a valid type reference to the global promise type, so we
 // report an error and return the unknown type.
 error(location, diagnostic, typeName);
 return unknownType;
 }

 /**
 * Checks the return type of an async function to ensure it is a compatible
 * Promise implementation.
Expand All@@ -15559,11 +15529,6 @@ namespace ts {
 * @param node The signature to check
 */
 function checkAsyncFunctionReturnType(node: FunctionLikeDeclaration): Type {
 if (languageVersion >= ScriptTarget.ES2015) {
 const returnType = getTypeFromTypeNode(node.type);
 return checkCorrectPromiseType(returnType, node.type, Diagnostics.The_return_type_of_an_async_function_or_method_must_be_the_global_Promise_T_type);
 }

 // As part of our emit for an async function, we will need to emit the entity name of
 // the return type annotation as an expression. To meet the necessary runtime semantics
 // for __awaiter, we must also check that the type of the declaration (e.g. the static
Expand All@@ -15588,61 +15553,67 @@ namespace ts {
 // then<U>(...): Promise<U>;
 // }
 //
 const returnType = getTypeFromTypeNode(node.type);

 // Always mark the type node as referenced if it points to a value
 markTypeNodeAsReferenced(node.type);

 const promiseConstructorName = getEntityNameFromTypeNode(node.type);
 const promiseType = getTypeFromTypeNode(node.type);
 if (promiseType === unknownType) {
 if (!compilerOptions.isolatedModules) {
 if (promiseConstructorName) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 }
 else {
 error(node.type, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }
 if (languageVersion >= ScriptTarget.ES2015) {
 if (returnType === unknownType) {
 return unknownType;
 }
 const globalPromiseType = getGlobalPromiseType();
 if (globalPromiseType !== emptyGenericType && globalPromiseType !== getTargetType(returnType)) {
 // The promise type was not a valid type reference to the global promise type, so we
 // report an error and return the unknown type.
 error(node.type, Diagnostics.The_return_type_of_an_async_function_or_method_must_be_the_global_Promise_T_type);
 return unknownType;
 }
 return unknownType;
 }
 else {
 // Always mark the type node as referenced if it points to a value
 markTypeNodeAsReferenced(node.type);

 if (promiseConstructorName === undefined) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, typeToString(promiseType));
 return unknownType;
 }
 if (returnType === unknownType) {
 return unknownType;
 }

 const promiseConstructorSymbol = resolveEntityName(promiseConstructorName, SymbolFlags.Value, /*ignoreErrors*/ true);
 const promiseConstructorType = promiseConstructorSymbol ? getTypeOfSymbol(promiseConstructorSymbol) : unknownType;
 if (promiseConstructorType === unknownType) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }
 const promiseConstructorName = getEntityNameFromTypeNode(node.type);
 if (promiseConstructorName === undefined) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, typeToString(returnType));
 return unknownType;
 }

 const globalPromiseConstructorLikeType = getGlobalPromiseConstructorLikeType();
 if (globalPromiseConstructorLikeType === emptyObjectType) {
 // If we couldn't resolve the global PromiseConstructorLike type we cannot verify
 // compatibility with __awaiter.
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }
 const promiseConstructorSymbol = resolveEntityName(promiseConstructorName, SymbolFlags.Value, /*ignoreErrors*/ true);
 const promiseConstructorType = promiseConstructorSymbol ? getTypeOfSymbol(promiseConstructorSymbol) : unknownType;
 if (promiseConstructorType === unknownType) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }

 if (!checkTypeAssignableTo(promiseConstructorType, globalPromiseConstructorLikeType, node.type,
 Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value)) {
 return unknownType;
 }
 const globalPromiseConstructorLikeType = getGlobalPromiseConstructorLikeType();
 if (globalPromiseConstructorLikeType === emptyObjectType) {
 // If we couldn't resolve the global PromiseConstructorLike type we cannot verify
 // compatibility with __awaiter.
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }

 // Verify there is no local declaration that could collide with the promise constructor.
 const rootName = promiseConstructorName && getFirstIdentifier(promiseConstructorName);
 const collidingSymbol = getSymbol(node.locals, rootName.text, SymbolFlags.Value);
 if (collidingSymbol) {
 error(collidingSymbol.valueDeclaration, Diagnostics.Duplicate_identifier_0_Compiler_uses_declaration_1_to_support_async_functions,
 rootName.text,
 entityNameToString(promiseConstructorName));
 return unknownType;
 if (!checkTypeAssignableTo(promiseConstructorType, globalPromiseConstructorLikeType, node.type,
 Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value)) {
 return unknownType;
 }

 // Verify there is no local declaration that could collide with the promise constructor.
 const rootName = promiseConstructorName && getFirstIdentifier(promiseConstructorName);
 const collidingSymbol = getSymbol(node.locals, rootName.text, SymbolFlags.Value);
 if (collidingSymbol) {
 error(collidingSymbol.valueDeclaration, Diagnostics.Duplicate_identifier_0_Compiler_uses_declaration_1_to_support_async_functions,
 rootName.text,
 entityNameToString(promiseConstructorName));
 return unknownType;
 }
 }

 // Get and return the awaited type of the return type.
 return checkAwaitedType(promiseType, node, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 return checkAwaitedType(returnType, node, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }

 /** Check a decorator */
Expand Down

4 changes: 4 additions & 0 deletions
src/compiler/diagnosticMessages.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1967,6 +1967,10 @@
 "category": "Error",
 "code": 2696
 },
 "An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.": {
 "category": "Error",
 "code": 2697
 },

 "Import declaration '{0}' is using private name '{1}'.": {
 "category": "Error",
Expand Down

4 changes: 2 additions & 2 deletions
tests/baselines/reference/asyncFunctionNoReturnType.errors.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
error TS2318: Cannot find global type 'Promise'.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS1057: An async function or method must have a valid awaitable return type.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS2697: An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS7030: Not all code paths return a value.
tests/cases/compiler/asyncFunctionNoReturnType.ts(2,9): error TS2304: Cannot find name 'window'.
tests/cases/compiler/asyncFunctionNoReturnType.ts(3,9): error TS7030: Not all code paths return a value.
Expand All@@ -9,7 +9,7 @@ tests/cases/compiler/asyncFunctionNoReturnType.ts(3,9): error TS7030: Not all co
==== tests/cases/compiler/asyncFunctionNoReturnType.ts (4 errors) ====
 async () => {
 ~~~~~~~~~~~~~
!!! error TS1057: An async function or method must have a valid awaitable return type.
!!! error TS2697: An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.
 ~~~~~~~~~~~~~
!!! error TS7030: Not all code paths return a value.
 if (window)
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Fix #11396: Make error message referene Promise explicitly#11982

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Mohamed Hegazy (mhegazy)
merged 2 commits into

from

Nov 2, 2016
 Merged


Fix #11396: Make error message referene Promise explicitly
#11982
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
859aa30

Simplify the checking for async function return type


mhegazy Nov 1, 2016
3435727

Fix https://github.com/Microsoft/TypeScript/issues/11396: Make error …


mhegazy Nov 1, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


131 changes: 51 additions & 80 deletions
src/compiler/checker.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13073,7 +13073,7 @@ namespace ts {
 function createPromiseReturnType(func: FunctionLikeDeclaration, promisedType: Type) {
 const promiseType = createPromiseType(promisedType);
 if (promiseType === emptyObjectType) {
 error(func, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 error(func, Diagnostics.An_async_function_or_method_must_return_a_Promise_Make_sure_you_have_a_declaration_for_Promise_or_include_ES2015_in_your_lib_option);
 return unknownType;
 }

Expand DownExpand Up@@ -15515,36 +15515,6 @@ namespace ts {
 }
 }

 /**
 * Checks that the return type provided is an instantiation of the global Promise<T> type
 * and returns the awaited type of the return type.
 *
 * @param returnType The return type of a FunctionLikeDeclaration
 * @param location The node on which to report the error.
 */
 function checkCorrectPromiseType(returnType: Type, location: Node, diagnostic: DiagnosticMessage, typeName?: string) {
 if (returnType === unknownType) {
 // The return type already had some other error, so we ignore and return
 // the unknown type.
 return unknownType;
 }

 const globalPromiseType = getGlobalPromiseType();
 if (globalPromiseType === emptyGenericType
 || globalPromiseType === getTargetType(returnType)) {
 // Either we couldn't resolve the global promise type, which would have already
 // reported an error, or we could resolve it and the return type is a valid type
 // reference to the global type. In either case, we return the awaited type for
 // the return type.
 return checkAwaitedType(returnType, location, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }

 // The promise type was not a valid type reference to the global promise type, so we
 // report an error and return the unknown type.
 error(location, diagnostic, typeName);
 return unknownType;
 }

 /**
 * Checks the return type of an async function to ensure it is a compatible
 * Promise implementation.
Expand All@@ -15559,11 +15529,6 @@ namespace ts {
 * @param node The signature to check
 */
 function checkAsyncFunctionReturnType(node: FunctionLikeDeclaration): Type {
 if (languageVersion >= ScriptTarget.ES2015) {
 const returnType = getTypeFromTypeNode(node.type);
 return checkCorrectPromiseType(returnType, node.type, Diagnostics.The_return_type_of_an_async_function_or_method_must_be_the_global_Promise_T_type);
 }

 // As part of our emit for an async function, we will need to emit the entity name of
 // the return type annotation as an expression. To meet the necessary runtime semantics
 // for __awaiter, we must also check that the type of the declaration (e.g. the static
Expand All@@ -15588,61 +15553,67 @@ namespace ts {
 // then<U>(...): Promise<U>;
 // }
 //
 const returnType = getTypeFromTypeNode(node.type);

 // Always mark the type node as referenced if it points to a value
 markTypeNodeAsReferenced(node.type);

 const promiseConstructorName = getEntityNameFromTypeNode(node.type);
 const promiseType = getTypeFromTypeNode(node.type);
 if (promiseType === unknownType) {
 if (!compilerOptions.isolatedModules) {
 if (promiseConstructorName) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 }
 else {
 error(node.type, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }
 if (languageVersion >= ScriptTarget.ES2015) {
 if (returnType === unknownType) {
 return unknownType;
 }
 const globalPromiseType = getGlobalPromiseType();
 if (globalPromiseType !== emptyGenericType && globalPromiseType !== getTargetType(returnType)) {
 // The promise type was not a valid type reference to the global promise type, so we
 // report an error and return the unknown type.
 error(node.type, Diagnostics.The_return_type_of_an_async_function_or_method_must_be_the_global_Promise_T_type);
 return unknownType;
 }
 return unknownType;
 }
 else {
 // Always mark the type node as referenced if it points to a value
 markTypeNodeAsReferenced(node.type);

 if (promiseConstructorName === undefined) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, typeToString(promiseType));
 return unknownType;
 }
 if (returnType === unknownType) {
 return unknownType;
 }

 const promiseConstructorSymbol = resolveEntityName(promiseConstructorName, SymbolFlags.Value, /*ignoreErrors*/ true);
 const promiseConstructorType = promiseConstructorSymbol ? getTypeOfSymbol(promiseConstructorSymbol) : unknownType;
 if (promiseConstructorType === unknownType) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }
 const promiseConstructorName = getEntityNameFromTypeNode(node.type);
 if (promiseConstructorName === undefined) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, typeToString(returnType));
 return unknownType;
 }

 const globalPromiseConstructorLikeType = getGlobalPromiseConstructorLikeType();
 if (globalPromiseConstructorLikeType === emptyObjectType) {
 // If we couldn't resolve the global PromiseConstructorLike type we cannot verify
 // compatibility with __awaiter.
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }
 const promiseConstructorSymbol = resolveEntityName(promiseConstructorName, SymbolFlags.Value, /*ignoreErrors*/ true);
 const promiseConstructorType = promiseConstructorSymbol ? getTypeOfSymbol(promiseConstructorSymbol) : unknownType;
 if (promiseConstructorType === unknownType) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }

 if (!checkTypeAssignableTo(promiseConstructorType, globalPromiseConstructorLikeType, node.type,
 Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value)) {
 return unknownType;
 }
 const globalPromiseConstructorLikeType = getGlobalPromiseConstructorLikeType();
 if (globalPromiseConstructorLikeType === emptyObjectType) {
 // If we couldn't resolve the global PromiseConstructorLike type we cannot verify
 // compatibility with __awaiter.
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }

 // Verify there is no local declaration that could collide with the promise constructor.
 const rootName = promiseConstructorName && getFirstIdentifier(promiseConstructorName);
 const collidingSymbol = getSymbol(node.locals, rootName.text, SymbolFlags.Value);
 if (collidingSymbol) {
 error(collidingSymbol.valueDeclaration, Diagnostics.Duplicate_identifier_0_Compiler_uses_declaration_1_to_support_async_functions,
 rootName.text,
 entityNameToString(promiseConstructorName));
 return unknownType;
 if (!checkTypeAssignableTo(promiseConstructorType, globalPromiseConstructorLikeType, node.type,
 Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value)) {
 return unknownType;
 }

 // Verify there is no local declaration that could collide with the promise constructor.
 const rootName = promiseConstructorName && getFirstIdentifier(promiseConstructorName);
 const collidingSymbol = getSymbol(node.locals, rootName.text, SymbolFlags.Value);
 if (collidingSymbol) {
 error(collidingSymbol.valueDeclaration, Diagnostics.Duplicate_identifier_0_Compiler_uses_declaration_1_to_support_async_functions,
 rootName.text,
 entityNameToString(promiseConstructorName));
 return unknownType;
 }
 }

 // Get and return the awaited type of the return type.
 return checkAwaitedType(promiseType, node, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 return checkAwaitedType(returnType, node, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }

 /** Check a decorator */
Expand Down

4 changes: 4 additions & 0 deletions
src/compiler/diagnosticMessages.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1967,6 +1967,10 @@
 "category": "Error",
 "code": 2696
 },
 "An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.": {
 "category": "Error",
 "code": 2697
 },

 "Import declaration '{0}' is using private name '{1}'.": {
 "category": "Error",
Expand Down

4 changes: 2 additions & 2 deletions
tests/baselines/reference/asyncFunctionNoReturnType.errors.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
error TS2318: Cannot find global type 'Promise'.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS1057: An async function or method must have a valid awaitable return type.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS2697: An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS7030: Not all code paths return a value.
tests/cases/compiler/asyncFunctionNoReturnType.ts(2,9): error TS2304: Cannot find name 'window'.
tests/cases/compiler/asyncFunctionNoReturnType.ts(3,9): error TS7030: Not all code paths return a value.
Expand All@@ -9,7 +9,7 @@ tests/cases/compiler/asyncFunctionNoReturnType.ts(3,9): error TS7030: Not all co
==== tests/cases/compiler/asyncFunctionNoReturnType.ts (4 errors) ====
 async () => {
 ~~~~~~~~~~~~~
!!! error TS1057: An async function or method must have a valid awaitable return type.
!!! error TS2697: An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.
 ~~~~~~~~~~~~~
!!! error TS7030: Not all code paths return a value.
 if (window)
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Fix #11396: Make error message referene Promise explicitly#11982

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Mohamed Hegazy (mhegazy)
merged 2 commits into

from

Nov 2, 2016
 Merged


Fix #11396: Make error message referene Promise explicitly
#11982
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
859aa30

Simplify the checking for async function return type


mhegazy Nov 1, 2016
3435727

Fix https://github.com/Microsoft/TypeScript/issues/11396: Make error …


mhegazy Nov 1, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


131 changes: 51 additions & 80 deletions
src/compiler/checker.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13073,7 +13073,7 @@ namespace ts {
 function createPromiseReturnType(func: FunctionLikeDeclaration, promisedType: Type) {
 const promiseType = createPromiseType(promisedType);
 if (promiseType === emptyObjectType) {
 error(func, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 error(func, Diagnostics.An_async_function_or_method_must_return_a_Promise_Make_sure_you_have_a_declaration_for_Promise_or_include_ES2015_in_your_lib_option);
 return unknownType;
 }

Expand DownExpand Up@@ -15515,36 +15515,6 @@ namespace ts {
 }
 }

 /**
 * Checks that the return type provided is an instantiation of the global Promise<T> type
 * and returns the awaited type of the return type.
 *
 * @param returnType The return type of a FunctionLikeDeclaration
 * @param location The node on which to report the error.
 */
 function checkCorrectPromiseType(returnType: Type, location: Node, diagnostic: DiagnosticMessage, typeName?: string) {
 if (returnType === unknownType) {
 // The return type already had some other error, so we ignore and return
 // the unknown type.
 return unknownType;
 }

 const globalPromiseType = getGlobalPromiseType();
 if (globalPromiseType === emptyGenericType
 || globalPromiseType === getTargetType(returnType)) {
 // Either we couldn't resolve the global promise type, which would have already
 // reported an error, or we could resolve it and the return type is a valid type
 // reference to the global type. In either case, we return the awaited type for
 // the return type.
 return checkAwaitedType(returnType, location, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }

 // The promise type was not a valid type reference to the global promise type, so we
 // report an error and return the unknown type.
 error(location, diagnostic, typeName);
 return unknownType;
 }

 /**
 * Checks the return type of an async function to ensure it is a compatible
 * Promise implementation.
Expand All@@ -15559,11 +15529,6 @@ namespace ts {
 * @param node The signature to check
 */
 function checkAsyncFunctionReturnType(node: FunctionLikeDeclaration): Type {
 if (languageVersion >= ScriptTarget.ES2015) {
 const returnType = getTypeFromTypeNode(node.type);
 return checkCorrectPromiseType(returnType, node.type, Diagnostics.The_return_type_of_an_async_function_or_method_must_be_the_global_Promise_T_type);
 }

 // As part of our emit for an async function, we will need to emit the entity name of
 // the return type annotation as an expression. To meet the necessary runtime semantics
 // for __awaiter, we must also check that the type of the declaration (e.g. the static
Expand All@@ -15588,61 +15553,67 @@ namespace ts {
 // then<U>(...): Promise<U>;
 // }
 //
 const returnType = getTypeFromTypeNode(node.type);

 // Always mark the type node as referenced if it points to a value
 markTypeNodeAsReferenced(node.type);

 const promiseConstructorName = getEntityNameFromTypeNode(node.type);
 const promiseType = getTypeFromTypeNode(node.type);
 if (promiseType === unknownType) {
 if (!compilerOptions.isolatedModules) {
 if (promiseConstructorName) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 }
 else {
 error(node.type, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }
 if (languageVersion >= ScriptTarget.ES2015) {
 if (returnType === unknownType) {
 return unknownType;
 }
 const globalPromiseType = getGlobalPromiseType();
 if (globalPromiseType !== emptyGenericType && globalPromiseType !== getTargetType(returnType)) {
 // The promise type was not a valid type reference to the global promise type, so we
 // report an error and return the unknown type.
 error(node.type, Diagnostics.The_return_type_of_an_async_function_or_method_must_be_the_global_Promise_T_type);
 return unknownType;
 }
 return unknownType;
 }
 else {
 // Always mark the type node as referenced if it points to a value
 markTypeNodeAsReferenced(node.type);

 if (promiseConstructorName === undefined) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, typeToString(promiseType));
 return unknownType;
 }
 if (returnType === unknownType) {
 return unknownType;
 }

 const promiseConstructorSymbol = resolveEntityName(promiseConstructorName, SymbolFlags.Value, /*ignoreErrors*/ true);
 const promiseConstructorType = promiseConstructorSymbol ? getTypeOfSymbol(promiseConstructorSymbol) : unknownType;
 if (promiseConstructorType === unknownType) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }
 const promiseConstructorName = getEntityNameFromTypeNode(node.type);
 if (promiseConstructorName === undefined) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, typeToString(returnType));
 return unknownType;
 }

 const globalPromiseConstructorLikeType = getGlobalPromiseConstructorLikeType();
 if (globalPromiseConstructorLikeType === emptyObjectType) {
 // If we couldn't resolve the global PromiseConstructorLike type we cannot verify
 // compatibility with __awaiter.
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }
 const promiseConstructorSymbol = resolveEntityName(promiseConstructorName, SymbolFlags.Value, /*ignoreErrors*/ true);
 const promiseConstructorType = promiseConstructorSymbol ? getTypeOfSymbol(promiseConstructorSymbol) : unknownType;
 if (promiseConstructorType === unknownType) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }

 if (!checkTypeAssignableTo(promiseConstructorType, globalPromiseConstructorLikeType, node.type,
 Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value)) {
 return unknownType;
 }
 const globalPromiseConstructorLikeType = getGlobalPromiseConstructorLikeType();
 if (globalPromiseConstructorLikeType === emptyObjectType) {
 // If we couldn't resolve the global PromiseConstructorLike type we cannot verify
 // compatibility with __awaiter.
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }

 // Verify there is no local declaration that could collide with the promise constructor.
 const rootName = promiseConstructorName && getFirstIdentifier(promiseConstructorName);
 const collidingSymbol = getSymbol(node.locals, rootName.text, SymbolFlags.Value);
 if (collidingSymbol) {
 error(collidingSymbol.valueDeclaration, Diagnostics.Duplicate_identifier_0_Compiler_uses_declaration_1_to_support_async_functions,
 rootName.text,
 entityNameToString(promiseConstructorName));
 return unknownType;
 if (!checkTypeAssignableTo(promiseConstructorType, globalPromiseConstructorLikeType, node.type,
 Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value)) {
 return unknownType;
 }

 // Verify there is no local declaration that could collide with the promise constructor.
 const rootName = promiseConstructorName && getFirstIdentifier(promiseConstructorName);
 const collidingSymbol = getSymbol(node.locals, rootName.text, SymbolFlags.Value);
 if (collidingSymbol) {
 error(collidingSymbol.valueDeclaration, Diagnostics.Duplicate_identifier_0_Compiler_uses_declaration_1_to_support_async_functions,
 rootName.text,
 entityNameToString(promiseConstructorName));
 return unknownType;
 }
 }

 // Get and return the awaited type of the return type.
 return checkAwaitedType(promiseType, node, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 return checkAwaitedType(returnType, node, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }

 /** Check a decorator */
Expand Down

4 changes: 4 additions & 0 deletions
src/compiler/diagnosticMessages.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1967,6 +1967,10 @@
 "category": "Error",
 "code": 2696
 },
 "An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.": {
 "category": "Error",
 "code": 2697
 },

 "Import declaration '{0}' is using private name '{1}'.": {
 "category": "Error",
Expand Down

4 changes: 2 additions & 2 deletions
tests/baselines/reference/asyncFunctionNoReturnType.errors.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
error TS2318: Cannot find global type 'Promise'.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS1057: An async function or method must have a valid awaitable return type.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS2697: An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS7030: Not all code paths return a value.
tests/cases/compiler/asyncFunctionNoReturnType.ts(2,9): error TS2304: Cannot find name 'window'.
tests/cases/compiler/asyncFunctionNoReturnType.ts(3,9): error TS7030: Not all code paths return a value.
Expand All@@ -9,7 +9,7 @@ tests/cases/compiler/asyncFunctionNoReturnType.ts(3,9): error TS7030: Not all co
==== tests/cases/compiler/asyncFunctionNoReturnType.ts (4 errors) ====
 async () => {
 ~~~~~~~~~~~~~
!!! error TS1057: An async function or method must have a valid awaitable return type.
!!! error TS2697: An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.
 ~~~~~~~~~~~~~
!!! error TS7030: Not all code paths return a value.
 if (window)
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Fix #11396: Make error message referene Promise explicitly#11982

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Mohamed Hegazy (mhegazy)
merged 2 commits into

from

Nov 2, 2016
 Merged


Fix #11396: Make error message referene Promise explicitly
#11982
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
859aa30

Simplify the checking for async function return type


mhegazy Nov 1, 2016
3435727

Fix https://github.com/Microsoft/TypeScript/issues/11396: Make error …


mhegazy Nov 1, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


131 changes: 51 additions & 80 deletions
src/compiler/checker.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13073,7 +13073,7 @@ namespace ts {
 function createPromiseReturnType(func: FunctionLikeDeclaration, promisedType: Type) {
 const promiseType = createPromiseType(promisedType);
 if (promiseType === emptyObjectType) {
 error(func, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 error(func, Diagnostics.An_async_function_or_method_must_return_a_Promise_Make_sure_you_have_a_declaration_for_Promise_or_include_ES2015_in_your_lib_option);
 return unknownType;
 }

Expand DownExpand Up@@ -15515,36 +15515,6 @@ namespace ts {
 }
 }

 /**
 * Checks that the return type provided is an instantiation of the global Promise<T> type
 * and returns the awaited type of the return type.
 *
 * @param returnType The return type of a FunctionLikeDeclaration
 * @param location The node on which to report the error.
 */
 function checkCorrectPromiseType(returnType: Type, location: Node, diagnostic: DiagnosticMessage, typeName?: string) {
 if (returnType === unknownType) {
 // The return type already had some other error, so we ignore and return
 // the unknown type.
 return unknownType;
 }

 const globalPromiseType = getGlobalPromiseType();
 if (globalPromiseType === emptyGenericType
 || globalPromiseType === getTargetType(returnType)) {
 // Either we couldn't resolve the global promise type, which would have already
 // reported an error, or we could resolve it and the return type is a valid type
 // reference to the global type. In either case, we return the awaited type for
 // the return type.
 return checkAwaitedType(returnType, location, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }

 // The promise type was not a valid type reference to the global promise type, so we
 // report an error and return the unknown type.
 error(location, diagnostic, typeName);
 return unknownType;
 }

 /**
 * Checks the return type of an async function to ensure it is a compatible
 * Promise implementation.
Expand All@@ -15559,11 +15529,6 @@ namespace ts {
 * @param node The signature to check
 */
 function checkAsyncFunctionReturnType(node: FunctionLikeDeclaration): Type {
 if (languageVersion >= ScriptTarget.ES2015) {
 const returnType = getTypeFromTypeNode(node.type);
 return checkCorrectPromiseType(returnType, node.type, Diagnostics.The_return_type_of_an_async_function_or_method_must_be_the_global_Promise_T_type);
 }

 // As part of our emit for an async function, we will need to emit the entity name of
 // the return type annotation as an expression. To meet the necessary runtime semantics
 // for __awaiter, we must also check that the type of the declaration (e.g. the static
Expand All@@ -15588,61 +15553,67 @@ namespace ts {
 // then<U>(...): Promise<U>;
 // }
 //
 const returnType = getTypeFromTypeNode(node.type);

 // Always mark the type node as referenced if it points to a value
 markTypeNodeAsReferenced(node.type);

 const promiseConstructorName = getEntityNameFromTypeNode(node.type);
 const promiseType = getTypeFromTypeNode(node.type);
 if (promiseType === unknownType) {
 if (!compilerOptions.isolatedModules) {
 if (promiseConstructorName) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 }
 else {
 error(node.type, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }
 if (languageVersion >= ScriptTarget.ES2015) {
 if (returnType === unknownType) {
 return unknownType;
 }
 const globalPromiseType = getGlobalPromiseType();
 if (globalPromiseType !== emptyGenericType && globalPromiseType !== getTargetType(returnType)) {
 // The promise type was not a valid type reference to the global promise type, so we
 // report an error and return the unknown type.
 error(node.type, Diagnostics.The_return_type_of_an_async_function_or_method_must_be_the_global_Promise_T_type);
 return unknownType;
 }
 return unknownType;
 }
 else {
 // Always mark the type node as referenced if it points to a value
 markTypeNodeAsReferenced(node.type);

 if (promiseConstructorName === undefined) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, typeToString(promiseType));
 return unknownType;
 }
 if (returnType === unknownType) {
 return unknownType;
 }

 const promiseConstructorSymbol = resolveEntityName(promiseConstructorName, SymbolFlags.Value, /*ignoreErrors*/ true);
 const promiseConstructorType = promiseConstructorSymbol ? getTypeOfSymbol(promiseConstructorSymbol) : unknownType;
 if (promiseConstructorType === unknownType) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }
 const promiseConstructorName = getEntityNameFromTypeNode(node.type);
 if (promiseConstructorName === undefined) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, typeToString(returnType));
 return unknownType;
 }

 const globalPromiseConstructorLikeType = getGlobalPromiseConstructorLikeType();
 if (globalPromiseConstructorLikeType === emptyObjectType) {
 // If we couldn't resolve the global PromiseConstructorLike type we cannot verify
 // compatibility with __awaiter.
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }
 const promiseConstructorSymbol = resolveEntityName(promiseConstructorName, SymbolFlags.Value, /*ignoreErrors*/ true);
 const promiseConstructorType = promiseConstructorSymbol ? getTypeOfSymbol(promiseConstructorSymbol) : unknownType;
 if (promiseConstructorType === unknownType) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }

 if (!checkTypeAssignableTo(promiseConstructorType, globalPromiseConstructorLikeType, node.type,
 Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value)) {
 return unknownType;
 }
 const globalPromiseConstructorLikeType = getGlobalPromiseConstructorLikeType();
 if (globalPromiseConstructorLikeType === emptyObjectType) {
 // If we couldn't resolve the global PromiseConstructorLike type we cannot verify
 // compatibility with __awaiter.
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }

 // Verify there is no local declaration that could collide with the promise constructor.
 const rootName = promiseConstructorName && getFirstIdentifier(promiseConstructorName);
 const collidingSymbol = getSymbol(node.locals, rootName.text, SymbolFlags.Value);
 if (collidingSymbol) {
 error(collidingSymbol.valueDeclaration, Diagnostics.Duplicate_identifier_0_Compiler_uses_declaration_1_to_support_async_functions,
 rootName.text,
 entityNameToString(promiseConstructorName));
 return unknownType;
 if (!checkTypeAssignableTo(promiseConstructorType, globalPromiseConstructorLikeType, node.type,
 Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value)) {
 return unknownType;
 }

 // Verify there is no local declaration that could collide with the promise constructor.
 const rootName = promiseConstructorName && getFirstIdentifier(promiseConstructorName);
 const collidingSymbol = getSymbol(node.locals, rootName.text, SymbolFlags.Value);
 if (collidingSymbol) {
 error(collidingSymbol.valueDeclaration, Diagnostics.Duplicate_identifier_0_Compiler_uses_declaration_1_to_support_async_functions,
 rootName.text,
 entityNameToString(promiseConstructorName));
 return unknownType;
 }
 }

 // Get and return the awaited type of the return type.
 return checkAwaitedType(promiseType, node, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 return checkAwaitedType(returnType, node, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }

 /** Check a decorator */
Expand Down

4 changes: 4 additions & 0 deletions
src/compiler/diagnosticMessages.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1967,6 +1967,10 @@
 "category": "Error",
 "code": 2696
 },
 "An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.": {
 "category": "Error",
 "code": 2697
 },

 "Import declaration '{0}' is using private name '{1}'.": {
 "category": "Error",
Expand Down

4 changes: 2 additions & 2 deletions
tests/baselines/reference/asyncFunctionNoReturnType.errors.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
error TS2318: Cannot find global type 'Promise'.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS1057: An async function or method must have a valid awaitable return type.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS2697: An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS7030: Not all code paths return a value.
tests/cases/compiler/asyncFunctionNoReturnType.ts(2,9): error TS2304: Cannot find name 'window'.
tests/cases/compiler/asyncFunctionNoReturnType.ts(3,9): error TS7030: Not all code paths return a value.
Expand All@@ -9,7 +9,7 @@ tests/cases/compiler/asyncFunctionNoReturnType.ts(3,9): error TS7030: Not all co
==== tests/cases/compiler/asyncFunctionNoReturnType.ts (4 errors) ====
 async () => {
 ~~~~~~~~~~~~~
!!! error TS1057: An async function or method must have a valid awaitable return type.
!!! error TS2697: An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.
 ~~~~~~~~~~~~~
!!! error TS7030: Not all code paths return a value.
 if (window)
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Fix #11396: Make error message referene Promise explicitly#11982

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Mohamed Hegazy (mhegazy)
merged 2 commits into

from

Nov 2, 2016
 Merged


Fix #11396: Make error message referene Promise explicitly
#11982
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
859aa30

Simplify the checking for async function return type


mhegazy Nov 1, 2016
3435727

Fix https://github.com/Microsoft/TypeScript/issues/11396: Make error …


mhegazy Nov 1, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


131 changes: 51 additions & 80 deletions
src/compiler/checker.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13073,7 +13073,7 @@ namespace ts {
 function createPromiseReturnType(func: FunctionLikeDeclaration, promisedType: Type) {
 const promiseType = createPromiseType(promisedType);
 if (promiseType === emptyObjectType) {
 error(func, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 error(func, Diagnostics.An_async_function_or_method_must_return_a_Promise_Make_sure_you_have_a_declaration_for_Promise_or_include_ES2015_in_your_lib_option);
 return unknownType;
 }

Expand DownExpand Up@@ -15515,36 +15515,6 @@ namespace ts {
 }
 }

 /**
 * Checks that the return type provided is an instantiation of the global Promise<T> type
 * and returns the awaited type of the return type.
 *
 * @param returnType The return type of a FunctionLikeDeclaration
 * @param location The node on which to report the error.
 */
 function checkCorrectPromiseType(returnType: Type, location: Node, diagnostic: DiagnosticMessage, typeName?: string) {
 if (returnType === unknownType) {
 // The return type already had some other error, so we ignore and return
 // the unknown type.
 return unknownType;
 }

 const globalPromiseType = getGlobalPromiseType();
 if (globalPromiseType === emptyGenericType
 || globalPromiseType === getTargetType(returnType)) {
 // Either we couldn't resolve the global promise type, which would have already
 // reported an error, or we could resolve it and the return type is a valid type
 // reference to the global type. In either case, we return the awaited type for
 // the return type.
 return checkAwaitedType(returnType, location, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }

 // The promise type was not a valid type reference to the global promise type, so we
 // report an error and return the unknown type.
 error(location, diagnostic, typeName);
 return unknownType;
 }

 /**
 * Checks the return type of an async function to ensure it is a compatible
 * Promise implementation.
Expand All@@ -15559,11 +15529,6 @@ namespace ts {
 * @param node The signature to check
 */
 function checkAsyncFunctionReturnType(node: FunctionLikeDeclaration): Type {
 if (languageVersion >= ScriptTarget.ES2015) {
 const returnType = getTypeFromTypeNode(node.type);
 return checkCorrectPromiseType(returnType, node.type, Diagnostics.The_return_type_of_an_async_function_or_method_must_be_the_global_Promise_T_type);
 }

 // As part of our emit for an async function, we will need to emit the entity name of
 // the return type annotation as an expression. To meet the necessary runtime semantics
 // for __awaiter, we must also check that the type of the declaration (e.g. the static
Expand All@@ -15588,61 +15553,67 @@ namespace ts {
 // then<U>(...): Promise<U>;
 // }
 //
 const returnType = getTypeFromTypeNode(node.type);

 // Always mark the type node as referenced if it points to a value
 markTypeNodeAsReferenced(node.type);

 const promiseConstructorName = getEntityNameFromTypeNode(node.type);
 const promiseType = getTypeFromTypeNode(node.type);
 if (promiseType === unknownType) {
 if (!compilerOptions.isolatedModules) {
 if (promiseConstructorName) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 }
 else {
 error(node.type, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }
 if (languageVersion >= ScriptTarget.ES2015) {
 if (returnType === unknownType) {
 return unknownType;
 }
 const globalPromiseType = getGlobalPromiseType();
 if (globalPromiseType !== emptyGenericType && globalPromiseType !== getTargetType(returnType)) {
 // The promise type was not a valid type reference to the global promise type, so we
 // report an error and return the unknown type.
 error(node.type, Diagnostics.The_return_type_of_an_async_function_or_method_must_be_the_global_Promise_T_type);
 return unknownType;
 }
 return unknownType;
 }
 else {
 // Always mark the type node as referenced if it points to a value
 markTypeNodeAsReferenced(node.type);

 if (promiseConstructorName === undefined) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, typeToString(promiseType));
 return unknownType;
 }
 if (returnType === unknownType) {
 return unknownType;
 }

 const promiseConstructorSymbol = resolveEntityName(promiseConstructorName, SymbolFlags.Value, /*ignoreErrors*/ true);
 const promiseConstructorType = promiseConstructorSymbol ? getTypeOfSymbol(promiseConstructorSymbol) : unknownType;
 if (promiseConstructorType === unknownType) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }
 const promiseConstructorName = getEntityNameFromTypeNode(node.type);
 if (promiseConstructorName === undefined) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, typeToString(returnType));
 return unknownType;
 }

 const globalPromiseConstructorLikeType = getGlobalPromiseConstructorLikeType();
 if (globalPromiseConstructorLikeType === emptyObjectType) {
 // If we couldn't resolve the global PromiseConstructorLike type we cannot verify
 // compatibility with __awaiter.
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }
 const promiseConstructorSymbol = resolveEntityName(promiseConstructorName, SymbolFlags.Value, /*ignoreErrors*/ true);
 const promiseConstructorType = promiseConstructorSymbol ? getTypeOfSymbol(promiseConstructorSymbol) : unknownType;
 if (promiseConstructorType === unknownType) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }

 if (!checkTypeAssignableTo(promiseConstructorType, globalPromiseConstructorLikeType, node.type,
 Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value)) {
 return unknownType;
 }
 const globalPromiseConstructorLikeType = getGlobalPromiseConstructorLikeType();
 if (globalPromiseConstructorLikeType === emptyObjectType) {
 // If we couldn't resolve the global PromiseConstructorLike type we cannot verify
 // compatibility with __awaiter.
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }

 // Verify there is no local declaration that could collide with the promise constructor.
 const rootName = promiseConstructorName && getFirstIdentifier(promiseConstructorName);
 const collidingSymbol = getSymbol(node.locals, rootName.text, SymbolFlags.Value);
 if (collidingSymbol) {
 error(collidingSymbol.valueDeclaration, Diagnostics.Duplicate_identifier_0_Compiler_uses_declaration_1_to_support_async_functions,
 rootName.text,
 entityNameToString(promiseConstructorName));
 return unknownType;
 if (!checkTypeAssignableTo(promiseConstructorType, globalPromiseConstructorLikeType, node.type,
 Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value)) {
 return unknownType;
 }

 // Verify there is no local declaration that could collide with the promise constructor.
 const rootName = promiseConstructorName && getFirstIdentifier(promiseConstructorName);
 const collidingSymbol = getSymbol(node.locals, rootName.text, SymbolFlags.Value);
 if (collidingSymbol) {
 error(collidingSymbol.valueDeclaration, Diagnostics.Duplicate_identifier_0_Compiler_uses_declaration_1_to_support_async_functions,
 rootName.text,
 entityNameToString(promiseConstructorName));
 return unknownType;
 }
 }

 // Get and return the awaited type of the return type.
 return checkAwaitedType(promiseType, node, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 return checkAwaitedType(returnType, node, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }

 /** Check a decorator */
Expand Down

4 changes: 4 additions & 0 deletions
src/compiler/diagnosticMessages.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1967,6 +1967,10 @@
 "category": "Error",
 "code": 2696
 },
 "An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.": {
 "category": "Error",
 "code": 2697
 },

 "Import declaration '{0}' is using private name '{1}'.": {
 "category": "Error",
Expand Down

4 changes: 2 additions & 2 deletions
tests/baselines/reference/asyncFunctionNoReturnType.errors.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
error TS2318: Cannot find global type 'Promise'.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS1057: An async function or method must have a valid awaitable return type.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS2697: An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS7030: Not all code paths return a value.
tests/cases/compiler/asyncFunctionNoReturnType.ts(2,9): error TS2304: Cannot find name 'window'.
tests/cases/compiler/asyncFunctionNoReturnType.ts(3,9): error TS7030: Not all code paths return a value.
Expand All@@ -9,7 +9,7 @@ tests/cases/compiler/asyncFunctionNoReturnType.ts(3,9): error TS7030: Not all co
==== tests/cases/compiler/asyncFunctionNoReturnType.ts (4 errors) ====
 async () => {
 ~~~~~~~~~~~~~
!!! error TS1057: An async function or method must have a valid awaitable return type.
!!! error TS2697: An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.
 ~~~~~~~~~~~~~
!!! error TS7030: Not all code paths return a value.
 if (window)
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Fix #11396: Make error message referene Promise explicitly#11982

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Mohamed Hegazy (mhegazy)
merged 2 commits into

from

Nov 2, 2016
 Merged


Fix #11396: Make error message referene Promise explicitly
#11982
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
859aa30

Simplify the checking for async function return type


mhegazy Nov 1, 2016
3435727

Fix https://github.com/Microsoft/TypeScript/issues/11396: Make error …


mhegazy Nov 1, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


131 changes: 51 additions & 80 deletions
src/compiler/checker.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13073,7 +13073,7 @@ namespace ts {
 function createPromiseReturnType(func: FunctionLikeDeclaration, promisedType: Type) {
 const promiseType = createPromiseType(promisedType);
 if (promiseType === emptyObjectType) {
 error(func, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 error(func, Diagnostics.An_async_function_or_method_must_return_a_Promise_Make_sure_you_have_a_declaration_for_Promise_or_include_ES2015_in_your_lib_option);
 return unknownType;
 }

Expand DownExpand Up@@ -15515,36 +15515,6 @@ namespace ts {
 }
 }

 /**
 * Checks that the return type provided is an instantiation of the global Promise<T> type
 * and returns the awaited type of the return type.
 *
 * @param returnType The return type of a FunctionLikeDeclaration
 * @param location The node on which to report the error.
 */
 function checkCorrectPromiseType(returnType: Type, location: Node, diagnostic: DiagnosticMessage, typeName?: string) {
 if (returnType === unknownType) {
 // The return type already had some other error, so we ignore and return
 // the unknown type.
 return unknownType;
 }

 const globalPromiseType = getGlobalPromiseType();
 if (globalPromiseType === emptyGenericType
 || globalPromiseType === getTargetType(returnType)) {
 // Either we couldn't resolve the global promise type, which would have already
 // reported an error, or we could resolve it and the return type is a valid type
 // reference to the global type. In either case, we return the awaited type for
 // the return type.
 return checkAwaitedType(returnType, location, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }

 // The promise type was not a valid type reference to the global promise type, so we
 // report an error and return the unknown type.
 error(location, diagnostic, typeName);
 return unknownType;
 }

 /**
 * Checks the return type of an async function to ensure it is a compatible
 * Promise implementation.
Expand All@@ -15559,11 +15529,6 @@ namespace ts {
 * @param node The signature to check
 */
 function checkAsyncFunctionReturnType(node: FunctionLikeDeclaration): Type {
 if (languageVersion >= ScriptTarget.ES2015) {
 const returnType = getTypeFromTypeNode(node.type);
 return checkCorrectPromiseType(returnType, node.type, Diagnostics.The_return_type_of_an_async_function_or_method_must_be_the_global_Promise_T_type);
 }

 // As part of our emit for an async function, we will need to emit the entity name of
 // the return type annotation as an expression. To meet the necessary runtime semantics
 // for __awaiter, we must also check that the type of the declaration (e.g. the static
Expand All@@ -15588,61 +15553,67 @@ namespace ts {
 // then<U>(...): Promise<U>;
 // }
 //
 const returnType = getTypeFromTypeNode(node.type);

 // Always mark the type node as referenced if it points to a value
 markTypeNodeAsReferenced(node.type);

 const promiseConstructorName = getEntityNameFromTypeNode(node.type);
 const promiseType = getTypeFromTypeNode(node.type);
 if (promiseType === unknownType) {
 if (!compilerOptions.isolatedModules) {
 if (promiseConstructorName) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 }
 else {
 error(node.type, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }
 if (languageVersion >= ScriptTarget.ES2015) {
 if (returnType === unknownType) {
 return unknownType;
 }
 const globalPromiseType = getGlobalPromiseType();
 if (globalPromiseType !== emptyGenericType && globalPromiseType !== getTargetType(returnType)) {
 // The promise type was not a valid type reference to the global promise type, so we
 // report an error and return the unknown type.
 error(node.type, Diagnostics.The_return_type_of_an_async_function_or_method_must_be_the_global_Promise_T_type);
 return unknownType;
 }
 return unknownType;
 }
 else {
 // Always mark the type node as referenced if it points to a value
 markTypeNodeAsReferenced(node.type);

 if (promiseConstructorName === undefined) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, typeToString(promiseType));
 return unknownType;
 }
 if (returnType === unknownType) {
 return unknownType;
 }

 const promiseConstructorSymbol = resolveEntityName(promiseConstructorName, SymbolFlags.Value, /*ignoreErrors*/ true);
 const promiseConstructorType = promiseConstructorSymbol ? getTypeOfSymbol(promiseConstructorSymbol) : unknownType;
 if (promiseConstructorType === unknownType) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }
 const promiseConstructorName = getEntityNameFromTypeNode(node.type);
 if (promiseConstructorName === undefined) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, typeToString(returnType));
 return unknownType;
 }

 const globalPromiseConstructorLikeType = getGlobalPromiseConstructorLikeType();
 if (globalPromiseConstructorLikeType === emptyObjectType) {
 // If we couldn't resolve the global PromiseConstructorLike type we cannot verify
 // compatibility with __awaiter.
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }
 const promiseConstructorSymbol = resolveEntityName(promiseConstructorName, SymbolFlags.Value, /*ignoreErrors*/ true);
 const promiseConstructorType = promiseConstructorSymbol ? getTypeOfSymbol(promiseConstructorSymbol) : unknownType;
 if (promiseConstructorType === unknownType) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }

 if (!checkTypeAssignableTo(promiseConstructorType, globalPromiseConstructorLikeType, node.type,
 Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value)) {
 return unknownType;
 }
 const globalPromiseConstructorLikeType = getGlobalPromiseConstructorLikeType();
 if (globalPromiseConstructorLikeType === emptyObjectType) {
 // If we couldn't resolve the global PromiseConstructorLike type we cannot verify
 // compatibility with __awaiter.
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }

 // Verify there is no local declaration that could collide with the promise constructor.
 const rootName = promiseConstructorName && getFirstIdentifier(promiseConstructorName);
 const collidingSymbol = getSymbol(node.locals, rootName.text, SymbolFlags.Value);
 if (collidingSymbol) {
 error(collidingSymbol.valueDeclaration, Diagnostics.Duplicate_identifier_0_Compiler_uses_declaration_1_to_support_async_functions,
 rootName.text,
 entityNameToString(promiseConstructorName));
 return unknownType;
 if (!checkTypeAssignableTo(promiseConstructorType, globalPromiseConstructorLikeType, node.type,
 Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value)) {
 return unknownType;
 }

 // Verify there is no local declaration that could collide with the promise constructor.
 const rootName = promiseConstructorName && getFirstIdentifier(promiseConstructorName);
 const collidingSymbol = getSymbol(node.locals, rootName.text, SymbolFlags.Value);
 if (collidingSymbol) {
 error(collidingSymbol.valueDeclaration, Diagnostics.Duplicate_identifier_0_Compiler_uses_declaration_1_to_support_async_functions,
 rootName.text,
 entityNameToString(promiseConstructorName));
 return unknownType;
 }
 }

 // Get and return the awaited type of the return type.
 return checkAwaitedType(promiseType, node, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 return checkAwaitedType(returnType, node, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }

 /** Check a decorator */
Expand Down

4 changes: 4 additions & 0 deletions
src/compiler/diagnosticMessages.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1967,6 +1967,10 @@
 "category": "Error",
 "code": 2696
 },
 "An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.": {
 "category": "Error",
 "code": 2697
 },

 "Import declaration '{0}' is using private name '{1}'.": {
 "category": "Error",
Expand Down

4 changes: 2 additions & 2 deletions
tests/baselines/reference/asyncFunctionNoReturnType.errors.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
error TS2318: Cannot find global type 'Promise'.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS1057: An async function or method must have a valid awaitable return type.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS2697: An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS7030: Not all code paths return a value.
tests/cases/compiler/asyncFunctionNoReturnType.ts(2,9): error TS2304: Cannot find name 'window'.
tests/cases/compiler/asyncFunctionNoReturnType.ts(3,9): error TS7030: Not all code paths return a value.
Expand All@@ -9,7 +9,7 @@ tests/cases/compiler/asyncFunctionNoReturnType.ts(3,9): error TS7030: Not all co
==== tests/cases/compiler/asyncFunctionNoReturnType.ts (4 errors) ====
 async () => {
 ~~~~~~~~~~~~~
!!! error TS1057: An async function or method must have a valid awaitable return type.
!!! error TS2697: An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.
 ~~~~~~~~~~~~~
!!! error TS7030: Not all code paths return a value.
 if (window)
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Fix #11396: Make error message referene Promise explicitly#11982

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Mohamed Hegazy (mhegazy)
merged 2 commits into

from

Nov 2, 2016
 Merged


Fix #11396: Make error message referene Promise explicitly
#11982
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
859aa30

Simplify the checking for async function return type


mhegazy Nov 1, 2016
3435727

Fix https://github.com/Microsoft/TypeScript/issues/11396: Make error …


mhegazy Nov 1, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


131 changes: 51 additions & 80 deletions
src/compiler/checker.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13073,7 +13073,7 @@ namespace ts {
 function createPromiseReturnType(func: FunctionLikeDeclaration, promisedType: Type) {
 const promiseType = createPromiseType(promisedType);
 if (promiseType === emptyObjectType) {
 error(func, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 error(func, Diagnostics.An_async_function_or_method_must_return_a_Promise_Make_sure_you_have_a_declaration_for_Promise_or_include_ES2015_in_your_lib_option);
 return unknownType;
 }

Expand DownExpand Up@@ -15515,36 +15515,6 @@ namespace ts {
 }
 }

 /**
 * Checks that the return type provided is an instantiation of the global Promise<T> type
 * and returns the awaited type of the return type.
 *
 * @param returnType The return type of a FunctionLikeDeclaration
 * @param location The node on which to report the error.
 */
 function checkCorrectPromiseType(returnType: Type, location: Node, diagnostic: DiagnosticMessage, typeName?: string) {
 if (returnType === unknownType) {
 // The return type already had some other error, so we ignore and return
 // the unknown type.
 return unknownType;
 }

 const globalPromiseType = getGlobalPromiseType();
 if (globalPromiseType === emptyGenericType
 || globalPromiseType === getTargetType(returnType)) {
 // Either we couldn't resolve the global promise type, which would have already
 // reported an error, or we could resolve it and the return type is a valid type
 // reference to the global type. In either case, we return the awaited type for
 // the return type.
 return checkAwaitedType(returnType, location, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }

 // The promise type was not a valid type reference to the global promise type, so we
 // report an error and return the unknown type.
 error(location, diagnostic, typeName);
 return unknownType;
 }

 /**
 * Checks the return type of an async function to ensure it is a compatible
 * Promise implementation.
Expand All@@ -15559,11 +15529,6 @@ namespace ts {
 * @param node The signature to check
 */
 function checkAsyncFunctionReturnType(node: FunctionLikeDeclaration): Type {
 if (languageVersion >= ScriptTarget.ES2015) {
 const returnType = getTypeFromTypeNode(node.type);
 return checkCorrectPromiseType(returnType, node.type, Diagnostics.The_return_type_of_an_async_function_or_method_must_be_the_global_Promise_T_type);
 }

 // As part of our emit for an async function, we will need to emit the entity name of
 // the return type annotation as an expression. To meet the necessary runtime semantics
 // for __awaiter, we must also check that the type of the declaration (e.g. the static
Expand All@@ -15588,61 +15553,67 @@ namespace ts {
 // then<U>(...): Promise<U>;
 // }
 //
 const returnType = getTypeFromTypeNode(node.type);

 // Always mark the type node as referenced if it points to a value
 markTypeNodeAsReferenced(node.type);

 const promiseConstructorName = getEntityNameFromTypeNode(node.type);
 const promiseType = getTypeFromTypeNode(node.type);
 if (promiseType === unknownType) {
 if (!compilerOptions.isolatedModules) {
 if (promiseConstructorName) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 }
 else {
 error(node.type, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }
 if (languageVersion >= ScriptTarget.ES2015) {
 if (returnType === unknownType) {
 return unknownType;
 }
 const globalPromiseType = getGlobalPromiseType();
 if (globalPromiseType !== emptyGenericType && globalPromiseType !== getTargetType(returnType)) {
 // The promise type was not a valid type reference to the global promise type, so we
 // report an error and return the unknown type.
 error(node.type, Diagnostics.The_return_type_of_an_async_function_or_method_must_be_the_global_Promise_T_type);
 return unknownType;
 }
 return unknownType;
 }
 else {
 // Always mark the type node as referenced if it points to a value
 markTypeNodeAsReferenced(node.type);

 if (promiseConstructorName === undefined) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, typeToString(promiseType));
 return unknownType;
 }
 if (returnType === unknownType) {
 return unknownType;
 }

 const promiseConstructorSymbol = resolveEntityName(promiseConstructorName, SymbolFlags.Value, /*ignoreErrors*/ true);
 const promiseConstructorType = promiseConstructorSymbol ? getTypeOfSymbol(promiseConstructorSymbol) : unknownType;
 if (promiseConstructorType === unknownType) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }
 const promiseConstructorName = getEntityNameFromTypeNode(node.type);
 if (promiseConstructorName === undefined) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, typeToString(returnType));
 return unknownType;
 }

 const globalPromiseConstructorLikeType = getGlobalPromiseConstructorLikeType();
 if (globalPromiseConstructorLikeType === emptyObjectType) {
 // If we couldn't resolve the global PromiseConstructorLike type we cannot verify
 // compatibility with __awaiter.
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }
 const promiseConstructorSymbol = resolveEntityName(promiseConstructorName, SymbolFlags.Value, /*ignoreErrors*/ true);
 const promiseConstructorType = promiseConstructorSymbol ? getTypeOfSymbol(promiseConstructorSymbol) : unknownType;
 if (promiseConstructorType === unknownType) {
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }

 if (!checkTypeAssignableTo(promiseConstructorType, globalPromiseConstructorLikeType, node.type,
 Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value)) {
 return unknownType;
 }
 const globalPromiseConstructorLikeType = getGlobalPromiseConstructorLikeType();
 if (globalPromiseConstructorLikeType === emptyObjectType) {
 // If we couldn't resolve the global PromiseConstructorLike type we cannot verify
 // compatibility with __awaiter.
 error(node.type, Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value, entityNameToString(promiseConstructorName));
 return unknownType;
 }

 // Verify there is no local declaration that could collide with the promise constructor.
 const rootName = promiseConstructorName && getFirstIdentifier(promiseConstructorName);
 const collidingSymbol = getSymbol(node.locals, rootName.text, SymbolFlags.Value);
 if (collidingSymbol) {
 error(collidingSymbol.valueDeclaration, Diagnostics.Duplicate_identifier_0_Compiler_uses_declaration_1_to_support_async_functions,
 rootName.text,
 entityNameToString(promiseConstructorName));
 return unknownType;
 if (!checkTypeAssignableTo(promiseConstructorType, globalPromiseConstructorLikeType, node.type,
 Diagnostics.Type_0_is_not_a_valid_async_function_return_type_in_ES5_SlashES3_because_it_does_not_refer_to_a_Promise_compatible_constructor_value)) {
 return unknownType;
 }

 // Verify there is no local declaration that could collide with the promise constructor.
 const rootName = promiseConstructorName && getFirstIdentifier(promiseConstructorName);
 const collidingSymbol = getSymbol(node.locals, rootName.text, SymbolFlags.Value);
 if (collidingSymbol) {
 error(collidingSymbol.valueDeclaration, Diagnostics.Duplicate_identifier_0_Compiler_uses_declaration_1_to_support_async_functions,
 rootName.text,
 entityNameToString(promiseConstructorName));
 return unknownType;
 }
 }

 // Get and return the awaited type of the return type.
 return checkAwaitedType(promiseType, node, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 return checkAwaitedType(returnType, node, Diagnostics.An_async_function_or_method_must_have_a_valid_awaitable_return_type);
 }

 /** Check a decorator */
Expand Down

4 changes: 4 additions & 0 deletions
src/compiler/diagnosticMessages.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1967,6 +1967,10 @@
 "category": "Error",
 "code": 2696
 },
 "An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.": {
 "category": "Error",
 "code": 2697
 },

 "Import declaration '{0}' is using private name '{1}'.": {
 "category": "Error",
Expand Down

4 changes: 2 additions & 2 deletions
tests/baselines/reference/asyncFunctionNoReturnType.errors.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
error TS2318: Cannot find global type 'Promise'.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS1057: An async function or method must have a valid awaitable return type.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS2697: An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.
tests/cases/compiler/asyncFunctionNoReturnType.ts(1,1): error TS7030: Not all code paths return a value.
tests/cases/compiler/asyncFunctionNoReturnType.ts(2,9): error TS2304: Cannot find name 'window'.
tests/cases/compiler/asyncFunctionNoReturnType.ts(3,9): error TS7030: Not all code paths return a value.
Expand All@@ -9,7 +9,7 @@ tests/cases/compiler/asyncFunctionNoReturnType.ts(3,9): error TS7030: Not all co
==== tests/cases/compiler/asyncFunctionNoReturnType.ts (4 errors) ====
 async () => {
 ~~~~~~~~~~~~~
!!! error TS1057: An async function or method must have a valid awaitable return type.
!!! error TS2697: An async function or method must return a 'Promise'. Make sure you have a declaration for 'Promise' or include 'ES2015' in your `--lib` option.
 ~~~~~~~~~~~~~
!!! error TS7030: Not all code paths return a value.
 if (window)
Expand Down