github.com/tilt-dev/tilt@v0.33.15-0.20240515162809-0a22ed45d8a0/internal/hud/server/controller.go

package server

import (
	"context"
	"crypto/tls"
	"fmt"
	"io"
	"log"
	"net/http"
	"regexp"

	"github.com/gorilla/mux"
	genericapiserver "k8s.io/apiserver/pkg/server"
	"k8s.io/client-go/rest"
	"k8s.io/client-go/tools/clientcmd"
	clientcmdapi "k8s.io/client-go/tools/clientcmd/api"
	"k8s.io/kubectl/pkg/proxy"

	"github.com/tilt-dev/tilt-apiserver/pkg/server/start"
	"github.com/tilt-dev/tilt/internal/filelock"
	"github.com/tilt-dev/tilt/internal/store"
	"github.com/tilt-dev/tilt/pkg/assets"
	"github.com/tilt-dev/tilt/pkg/model"
)

// apiServerProxyPrefix routes web HUD requests to the apiserver as it cannot contact it directly.
//
// This prefix is stripped from the subsequent request to the apiserver, e.g. to list API versions,
// `/proxy/apis` --> `/apis`.
//
// NOTE: The kubectl ProxyHandler code has some odd behavior in this regard in that it only strips
//
//	the prefix if it does not start with `/api`. As a result, something like a prefix of `/apiserver`
//	will cause problems because `/apiserver/apis/foo` will be passed as-is, which is why `/proxy` was
//	chosen here.
const apiServerProxyPrefix = "/proxy"

type HeadsUpServerController struct {
	// configAccess may be nil in cases where we don't
	// want to persist the config to disk.
	configAccess clientcmd.ConfigAccess

	apiServerName   model.APIServerName
	webListener     WebListener
	hudServer       *HeadsUpServer
	assetServer     assets.Server
	apiServer       *http.Server
	webServer       *http.Server
	webURL          model.WebURL
	apiServerConfig *APIServerConfig

	shutdown func()
}

func ProvideHeadsUpServerController(
	configAccess clientcmd.ConfigAccess,
	apiServerName model.APIServerName,
	webListener WebListener,
	apiServerConfig *APIServerConfig,
	hudServer *HeadsUpServer,
	assetServer assets.Server,
	webURL model.WebURL) *HeadsUpServerController {

	emptyCh := make(chan struct{})
	close(emptyCh)

	return &HeadsUpServerController{
		configAccess:    configAccess,
		apiServerName:   apiServerName,
		webListener:     webListener,
		hudServer:       hudServer,
		assetServer:     assetServer,
		webURL:          webURL,
		apiServerConfig: apiServerConfig,
		shutdown:        func() {},
	}
}

func (s *HeadsUpServerController) TearDown(ctx context.Context) {
	s.shutdown()
	s.assetServer.TearDown(ctx)

	// Close all active connections immediately.
	// Tilt is deleting all its state, so there's no good
	// reason to handle graceful shutdown.
	_ = s.webServer.Close()
	_ = s.apiServer.Close()

	_ = s.removeFromAPIServerConfig()
}

func (s *HeadsUpServerController) OnChange(ctx context.Context, st store.RStore, _ store.ChangeSummary) error {
	return nil
}

// Merge the APIServer and the Tilt Web server into a single handler,
// and attach them both to the public listener.
func (s *HeadsUpServerController) SetUp(ctx context.Context, st store.RStore) error {
	ctx, cancel := context.WithCancel(ctx)
	s.shutdown = cancel

	err := s.setUpHelper(ctx, st)
	if err != nil {
		return fmt.Errorf("Cannot start the tilt-apiserver: %v", err)
	}
	err = s.addToAPIServerConfig()
	if err != nil {
		return fmt.Errorf("writing tilt api configs: %v", err)
	}
	return nil
}

