lbatuska/goutils
1
1
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: naming (#1)

Browse Source
This commit was merged in pull request #1.
This commit is contained in:
Levente Nas
2024-09-25 09:42:06 +02:00
committed by GitHub
parent 23a8a9ee04
commit c4b6077e3a
11 changed files with 122 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
logger/ConsoleLogger.go
View File

@@ -5,11 +5,11 @@ import (
"time"
)
func (lgr *ConsoleLoggerimpl) init() {
func (lgr *ConsoleLoggerImpl) init() {
lgr.messages = make(chan string, logbuffersize)
}
func (logger *ConsoleLoggerimpl) StartLogger() {
func (logger *ConsoleLoggerImpl) StartLogger() {
fmt.Println("Starting Logger")
loggerlogonce.Do(func() {
for msg := range logger.messages {
@@ -18,15 +18,15 @@ func (logger *ConsoleLoggerimpl) StartLogger() {
})
}
func (logger *ConsoleLoggerimpl) Write(message string) {
func (logger *ConsoleLoggerImpl) Write(message string) {
logger.messages <- time.Now().Format(time.UnixDate) + " : " + message + "\n"
}
func (logger *ConsoleLoggerimpl) Write_Request(message string, uuid string) {
func (logger *ConsoleLoggerImpl) WriteRequest(message string, uuid string) {
logger.Write(uuid + " : " + message)
}
func (logger *ConsoleLoggerimpl) WriteErr(err error) (errnum int) {
func (logger *ConsoleLoggerImpl) WriteErr(err error) (errnum int) {
if err != nil {
logger.Write("Error: " + err.Error())
errnum = 1
@@ -34,7 +34,7 @@ func (logger *ConsoleLoggerimpl) WriteErr(err error) (errnum int) {
return errnum
}
func (logger *ConsoleLoggerimpl) WriteErr_Request(err error, uuid string) (errnum int) {
func (logger *ConsoleLoggerImpl) WriteErrRequest(err error, uuid string) (errnum int) {
if err != nil {
logger.Write(uuid + " : Error: " + err.Error())
errnum = 1
@@ -42,29 +42,29 @@ func (logger *ConsoleLoggerimpl) WriteErr_Request(err error, uuid string) (errnu
return errnum
}
func (logger *ConsoleLoggerimpl) Write_DEBUG(message string) {
func (logger *ConsoleLoggerImpl) WriteDebug(message string) {
if DEBUG {
logger.Write(message)
}
}
func (logger *ConsoleLoggerimpl) Write_Request_DEBUG(message string, uuid string) {
func (logger *ConsoleLoggerImpl) WriteRequestDebug(message string, uuid string) {
if DEBUG {
logger.Write_Request(message, uuid)
logger.WriteRequest(message, uuid)
}
}
func (logger *ConsoleLoggerimpl) WriteErr_DEBUG(err error) (errnum int) {
func (logger *ConsoleLoggerImpl) WriteErrDebug(err error) (errnum int) {
if err != nil {
logger.Write_DEBUG("Error: " + err.Error())
logger.WriteDebug("Error: " + err.Error())
errnum = 1
}
return errnum
}
func (logger *ConsoleLoggerimpl) WriteErr_Request_DEBUG(err error, uuid string) (errnum int) {
func (logger *ConsoleLoggerImpl) WriteErrRequestDebug(err error, uuid string) (errnum int) {
if err != nil {
logger.Write_DEBUG(uuid + " : Error: " + err.Error())
logger.WriteDebug(uuid + " : Error: " + err.Error())
errnum = 1
}
return errnum

30
logger/FileLogger.go
View File

@@ -7,7 +7,7 @@ import (
"time"
)
func (lgr *FileLoggerimpl) init() {
func (lgr *FileLoggerImpl) init() {
lgr.filepath = "./log"
lgr.messages = make(chan string, logbuffersize)
envfp, envexist := os.LookupEnv("LOGFILE_GO_LOGGER")
@@ -15,10 +15,10 @@ func (lgr *FileLoggerimpl) init() {
if len(envfp) > 0 {
lgr.filepath = envfp
} else {
Logger().Write_DEBUG(fmt.Sprintf("LOGFILE_GO_LOGGER env exist but has an empty value using default value: %s !\n", lgr.filepath))
LoggerInstance().WriteDebug(fmt.Sprintf("LOGFILE_GO_LOGGER env exist but has an empty value using default value: %s !\n", lgr.filepath))
}
} else {
Logger().Write_DEBUG(fmt.Sprintf("LOGFILE_GO_LOGGER env doesn't exist using default value: %s !\n", lgr.filepath))
LoggerInstance().WriteDebug(fmt.Sprintf("LOGFILE_GO_LOGGER env doesn't exist using default value: %s !\n", lgr.filepath))
}
f, err := os.OpenFile(lgr.filepath, os.O_RDWR|os.O_APPEND|os.O_CREATE, 0660)
if err != nil {
@@ -29,7 +29,7 @@ func (lgr *FileLoggerimpl) init() {
lgr.mutex = &sync.Mutex{}
}
func (logger *FileLoggerimpl) StartLogger() {
func (logger *FileLoggerImpl) StartLogger() {
fmt.Println("Starting FileLogger")
loggerlogonce.Do(func() {
for msg := range logger.messages {
@@ -58,15 +58,15 @@ func (logger *FileLoggerimpl) StartLogger() {
// logger.mutex.Unlock()
}
func (logger *FileLoggerimpl) Write(message string) {
func (logger *FileLoggerImpl) Write(message string) {
logger.messages <- time.Now().Format(time.UnixDate) + " : " + message + "\n"
}
func (logger *FileLoggerimpl) Write_Request(message string, request string) {
func (logger *FileLoggerImpl) WriteRequest(message string, request string) {
logger.Write(request + " : " + message)
}
func (logger *FileLoggerimpl) WriteErr(err error) (errnum int) {
func (logger *FileLoggerImpl) WriteErr(err error) (errnum int) {
if err != nil {
logger.Write("Error: " + err.Error())
errnum = 1
@@ -74,7 +74,7 @@ func (logger *FileLoggerimpl) WriteErr(err error) (errnum int) {
return errnum
}
func (logger *FileLoggerimpl) WriteErr_Request(err error, uuid string) (errnum int) {
func (logger *FileLoggerImpl) WriteErrRequest(err error, uuid string) (errnum int) {
if err != nil {
logger.Write(uuid + " : Error: " + err.Error())
errnum = 1
@@ -82,29 +82,29 @@ func (logger *FileLoggerimpl) WriteErr_Request(err error, uuid string) (errnum i
return errnum
}
func (logger *FileLoggerimpl) Write_DEBUG(message string) {
func (logger *FileLoggerImpl) WriteDebug(message string) {
if DEBUG {
logger.Write(message)
}
}
func (logger *FileLoggerimpl) Write_Request_DEBUG(message string, uuid string) {
func (logger *FileLoggerImpl) WriteRequestDebug(message string, uuid string) {
if DEBUG {
logger.Write_Request(message, uuid)
logger.WriteRequest(message, uuid)
}
}
func (logger *FileLoggerimpl) WriteErr_DEBUG(err error) (errnum int) {
func (logger *FileLoggerImpl) WriteErrDebug(err error) (errnum int) {
if err != nil {
logger.Write_DEBUG("Error: " + err.Error())
logger.WriteDebug("Error: " + err.Error())
errnum = 1
}
return errnum
}
func (logger *FileLoggerimpl) WriteErr_Request_DEBUG(err error, uuid string) (errnum int) {
func (logger *FileLoggerImpl) WriteErrRequestDebug(err error, uuid string) (errnum int) {
if err != nil {
logger.Write_DEBUG(uuid + " : Error: " + err.Error())
logger.WriteDebug(uuid + " : Error: " + err.Error())
errnum = 1
}
return errnum

8
logger/Logger.go
View File

@@ -14,19 +14,19 @@ const logbuffersize int32 = 200
var DEBUG bool = true
var (
loggerInstance LGRImpl
loggerInstance Logger
loggeronce sync.Once
loggerlogonce sync.Once
)
func Create(instance LGRImpl) {
func Create(instance Logger) {
loggeronce.Do(func() {
loggerInstance = instance
loggerInstance.init()
})
}
func Logger() LGRImpl {
func LoggerInstance() Logger {
return loggerInstance
}
@@ -42,7 +42,7 @@ func PrintJson[T any](entity *T) string {
func ExampleLogMiddleware(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
Logger().Write_DEBUG(fmt.Sprintf("\tRequest from: %s to: Host: %s URL: %s \tWith HEADERS: %s \tWith BODY: %s", r.RemoteAddr, r.Host, r.URL, r.Header, r.Body))
LoggerInstance().WriteDebug(fmt.Sprintf("\tRequest from: %s to: Host: %s URL: %s \tWith HEADERS: %s \tWith BODY: %s", r.RemoteAddr, r.Host, r.URL, r.Header, r.Body))
next.ServeHTTP(w, r)
})
}

20
logger/NullLogger.go
View File

@@ -1,39 +1,39 @@
package logger
func (lgr *NullLoggerimpl) init() {}
func (lgr *NullLoggerImpl) init() {}
func (logger *NullLoggerimpl) StartLogger() {}
func (logger *NullLoggerImpl) StartLogger() {}
func (logger *NullLoggerimpl) Write(message string) {}
func (logger *NullLoggerImpl) Write(message string) {}
func (logger *NullLoggerimpl) Write_Request(message string, request string) {}
func (logger *NullLoggerImpl) WriteRequest(message string, request string) {}
func (logger *NullLoggerimpl) WriteErr(err error) (errnum int) {
func (logger *NullLoggerImpl) WriteErr(err error) (errnum int) {
if err != nil {
errnum = 1
}
return errnum
}
func (logger *NullLoggerimpl) WriteErr_Request(err error, request string) (errnum int) {
func (logger *NullLoggerImpl) WriteErrRequest(err error, request string) (errnum int) {
if err != nil {
errnum = 1
}
return errnum
}
func (logger *NullLoggerimpl) Write_DEBUG(message string) {}
func (logger *NullLoggerImpl) WriteDebug(message string) {}
func (logger *NullLoggerimpl) Write_Request_DEBUG(message string, uuid string) {}
func (logger *NullLoggerImpl) WriteRequestDebug(message string, uuid string) {}
func (logger *NullLoggerimpl) WriteErr_DEBUG(err error) (errnum int) {
func (logger *NullLoggerImpl) WriteErrDebug(err error) (errnum int) {
if err != nil {
errnum = 1
}
return errnum
}
func (logger *NullLoggerimpl) WriteErr_Request_DEBUG(err error, uuid string) (errnum int) {
func (logger *NullLoggerImpl) WriteErrRequestDebug(err error, uuid string) (errnum int) {
if err != nil {
errnum = 1
}

28
logger/interfaces.go
View File

@@ -9,39 +9,39 @@ package logger
// Unixdate : uuid : message\n
//
// Unixdate : uuid : Error: error\n
type LGRImpl interface {
LoggerI
DebugLoggerI
type Logger interface {
ReleaseLogger
DebugLogger
}
type (
LoggerI interface {
ReleaseLogger interface {
// Private, use it for member initialization etc
init()
// Start an infinite loop to write out messages from the channel
StartLogger()
Write(message string)
Write_Request(message string, uuid string)
WriteRequest(message string, uuid string)
// If an error that is not nill passed in it logs the error and returns 1, otherwise 0
WriteErr(error) int
WriteErr_Request(err error, uuid string) int
WriteErrRequest(err error, uuid string) int
}
// Use _DEBUG prints to strip them out of release builds
DebugLoggerI interface {
DebugLogger interface {
// Private, use it for member initialization etc
init()
// Start an infinite loop to write out messages from the channel
StartLogger()
Write_DEBUG(message string)
Write_Request_DEBUG(message string, uuid string)
WriteErr_DEBUG(err error) (errnum int)
WriteErr_Request_DEBUG(err error, uuid string) int
WriteDebug(message string)
WriteRequestDebug(message string, uuid string)
WriteErrDebug(err error) (errnum int)
WriteErrRequestDebug(err error, uuid string) int
}
)
// Ensure all methods from LGRImpl are implemented ccompile time
var (
_ LGRImpl = (*NullLoggerimpl)(nil)
_ LGRImpl = (*ConsoleLoggerimpl)(nil)
_ LGRImpl = (*FileLoggerimpl)(nil)
_ Logger = (*NullLoggerImpl)(nil)
_ Logger = (*ConsoleLoggerImpl)(nil)
_ Logger = (*FileLoggerImpl)(nil)
)

6
logger/types.go
View File

@@ -6,14 +6,14 @@ import (
)
// A logger without logging functionality
type NullLoggerimpl struct{}
type NullLoggerImpl struct{}
// A logger that logs to sdtout
type ConsoleLoggerimpl struct {
type ConsoleLoggerImpl struct {
messages chan string
}
type FileLoggerimpl struct {
type FileLoggerImpl struct {
messages chan string
mutex *sync.Mutex
logFile *os.File