v23: add 'GetRequestID' to the v23 and runtime APIs. (#169)

This PR moves the API for adding/getting requestIDs to the v23 level for GetRequestID but hides the ability to set a requestID to within the runtime since it only makes sense to do so from within the runtime implementation.

Author: cosnicolaou

v23/init_internal_test.go

@@ -9,6 +9,7 @@ import (
 	"testing"
 	"time"
 
+	"github.com/google/uuid"
 	"v.io/v23/context"
 	"v.io/v23/discovery"
 	"v.io/v23/flow"
@@ -43,6 +44,9 @@ func (*mockRuntime) GetListenSpec(ctx *context.T) rpc.ListenSpec { return rpc.Li
 func (*mockRuntime) GetPermissionsSpec(ctx *context.T) access.PermissionsSpec {
 	return access.PermissionsSpec{}
 }
+func (*mockRuntime) GetRequestID(ctx *context.T) uuid.UUID {
+	return uuid.UUID{}
+}
 func (*mockRuntime) WithBackgroundContext(ctx *context.T) *context.T { return nil }
 func (*mockRuntime) GetBackgroundContext(ctx *context.T) *context.T  { return nil }
 

v23/model.go

@@ -25,6 +25,7 @@ import (
 	"sync"
 	"time"
 
+	"github.com/google/uuid"
 	"v.io/v23/context"
 	"v.io/v23/discovery"
 	"v.io/v23/flow"
@@ -134,6 +135,9 @@ type Runtime interface {
 	// Dispatcher's Lookup method which will returns the object and
 	// security.Authorizer used to serve the actual RPC call.
 	WithNewDispatchingServer(ctx *context.T, name string, disp rpc.Dispatcher, opts ...rpc.ServerOpt) (*context.T, rpc.Server, error)
+
+	// GetRequestID returns the RequestID in 'ctx'.
+	GetRequestID(ctx *context.T) uuid.UUID
 }
 
 // WithPrincipal attaches 'principal' to the returned context.
@@ -207,6 +211,13 @@ func GetReservedNameDispatcher(ctx *context.T) rpc.Dispatcher {
 	return initState.currentRuntime().GetReservedNameDispatcher(ctx)
 }
 
+// GetRequestID returns the RequestID in 'ctx'. The underlying runtime should
+// set a new request ID for each new request that it receives and is prepared
+// to process.
+func GetRequestID(ctx *context.T) uuid.UUID {
+	return initState.currentRuntime().GetRequestID(ctx)
+}
+
 // NewFlowManager creates a new flow.Manager instance.
 // channelTimeout specifies the duration we are willing to wait before determining
 // that connections managed by this FlowManager are unhealthy and should be

v23/requestid/model.go

@@ -5,6 +5,7 @@
 package fake
 
 import (
+	"github.com/google/uuid"
 	v23 "v.io/v23"
 	"v.io/v23/context"
 	"v.io/v23/discovery"
@@ -79,6 +80,10 @@ func (r *Runtime) GetPermissionsSpec(ctx *context.T) access.PermissionsSpec {
 	return access.PermissionsSpec{}
 }
 
+func (r *Runtime) GetRequestID(ctx *context.T) uuid.UUID {
+	return uuid.UUID{}
+}
+
 func (r *Runtime) NewDiscovery(ctx *context.T) (discovery.T, error) {
 	// nologcall
 	panic("unimplemented")

x/ref/runtime/factories/fake/runtime.go

@@ -0,0 +1,20 @@
+package rpc
+
+import (
+	"github.com/google/uuid"
+
+	"v.io/v23/context"
+)
+
+type contextKey int
+
+const requestIDKey = contextKey(iota)
+
+func WithRequestID(ctx *context.T, requestID uuid.UUID) *context.T {
+	return context.WithValue(ctx, requestIDKey, requestID)
+}
+
+func RequestID(ctx *context.T) uuid.UUID {
+	requestID, _ := ctx.Value(requestIDKey).(uuid.UUID)
+	return requestID
+}

x/ref/runtime/internal/rpc/requestid.go

@@ -13,14 +13,14 @@ import (
 	"sync"
 	"time"
 
+	"github.com/google/uuid"
 	"golang.org/x/net/trace"
 	v23 "v.io/v23"
 	"v.io/v23/context"
 	"v.io/v23/flow"
 	"v.io/v23/i18n"
 	"v.io/v23/naming"
 	"v.io/v23/options"
-	"v.io/v23/requestid"
 	"v.io/v23/rpc"
 	"v.io/v23/security"
 	"v.io/v23/security/access"
@@ -606,8 +606,12 @@ var (
 )
 
 func newXFlowServer(flow flow.Flow, server *server) (*flowServer, error) {
-	ctx := requestid.WithNewRequestID(server.ctx)
-	ctx = context.WithLoggingPrefix(ctx, requestid.RequestID(ctx))
+	requestID, err := uuid.NewUUID()
+	if err != nil {
+		return nil, fmt.Errorf("failed to allocate requestid: %v", err)
+	}
+	ctx := WithRequestID(server.ctx, requestID)
+	ctx = context.WithLoggingPrefix(ctx, requestID)
 	fs := &flowServer{
 		ctx:        ctx,
 		server:     server,

x/ref/runtime/internal/rpc/server.go

@@ -15,8 +15,7 @@ import (
 	"syscall"
 	"time"
 
-	"v.io/x/lib/metadata"
-
+	"github.com/google/uuid"
 	v23 "v.io/v23"
 	"v.io/v23/context"
 	"v.io/v23/discovery"
@@ -29,7 +28,7 @@ import (
 	"v.io/v23/security/access"
 	"v.io/v23/verror"
 	"v.io/v23/vtrace"
-
+	"v.io/x/lib/metadata"
 	"v.io/x/ref/internal/logger"
 	idiscovery "v.io/x/ref/lib/discovery"
 	"v.io/x/ref/lib/flags"
@@ -393,6 +392,10 @@ func (*Runtime) GetPermissionsSpec(ctx *context.T) access.PermissionsSpec {
 	return ps
 }
 
+func (*Runtime) GetRequestID(ctx *context.T) uuid.UUID {
+	return irpc.RequestID(ctx)
+}
+
 func (*Runtime) WithBackgroundContext(ctx *context.T) *context.T {
 	// Note we add an extra context with a nil value here.
 	// This prevents users from travelling back through the