golib/context/ginTonic.go

/*
MIT License

Copyright (c) 2019 Nicolas JUHEL

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 context

import (
	"context"
	"os"
	"os/signal"
	"time"

	"github.com/gin-gonic/gin"
	liblog "github.com/nabbar/golib/logger"
)

type GinTonic interface {
	context.Context

	//generic
	GinContext() *gin.Context
	CancelOnSignal(s ...os.Signal)

	//gin context metadata
	Set(key string, value interface{})
	Get(key string) (value interface{}, exists bool)
	MustGet(key string) interface{}
	GetString(key string) (s string)
	GetBool(key string) (b bool)
	GetInt(key string) (i int)
	GetInt64(key string) (i64 int64)
	GetFloat64(key string) (f64 float64)
	GetTime(key string) (t time.Time)
	GetDuration(key string) (d time.Duration)
	GetStringSlice(key string) (ss []string)
	GetStringMap(key string) (sm map[string]interface{})
	GetStringMapString(key string) (sms map[string]string)
	GetStringMapStringSlice(key string) (smss map[string][]string)
}

type ctxGinTonic struct {
	g *gin.Context
	x context.Context
	c context.CancelFunc
}

func NewGinTonic(c *gin.Context) GinTonic {
	if c == nil {
		c = &gin.Context{
			Request:  nil,
			Writer:   nil,
			Params:   make(gin.Params, 0),
			Keys:     make(map[string]interface{}),
			Errors:   make([]*gin.Error, 0),
			Accepted: make([]string, 0),
		}
	}

	var (
		x context.Context
		l context.CancelFunc
	)

	if c.Request != nil && c.Request.Context() != nil {
		x, l = context.WithCancel(c.Request.Context())
	} else {
		x, l = context.WithCancel(c)
	}

	return &ctxGinTonic{
		c,
		x,
		l,
	}
}

func (c *ctxGinTonic) CancelOnSignal(s ...os.Signal) {
	go func() {
		sc := make(chan os.Signal, 1)
		signal.Notify(sc, s...)

		select {
		case <-sc:
			liblog.InfoLevel.Logf("Os Signal received, calling context cancel !")
			c.c()
			return
		case <-c.Done():
			liblog.InfoLevel.Logf("Context has been closed...")
			return
		}
	}()
}

func (c *ctxGinTonic) Deadline() (deadline time.Time, ok bool) {
	return c.x.Deadline()
}

func (c *ctxGinTonic) Done() <-chan struct{} {
	return c.x.Done()
}

func (c *ctxGinTonic) Err() error {
	return c.x.Err()
}

func (c *ctxGinTonic) Value(key interface{}) interface{} {
	return c.g.Value(key)
}

func (c *ctxGinTonic) GinContext() *gin.Context {
	return c.g
}

func (c *ctxGinTonic) Set(key string, value interface{}) {
	c.g.Set(key, value)
}

func (c *ctxGinTonic) Get(key string) (value interface{}, exists bool) {
	return c.g.Get(key)
}

func (c *ctxGinTonic) MustGet(key string) interface{} {
	return c.g.MustGet(key)
}

func (c *ctxGinTonic) GetString(key string) (s string) {
	return c.g.GetString(key)
}

func (c *ctxGinTonic) GetBool(key string) (b bool) {
	return c.g.GetBool(key)
}

func (c *ctxGinTonic) GetInt(key string) (i int) {
	return c.g.GetInt(key)
}

func (c *ctxGinTonic) GetInt64(key string) (i64 int64) {
	return c.g.GetInt64(key)
}

func (c *ctxGinTonic) GetFloat64(key string) (f64 float64) {
	return c.g.GetFloat64(key)
}

func (c *ctxGinTonic) GetTime(key string) (t time.Time) {
	return c.g.GetTime(key)
}

func (c *ctxGinTonic) GetDuration(key string) (d time.Duration) {
	return c.g.GetDuration(key)
}

func (c *ctxGinTonic) GetStringSlice(key string) (ss []string) {
	return c.g.GetStringSlice(key)
}

func (c *ctxGinTonic) GetStringMap(key string) (sm map[string]interface{}) {
	return c.g.GetStringMap(key)
}

func (c *ctxGinTonic) GetStringMapString(key string) (sms map[string]string) {
	return c.g.GetStringMapString(key)
}

func (c *ctxGinTonic) GetStringMapStringSlice(key string) (smss map[string][]string) {
	return c.g.GetStringMapStringSlice(key)
}