feat: Implement request logging functionality

logutils/override.go

@@ -10,13 +10,13 @@ import (
 )
 
 type LogSettings struct {
-	Enabled         bool
-	MobileSystem    bool
-	Level           string
-	File            string
-	MaxSize         int
-	MaxBackups      int
-	CompressRotated bool
+	Enabled         bool   `json:"Enabled"`
+	MobileSystem    bool   `json:"MobileSystem"`
+	Level           string `json:"Level"`
+	File            string `json:"File"`
+	MaxSize         int    `json:"MaxSize"`
+	MaxBackups      int    `json:"MaxBackups"`
+	CompressRotated bool   `json:"CompressRotated"`
 }
 
 // OverrideWithStdLogger overwrites ethereum's root logger with a logger from golang std lib.

logutils/requestlog/request_log.go

@@ -0,0 +1,59 @@
+package requestlog
+
+import (
+	"errors"
+	"sync/atomic"
+
+	"github.com/ethereum/go-ethereum/log"
+
+	"github.com/status-im/status-go/logutils"
+)
+
+var (
+	// requestLogger is the request logger object
+	requestLogger log.Logger
+	// isRequestLoggingEnabled controls whether request logging is enabled
+	isRequestLoggingEnabled atomic.Bool
+)
+
+// NewRequestLogger creates a new request logger object
+func NewRequestLogger(ctx ...interface{}) log.Logger {
+	requestLogger = log.New(ctx...)
+	return requestLogger
+}
+
+// EnableRequestLogging enables or disables RPC logging
+func EnableRequestLogging(enable bool) {
+	if enable {
+		isRequestLoggingEnabled.Store(true)
+	} else {
+		isRequestLoggingEnabled.Store(false)
+	}
+}
+
+// IsRequestLoggingEnabled returns whether RPC logging is enabled
+func IsRequestLoggingEnabled() bool {
+	return isRequestLoggingEnabled.Load()
+}
+
+// GetRequestLogger returns the RPC logger object
+func GetRequestLogger() log.Logger {
+	return requestLogger
+}
+
+func ConfigureAndEnableRequestLogging(file string) error {
+	log.Info("initialising request logger", "log file", file)
+	requestLogger := NewRequestLogger()
+	if file == "" {
+		return errors.New("log file path is required")
+	}
+	fileOpts := logutils.FileOptions{
+		Filename:   file,
+		MaxBackups: 1,
+	}
+	handler := logutils.FileHandlerWithRotation(fileOpts, log.LogfmtFormat())
+	filteredHandler := log.LvlFilterHandler(log.LvlDebug, handler)
+	requestLogger.SetHandler(filteredHandler)
+	EnableRequestLogging(true)
+	return nil
+}

mobile/init_logging_test.go

@@ -0,0 +1,47 @@
+package statusgo
+
+import (
+	"fmt"
+	"os"
+	"path"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/status-im/status-go/logutils/requestlog"
+	"github.com/status-im/status-go/protocol/requests"
+)
+
+func TestInitLogging(t *testing.T) {
+	tempDir := t.TempDir()
+	t.Logf("temp dir: %s", tempDir)
+	gethLogFile := path.Join(tempDir, "geth.log")
+	requestsLogFile := path.Join(tempDir, "requests.log")
+	logSettings := fmt.Sprintf(`{"LogRequestGo": true, "LogRequestFile": "%s", "File": "%s", "Level": "INFO", "Enabled": true, "MobileSystem": false}`, requestsLogFile, gethLogFile)
+	response := InitLogging(logSettings)
+	require.Equal(t, `{"error":""}`, response)
+	_, err := os.Stat(gethLogFile)
+	require.NoError(t, err)
+	require.True(t, requestlog.IsRequestLoggingEnabled())
+
+	// requests log file should not be created yet
+	_, err = os.Stat(requestsLogFile)
+	require.Error(t, err)
+	require.True(t, os.IsNotExist(err))
+
+	createAccountRequest := &requests.CreateAccount{
+		DisplayName:        "some-display-name",
+		CustomizationColor: "#ffffff",
+		Password:           "some-password",
+		RootDataDir:        tempDir,
+		LogFilePath:        gethLogFile,
+	}
+	_, err = statusBackend.CreateAccountAndLogin(createAccountRequest)
+	require.NoError(t, err)
+	result := CallPrivateRPC(`{"jsonrpc":"2.0","method":"settings_getSettings","params":[],"id":1}`)
+	require.NotContains(t, result, "error")
+	// Check if request log file exists now
+	_, err = os.Stat(requestsLogFile)
+	require.NoError(t, err)
+	require.FileExists(t, requestsLogFile)
+}