TBR ref: VDL require named in-args, fix bug with named out-args.
Closes vanadium/issues#62
We now require all input arguments to be named in VDL. This is
better for API documentation, and makes code generation slightly
simpler. It'll also help if we move to structed documentation in
the future.
Also fix an off-by-1 bug with named out-args.
MultiPart: 2/3
Change-Id: I417b4a9595e813e48afc29a3b770894e62fa1f8d
diff --git a/lib/vdl/compile/interface.go b/lib/vdl/compile/interface.go
index eae574b..fc3a161 100644
--- a/lib/vdl/compile/interface.go
+++ b/lib/vdl/compile/interface.go
@@ -184,8 +184,12 @@
continue // keep going to catch more errors
}
seen[parg.Name] = parg
- if io == out && len(pargs) > 2 && parg.Name == "" {
- id.env.Errorf(file, parg.Pos, "method %s out arg unnamed (must name all out args if there are more than 2)", method.Name)
+ switch {
+ case io == in && parg.Name == "":
+ id.env.Errorf(file, parg.Pos, "method %s in-arg unnamed (must name all in-args)", method.Name)
+ continue // keep going to catch more errors
+ case io == out && len(pargs) > 1 && parg.Name == "":
+ id.env.Errorf(file, parg.Pos, "method %s out-arg unnamed (must name all out-args if there are more than 1)", method.Name)
continue // keep going to catch more errors
}
if parg.Name != "" {
diff --git a/lib/vdl/compile/interface_test.go b/lib/vdl/compile/interface_test.go
index 1d2f8ac..0546e49 100644
--- a/lib/vdl/compile/interface_test.go
+++ b/lib/vdl/compile/interface_test.go
@@ -130,6 +130,16 @@
},
"",
}}},
+ {"NamedOutArg", ip{{"a", `type Res interface{NamedOutArg() (s string | error)}`,
+ &compile.Interface{
+ NamePos: np("Res"),
+ Methods: []*compile.Method{{
+ NamePos: np("NamedOutArg"),
+ OutArgs: []*compile.Field{{NamePos: np("s"), Type: vdl.StringType}},
+ }},
+ },
+ "",
+ }}},
{"Embed", ip{{"a", `type A interface{};type Res interface{A}`,
&compile.Interface{
NamePos: np("Res"),
@@ -167,4 +177,13 @@
{"UnmatchedEmbed", ip{{"a", `type A interface{};type Res interface{A.foobar}`, nil,
`\(\.foobar unmatched\)`,
}}},
+ {"NoErrorReturn", ip{{"a", `type Res interface{NoArgs()}`, nil,
+ `syntax error`,
+ }}},
+ {"UnnamedInArg", ip{{"a", `type Res interface{UnnamedInArg(string) error}`, nil,
+ `must name all in-args`,
+ }}},
+ {"UnnamedOutArgs", ip{{"a", `type Res interface{UnnamedOutArgs() (bool, string | error)}`, nil,
+ `must name all out-args if there are more than 1`,
+ }}},
}
diff --git a/services/wspr/internal/app/controller.vdl b/services/wspr/internal/app/controller.vdl
index 0f6be7c..68376f0 100644
--- a/services/wspr/internal/app/controller.vdl
+++ b/services/wspr/internal/app/controller.vdl
@@ -29,13 +29,13 @@
BlessingsDebugString(handle principal.BlessingsHandle) (string | error)
// Bless binds extensions of blessings held by this principal to
// another principal (represented by its public key).
- Bless(publicKey string, blessingHandle principal.BlessingsHandle, extension string, caveat []security.Caveat) (string, principal.BlessingsHandle | error)
+ Bless(publicKey string, handle principal.BlessingsHandle, extension string, caveat []security.Caveat) (publicKeyOut string, handleOut principal.BlessingsHandle | error)
// BlessSelf creates a blessing with the provided name for this principal.
- BlessSelf(name string, caveats []security.Caveat) (string, principal.BlessingsHandle | error)
+ BlessSelf(name string, caveats []security.Caveat) (publicKeyOut string, handleOut principal.BlessingsHandle | error)
// PutToBlessingStore puts the specified blessing to the blessing store under the provided pattern.
- PutToBlessingStore(blessingHandle principal.BlessingsHandle, pattern security.BlessingPattern) (?principal.JsBlessings | error)
+ PutToBlessingStore(handle principal.BlessingsHandle, pattern security.BlessingPattern) (?principal.JsBlessings | error)
// AddToRoots adds the provided blessing as a root.
- AddToRoots(blessingHandle principal.BlessingsHandle) error
+ AddToRoots(handle principal.BlessingsHandle) error
// RemoteBlessings fetches the remote blessings for a given name and method.
RemoteBlessings(name, method string) ([]string | error)
diff --git a/services/wspr/internal/app/controller.vdl.go b/services/wspr/internal/app/controller.vdl.go
index fe63c72..f8b6c0d 100644
--- a/services/wspr/internal/app/controller.vdl.go
+++ b/services/wspr/internal/app/controller.vdl.go
@@ -38,13 +38,13 @@
BlessingsDebugString(ctx *context.T, handle principal.BlessingsHandle, opts ...rpc.CallOpt) (string, error)
// Bless binds extensions of blessings held by this principal to
// another principal (represented by its public key).
- Bless(ctx *context.T, publicKey string, blessingHandle principal.BlessingsHandle, extension string, caveat []security.Caveat, opts ...rpc.CallOpt) (string, principal.BlessingsHandle, error)
+ Bless(ctx *context.T, publicKey string, handle principal.BlessingsHandle, extension string, caveat []security.Caveat, opts ...rpc.CallOpt) (publicKeyOut string, handleOut principal.BlessingsHandle, err error)
// BlessSelf creates a blessing with the provided name for this principal.
- BlessSelf(ctx *context.T, name string, caveats []security.Caveat, opts ...rpc.CallOpt) (string, principal.BlessingsHandle, error)
+ BlessSelf(ctx *context.T, name string, caveats []security.Caveat, opts ...rpc.CallOpt) (publicKeyOut string, handleOut principal.BlessingsHandle, err error)
// PutToBlessingStore puts the specified blessing to the blessing store under the provided pattern.
- PutToBlessingStore(ctx *context.T, blessingHandle principal.BlessingsHandle, pattern security.BlessingPattern, opts ...rpc.CallOpt) (*principal.JsBlessings, error)
+ PutToBlessingStore(ctx *context.T, handle principal.BlessingsHandle, pattern security.BlessingPattern, opts ...rpc.CallOpt) (*principal.JsBlessings, error)
// AddToRoots adds the provided blessing as a root.
- AddToRoots(ctx *context.T, blessingHandle principal.BlessingsHandle, opts ...rpc.CallOpt) error
+ AddToRoots(ctx *context.T, handle principal.BlessingsHandle, opts ...rpc.CallOpt) error
// RemoteBlessings fetches the remote blessings for a given name and method.
RemoteBlessings(ctx *context.T, name string, method string, opts ...rpc.CallOpt) ([]string, error)
// Signature fetches the signature for a given name.
@@ -152,13 +152,13 @@
BlessingsDebugString(ctx *context.T, call rpc.ServerCall, handle principal.BlessingsHandle) (string, error)
// Bless binds extensions of blessings held by this principal to
// another principal (represented by its public key).
- Bless(ctx *context.T, call rpc.ServerCall, publicKey string, blessingHandle principal.BlessingsHandle, extension string, caveat []security.Caveat) (string, principal.BlessingsHandle, error)
+ Bless(ctx *context.T, call rpc.ServerCall, publicKey string, handle principal.BlessingsHandle, extension string, caveat []security.Caveat) (publicKeyOut string, handleOut principal.BlessingsHandle, err error)
// BlessSelf creates a blessing with the provided name for this principal.
- BlessSelf(ctx *context.T, call rpc.ServerCall, name string, caveats []security.Caveat) (string, principal.BlessingsHandle, error)
+ BlessSelf(ctx *context.T, call rpc.ServerCall, name string, caveats []security.Caveat) (publicKeyOut string, handleOut principal.BlessingsHandle, err error)
// PutToBlessingStore puts the specified blessing to the blessing store under the provided pattern.
- PutToBlessingStore(ctx *context.T, call rpc.ServerCall, blessingHandle principal.BlessingsHandle, pattern security.BlessingPattern) (*principal.JsBlessings, error)
+ PutToBlessingStore(ctx *context.T, call rpc.ServerCall, handle principal.BlessingsHandle, pattern security.BlessingPattern) (*principal.JsBlessings, error)
// AddToRoots adds the provided blessing as a root.
- AddToRoots(ctx *context.T, call rpc.ServerCall, blessingHandle principal.BlessingsHandle) error
+ AddToRoots(ctx *context.T, call rpc.ServerCall, handle principal.BlessingsHandle) error
// RemoteBlessings fetches the remote blessings for a given name and method.
RemoteBlessings(ctx *context.T, call rpc.ServerCall, name string, method string) ([]string, error)
// Signature fetches the signature for a given name.
@@ -322,14 +322,14 @@
Name: "Bless",
Doc: "// Bless binds extensions of blessings held by this principal to\n// another principal (represented by its public key).",
InArgs: []rpc.ArgDesc{
- {"publicKey", ``}, // string
- {"blessingHandle", ``}, // principal.BlessingsHandle
- {"extension", ``}, // string
- {"caveat", ``}, // []security.Caveat
+ {"publicKey", ``}, // string
+ {"handle", ``}, // principal.BlessingsHandle
+ {"extension", ``}, // string
+ {"caveat", ``}, // []security.Caveat
},
OutArgs: []rpc.ArgDesc{
- {"", ``}, // string
- {"", ``}, // principal.BlessingsHandle
+ {"publicKeyOut", ``}, // string
+ {"handleOut", ``}, // principal.BlessingsHandle
},
},
{
@@ -340,16 +340,16 @@
{"caveats", ``}, // []security.Caveat
},
OutArgs: []rpc.ArgDesc{
- {"", ``}, // string
- {"", ``}, // principal.BlessingsHandle
+ {"publicKeyOut", ``}, // string
+ {"handleOut", ``}, // principal.BlessingsHandle
},
},
{
Name: "PutToBlessingStore",
Doc: "// PutToBlessingStore puts the specified blessing to the blessing store under the provided pattern.",
InArgs: []rpc.ArgDesc{
- {"blessingHandle", ``}, // principal.BlessingsHandle
- {"pattern", ``}, // security.BlessingPattern
+ {"handle", ``}, // principal.BlessingsHandle
+ {"pattern", ``}, // security.BlessingPattern
},
OutArgs: []rpc.ArgDesc{
{"", ``}, // *principal.JsBlessings
@@ -359,7 +359,7 @@
Name: "AddToRoots",
Doc: "// AddToRoots adds the provided blessing as a root.",
InArgs: []rpc.ArgDesc{
- {"blessingHandle", ``}, // principal.BlessingsHandle
+ {"handle", ``}, // principal.BlessingsHandle
},
},
{
