Support RuntimeConfig API v2 (#96)

Author: derekhuizhang

pkg/golinters/runtimeconfig.go

@@ -47,62 +47,74 @@ func run(pass *analysis.Pass) (interface{}, error) {
 	i.Preorder(nodeFilter, func(n ast.Node) {
 		call := n.(*ast.CallExpr)
 		target := typeutil.Callee(pass.TypesInfo, call)
-		numArgs := 3
+		numArgs := len(call.Args)
 		if target == nil {
 			return
 		} else if target.Pkg() == nil || !(target.Pkg().Path() == "ghe.anduril.dev/anduril/graphene-go/pkg/graphene" &&
-			(target.Name() == getFn || target.Name() == subscribeFn)) || len(call.Args) != numArgs {
+			((target.Name() == getFn && (numArgs == 2 || numArgs == 3)) ||
+				(target.Name() == subscribeFn) && numArgs != 3)) {
 			return
 		}
 		if selector, ok := call.Fun.(*ast.SelectorExpr); ok {
 			fnName := selector.Sel.Name
 			isGetConfig := fnName == getFn
 			isSubscribeConfig := fnName == subscribeFn
 			if isGetConfig || isSubscribeConfig {
-				defaultConfArg := call.Args[1]
-				defaultConfArgType := pass.TypesInfo.Types[defaultConfArg].Type
-				defaultConfig := getStructType(defaultConfArgType)
-				if defaultConfig == nil {
-					pass.Reportf(
-						defaultConfArg.Pos(),
-						"expected 2nd arg to be non nil but got %v",
-						defaultConfig,
-					)
-					return
-				}
-				validateFieldSerialization(pass, defaultConfArg.Pos(), defaultConfig, defaultConfArgType.String())
-				arg3 := call.Args[2]
-				if isSubscribeConfig {
-					validateTypeConversion(arg3, defaultConfArgType.String(), pass)
-				} else if isGetConfig {
-					checkPointerArg(arg3, "", defaultConfArgType.String(), arg3.Pos(), pass, false)
+				if numArgs == 3 {
+					// Using Subscribe or Get from RuntimeConfig
+					defaultConfArg := call.Args[1]
+					defaultConfArgType := pass.TypesInfo.Types[defaultConfArg].Type
+					defaultConfig := getStructType(defaultConfArgType)
+					if defaultConfig == nil {
+						pass.Reportf(
+							defaultConfArg.Pos(),
+							"expected 2nd arg to be non nil but got %v",
+							defaultConfig,
+						)
+						return
+					}
+					validateFieldSerialization(pass, defaultConfArg.Pos(), defaultConfig, defaultConfArgType.String())
+					arg3 := call.Args[2]
+					if isSubscribeConfig {
+						validateTypeConversion(arg3, defaultConfArgType.String(), pass)
+					} else if isGetConfig {
+						checkPointerArg(arg3, "", defaultConfArgType.String(), arg3.Pos(), pass, "3rd", false)
+					}
+				} else {
+					// Using Get from RuntimeConfigV2
+					arg2 := call.Args[1]
+					checkPointerArg(arg2, "", "", arg2.Pos(), pass, "2nd", false)
 				}
 			}
 		}
 	})
 	return nil, nil
 }
 
-func checkPointerArg(arg ast.Expr, argName, defType string, pos token.Pos, pass *analysis.Pass, isRef bool) {
+func checkPointerArg(arg ast.Expr, argName, defType string, pos token.Pos, pass *analysis.Pass, numArgsString string, isRef bool) {
 	switch t := arg.(type) {
 	case *ast.Ident:
 		if t.Obj == nil {
-			pass.Reportf(t.Pos(), "expected configuration object as 3rd arg but got nil")
+			pass.Reportf(t.Pos(), "expected configuration object as %s arg but got nil", numArgsString)
 			return
 		}
 		if varDec, ok := t.Obj.Decl.(*ast.AssignStmt); ok {
 			if len(varDec.Rhs) == 1 {
-				checkPointerArg(varDec.Rhs[0], t.Name, defType, pos, pass, isRef)
+				checkPointerArg(varDec.Rhs[0], t.Name, defType, pos, pass, numArgsString, isRef)
 			}
 		}
 	case *ast.UnaryExpr:
 		if !t.Op.IsOperator() || t.Op.String() != "&" {
-			pass.Reportf(pos, "expected ref as 3rd arg to Get")
+			pass.Reportf(pos, "expected ref as %s arg to Get", numArgsString)
 		}
-		checkPointerArg(t.X, argName, defType, pos, pass, true)
+		checkPointerArg(t.X, argName, defType, pos, pass, numArgsString, true)
 	case *ast.CompositeLit:
 		if !isRef {
-			pass.Reportf(pos, "expected ref as 3rd arg to Get")
+			pass.Reportf(pos, "expected ref as %s arg to Get", numArgsString)
+		}
+		if defType == "" {
+			// Using RuntimeConfigV2, skip SameType checks
+			return
 		}
 		switch sl := t.Type.(type) {
 		case *ast.Ident:
@@ -112,10 +124,10 @@ func checkPointerArg(arg ast.Expr, argName, defType string, pos token.Pos, pass
 		}
 	case *ast.SelectorExpr:
 		if !isRef {
-			pass.Reportf(pos, "expected ref as 3rd arg to Get")
+			pass.Reportf(pos, "expected ref as %s arg to Get", numArgsString)
 		}
 	default:
-		pass.Reportf(pos, "expected ref as 3rd arg to Get")
+		pass.Reportf(pos, "expected ref as %s arg to Get", numArgsString)
 	}
 }
 

test/testdata/runtimeconfig_test.go

@@ -61,6 +61,21 @@ func GetTest() {
 
 	// valid usage
 	rtc.Get("", T1{}, &t1)
+
+	rtcv2 := setupv2()
+
+	// nil or primitive values are not allowed
+	rtcv2.Get("", nil)   // __ERROR__ "expected configuration object as 2nd arg but got nil"
+	rtcv2.Get("", false) // __ERROR__ "expected configuration object as 2nd arg but got nil"
+	rtcv2.Get("", "")    // __ERROR__ "expected ref as 2nd arg to Get"
+	rtcv2.Get("", 456)   // __ERROR__ "expected ref as 2nd arg to Get"
+
+	// 3rd arg needs to be a ref (update in-place)
+	t1 = T1{}
+	rtcv2.Get("", t1) // __ERROR__ "expected ref as 2nd arg to Get"
+
+	// valid usage
+	rtcv2.Get("", T1{}, &t1)
 }
 
 func SubscribeTest() {
@@ -120,4 +135,14 @@ func setup() graphene.RuntimeConfigRegistry {
 	return rtc
 }
 
+func setupv2() graphene.RuntimeConfigRegistry2 {
+	var rtc graphene.RuntimeConfigRegistry2
+	_, _ = graphene.Create("asdf", 123, 123, nil, func(g *graphene.Graphene) error {
+		rtc = g.RuntimeConfig2()
+		return nil
+	})
+	return rtc
+}
+
+
 */