Merge pull request #56 from ilya-hontarau/fix/incorrect-handling-variadic-functions

Fix handling variadic functions

Author: fe3dback

internal/services/checker/deepscan/models.go

@@ -19,6 +19,7 @@ type (
 		ArgumentDefinition Source           // where method param type defined (func (a,b,c _int_))
 		Interface          Interface        // used interface for injection
 		Implementations    []Implementation // all code links to this param
+		IsVariadic         bool             // function param is variadic (func (a bool, nums ...int))
 	}
 
 	Interface struct {

internal/services/checker/deepscan/searcher_find_implementations.go

@@ -131,43 +131,57 @@ func (s *Searcher) applyMethodImplementationsInPackages(method *InjectionMethod,
 				for gateIndex := range method.Gates {
 					gate := &method.Gates[gateIndex]
 					callMethod := callExpr.Fun
-					callParam := callExpr.Args[gate.Index]
-
-					paramType := astPackage.TypesInfo.TypeOf(callParam)
-					targetName, targetPos, valid := s.extractTargetFromCallParam(paramType)
-					if !valid {
-						// unknown injection type, possible generics or other not known
-						// go features on current moment
-						// we can extend this function later for new cases
-						continue
-					}
 
-					targetDefinitions := s.sourceFromToken(targetPos)
-					if targetDefinitions.Import == method.Definition.Import {
-						// injector use our public interface for typing
-						// we exclude this cases from more deep analyse, because of runtime
-						// types injection. (we have not known type on compile time)
+					// variadic function arguments may be absent in callExpr.Args
+					if gate.IsVariadic && len(callExpr.Args) <= gate.Index {
 						continue
 					}
-
-					if !targetDefinitions.Place.Valid {
-						// invalid target
-						// possible is some not importable std const like `errors`
-						// or not known ast at this moment
-						continue
+					maxIdx := gate.Index
+					if gate.IsVariadic {
+						// variadic function arguments are passed as individual elements in callExpr.Args
+						// iterate over callExpr.Args to process all variadic arguments
+						maxIdx = len(callExpr.Args) - 1
 					}
 
-					gate.Implementations = append(gate.Implementations, Implementation{
-						Injector: Injector{
-							CodeName:         s.extractCodeFromASTNode(callParam),
-							ParamDefinition:  s.sourceFromToken(callParam.Pos()),
-							MethodDefinition: s.sourceFromToken(callMethod.Pos()),
-						},
-						Target: Target{
-							StructName: targetName,
-							Definition: targetDefinitions,
-						},
-					})
+					for idx := gate.Index; idx <= maxIdx; idx++ {
+						callParam := callExpr.Args[idx]
+
+						paramType := astPackage.TypesInfo.TypeOf(callParam)
+						targetName, targetPos, valid := s.extractTargetFromCallParam(paramType)
+						if !valid {
+							// unknown injection type, possible generics or other not known
+							// go features on current moment
+							// we can extend this function later for new cases
+							continue
+						}
+
+						targetDefinitions := s.sourceFromToken(targetPos)
+						if targetDefinitions.Import == method.Definition.Import {
+							// injector use our public interface for typing
+							// we exclude this cases from more deep analyse, because of runtime
+							// types injection. (we have not known type on compile time)
+							continue
+						}
+
+						if !targetDefinitions.Place.Valid {
+							// invalid target
+							// possible is some not importable std const like `errors`
+							// or not known ast at this moment
+							continue
+						}
+
+						gate.Implementations = append(gate.Implementations, Implementation{
+							Injector: Injector{
+								CodeName:         s.extractCodeFromASTNode(callParam),
+								ParamDefinition:  s.sourceFromToken(callParam.Pos()),
+								MethodDefinition: s.sourceFromToken(callMethod.Pos()),
+							},
+							Target: Target{
+								StructName: targetName,
+								Definition: targetDefinitions,
+							},
+						})
+					}
 				}
 			})
 		}

internal/services/checker/deepscan/searcher_parse_methods.go

@@ -84,6 +84,11 @@ func (s *Searcher) extractMethodGates(astPackage *packages.Package, method *ast.
 				pos = field.Pos()
 			}
 
+			var isVariadic bool
+			if _, ok := field.Type.(*ast.Ellipsis); ok {
+				isVariadic = true
+			}
+
 			params = append(params, Gate{
 				MethodName:         method.Name.Name,
 				ParamName:          fieldIdent.Name,
@@ -95,6 +100,7 @@ func (s *Searcher) extractMethodGates(astPackage *packages.Package, method *ast.
 					Definition: s.sourceFromToken(pos),
 					GoType:     paramType.String(),
 				},
+				IsVariadic: isVariadic,
 			})
 		}
 	}

test/check/arch3_variadic.ct

@@ -0,0 +1,8 @@
+$ go-arch-lint check --project-path ${PWD}/test/check/project --arch-file arch3_variadic.yml --output-color=false
+module: github.com/fe3dback/go-arch-lint/test/check/project
+linters:
+   On | Base: component imports # always on
+   On | Advanced: vendor imports # switch 'allow.depOnAnyVendor = false' (or delete) to on
+   On | Advanced: method calls and dependency injections # switch 'allow.deepScan = true' (or delete) to on
+
+OK - No warnings found

test/check/project/arch1_nested_glob.yml

@@ -6,6 +6,7 @@ allow:
 exclude:
   - internal/excluded
   - vendor
+  - variadic
 
 excludeFiles:
   - "^.*_test\\.go$"

test/check/project/arch1_ok.yml

@@ -6,6 +6,7 @@ allow:
 exclude:
   - internal/excluded
   - vendor
+  - variadic
 
 excludeFiles:
   - "^.*_test\\.go$"

test/check/project/arch1_warnings.yml

@@ -6,6 +6,7 @@ allow:
 exclude:
   - internal/excluded
   - vendor
+  - variadic
 
 excludeFiles:
   - "^.*_test\\.go$"

test/check/project/arch2_ok_fallback.yml

@@ -6,6 +6,7 @@ allow:
 exclude:
   - internal/excluded
   - vendor
+  - variadic
 
 excludeFiles:
   - "^.*_test\\.go$"

test/check/project/arch3_variadic.yml

@@ -0,0 +1,19 @@
+version: 3
+
+workdir:
+  variadic
+
+allow:
+  depOnAnyVendor: false
+  deepScan: true
+
+components:
+  foo: { in: foo }
+  use_foo: { in: use_foo }
+
+deps:
+  foo:
+    anyProjectDeps: true
+
+  use_foo:
+    anyProjectDeps: true

test/check/project/variadic/foo/error.go

@@ -0,0 +1,11 @@
+package foo
+
+import (
+	"fmt"
+)
+
+type Foo []string
+
+func FooF(message string, args ...any) Foo {
+	return Foo{fmt.Sprintf(message, args)}
+}