k9s/internal/dao/table.go

// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of K9s

package dao

import (
	"context"
	"fmt"

	"github.com/derailed/k9s/internal"
	"github.com/derailed/k9s/internal/client"
	"k8s.io/apimachinery/pkg/api/meta"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
	"k8s.io/apimachinery/pkg/runtime"
	"k8s.io/apimachinery/pkg/runtime/serializer"
	"k8s.io/client-go/rest"
)

const (
	gvFmt       = "application/json;as=Table;v=%s;g=%s, application/json"
	includeMeta = "Metadata"
	includeObj  = "Object"
	includeNone = "None"
	header      = "application/json;as=Table;v=v1;g=meta.k8s.io,application/json;as=Table;v=v1beta1;g=meta.k8s.io,application/json"
)

var genScheme = runtime.NewScheme()

// Table retrieves K8s resources as tabular data.
type Table struct {
	Generic
}

// Get returns a given resource.
func (t *Table) Get(ctx context.Context, path string) (runtime.Object, error) {
	f, p := t.codec()
	c, err := t.getClient(f)
	if err != nil {
		return nil, err
	}

	ns, n := client.Namespaced(path)
	a := fmt.Sprintf(gvFmt, metav1.SchemeGroupVersion.Version, metav1.GroupName)
	req := c.Get().
		SetHeader("Accept", a).
		Name(n).
		Resource(t.gvr.R()).
		VersionedParams(&metav1.TableOptions{}, p)
	if ns != client.ClusterScope {
		req = req.Namespace(ns)
	}

	return req.Do(ctx).Get()
}

// List all Resources in a given namespace.
func (t *Table) List(ctx context.Context, ns string) ([]runtime.Object, error) {
	labelSel, _ := ctx.Value(internal.KeyLabels).(string)
	fieldSel, _ := ctx.Value(internal.KeyFields).(string)

	includeObject := includeMeta
	if t.includeObj {
		includeObject = includeObj
	}

	f, _ := t.codec()
	c, err := t.getClient(f)
	if err != nil {
		return nil, err
	}
	o, err := c.Get().
		SetHeader("Accept", header).
		Param("includeObject", includeObject).
		Namespace(ns).
		Resource(t.gvr.R()).
		VersionedParams(&metav1.ListOptions{
			LabelSelector: labelSel,
			FieldSelector: fieldSel,
		}, metav1.ParameterCodec).
		Do(ctx).Get()
	if err != nil {
		return nil, err
	}

	namespaced := true
	if res, e := MetaAccess.MetaFor(t.gvr); e == nil && !res.Namespaced {
		namespaced = false
	}
	ta, err := decodeTable(ctx, o.(*metav1.Table), namespaced)
	if err != nil {
		return nil, err
	}

	return []runtime.Object{ta}, nil
}

// ----------------------------------------------------------------------------
// Helpers...

func decodeTable(ctx context.Context, table *metav1.Table, namespaced bool) (runtime.Object, error) {
	if namespaced {
		table.ColumnDefinitions = append([]metav1.TableColumnDefinition{{Name: "Namespace", Type: "string"}}, table.ColumnDefinitions...)
	}
	pool := internal.NewWorkerPool(ctx, internal.DefaultPoolSize)
	for i := range table.Rows {
		pool.Add(func(_ context.Context) error {
			row := &table.Rows[i]
			if row.Object.Raw == nil || row.Object.Object != nil {
				return nil
			}
			converted, err := runtime.Decode(unstructured.UnstructuredJSONScheme, row.Object.Raw)
			if err != nil {
				return err
			}
			row.Object.Object = converted
			var m metav1.Object
			if obj := row.Object.Object; obj != nil {
				m, _ = meta.Accessor(obj)
			}
			var ns string
			if m != nil {
				ns = m.GetNamespace()
			}
			if namespaced {
				row.Cells = append([]any{ns}, row.Cells...)
			}
			return nil
		})
	}
	errs := pool.Drain()
	if len(errs) > 0 {
		return nil, fmt.Errorf("failed to decode table rows: %w", errs[0])
	}

	return table, nil
}

func (t *Table) getClient(f serializer.CodecFactory) (*rest.RESTClient, error) {
	cfg, err := t.Client().RestConfig()
	if err != nil {
		return nil, err
	}
	gv := t.gvr.GV()
	cfg.GroupVersion = &gv
	cfg.APIPath = "/apis"
	if t.gvr.G() == "" {
		cfg.APIPath = "/api"
	}
	cfg.NegotiatedSerializer = f.WithoutConversion()
	crRestClient, err := rest.RESTClientFor(cfg)
	if err != nil {
		return nil, err
	}

	return crRestClient, nil
}

func (t *Table) codec() (serializer.CodecFactory, runtime.ParameterCodec) {
	var tt metav1.Table
	opts := metav1.TableOptions{IncludeObject: metav1.IncludeObject}
	gv := t.gvr.GV()
	metav1.AddToGroupVersion(genScheme, gv)
	genScheme.AddKnownTypes(gv, &tt, &opts)
	genScheme.AddKnownTypes(metav1.SchemeGroupVersion, &tt, &opts)

	return serializer.NewCodecFactory(genScheme), runtime.NewParameterCodec(genScheme)
}