Skip to content

Only provide suggestion for outermost async fix #29214

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.

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
merged 3 commits into from
Jan 1, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 21 additions & 7 deletions src/services/suggestionDiagnostics.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
/* @internal */
namespace ts {
const visitedNestedConvertibleFunctions = createMap<true>();

export function computeSuggestionDiagnostics(sourceFile: SourceFile, program: Program, cancellationToken: CancellationToken): DiagnosticWithLocation[] {
program.getSemanticDiagnostics(sourceFile, cancellationToken);
const diags: DiagnosticWithLocation[] = [];
Expand All @@ -13,6 +15,7 @@ namespace ts {

const isJsFile = isSourceFileJS(sourceFile);

visitedNestedConvertibleFunctions.clear();
check(sourceFile);

if (getAllowSyntheticDefaultImports(program.getCompilerOptions())) {
Expand Down Expand Up @@ -114,17 +117,22 @@ namespace ts {
}

function addConvertToAsyncFunctionDiagnostics(node: FunctionLikeDeclaration, checker: TypeChecker, diags: Push<DiagnosticWithLocation>): void {
if (!isAsyncFunction(node) &&
node.body &&
isBlock(node.body) &&
hasReturnStatementWithPromiseHandler(node.body) &&
returnsPromise(node, checker)) {
// need to check function before checking map so that deeper levels of nested callbacks are checked
if (isConvertibleFunction(node, checker) && !visitedNestedConvertibleFunctions.has(getKeyFromNode(node))) {
diags.push(createDiagnosticForNode(
!node.name && isVariableDeclaration(node.parent) && isIdentifier(node.parent.name) ? node.parent.name : node,
Diagnostics.This_may_be_converted_to_an_async_function));
}
}

function isConvertibleFunction(node: FunctionLikeDeclaration, checker: TypeChecker) {
return !isAsyncFunction(node) &&
node.body &&
isBlock(node.body) &&
hasReturnStatementWithPromiseHandler(node.body) &&
returnsPromise(node, checker);
}

function returnsPromise(node: FunctionLikeDeclaration, checker: TypeChecker): boolean {
const functionType = checker.getTypeAtLocation(node);
const callSignatures = checker.getSignaturesOfType(functionType, SignatureKind.Call);
Expand Down Expand Up @@ -169,14 +177,20 @@ namespace ts {
// should be kept up to date with getTransformationBody in convertToAsyncFunction.ts
function isFixablePromiseArgument(arg: Expression): boolean {
switch (arg.kind) {
case SyntaxKind.NullKeyword:
case SyntaxKind.Identifier: // identifier includes undefined
case SyntaxKind.FunctionDeclaration:
case SyntaxKind.FunctionExpression:
case SyntaxKind.ArrowFunction:
visitedNestedConvertibleFunctions.set(getKeyFromNode(arg as FunctionLikeDeclaration), true);
/* falls through */
case SyntaxKind.NullKeyword:
case SyntaxKind.Identifier: // identifier includes undefined
return true;
default:
return false;
}
}

function getKeyFromNode(exp: FunctionLikeDeclaration) {
return `${exp.pos.toString()}:${exp.end.toString()}`;
}
}
42 changes: 31 additions & 11 deletions src/testRunner/unittests/services/convertToAsyncFunction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ interface String { charAt: any; }
interface Array<T> {}`
};

function testConvertToAsyncFunction(caption: string, text: string, baselineFolder: string, includeLib?: boolean, expectFailure = false) {
function testConvertToAsyncFunction(caption: string, text: string, baselineFolder: string, includeLib?: boolean, expectFailure = false, onlyProvideAction = false) {
const t = extractTest(text);
const selectionRange = t.ranges.get("selection")!;
if (!selectionRange) {
Expand Down Expand Up @@ -307,7 +307,7 @@ interface Array<T> {}`

const actions = codefix.getFixes(context);
const action = find(actions, action => action.description === Diagnostics.Convert_to_async_function.message);
if (expectFailure) {
if (expectFailure && !onlyProvideAction) {
assert.isNotTrue(action && action.changes.length > 0);
return;
}
Expand Down Expand Up @@ -1151,25 +1151,25 @@ function [#|f|]() {
_testConvertToAsyncFunction("convertToAsyncFunction_simpleFunctionExpression", `
const [#|foo|] = function () {
return fetch('https://typescriptlang.org').then(result => { console.log(result) });
}
}
`);

_testConvertToAsyncFunction("convertToAsyncFunction_simpleFunctionExpressionWithName", `
const foo = function [#|f|]() {
return fetch('https://typescriptlang.org').then(result => { console.log(result) });
}
}
`);

_testConvertToAsyncFunction("convertToAsyncFunction_simpleFunctionExpressionAssignedToBindingPattern", `
const { length } = [#|function|] () {
return fetch('https://typescriptlang.org').then(result => { console.log(result) });
}
}
`);

_testConvertToAsyncFunction("convertToAsyncFunction_catchBlockUniqueParams", `
function [#|f|]() {
return Promise.resolve().then(x => 1).catch(x => "a").then(x => !!x);
}
return Promise.resolve().then(x => 1).catch(x => "a").then(x => !!x);
}
`);

_testConvertToAsyncFunction("convertToAsyncFunction_bindingPattern", `
Expand All @@ -1178,7 +1178,7 @@ function [#|f|]() {
}
function res({ status, trailer }){
console.log(status);
}
}
`);

_testConvertToAsyncFunction("convertToAsyncFunction_bindingPatternNameCollision", `
Expand All @@ -1188,7 +1188,7 @@ function [#|f|]() {
}
function res({ status, trailer }){
console.log(status);
}
}
`);

_testConvertToAsyncFunctionFailed("convertToAsyncFunction_thenArgumentNotFunction", `
Expand All @@ -1209,7 +1209,7 @@ function [#|f|]() {
}
function res(result) {
return Promise.resolve().then(x => console.log(result));
}
}
`);

_testConvertToAsyncFunction("convertToAsyncFunction_callbackReturnsPromise", `
Expand Down Expand Up @@ -1241,7 +1241,7 @@ function [#|f|]() {
return Promise.resolve(1)
.then(x => Promise.reject(x))
.catch(err => console.log(err));
}
}
`);

_testConvertToAsyncFunction("convertToAsyncFunction_nestedPromises", `
Expand All @@ -1266,6 +1266,22 @@ _testConvertToAsyncFunction("convertToAsyncFunction_exportModifier", `
export function [#|foo|]() {
return fetch('https://typescriptlang.org').then(s => console.log(s));
}
`);

_testConvertToAsyncFunction("convertToAsyncFunction_OutermostOnlySuccess", `
function [#|foo|]() {
return fetch('a').then(() => {
return fetch('b').then(() => 'c');
})
}
`);

_testConvertToAsyncFunctionFailedSuggestion("convertToAsyncFunction_OutermostOnlyFailure", `
function foo() {
return fetch('a').then([#|() => {|]
return fetch('b').then(() => 'c');
})
}
`);
});

Expand All @@ -1276,4 +1292,8 @@ export function [#|foo|]() {
function _testConvertToAsyncFunctionFailed(caption: string, text: string) {
testConvertToAsyncFunction(caption, text, "convertToAsyncFunction", /*includeLib*/ true, /*expectFailure*/ true);
}

function _testConvertToAsyncFunctionFailedSuggestion(caption: string, text: string) {
testConvertToAsyncFunction(caption, text, "convertToAsyncFunction", /*includeLib*/ true, /*expectFailure*/ true, /*onlyProvideAction*/ true);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// ==ORIGINAL==

function foo() {
return fetch('a').then(/*[#|*/() => {/*|]*/
return fetch('b').then(() => 'c');
})
}

// ==ASYNC FUNCTION::Convert to async function==

function foo() {
return fetch('a').then(async () => {
await fetch('b');
return 'c';
})
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// ==ORIGINAL==

function /*[#|*/foo/*|]*/() {
return fetch('a').then(() => {
return fetch('b').then(() => 'c');
})
}

// ==ASYNC FUNCTION::Convert to async function==

async function foo() {
await fetch('a');
await fetch('b');
return 'c';
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// ==ORIGINAL==

function /*[#|*/foo/*|]*/() {
return fetch('a').then(() => {
return fetch('b').then(() => 'c');
})
}

// ==ASYNC FUNCTION::Convert to async function==

async function foo() {
await fetch('a');
await fetch('b');
return 'c';
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ function /*[#|*/f/*|]*/() {
}
function res({ status, trailer }){
console.log(status);
}
}

// ==ASYNC FUNCTION::Convert to async function==

Expand All @@ -15,4 +15,4 @@ async function f() {
}
function res({ status, trailer }){
console.log(status);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ function /*[#|*/f/*|]*/() {
}
function res({ status, trailer }){
console.log(status);
}
}

// ==ASYNC FUNCTION::Convert to async function==

Expand All @@ -15,4 +15,4 @@ async function f() {
}
function res({ status, trailer }){
console.log(status);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ function /*[#|*/f/*|]*/() {
}
function res({ status, trailer }){
console.log(status);
}
}

// ==ASYNC FUNCTION::Convert to async function==

Expand All @@ -17,4 +17,4 @@ async function f() {
}
function res({ status, trailer }){
console.log(status);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ function /*[#|*/f/*|]*/() {
}
function res({ status, trailer }){
console.log(status);
}
}

// ==ASYNC FUNCTION::Convert to async function==

Expand All @@ -17,4 +17,4 @@ async function f() {
}
function res({ status, trailer }){
console.log(status);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ function /*[#|*/f/*|]*/() {
return Promise.resolve(1)
.then(x => Promise.reject(x))
.catch(err => console.log(err));
}
}

// ==ASYNC FUNCTION::Convert to async function==

Expand All @@ -16,4 +16,4 @@ async function f() {
catch (err) {
return console.log(err);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ function /*[#|*/f/*|]*/() {
return Promise.resolve(1)
.then(x => Promise.reject(x))
.catch(err => console.log(err));
}
}

// ==ASYNC FUNCTION::Convert to async function==

Expand All @@ -16,4 +16,4 @@ async function f() {
catch (err) {
return console.log(err);
}
}
}
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// ==ORIGINAL==

function /*[#|*/f/*|]*/() {
return Promise.resolve().then(x => 1).catch(x => "a").then(x => !!x);
}
return Promise.resolve().then(x => 1).catch(x => "a").then(x => !!x);
}

// ==ASYNC FUNCTION::Convert to async function==

Expand All @@ -15,5 +15,5 @@ async function f() {
catch (x_1) {
x_2 = "a";
}
return !!x_2;
}
return !!x_2;
}
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// ==ORIGINAL==

function /*[#|*/f/*|]*/() {
return Promise.resolve().then(x => 1).catch(x => "a").then(x => !!x);
}
return Promise.resolve().then(x => 1).catch(x => "a").then(x => !!x);
}

// ==ASYNC FUNCTION::Convert to async function==

Expand All @@ -15,5 +15,5 @@ async function f() {
catch (x_1) {
x_2 = "a";
}
return !!x_2;
}
return !!x_2;
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ function /*[#|*/f/*|]*/() {
}
function res(result) {
return Promise.resolve().then(x => console.log(result));
}
}

// ==ASYNC FUNCTION::Convert to async function==

Expand All @@ -16,4 +16,4 @@ async function f() {
}
function res(result) {
return Promise.resolve().then(x => console.log(result));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ function /*[#|*/f/*|]*/() {
}
function res(result) {
return Promise.resolve().then(x => console.log(result));
}
}

// ==ASYNC FUNCTION::Convert to async function==

Expand All @@ -16,4 +16,4 @@ async function f() {
}
function res(result) {
return Promise.resolve().then(x => console.log(result));
}
}
Loading