Expose client state as an interface from service

[vmware-archive#2305]

Signed-off-by: vikram yadav <[email protected]>

cmd/octant-sample-plugin/main.go

@@ -180,8 +180,8 @@ func handleAction(request *service.ActionRequest) error {
 
 	if actionValue == pluginActionName {
 		// Sending an alert needs a clientID from the request context
-		alert := action.CreateAlert(action.AlertTypeInfo, fmt.Sprintf("My client ID is: %s", request.ClientState.ClientID), action.DefaultAlertExpiration)
-		request.DashboardClient.SendAlert(request.Context(), request.ClientState.ClientID, alert)
+		alert := action.CreateAlert(action.AlertTypeInfo, fmt.Sprintf("My client ID is: %s", request.ClientState.ClientID()), action.DefaultAlertExpiration)
+		request.DashboardClient.SendAlert(request.Context(), request.ClientState.ClientID(), alert)
 	}
 
 	return nil

pkg/plugin/client_filter.go

@@ -0,0 +1,19 @@
+package plugin
+
+type Filter interface {
+	Key() string
+	Value() string
+}
+
+type clientFilter struct {
+	key   string
+	value string
+}
+
+func (cf clientFilter) Key() string {
+	return cf.key
+}
+
+func (cf clientFilter) Value() string {
+	return cf.value
+}

pkg/plugin/client_state.go

@@ -0,0 +1,50 @@
+package plugin
+
+import (
+	"context"
+
+	ocontext "github.com/vmware-tanzu/octant/internal/context"
+)
+
+type ClientState interface {
+	ClientID() string
+	Filters() []Filter
+	Namespace() string
+	ContextName() string
+}
+
+func ClientStateFrom(ctx context.Context) clientState {
+	cs := ocontext.ClientStateFrom(ctx)
+	filters := []Filter{}
+
+	for _, f := range cs.Filters {
+		filters = append(filters, clientFilter{key: f.Key, value: f.Value})
+	}
+
+	return clientState{
+		clientID:    cs.ClientID,
+		filters:     filters,
+		namespace:   cs.Namespace,
+		contextName: cs.ContextName,
+	}
+}
+
+type clientState struct {
+	clientID    string
+	filters     []Filter
+	namespace   string
+	contextName string
+}
+
+func (c clientState) ClientID() string {
+	return c.clientID
+}
+func (c clientState) Filters() []Filter {
+	return c.filters
+}
+func (c clientState) Namespace() string {
+	return c.namespace
+}
+func (c clientState) ContextName() string {
+	return c.contextName
+}

pkg/plugin/javascript.go

@@ -14,8 +14,6 @@ import (
 
 	"github.com/vmware-tanzu/octant/internal/util/json"
 
-	ocontext "github.com/vmware-tanzu/octant/internal/context"
-
 	"github.com/dop251/goja"
 	"github.com/dop251/goja_nodejs/eventloop"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -237,7 +235,7 @@ func (t *jsPlugin) Content(ctx context.Context, contentPath string) (component.C
 	errCh := make(chan error)
 
 	t.loop.RunOnLoop(func(vm *goja.Runtime) {
-		clientState := ocontext.ClientStateFrom(ctx)
+		clientState := ClientStateFrom(ctx)
 
 		handler, err := vm.RunString("_concretePlugin.contentHandler")
 		if err != nil {
@@ -458,7 +456,7 @@ func (t *jsPlugin) HandleAction(ctx context.Context, actionPath string, payload
 	errCh := make(chan error)
 
 	t.loop.RunOnLoop(func(vm *goja.Runtime) {
-		clientState := ocontext.ClientStateFrom(ctx)
+		clientState := ClientStateFrom(ctx)
 
 		handler, err := vm.RunString("_concretePlugin.actionHandler")
 		if err != nil {
@@ -571,7 +569,7 @@ func (t *jsPlugin) objectRequestCall(ctx context.Context, handlerName string, ob
 	var response *goja.Object
 
 	t.loop.RunOnLoop(func(vm *goja.Runtime) {
-		clientState := ocontext.ClientStateFrom(ctx)
+		clientState := ClientStateFrom(ctx)
 
 		handler, err := vm.RunString(fmt.Sprintf("_concretePlugin.%s", handlerName))
 		if err != nil {

pkg/plugin/service/handler.go

@@ -4,8 +4,6 @@ import (
 	"context"
 	"sync"
 
-	ocontext "github.com/vmware-tanzu/octant/internal/context"
-
 	"github.com/pkg/errors"
 	"k8s.io/apimachinery/pkg/runtime"
 
@@ -62,8 +60,6 @@ func (p *Handler) Register(ctx context.Context, dashboardAPIAddress string) (plu
 
 // Print prints components for an object.
 func (p *Handler) Print(ctx context.Context, object runtime.Object) (plugin.PrintResponse, error) {
-	clientState := ocontext.ClientStateFrom(ctx)
-
 	if p.HandlerFuncs.Print == nil {
 		return plugin.PrintResponse{}, nil
 	}
@@ -72,7 +68,7 @@ func (p *Handler) Print(ctx context.Context, object runtime.Object) (plugin.Prin
 		baseRequest:     newBaseRequest(ctx, p.name),
 		DashboardClient: p.dashboardClient,
 		Object:          object,
-		ClientState:     clientState,
+		ClientState:     plugin.ClientStateFrom(ctx),
 	}
 
 	return p.HandlerFuncs.Print(request)
@@ -88,7 +84,7 @@ func (p *Handler) PrintTabs(ctx context.Context, object runtime.Object) ([]plugi
 		baseRequest:     newBaseRequest(ctx, p.name),
 		DashboardClient: p.dashboardClient,
 		Object:          object,
-		ClientState:     ocontext.ClientStateFrom(ctx),
+		ClientState:     plugin.ClientStateFrom(ctx),
 	}
 
 	var tabResponses []plugin.TabResponse
@@ -112,7 +108,7 @@ func (p *Handler) ObjectStatus(ctx context.Context, object runtime.Object) (plug
 		baseRequest:     newBaseRequest(ctx, p.name),
 		DashboardClient: p.dashboardClient,
 		Object:          object,
-		ClientState:     ocontext.ClientStateFrom(ctx),
+		ClientState:     plugin.ClientStateFrom(ctx),
 	}
 
 	return p.HandlerFuncs.ObjectStatus(request)
@@ -129,7 +125,7 @@ func (p *Handler) HandleAction(ctx context.Context, actionName string, payload a
 		DashboardClient: p.dashboardClient,
 		ActionName:      actionName,
 		Payload:         payload,
-		ClientState:     ocontext.ClientStateFrom(ctx),
+		ClientState:     plugin.ClientStateFrom(ctx),
 	}
 
 	return p.HandlerFuncs.HandleAction(request)
@@ -144,7 +140,7 @@ func (p *Handler) Navigation(ctx context.Context) (navigation.Navigation, error)
 	request := &NavigationRequest{
 		baseRequest:     newBaseRequest(ctx, p.name),
 		DashboardClient: p.dashboardClient,
-		ClientState:     ocontext.ClientStateFrom(ctx),
+		ClientState:     plugin.ClientStateFrom(ctx),
 	}
 
 	return p.HandlerFuncs.Navigation(request)

pkg/plugin/service/handler_test.go

@@ -109,6 +109,10 @@ func TestHandler_Print_using_supplied_function(t *testing.T) {
 		Filters:   []octant.Filter{{Key: "foo", Value: "bar"}},
 	}
 
+	ctx := context.Background()
+	ctx = ocontext.WithClientState(ctx, clientState)
+	pluginClientState := plugin.ClientStateFrom(ctx)
+
 	dashboardClient := fake.NewMockDashboard(controller)
 
 	ran := false
@@ -118,15 +122,13 @@ func TestHandler_Print_using_supplied_function(t *testing.T) {
 				ran = true
 				assert.Equal(t, dashboardClient, r.DashboardClient)
 				assert.Equal(t, pod, r.Object)
-				assert.Equal(t, clientState, r.ClientState)
+				assert.Equal(t, pluginClientState, r.ClientState)
 				return plugin.PrintResponse{}, nil
 			},
 		},
 		dashboardClient: dashboardClient,
 	}
 
-	ctx := context.Background()
-	ctx = ocontext.WithClientState(ctx, clientState)
 	got, err := h.Print(ctx, pod)
 	require.NoError(t, err)
 
@@ -167,6 +169,10 @@ func TestHandler_PrintTabs_using_supplied_function(t *testing.T) {
 		Filters:   []octant.Filter{{Key: "foo", Value: "bar"}},
 	}
 
+	ctx := context.Background()
+	ctx = ocontext.WithClientState(ctx, clientState)
+	pluginClientState := plugin.ClientStateFrom(ctx)
+
 	dashboardClient := fake.NewMockDashboard(controller)
 
 	ran := false
@@ -179,15 +185,13 @@ func TestHandler_PrintTabs_using_supplied_function(t *testing.T) {
 					ran = true
 					assert.Equal(t, dashboardClient, r.DashboardClient)
 					assert.Equal(t, pod, r.Object)
-					assert.Equal(t, clientState, r.ClientState)
+					assert.Equal(t, pluginClientState, r.ClientState)
 					return plugin.TabResponse{}, nil
 				},
 			},
 		},
 	}
 
-	ctx := context.Background()
-	ctx = ocontext.WithClientState(ctx, clientState)
 	got, err := h.PrintTabs(ctx, pod)
 	require.NoError(t, err)
 
@@ -231,6 +235,10 @@ func TestHandler_ObjectStatus_using_supplied_function(t *testing.T) {
 		Filters:   []octant.Filter{{Key: "foo", Value: "bar"}},
 	}
 
+	ctx := context.Background()
+	ctx = ocontext.WithClientState(ctx, clientState)
+	pluginClientState := plugin.ClientStateFrom(ctx)
+
 	ran := false
 
 	h := Handler{
@@ -240,14 +248,12 @@ func TestHandler_ObjectStatus_using_supplied_function(t *testing.T) {
 				ran = true
 				assert.Equal(t, dashboardClient, r.DashboardClient)
 				assert.Equal(t, pod, r.Object)
-				assert.Equal(t, clientState, r.ClientState)
+				assert.Equal(t, pluginClientState, r.ClientState)
 				return plugin.ObjectStatusResponse{}, nil
 			},
 		},
 	}
 
-	ctx := context.Background()
-	ctx = ocontext.WithClientState(ctx, clientState)
 	got, err := h.ObjectStatus(ctx, pod)
 	require.NoError(t, err)
 
@@ -288,6 +294,10 @@ func TestHandler_HandleAction_using_supplied_function(t *testing.T) {
 		Filters:   []octant.Filter{{Key: "foo", Value: "bar"}},
 	}
 
+	ctx := context.Background()
+	ctx = ocontext.WithClientState(ctx, clientState)
+	pluginClientState := plugin.ClientStateFrom(ctx)
+
 	ran := false
 
 	h := Handler{
@@ -297,15 +307,13 @@ func TestHandler_HandleAction_using_supplied_function(t *testing.T) {
 				ran = true
 				assert.Equal(t, dashboardClient, r.DashboardClient)
 				assert.Equal(t, payload, r.Payload)
-				assert.Equal(t, clientState, r.ClientState)
+				assert.Equal(t, pluginClientState, r.ClientState)
 
 				return nil
 			},
 		},
 	}
 
-	ctx := context.Background()
-	ctx = ocontext.WithClientState(ctx, clientState)
 	err := h.HandleAction(ctx, actionName, payload)
 	assert.NoError(t, err)
 	assert.True(t, ran)
@@ -341,6 +349,10 @@ func TestHandler_Navigation_using_supplied_function(t *testing.T) {
 		Filters:   []octant.Filter{{Key: "foo", Value: "bar"}},
 	}
 
+	ctx := context.Background()
+	ctx = ocontext.WithClientState(ctx, clientState)
+	pluginClientState := plugin.ClientStateFrom(ctx)
+
 	ran := false
 
 	h := Handler{
@@ -349,14 +361,12 @@ func TestHandler_Navigation_using_supplied_function(t *testing.T) {
 			Navigation: func(r *NavigationRequest) (navigation.Navigation, error) {
 				ran = true
 				assert.Equal(t, dashboardClient, r.DashboardClient)
-				assert.Equal(t, clientState, r.ClientState)
+				assert.Equal(t, pluginClientState, r.ClientState)
 				return navigation.Navigation{}, nil
 			},
 		},
 	}
 
-	ctx := context.Background()
-	ctx = ocontext.WithClientState(ctx, clientState)
 	got, err := h.Navigation(ctx)
 	require.NoError(t, err)
 

pkg/plugin/service/router.go

@@ -5,7 +5,7 @@ import (
 
 	"github.com/gobwas/glob"
 
-	ocontext "github.com/vmware-tanzu/octant/internal/context"
+	"github.com/vmware-tanzu/octant/pkg/plugin"
 	"github.com/vmware-tanzu/octant/pkg/view/component"
 )
 
@@ -16,7 +16,7 @@ type Request interface {
 	Context() context.Context
 	DashboardClient() Dashboard
 	Path() string
-	ClientState() ocontext.ClientState
+	ClientState() plugin.ClientState
 }
 
 var _ Request = (*request)(nil)
@@ -30,11 +30,11 @@ type request struct {
 
 	path string
 
-	clientState ocontext.ClientState
+	clientState plugin.ClientState
 }
 
 // ClientState returns the octant plugin state
-func (r *request) ClientState() ocontext.ClientState {
+func (r *request) ClientState() plugin.ClientState {
 	return r.clientState
 }
 

pkg/plugin/service/service.go

@@ -13,7 +13,6 @@ import (
 	"github.com/pkg/errors"
 	"k8s.io/apimachinery/pkg/runtime"
 
-	ocontext "github.com/vmware-tanzu/octant/internal/context"
 	"github.com/vmware-tanzu/octant/pkg/action"
 	"github.com/vmware-tanzu/octant/pkg/navigation"
 	"github.com/vmware-tanzu/octant/pkg/plugin"
@@ -156,7 +155,7 @@ type PrintRequest struct {
 
 	DashboardClient Dashboard
 	Object          runtime.Object
-	ClientState     ocontext.ClientState
+	ClientState     plugin.ClientState
 }
 
 // ActionRequest is a request for actions.
@@ -166,15 +165,15 @@ type ActionRequest struct {
 	DashboardClient Dashboard
 	ActionName      string
 	Payload         action.Payload
-	ClientState     ocontext.ClientState
+	ClientState     plugin.ClientState
 }
 
 // NavigationRequest is a request for navigation.
 type NavigationRequest struct {
 	baseRequest
 
 	DashboardClient Dashboard
-	ClientState     ocontext.ClientState
+	ClientState     plugin.ClientState
 }
 
 type HandlerPrinterFunc func(request *PrintRequest) (plugin.PrintResponse, error)