github.com/kaydxh/golang@v0.0.131/pkg/webserver/webserver.go

/*
 *Copyright (c) 2022, kaydxh
 *
 *Permission is hereby granted, free of charge, to any person obtaining a copy
 *of this software and associated documentation files (the "Software"), to deal
 *in the Software without restriction, including without limitation the rights
 *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *copies of the Software, and to permit persons to whom the Software is
 *furnished to do so, subject to the following conditions:
 *
 *The above copyright notice and this permission notice shall be included in all
 *copies or substantial portions of the Software.
 *
 *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 *SOFTWARE.
 */
package webserver

import (
	"context"
	"sync"
	"time"

	"github.com/gin-gonic/gin"
	context_ "github.com/kaydxh/golang/go/context"
	syscall_ "github.com/kaydxh/golang/go/syscall"
	"github.com/kaydxh/golang/pkg/discovery/consul"
	gw_ "github.com/kaydxh/golang/pkg/grpc-gateway"
	"github.com/sirupsen/logrus"
)

type WebHandler interface {
	SetRoutes(ginRouter gin.IRouter, grpcRouter *gw_.GRPCGateway)
}

type GenericWebServer struct {
	// Server Register. The backend is started after the server starts listening.
	ServiceRegistryBackend *consul.ServiceRegistryServer

	ginBackend  *gin.Engine
	grpcBackend *gw_.GRPCGateway

	// PostStartHooks are each called after the server has started listening, in a separate go func for each
	// with no guarantee of ordering between them.  The map key is a name used for error reporting.
	// It may kill the process with a panic if it wishes to by returning an error.
	postStartHookLock    sync.Mutex
	postStartHooks       map[string]postStartHookEntry
	postStartHooksCalled bool

	preShutdownHookLock    sync.Mutex
	preShutdownHooks       map[string]preShutdownHookEntry
	preShutdownHooksCalled bool

	// healthz checks
	//	healthzLock            sync.Mutex
	//	healthzChecks          []healthz.HealthCheck
	//	healthzChecksInstalled bool
	// livez checks
	//	livezLock            sync.Mutex
	//	livezChecks          []healthz.HealthCheck
	//	livezChecksInstalled bool
	// readyz checks
	//	readyzLock            sync.Mutex
	//	readyzChecks          []healthz.HealthCheck
	//	readyzChecksInstalled bool
	//	livezGracePeriod      time.Duration

	// the readiness stop channel is used to signal that the apiserver has initiated a shutdown sequence, this
	// will cause readyz to return unhealthy.
	readinessStopCh chan struct{}

	// ShutdownDelayDuration allows to block shutdown for some time, e.g. until endpoints pointing to this API server
	// have converged on all node. During this time, the API server keeps serving, /healthz will return 200,
	// but /readyz will return failure.
	ShutdownDelayDuration time.Duration

	ShutdownTimeoutDuration time.Duration

	// The limit on the request body size that would be accepted and decoded in a write request.
	// 0 means no limit.
	maxRequestBodyBytes int64

	// WebServerID is the ID of this Web server
	WebServerID string
}

// preparedGenericWebServer is a private wrapper that enforces a call of PrepareRun() before Run can be invoked.
type preparedGenericWebServer struct {
	*GenericWebServer
}

func (s preparedGenericWebServer) NonBlockingRun(ctx context.Context) (context.Context, error) {

	ctx, cancel := context.WithCancel(ctx)
	go func() {
		defer cancel()
		err := s.grpcBackend.ListenAndServe()
		if err != nil {
			return
		}
	}()

	return ctx, nil
}

func (s preparedGenericWebServer) Run(ctx context.Context) error {
	ctx, cancel := context.WithCancel(ctx)
	defer cancel()

	logrus.Infof("Installing http server on %s", s.grpcBackend.Addr)
	ctx, err := s.NonBlockingRun(ctx)
	if err != nil {
		return err
	}
	s.RunPostStartHooks(ctx)
	logrus.Infof("Installed http server on %s", s.grpcBackend.Addr)

	<-ctx.Done()
	// run shutdown hooks directly. This includes deregistering from the kubernetes endpoint in case of kube-apiserver.
	err = s.RunPreShutdownHooks()
	if err != nil {
		logrus.Errorf("failed to run pre shutted down hook, err: %v", err)
		return err
	}

	//shutdown
	shutDownCtx, shutDownCancel := context_.WithTimeout(context.Background(), s.ShutdownTimeoutDuration)
	defer shutDownCancel()

	err = s.grpcBackend.Shutdown(shutDownCtx)
	if err != nil {
		logrus.Errorf("failed to shutted down http server on %s, err: %v", s.grpcBackend.Addr, err)
		return err
	}
	logrus.Infof("Shutted down http server on %s", s.grpcBackend.Addr)
	return nil
}

func (s *GenericWebServer) PrepareRun() (preparedGenericWebServer, error) {
	if s.grpcBackend != nil {
		// assgined ginBackend to grpc handler
		s.grpcBackend.Handler = s.ginBackend
	}

	curOpenFiles, err := syscall_.SetMaxNumFiles()
	if err != nil {
		logrus.Errorf("failed to set max num files, err: %v", err)
		return preparedGenericWebServer{}, err
	}
	logrus.Infof("set %v num files", curOpenFiles)
	return preparedGenericWebServer{s}, nil
}

func (s *GenericWebServer) InstallWebHandlers(handlers ...WebHandler) {
	for _, h := range handlers {
		if h == nil {
			continue
		}
		h.SetRoutes(s.ginBackend, s.grpcBackend)
	}
}