gopls/internal/lsp/source: put context first in extracted functions

Put the context first when extracting functions/methods

Fixes golang/go#60738

Change-Id: I04f86355ffa0c7b080a8aea82baf0947722b6440
GitHub-Last-Rev: 5267944
GitHub-Pull-Request: #440
Reviewed-on: https://go-review.googlesource.com/c/tools/+/503295
Reviewed-by: Robert Findley <[email protected]>
TryBot-Result: Gopher Robot <[email protected]>
Run-TryBot: Robert Findley <[email protected]>
gopls-CI: kokoro <[email protected]>
Reviewed-by: Joedian Reid <[email protected]>
Reviewed-by: Alan Donovan <[email protected]>

Author: vikstrous2

gopls/internal/lsp/source/extract.go

@@ -363,6 +363,8 @@ func extractFunctionMethod(fset *token.FileSet, start, end token.Pos, src []byte
 		}
 	}
 
+	reorderParams(params, paramTypes)
+
 	// Find the function literal that encloses the selection. The enclosing function literal
 	// may not be the enclosing function declaration (i.e. 'outer'). For example, in the
 	// following block:
@@ -631,6 +633,33 @@ func extractFunctionMethod(fset *token.FileSet, start, end token.Pos, src []byte
 	}, nil
 }
 
+// isSelector reports if e is the selector expr <x>, <sel>.
+func isSelector(e ast.Expr, x, sel string) bool {
+	selectorExpr, ok := e.(*ast.SelectorExpr)
+	if !ok {
+		return false
+	}
+	ident, ok := selectorExpr.X.(*ast.Ident)
+	if !ok {
+		return false
+	}
+	return ident.Name == x && selectorExpr.Sel.Name == sel
+}
+
+// reorderParams reorders the given parameters in-place to follow common Go conventions.
+func reorderParams(params []ast.Expr, paramTypes []*ast.Field) {
+	// Move Context parameter (if any) to front.
+	for i, t := range paramTypes {
+		if isSelector(t.Type, "context", "Context") {
+			p, t := params[i], paramTypes[i]
+			copy(params[1:], params[:i])
+			copy(paramTypes[1:], paramTypes[:i])
+			params[0], paramTypes[0] = p, t
+			break
+		}
+	}
+}
+
 // adjustRangeForCommentsAndWhiteSpace adjusts the given range to exclude unnecessary leading or
 // trailing whitespace characters from selection as well as leading or trailing comments.
 // In the following example, each line of the if statement is indented once. There are also two

gopls/internal/lsp/testdata/extract/extract_method/extract_context.go

@@ -0,0 +1,20 @@
+package extract
+
+import "context"
+
+type B struct {
+	x int
+	y int
+}
+
+func (b *B) AddP(ctx context.Context) (int, error) {
+	sum := b.x + b.y
+	return sum, ctx.Err() //@extractmethod("return", "ctx.Err()"),extractfunc("return", "ctx.Err()")
+}
+
+func (b *B) LongList(ctx context.Context) (int, error) {
+	p1 := 1
+	p2 := 1
+	p3 := 1
+	return p1 + p2 + p3, ctx.Err() //@extractmethod("return", "ctx.Err()"),extractfunc("return", "ctx.Err()")
+}

gopls/internal/lsp/testdata/extract/extract_method/extract_context.go.golden

@@ -0,0 +1,52 @@
+-- methodextraction_extract_context_12_2 --
+package extract
+
+import "context"
+
+type B struct {
+	x int
+	y int
+}
+
+func (b *B) AddP(ctx context.Context) (int, error) {
+	sum := b.x + b.y
+	return b.newMethod(ctx, sum) //@extractmethod("return", "ctx.Err()"),extractfunc("return", "ctx.Err()")
+}
+
+func (*B) newMethod(ctx context.Context, sum int) (int, error) {
+	return sum, ctx.Err()
+}
+
+func (b *B) LongList(ctx context.Context) (int, error) {
+	p1 := 1
+	p2 := 1
+	p3 := 1
+	return p1 + p2 + p3, ctx.Err() //@extractmethod("return", "ctx.Err()"),extractfunc("return", "ctx.Err()")
+}
+
+-- methodextraction_extract_context_19_2 --
+package extract
+
+import "context"
+
+type B struct {
+	x int
+	y int
+}
+
+func (b *B) AddP(ctx context.Context) (int, error) {
+	sum := b.x + b.y
+	return sum, ctx.Err() //@extractmethod("return", "ctx.Err()"),extractfunc("return", "ctx.Err()")
+}
+
+func (b *B) LongList(ctx context.Context) (int, error) {
+	p1 := 1
+	p2 := 1
+	p3 := 1
+	return b.newMethod(ctx, p1, p2, p3) //@extractmethod("return", "ctx.Err()"),extractfunc("return", "ctx.Err()")
+}
+
+func (*B) newMethod(ctx context.Context, p1 int, p2 int, p3 int) (int, error) {
+	return p1 + p2 + p3, ctx.Err()
+}
+

gopls/internal/lsp/testdata/summary.txt.golden

@@ -12,7 +12,7 @@ DiagnosticsCount = 23
 FoldingRangesCount = 2
 SemanticTokenCount = 3
 SuggestedFixCount = 73
-MethodExtractionCount = 6
+MethodExtractionCount = 8
 DefinitionsCount = 46
 TypeDefinitionsCount = 18
 HighlightsCount = 70

gopls/internal/lsp/testdata/summary_go1.18.txt.golden

@@ -12,7 +12,7 @@ DiagnosticsCount = 23
 FoldingRangesCount = 2
 SemanticTokenCount = 3
 SuggestedFixCount = 79
-MethodExtractionCount = 6
+MethodExtractionCount = 8
 DefinitionsCount = 46
 TypeDefinitionsCount = 18
 HighlightsCount = 70

gopls/internal/lsp/testdata/summary_go1.21.txt.golden

@@ -12,7 +12,7 @@ DiagnosticsCount = 24
 FoldingRangesCount = 2
 SemanticTokenCount = 3
 SuggestedFixCount = 79
-MethodExtractionCount = 6
+MethodExtractionCount = 8
 DefinitionsCount = 46
 TypeDefinitionsCount = 18
 HighlightsCount = 70