introspection: add support for deprecations

samuelkarp · samuelkarp · commit 90b42da6f449 · 2023-11-03T22:35:19.000-07:00
Deprecation warnings are retrieved from the warning service and returned via the Server RPC. Signed-off-by: Samuel Karp <samuelkarp@google.com> (cherry picked from commit 9aab446) Signed-off-by: Samuel Karp <samuelkarp@google.com>
diff --git a/services/introspection/local.go b/services/introspection/local.go
@@ -18,44 +18,68 @@ package introspection
 
 import (
 	context "context"
+	"errors"
 	"os"
 	"path/filepath"
 	"sync"
 
+	"github.com/gogo/googleapis/google/rpc"
+	ptypes "github.com/gogo/protobuf/types"
+	"github.com/google/uuid"
+	"google.golang.org/grpc"
+	"google.golang.org/grpc/status"
+
 	api "github.com/containerd/containerd/api/services/introspection/v1"
 	"github.com/containerd/containerd/api/types"
 	"github.com/containerd/containerd/errdefs"
 	"github.com/containerd/containerd/filters"
 	"github.com/containerd/containerd/plugin"
 	"github.com/containerd/containerd/services"
-	"github.com/gogo/googleapis/google/rpc"
-	ptypes "github.com/gogo/protobuf/types"
-	"github.com/google/uuid"
-	"google.golang.org/grpc"
-	"google.golang.org/grpc/status"
+	"github.com/containerd/containerd/services/warning"
 )
 
 func init() {
 	plugin.Register(&plugin.Registration{
 		Type:     plugin.ServicePlugin,
 		ID:       services.IntrospectionService,
-		Requires: []plugin.Type{},
+		Requires: []plugin.Type{plugin.WarningPlugin},
 		InitFn: func(ic *plugin.InitContext) (interface{}, error) {
+			sps, err := ic.GetByType(plugin.WarningPlugin)
+			if err != nil {
+				return nil, err
+			}
+			p, ok := sps[plugin.DeprecationsPlugin]
+			if !ok {
+				return nil, errors.New("warning service not found")
+			}
+
+			i, err := p.Instance()
+			if err != nil {
+				return nil, err
+			}
+
+			warningClient, ok := i.(warning.Service)
+			if !ok {
+				return nil, errors.New("could not create a local client for warning service")
+			}
+
 			// this service fetches all plugins through the plugin set of the plugin context
 			return &Local{
-				plugins: ic.Plugins(),
-				root:    ic.Root,
+				plugins:       ic.Plugins(),
+				root:          ic.Root,
+				warningClient: warningClient,
 			}, nil
 		},
 	})
 }
 
 // Local is a local implementation of the introspection service
 type Local struct {
-	mu          sync.Mutex
-	root        string
-	plugins     *plugin.Set
-	pluginCache []api.Plugin
+	mu            sync.Mutex
+	root          string
+	plugins       *plugin.Set
+	pluginCache   []api.Plugin
+	warningClient warning.Service
 }
 
 var _ = (api.IntrospectionClient)(&Local{})
@@ -106,7 +130,8 @@ func (l *Local) Server(ctx context.Context, _ *ptypes.Empty, _ ...grpc.CallOptio
 		return nil, errdefs.ToGRPC(err)
 	}
 	return &api.ServerResponse{
-		UUID: u,
+		UUID:         u,
+		Deprecations: l.getWarnings(ctx),
 	}, nil
 }
 
@@ -148,6 +173,10 @@ func (l *Local) uuidPath() string {
 	return filepath.Join(l.root, "uuid")
 }
 
+func (l *Local) getWarnings(ctx context.Context) []*api.DeprecationWarning {
+	return warningsPB(ctx, l.warningClient.Warnings())
+}
+
 func adaptPlugin(o interface{}) filters.Adaptor {
 	obj := o.(api.Plugin)
 	return filters.AdapterFunc(func(fieldpath []string) (string, bool) {
@@ -229,3 +258,17 @@ func pluginsToPB(plugins []*plugin.Plugin) []api.Plugin {
 
 	return pluginsPB
 }
+
+func warningsPB(ctx context.Context, warnings []warning.Warning) []*api.DeprecationWarning {
+	var pb []*api.DeprecationWarning
+
+	for _, w := range warnings {
+		ts, _ := ptypes.TimestampProto(w.LastOccurrence)
+		pb = append(pb, &api.DeprecationWarning{
+			ID:             string(w.ID),
+			Message:        w.Message,
+			LastOccurrence: ts,
+		})
+	}
+	return pb
+}