func (s *HeadsUpServerController) setUpHelper(ctx context.Context, st store.RStore) error {
	stopCh := ctx.Done()
	config := s.apiServerConfig
	server, err := config.Complete().New()
	if err != nil {
		return err
	}

	err = server.GenericAPIServer.AddPostStartHook("start-tilt-server-informers", func(context genericapiserver.PostStartHookContext) error {
		if config.GenericConfig.SharedInformerFactory != nil {
			config.GenericConfig.SharedInformerFactory.Start(context.StopCh)
		}
		return nil
	})
	if err != nil {
		return err
	}

	prepared := server.GenericAPIServer.PrepareRun()
	apiserverHandler := prepared.Handler
	serving := config.ExtraConfig.ServingInfo

	apiRouter := mux.NewRouter()
	apiRouter.Path("/api").Handler(http.NotFoundHandler())
	apiRouter.PathPrefix("/apis").Handler(apiserverHandler)
	apiRouter.PathPrefix("/healthz").Handler(apiserverHandler)
	apiRouter.PathPrefix("/livez").Handler(apiserverHandler)
	apiRouter.PathPrefix("/metrics").Handler(apiserverHandler)
	apiRouter.PathPrefix("/openapi").Handler(apiserverHandler)
	apiRouter.PathPrefix("/readyz").Handler(apiserverHandler)
	apiRouter.PathPrefix("/swagger").Handler(apiserverHandler)
	apiRouter.PathPrefix("/version").Handler(apiserverHandler)
	apiRouter.PathPrefix("/debug").Handler(http.DefaultServeMux) // for /debug/pprof

	var apiTLSConfig *tls.Config
	if serving.Cert != nil {
		apiTLSConfig, err = start.TLSConfig(ctx, serving)
		if err != nil {
			return fmt.Errorf("Starting apiserver: %v", err)
		}
	}

	proxyHandler, err := newAPIServerProxyHandler(config.GenericConfig.LoopbackClientConfig)
	if err != nil {
		return fmt.Errorf("failed to create apiserver proxy: %v", err)
	}

	webRouter := mux.NewRouter()
	webRouter.PathPrefix("/debug").Handler(http.DefaultServeMux) // for /debug/pprof
	// the path prefix here must be kept in sync with the prefix configured in the proxy handler
	// (it needs to know what to strip before forwarding the request)
	webRouter.PathPrefix(apiServerProxyPrefix).Handler(proxyHandler)
	webRouter.PathPrefix("/").Handler(s.hudServer.Router())

	s.webServer = &http.Server{
		Addr:    s.webListener.Addr().String(),
		Handler: webRouter,

		// blackhole any server errors
		ErrorLog: log.New(io.Discard, "", 0),
	}
	runServer(ctx, s.webServer, s.webListener)

	s.apiServer = &http.Server{
		Addr:           serving.Listener.Addr().String(),
		Handler:        apiRouter,
		MaxHeaderBytes: 1 << 20,
		TLSConfig:      apiTLSConfig,

		// blackhole any server errors
		ErrorLog: log.New(io.Discard, "", 0),
	}
	runServer(ctx, s.apiServer, serving.Listener)
	server.GenericAPIServer.RunPostStartHooks(stopCh)

	go func() {
		err := s.assetServer.Serve(ctx)
		if err != nil && ctx.Err() == nil {
			st.Dispatch(store.NewErrorAction(err))
		}
	}()

	return nil
}

// Write the API server configs into the user settings directory.
//
// Usually shows up as ~/.windmill/config or ~/.tilt-dev/config.
func (s *HeadsUpServerController) addToAPIServerConfig() error {
	if s.configAccess == nil {
		return nil
	}

	var newConfig *clientcmdapi.Config
	err := filelock.WithRLock(s.configAccess, func() error {
		var e error
		newConfig, e = s.configAccess.GetStartingConfig()
		return e
	})
	if err != nil {
		return err
	}
	newConfig = newConfig.DeepCopy()

	clientConfig := s.apiServerConfig.GenericConfig.LoopbackClientConfig
	if err := model.ValidateAPIServerName(s.apiServerName); err != nil {
		return err
	}

	name := string(s.apiServerName)
	newConfig.Contexts[name] = &clientcmdapi.Context{
		Cluster:  name,
		AuthInfo: name,
	}
	newConfig.AuthInfos[name] = &clientcmdapi.AuthInfo{
		Token: clientConfig.BearerToken,
	}

	newConfig.Clusters[name] = &clientcmdapi.Cluster{
		Server:                   clientConfig.Host,
		CertificateAuthorityData: clientConfig.TLSClientConfig.CAData,
	}

	return s.modifyConfig(*newConfig)
}

// Remove this API server's configs into the user settings directory.
//
// Usually shows up as ~/.windmill/config or ~/.tilt-dev/config.
func (s *HeadsUpServerController) removeFromAPIServerConfig() error {
	if s.configAccess == nil {
		return nil
	}

	var newConfig *clientcmdapi.Config
	err := filelock.WithRLock(s.configAccess, func() error {
		var e error
		newConfig, e = s.configAccess.GetStartingConfig()
		return e
	})
	if err != nil {
		return err
	}
	newConfig = newConfig.DeepCopy()
	if err := model.ValidateAPIServerName(s.apiServerName); err != nil {
		return err
	}

	name := string(s.apiServerName)
	delete(newConfig.Contexts, name)
	delete(newConfig.AuthInfos, name)
	delete(newConfig.Clusters, name)

	return s.modifyConfig(*newConfig)
}

func (s *HeadsUpServerController) modifyConfig(config clientcmdapi.Config) error {
	return filelock.WithLock(s.configAccess, func() error {
		return clientcmd.ModifyConfig(s.configAccess, config, true)
	})
}

func newAPIServerProxyHandler(config *rest.Config) (http.Handler, error) {
	// all requests to the proxy handler are same origin from the HUD server, so there is
	// no CORS policy in place because we explicitly want to reject all other origin requests
	// in the future, it's worth considering adding a CSRF token for a bit of extra robustness;
	// but it's not critical because the content returned by the proxy for GETs is not embeddable
	// and for POST cannot accept form data (only JSON or protobuf), so XHR same origin policy
	// is sufficient
	fs := &proxy.FilterServer{
		AcceptHosts: []*regexp.Regexp{
			// filtering by Host header is not useful, just ignore it
			regexp.MustCompile(`.+`),
		},
		AcceptPaths: []*regexp.Regexp{
			regexp.MustCompile(`^/apis/tilt\.dev/\w+/uibuttons`),
		},
	}

	// the prefix here must be kept in sync with the route definition on the mux
	return proxy.NewProxyHandler(apiServerProxyPrefix, fs, config, 0, false)
}

var _ store.SetUpper = &HeadsUpServerController{}
var _ store.TearDowner = &HeadsUpServerController{}