Merge pull request #3213 from corhere/controlapi-hooks-request-data

api: afford passing params to OnGetNetwork hook

Author: dperny

api/api.pb.txt

@@ -8304,6 +8304,14 @@ file {
       type: TYPE_STRING
       json_name: "networkId"
     }
+    field {
+      name: "appdata"
+      number: 3
+      label: LABEL_OPTIONAL
+      type: TYPE_MESSAGE
+      type_name: ".google.protobuf.Any"
+      json_name: "appdata"
+    }
   }
   message_type {
     name: "GetNetworkResponse"
@@ -8346,6 +8354,14 @@ file {
       type_name: ".docker.swarmkit.v1.ListNetworksRequest.Filters"
       json_name: "filters"
     }
+    field {
+      name: "appdata"
+      number: 2
+      label: LABEL_OPTIONAL
+      type: TYPE_MESSAGE
+      type_name: ".google.protobuf.Any"
+      json_name: "appdata"
+    }
     nested_type {
       name: "Filters"
       field {

api/control.pb.go

@@ -484,6 +484,8 @@ message CreateNetworkResponse {
 message GetNetworkRequest {
 	string name = 1;
 	string network_id = 2;
+	// Application-specific message for the NetworkAllocator's OnGetNetwork callback.
+	google.protobuf.Any appdata = 3;
 }
 
 message GetNetworkResponse {
@@ -507,6 +509,8 @@ message ListNetworksRequest {
 	}
 
 	Filters filters = 1;
+	// Application-specific message for the NetworkAllocator's OnGetNetwork callback.
+	google.protobuf.Any appdata = 2;
 }
 
 message ListNetworksResponse {

api/control.proto

@@ -98,12 +98,16 @@ type OnGetNetworker interface {
 	// response. The modified network object will not be persisted to the
 	// store. Errors returned will be bubbled up to the Control API client.
 	//
+	// The appdataTypeURL and appdata parameters are set to the TypeUrl and
+	// value, respectively, of the appdata field in the ListNetworks or
+	// GetNetwork Control API request.
+	//
 	// The network may not have been allocated at the time of the call.
 	// Calling OnGetNetwork with an unallocated network should not be an
 	// error.
 	//
 	// This method may be called concurrently from multiple goroutines.
-	OnGetNetwork(context.Context, *api.Network) error
+	OnGetNetwork(ctx context.Context, network *api.Network, appdataTypeURL string, appdata []byte) error
 }
 
 // Config is used to store network related cluster config in the Manager.

manager/allocator/networkallocator/networkallocator.go

@@ -16,17 +16,17 @@ func (m *Manager) networkAllocator() networkallocator.NetworkAllocator {
 	return m.allocator.NetworkAllocator()
 }
 
-func (m *Manager) OnGetNetwork(ctx context.Context, n *api.Network) error {
+func (m *Manager) OnGetNetwork(ctx context.Context, n *api.Network, appdataTypeURL string, appdata []byte) error {
 	if nwh, ok := m.networkAllocator().(networkallocator.OnGetNetworker); ok {
-		return nwh.OnGetNetwork(ctx, n)
+		return nwh.OnGetNetwork(ctx, n, appdataTypeURL, appdata)
 	}
 	return nil
 }
 
-func (m *Manager) OnListNetworks(ctx context.Context, networks []*api.Network) error {
+func (m *Manager) OnListNetworks(ctx context.Context, networks []*api.Network, appdataTypeURL string, appdata []byte) error {
 	if nwh, ok := m.networkAllocator().(networkallocator.OnGetNetworker); ok {
 		for _, n := range networks {
-			if err := nwh.OnGetNetwork(ctx, n); err != nil {
+			if err := nwh.OnGetNetwork(ctx, n, appdataTypeURL, appdata); err != nil {
 				return err
 			}
 		}

manager/apihooks.go

@@ -10,17 +10,17 @@ import (
 // objects for GetNetwork and ListNetworks Control API requests before they are
 // sent to the client.
 type NetworkViewResponseMutator interface {
-	OnGetNetwork(context.Context, *api.Network) error
-	OnListNetworks(context.Context, []*api.Network) error
+	OnGetNetwork(context.Context, *api.Network, string, []byte) error
+	OnListNetworks(context.Context, []*api.Network, string, []byte) error
 }
 
 type NoopViewResponseMutator struct{}
 
-func (NoopViewResponseMutator) OnGetNetwork(ctx context.Context, n *api.Network) error {
+func (NoopViewResponseMutator) OnGetNetwork(ctx context.Context, n *api.Network, appdataTypeURL string, appdata []byte) error {
 	return nil
 }
 
-func (NoopViewResponseMutator) OnListNetworks(ctx context.Context, networks []*api.Network) error {
+func (NoopViewResponseMutator) OnListNetworks(ctx context.Context, networks []*api.Network, appdataTypeURL string, appdata []byte) error {
 	return nil
 }
 

manager/controlapi/apihooks.go

@@ -148,7 +148,7 @@ func (s *Server) GetNetwork(ctx context.Context, request *api.GetNetworkRequest)
 	if n == nil {
 		return nil, status.Errorf(codes.NotFound, "network %s not found", request.NetworkID)
 	}
-	if err := s.networkhooks().OnGetNetwork(ctx, n); err != nil {
+	if err := s.networkhooks().OnGetNetwork(ctx, n, request.Appdata.GetTypeUrl(), request.Appdata.GetValue()); err != nil {
 		return nil, err
 	}
 	return &api.GetNetworkResponse{
@@ -295,7 +295,7 @@ func (s *Server) ListNetworks(ctx context.Context, request *api.ListNetworksRequ
 		)
 	}
 
-	if err := s.networkhooks().OnListNetworks(ctx, networks); err != nil {
+	if err := s.networkhooks().OnListNetworks(ctx, networks, request.Appdata.GetTypeUrl(), request.Appdata.GetValue()); err != nil {
 		return nil, err
 	}