feat: [#347] Switch logging channels on runtime

contracts/log/log.go

@@ -26,6 +26,10 @@ const (
 type Log interface {
 	// WithContext adds a context to the logger.
 	WithContext(ctx context.Context) Writer
+	// Channel return a writer for a specific channel.
+	Channel(channel string) Writer
+	// Stack return a writer for multiple channels.
+	Stack(channels []string) Writer
 	Writer
 }
 

log/application.go

@@ -13,17 +13,17 @@ import (
 type Application struct {
 	log.Writer
 	instance *logrus.Logger
+	config   config.Config
 }
 
 func NewApplication(config config.Config) *Application {
 	instance := logrus.New()
 	instance.SetLevel(logrus.DebugLevel)
 
 	if config != nil {
-		if logging := config.GetString("logging.default"); logging != "" {
-			if err := registerHook(config, instance, logging); err != nil {
+		if channel := config.GetString("logging.default"); channel != "" {
+			if err := registerHook(config, instance, channel); err != nil {
 				color.Red().Println("Init facades.Log error: " + err.Error())
-
 				return nil
 			}
 		}
@@ -32,14 +32,48 @@ func NewApplication(config config.Config) *Application {
 	return &Application{
 		instance: instance,
 		Writer:   NewWriter(instance.WithContext(context.Background())),
+		config:   config,
 	}
 }
 
 func (r *Application) WithContext(ctx context.Context) log.Writer {
-	switch r.Writer.(type) {
-	case *Writer:
-		return NewWriter(r.instance.WithContext(ctx))
-	default:
+	return NewWriter(r.instance.WithContext(ctx))
+}
+
+func (r *Application) Channel(channel string) log.Writer {
+	if channel == "" || r.config == nil {
+		return r.Writer
+	}
+
+	instance := logrus.New()
+	instance.SetLevel(logrus.DebugLevel)
+
+	if err := registerHook(r.config, instance, channel); err != nil {
+		color.Red().Println("Init facades.Log error: " + err.Error())
+		return nil
+	}
+
+	return NewWriter(instance.WithContext(context.Background()))
+}
+
+func (r *Application) Stack(channels []string) log.Writer {
+	if r.config == nil || len(channels) == 0 {
 		return r.Writer
 	}
+
+	instance := logrus.New()
+	instance.SetLevel(logrus.DebugLevel)
+
+	for _, channel := range channels {
+		if channel == "" {
+			continue
+		}
+
+		if err := registerHook(r.config, instance, channel); err != nil {
+			color.Red().Println("Init facades.Log error: " + err.Error())
+			return nil
+		}
+	}
+
+	return NewWriter(instance.WithContext(context.Background()))
 }

log/application_test.go

@@ -0,0 +1,81 @@
+package log
+
+import (
+	"io"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	mocksconfig "github.com/goravel/framework/mocks/config"
+	"github.com/goravel/framework/support/color"
+)
+
+func TestNewApplication(t *testing.T) {
+	app := NewApplication(nil)
+	assert.NotNil(t, app)
+
+	mockConfig := &mocksconfig.Config{}
+	mockConfig.On("GetString", "logging.default").Return("test")
+	mockConfig.On("GetString", "logging.channels.test.driver").Return("single")
+	mockConfig.On("GetString", "logging.channels.test.path").Return("test")
+	mockConfig.On("GetString", "logging.channels.test.level").Return("debug")
+	mockConfig.On("GetBool", "logging.channels.test.print").Return(true)
+	app = NewApplication(mockConfig)
+	assert.NotNil(t, app)
+
+	mockConfig = &mocksconfig.Config{}
+	mockConfig.On("GetString", "logging.default").Return("test")
+	mockConfig.On("GetString", "logging.channels.test.driver").Return("test")
+	assert.Contains(t, color.CaptureOutput(func(w io.Writer) {
+		assert.Nil(t, NewApplication(mockConfig))
+	}), "Init facades.Log error: Error logging channel: test")
+}
+
+func TestApplication_Channel(t *testing.T) {
+	mockConfig := &mocksconfig.Config{}
+	mockConfig.On("GetString", "logging.default").Return("test")
+	mockConfig.On("GetString", "logging.channels.test.driver").Return("single")
+	mockConfig.On("GetString", "logging.channels.test.path").Return("test")
+	mockConfig.On("GetString", "logging.channels.test.level").Return("debug")
+	mockConfig.On("GetBool", "logging.channels.test.print").Return(true)
+	app := NewApplication(mockConfig)
+	assert.NotNil(t, app)
+	assert.NotNil(t, app.Channel(""))
+
+	mockConfig.On("GetString", "logging.channels.dummy.driver").Return("daily")
+	mockConfig.On("GetString", "logging.channels.dummy.path").Return("dummy")
+	mockConfig.On("GetString", "logging.channels.dummy.level").Return("debug")
+	mockConfig.On("GetBool", "logging.channels.dummy.print").Return(true)
+	mockConfig.On("GetInt", "logging.channels.dummy.days").Return(1)
+	writer := app.Channel("dummy")
+	assert.NotNil(t, writer)
+
+	mockConfig.On("GetString", "logging.channels.test2.driver").Return("test2")
+	assert.Contains(t, color.CaptureOutput(func(w io.Writer) {
+		assert.Nil(t, app.Channel("test2"))
+	}), "Init facades.Log error: Error logging channel: test2")
+}
+
+func TestApplication_Stack(t *testing.T) {
+	mockConfig := &mocksconfig.Config{}
+	mockConfig.On("GetString", "logging.default").Return("test")
+	mockConfig.On("GetString", "logging.channels.test.driver").Return("single")
+	mockConfig.On("GetString", "logging.channels.test.path").Return("test")
+	mockConfig.On("GetString", "logging.channels.test.level").Return("debug")
+	mockConfig.On("GetBool", "logging.channels.test.print").Return(true)
+	app := NewApplication(mockConfig)
+	assert.NotNil(t, app)
+	assert.NotNil(t, app.Stack([]string{}))
+
+	mockConfig.On("GetString", "logging.channels.test2.driver").Return("test2")
+	assert.Contains(t, color.CaptureOutput(func(w io.Writer) {
+		assert.Nil(t, app.Stack([]string{"", "test2", "daily"}))
+	}), "Init facades.Log error: Error logging channel: test2")
+
+	mockConfig.On("GetString", "logging.channels.dummy.driver").Return("daily")
+	mockConfig.On("GetString", "logging.channels.dummy.path").Return("dummy")
+	mockConfig.On("GetString", "logging.channels.dummy.level").Return("debug")
+	mockConfig.On("GetBool", "logging.channels.dummy.print").Return(true)
+	mockConfig.On("GetInt", "logging.channels.dummy.days").Return(1)
+	assert.NotNil(t, app.Stack([]string{"dummy"}))
+}

log/logrus_writer.go

@@ -197,6 +197,10 @@
 
 func (r *Writer) withStackTrace(message string) {
 	erisNew := eris.New(message)
+	if erisNew == nil {
+		return
+	}
+
 	r.message = erisNew.Error()
 	format := eris.NewDefaultJSONFormat(eris.FormatOptions{
 		InvertOutput: true,
@@ -297,7 +301,7 @@
 	case log.StackDriver:
 		for _, stackChannel := range config.Get(channelPath + ".channels").([]string) {
 			if stackChannel == channel {
-				return errors.New("stack drive can't include self channel")
+				return errors.New("stack driver can't include self channel")
 			}
 
 			if err := registerHook(config, instance, stackChannel); err != nil {

testing/mock/log.go

@@ -25,6 +25,14 @@ func (r *TestLog) WithContext(ctx context.Context) log.Writer {
 	return NewTestLogWriter()
 }
 
+func (r *TestLog) Channel(channel string) log.Writer {
+	return NewTestLogWriter()
+}
+
+func (r *TestLog) Stack(channels []string) log.Writer {
+	return NewTestLogWriter()
+}
+
 type TestLogWriter struct {
 	data map[string]any
 }