refactor(serverLog): split file manager and writer manager

Author: marjune163

src/app/main.go

@@ -14,8 +14,8 @@ import (
 )
 
 type App struct {
-	vhostSvc   *goVirtualHost.Service
-	logFileMan *serverLog.FileMan
+	vhostSvc *goVirtualHost.Service
+	logMan   *serverLog.Man
 }
 
 func (app *App) Open() []error {
@@ -31,17 +31,17 @@ func (app *App) Open() []error {
 
 func (app *App) Close() {
 	app.vhostSvc.Close()
-	app.logFileMan.Close()
+	app.logMan.CloseFiles()
 }
 
 func (app *App) Shutdown() {
 	ctx, _ := context.WithTimeout(context.Background(), time.Millisecond*100)
 	app.vhostSvc.Shutdown(ctx)
-	app.logFileMan.Close()
+	app.logMan.CloseFiles()
 }
 
 func (app *App) ReOpenLog() []error {
-	return app.logFileMan.Reopen()
+	return app.logMan.ReOpenFiles()
 }
 
 func (app *App) ReLoadCertificates() []error {
@@ -61,12 +61,12 @@ func NewApp(params param.Params, settings *setting.Setting) (*App, []error) {
 	}
 
 	vhSvc := goVirtualHost.NewService()
-	logFileMan := serverLog.NewFileMan()
+	logMan := serverLog.NewMan()
 	themePool := make(map[string]theme.Theme)
 
 	for _, p := range params {
 		// logger
-		logger, errs := logFileMan.NewLogger(p.AccessLog, p.ErrorLog)
+		logger, errs := logMan.NewLogger(p.AccessLog, p.ErrorLog)
 		if len(errs) > 0 {
 			return nil, errs
 		}
@@ -125,7 +125,7 @@ func NewApp(params param.Params, settings *setting.Setting) (*App, []error) {
 	}
 
 	return &App{
-		vhostSvc:   vhSvc,
-		logFileMan: logFileMan,
+		vhostSvc: vhSvc,
+		logMan:   logMan,
 	}, nil
 }

src/serverLog/fileDest.go

@@ -77,16 +77,10 @@ func (dest *fileDest) serve() {
 			os.Stderr.WriteString(e.Error() + "\n")
 		}
 	}
-	if dest.info != nil { // not Stdout or Stderr
-		dest.file.Close()
-	}
+	dest.file.Close()
 }
 
 func (dest *fileDest) reopen() error {
-	if dest.info == nil { // Stdout or Stderr
-		return nil
-	}
-
 	matched := false
 	file, info, err := getFileInfoIfNotMatch(dest.fsPath, func(info os.FileInfo) bool {
 		matched = os.SameFile(info, dest.info)

src/serverLog/fileMan.go

@@ -1,5 +1,3 @@
-// fileMan maintains opened files shared by multiple loggerChan
-
 package serverLog
 
 import (
@@ -15,41 +13,52 @@ type FileMan struct {
 	dests []*fileDest
 }
 
-func (fMan *FileMan) getWritingCh(fsPath string, file *os.File) (chan<- []byte, error) {
-	if len(fsPath) == 0 && file == nil {
+func (fMan *FileMan) ReOpen() []error {
+	var errs []error
+
+	for _, dest := range fMan.dests {
+		err := dest.reopen()
+		if err != nil {
+			errs = append(errs, err)
+		}
+	}
+
+	return errs
+}
+
+func (fMan *FileMan) Close() {
+	for _, dest := range fMan.dests {
+		dest.close()
+	}
+	fMan.wg.Wait()
+}
+
+func (fMan *FileMan) getWritingCh(fsPath string) (chan<- []byte, error) {
+	if len(fsPath) == 0 {
 		return nil, errors.New("log file not provided")
 	}
 
+	var file *os.File
 	var info os.FileInfo
 	var err error
 
-	if file == nil { // regular file
-		var ch chan<- []byte
-		file, info, err = getFileInfoIfNotMatch(fsPath, func(info os.FileInfo) bool {
-			for _, dest := range fMan.dests {
-				if os.SameFile(info, dest.info) {
-					ch = dest.ch
-					return true
-				}
-			}
-			return false
-		})
-
-		if err != nil {
-			return nil, err
-		}
-
-		if ch != nil {
-			return ch, nil
-		}
-	} else { // Stdout or Stderr
+	var ch chan<- []byte
+	file, info, err = getFileInfoIfNotMatch(fsPath, func(info os.FileInfo) bool {
 		for _, dest := range fMan.dests {
-			if file == dest.file {
-				return dest.ch, nil
+			if os.SameFile(info, dest.info) {
+				ch = dest.ch
+				return true
 			}
 		}
+		return false
+	})
+
+	if err != nil {
+		return nil, err
+	}
 
-		fsPath = file.Name()
+	if ch != nil {
+		return ch, nil
 	}
 
 	dest := newFileDest(fsPath, file, info)
@@ -64,37 +73,12 @@ func (fMan *FileMan) getWritingCh(fsPath string, file *os.File) (chan<- []byte,
 	return dest.ch, nil
 }
 
-func (fMan *FileMan) Reopen() []error {
-	var errs []error
-
-	for _, dest := range fMan.dests {
-		err := dest.reopen()
-		if err != nil {
-			errs = append(errs, err)
-		}
-	}
-
-	return errs
-}
-
-func (fMan *FileMan) Close() {
-	for _, dest := range fMan.dests {
-		dest.close()
-	}
-	fMan.wg.Wait()
-}
-
-func (fMan *FileMan) newLogChan(fsPath string, dashFile *os.File) (loggerChan, error) {
+func (fMan *FileMan) newLogChan(fsPath string) (loggerChan, error) {
 	var ch chan<- []byte
 	var err error
 
 	if len(fsPath) > 0 {
-		if fsPath == "-" {
-			ch, err = fMan.getWritingCh("", dashFile)
-		} else {
-			ch, err = fMan.getWritingCh(fsPath, nil)
-		}
-
+		ch, err = fMan.getWritingCh(fsPath)
 		if err != nil {
 			return nil, err
 		}
@@ -106,20 +90,16 @@ func (fMan *FileMan) newLogChan(fsPath string, dashFile *os.File) (loggerChan, e
 func (fMan *FileMan) NewLogger(accLogFilename, errLogFilename string) (*Logger, []error) {
 	var errs []error
 
-	accChan, err := fMan.newLogChan(accLogFilename, os.Stdout)
+	accChan, err := fMan.newLogChan(accLogFilename)
 	if err != nil {
 		errs = append(errs, err)
 	}
 
-	errChan, err := fMan.newLogChan(errLogFilename, os.Stderr)
+	errChan, err := fMan.newLogChan(errLogFilename)
 	if err != nil {
 		errs = append(errs, err)
 	}
 
-	if len(errs) > 0 {
-		return nil, errs
-	}
-
 	logger := &Logger{
 		acc: accChan,
 		err: errChan,

src/serverLog/logger.go

@@ -1,6 +1,3 @@
-// Logger maintains access log and error log objects for each virtual host.
-// It also determines what a "-" file means, Stdout or Stderr, depends on the loggerChan's role.
-
 package serverLog
 
 type Logger struct {

src/serverLog/loggerChan.go

@@ -1,7 +1,3 @@
-// loggerChan controls if log action should really be performed by `canLog()`
-// It also provides utility functions to accept other data format rather than []byte,
-// e.g. `logString()` accepts string as log data.
-
 package serverLog
 
 type loggerChan chan<- []byte

src/serverLog/man.go

@@ -0,0 +1,55 @@
+package serverLog
+
+import "os"
+
+const stdIO string = "-"
+
+type Man struct {
+	fMan *FileMan
+	wMan *WriterMan
+}
+
+func (man *Man) ReOpenFiles() []error {
+	return man.fMan.ReOpen()
+}
+
+func (man *Man) CloseFiles() {
+	man.fMan.Close()
+}
+
+func (man *Man) NewLogger(accessLog, errorLog string) (*Logger, []error) {
+	var accChan, errChan loggerChan
+	var err error
+	var errs []error
+
+	if accessLog != stdIO {
+		accChan, err = man.fMan.newLogChan(accessLog)
+	} else {
+		accChan, err = man.wMan.newLogChan(os.Stdout)
+	}
+	if err != nil {
+		errs = append(errs, err)
+	}
+
+	if errorLog != stdIO {
+		errChan, err = man.fMan.newLogChan(errorLog)
+	} else {
+		errChan, err = man.wMan.newLogChan(os.Stderr)
+	}
+	if err != nil {
+		errs = append(errs, err)
+	}
+
+	logger := &Logger{
+		acc: accChan,
+		err: errChan,
+	}
+	return logger, nil
+}
+
+func NewMan() *Man {
+	return &Man{
+		fMan: NewFileMan(),
+		wMan: NewWriterMan(),
+	}
+}

src/serverLog/writerDest.go

@@ -0,0 +1,36 @@
+package serverLog
+
+import (
+	"io"
+	"os"
+)
+
+type writerDest struct {
+	w  io.Writer
+	ch chan []byte
+}
+
+func newWriterDest(w io.Writer) *writerDest {
+	ch := make(chan []byte, chanBuffer)
+
+	dest := &writerDest{
+		w:  w,
+		ch: ch,
+	}
+
+	return dest
+}
+
+func (dest *writerDest) serve() {
+	for payload := range dest.ch {
+		payload = append(payload, logEnding)
+		_, e := dest.w.Write(payload)
+		if e != nil {
+			os.Stderr.WriteString(e.Error() + "\n")
+		}
+	}
+}
+
+func (dest *writerDest) close() {
+	close(dest.ch)
+}