Refactor & enabled log() fn in all services

This commit is contained in:
Denis Arh
2019-09-30 19:50:04 +02:00
parent 56925fc831
commit f9c3cd0065
20 changed files with 110 additions and 71 deletions
+5 -3
View File
@@ -5,10 +5,12 @@ import (
"github.com/titpetric/factory"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"github.com/cortezaproject/corteza-server/compose/repository"
"github.com/cortezaproject/corteza-server/compose/types"
"github.com/cortezaproject/corteza-server/pkg/handle"
"github.com/cortezaproject/corteza-server/pkg/logger"
)
type (
@@ -66,9 +68,9 @@ func (svc chart) With(ctx context.Context) ChartService {
}
// log() returns zap's logger with requestID from current context and fields.
// func (svc chart) log(fields ...zapcore.Field) *zap.Logger {
// return logger.AddRequestID(svc.ctx, svc.logger).With(fields...)
// }
func (svc chart) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
func (svc chart) FindByID(namespaceID, chartID uint64) (c *types.Chart, err error) {
if _, err = svc.loadNamespace(namespaceID); err != nil {
+5 -3
View File
@@ -5,10 +5,12 @@ import (
"github.com/titpetric/factory"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"github.com/cortezaproject/corteza-server/compose/repository"
"github.com/cortezaproject/corteza-server/compose/types"
"github.com/cortezaproject/corteza-server/pkg/handle"
"github.com/cortezaproject/corteza-server/pkg/logger"
)
type (
@@ -69,9 +71,9 @@ func (svc module) With(ctx context.Context) ModuleService {
}
// log() returns zap's logger with requestID from current context and fields.
// func (svc module) log(fields ...zapcore.Field) *zap.Logger {
// return logger.AddRequestID(svc.ctx, svc.logger).With(fields...)
// }
func (svc module) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
func (svc module) FindByID(namespaceID, moduleID uint64) (m *types.Module, err error) {
if _, err = svc.loadNamespace(namespaceID); err != nil {
+5 -3
View File
@@ -5,11 +5,13 @@ import (
"github.com/titpetric/factory"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"github.com/cortezaproject/corteza-server/compose/repository"
"github.com/cortezaproject/corteza-server/compose/types"
"github.com/cortezaproject/corteza-server/internal/permissions"
"github.com/cortezaproject/corteza-server/pkg/handle"
"github.com/cortezaproject/corteza-server/pkg/logger"
)
type (
@@ -66,9 +68,9 @@ func (svc namespace) With(ctx context.Context) NamespaceService {
}
// log() returns zap's logger with requestID from current context and fields.
// func (svc namespace) log(fields ...zapcore.Field) *zap.Logger {
// return logger.AddRequestID(svc.ctx, svc.logger).With(fields...)
// }
func (svc namespace) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
func (svc namespace) FindByID(ID uint64) (ns *types.Namespace, err error) {
return svc.checkPermissions(svc.namespaceRepo.FindByID(ID))
+5 -3
View File
@@ -9,10 +9,12 @@ import (
"github.com/pkg/errors"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
gomail "gopkg.in/mail.v2"
httpClient "github.com/cortezaproject/corteza-server/internal/http"
"github.com/cortezaproject/corteza-server/internal/mail"
"github.com/cortezaproject/corteza-server/pkg/logger"
)
type (
@@ -28,9 +30,9 @@ func Notification() *notification {
}
// log() returns zap's logger with requestID from current context and fields.
// func (svc notification) log(fields ...zapcore.Field) *zap.Logger {
// return logger.AddRequestID(svc.ctx, svc.logger).With(fields...)
// }
func (svc notification) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
func (svc notification) SendEmail(message *gomail.Message) error {
return mail.Send(message)
+5 -3
View File
@@ -5,10 +5,12 @@ import (
"github.com/titpetric/factory"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"github.com/cortezaproject/corteza-server/compose/repository"
"github.com/cortezaproject/corteza-server/compose/types"
"github.com/cortezaproject/corteza-server/pkg/handle"
"github.com/cortezaproject/corteza-server/pkg/logger"
)
type (
@@ -73,9 +75,9 @@ func (svc page) With(ctx context.Context) PageService {
}
// log() returns zap's logger with requestID from current context and fields.
// func (svc page) log(fields ...zapcore.Field) *zap.Logger {
// return logger.AddRequestID(svc.ctx, svc.logger).With(fields...)
// }
func (svc page) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
func (svc page) FindByID(namespaceID, pageID uint64) (p *types.Page, err error) {
if _, err = svc.loadNamespace(namespaceID); err != nil {
+5 -3
View File
@@ -10,11 +10,13 @@ import (
"github.com/pkg/errors"
"github.com/titpetric/factory"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"github.com/cortezaproject/corteza-server/compose/decoder"
"github.com/cortezaproject/corteza-server/compose/repository"
"github.com/cortezaproject/corteza-server/compose/types"
"github.com/cortezaproject/corteza-server/internal/auth"
"github.com/cortezaproject/corteza-server/pkg/logger"
)
const (
@@ -133,9 +135,9 @@ func (svc record) With(ctx context.Context) RecordService {
}
// log() returns zap's logger with requestID from current context and fields.
// func (svc record) log(fields ...zapcore.Field) *zap.Logger {
// return logger.AddRequestID(svc.ctx, svc.logger).With(fields...)
// }
func (svc record) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
func (svc record) FindByID(namespaceID, recordID uint64) (r *types.Record, err error) {
if namespaceID == 0 {
+5 -3
View File
@@ -4,8 +4,10 @@ import (
"context"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"github.com/cortezaproject/corteza-server/messaging/types"
"github.com/cortezaproject/corteza-server/pkg/logger"
)
type (
@@ -33,9 +35,9 @@ func (svc command) With(ctx context.Context) CommandService {
}
// log() returns zap's logger with requestID from current context and fields.
// func (svc command) log(fields ...zapcore.Field) *zap.Logger {
// return logger.AddRequestID(svc.ctx, svc.logger).With(fields...)
// }
func (svc command) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
func (svc command) Do(channelID uint64, command, input string) (*types.Message, error) {
switch command {
+5 -3
View File
@@ -4,11 +4,13 @@ import (
"context"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"github.com/cortezaproject/corteza-server/internal/payload"
"github.com/cortezaproject/corteza-server/internal/payload/outgoing"
"github.com/cortezaproject/corteza-server/messaging/repository"
"github.com/cortezaproject/corteza-server/messaging/types"
"github.com/cortezaproject/corteza-server/pkg/logger"
)
type (
@@ -48,9 +50,9 @@ func (svc event) With(ctx context.Context) EventService {
}
// log() returns zap's logger with requestID from current context and fields.
// func (svc event) log(fields ...zapcore.Field) *zap.Logger {
// return logger.AddRequestID(svc.ctx, svc.logger).With(fields...)
// }
func (svc event) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
// Message sends message events to subscribers
func (svc event) Message(m *types.Message) error {
+5 -3
View File
@@ -8,11 +8,13 @@ import (
"github.com/pkg/errors"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"github.com/cortezaproject/corteza-server/internal/auth"
"github.com/cortezaproject/corteza-server/internal/payload"
"github.com/cortezaproject/corteza-server/messaging/repository"
"github.com/cortezaproject/corteza-server/messaging/types"
"github.com/cortezaproject/corteza-server/pkg/logger"
)
type (
@@ -104,9 +106,9 @@ func (svc message) With(ctx context.Context) MessageService {
}
// log() returns zap's logger with requestID from current context and fields.
// func (svc message) log(fields ...zapcore.Field) *zap.Logger {
// return logger.AddRequestID(svc.ctx, svc.logger).With(fields...)
// }
func (svc message) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
func (svc message) Find(filter *types.MessageFilter) (mm types.MessageSet, err error) {
filter.CurrentUserID = auth.GetIdentityFromContext(svc.ctx).Identity()
+5 -3
View File
@@ -10,12 +10,14 @@ import (
"github.com/pkg/errors"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"github.com/cortezaproject/corteza-server/internal/auth"
"github.com/cortezaproject/corteza-server/internal/http"
"github.com/cortezaproject/corteza-server/internal/store"
"github.com/cortezaproject/corteza-server/messaging/repository"
"github.com/cortezaproject/corteza-server/messaging/types"
"github.com/cortezaproject/corteza-server/pkg/logger"
)
type (
@@ -78,9 +80,9 @@ func (svc webhook) With(ctx context.Context) WebhookService {
}
// log() returns zap's logger with requestID from current context and fields.
// func (svc webhook) log(fields ...zapcore.Field) *zap.Logger {
// return logger.AddRequestID(svc.ctx, svc.logger).With(fields...)
// }
func (svc webhook) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
func (svc webhook) Create(kind types.WebhookKind, channelID uint64, params types.WebhookRequest) (*types.Webhook, error) {
var userID = repository.Identity(svc.ctx)
+9 -8
View File
@@ -92,7 +92,7 @@ func (svc auth) With(ctx context.Context) AuthService {
return &auth{
db: db,
ctx: ctx,
logger: svc.logger,
logger: logger.AddRequestID(ctx, svc.logger),
credentials: repository.Credentials(ctx, db),
users: repository.User(ctx, db),
@@ -110,8 +110,8 @@ func (svc auth) With(ctx context.Context) AuthService {
}
// log() returns zap's logger with requestID from current context and fields.
func (svc auth) log(fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(svc.ctx, svc.logger).With(fields...)
func (svc auth) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
// External func performs login/signup procedures
@@ -142,7 +142,7 @@ func (svc auth) External(profile goth.User) (u *types.User, err error) {
return nil, errors.New("can not use profile data without an email")
}
log := svc.log(zap.String("provider", profile.Provider))
log := svc.log(svc.ctx, zap.String("provider", profile.Provider))
return u, svc.db.Transaction(func() error {
var c *types.Credentials
@@ -466,7 +466,7 @@ func (svc auth) checkPassword(password string, cc types.CredentialsSet) (err err
// SetPassword sets new password for a user
func (svc auth) SetPassword(userID uint64, newPassword string) (err error) {
log := svc.log(zap.Uint64("userID", userID))
log := svc.log(svc.ctx, zap.Uint64("userID", userID))
if !svc.settings.InternalEnabled {
return errors.New("internal authentication disabled")
@@ -488,7 +488,7 @@ func (svc auth) SetPassword(userID uint64, newPassword string) (err error) {
// ChangePassword validates old password and changes it with new
func (svc auth) ChangePassword(userID uint64, oldPassword, newPassword string) (err error) {
log := svc.log(zap.Uint64("userID", userID))
log := svc.log(svc.ctx, zap.Uint64("userID", userID))
if !svc.settings.InternalEnabled {
return errors.New("internal authentication disabled")
@@ -659,7 +659,7 @@ func (svc auth) SendEmailAddressConfirmationToken(email string) error {
}
func (svc auth) sendEmailAddressConfirmationToken(u *types.User) (err error) {
log := svc.log(zap.Uint64("userID", u.ID), zap.String("email", u.Email))
log := svc.log(svc.ctx, zap.Uint64("userID", u.ID), zap.String("email", u.Email))
var (
notificationLang = "en"
@@ -700,7 +700,7 @@ func (svc auth) SendPasswordResetToken(email string) error {
}
func (svc auth) sendPasswordResetToken(u *types.User) (err error) {
log := svc.log(zap.Uint64("userID", u.ID), zap.String("email", u.Email))
log := svc.log(svc.ctx, zap.Uint64("userID", u.ID), zap.String("email", u.Email))
var (
notificationLang = "en"
@@ -819,6 +819,7 @@ func (svc auth) autoPromote(u *types.User) (err error) {
err = svc.roles.MemberAddByID(permissions.AdminRoleID, u.ID)
svc.log(
svc.ctx,
zap.String("email", u.Email),
zap.Uint64("userID", u.ID),
zap.Error(err),
+6 -6
View File
@@ -115,13 +115,13 @@ func AuthNotification(ctx context.Context) AuthNotificationService {
func (svc authNotification) With(ctx context.Context) AuthNotificationService {
return &authNotification{
ctx: ctx,
logger: svc.logger,
logger: logger.AddRequestID(ctx, svc.logger),
settings: svc.settings,
}
}
func (svc authNotification) log(fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(svc.ctx, svc.logger).With(fields...)
func (svc authNotification) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
func (svc authNotification) EmailConfirmation(lang string, emailAddress string, token string) error {
@@ -156,7 +156,7 @@ func (svc authNotification) send(name, lang string, payload authNotificationPayl
ntf.SetHeader("Subject", svc.render(emailTemplates[name+"."+lang+".subject"], payload))
ntf.SetBody("text/html", svc.render(emailTemplates[name+"."+lang+".html"], payload))
svc.log().Debug(
svc.log(svc.ctx).Debug(
"sending auth notification",
zap.String("name", name),
zap.String("language", lang),
@@ -175,13 +175,13 @@ func (svc authNotification) render(source string, payload interface{}) (out stri
tpl, err = template.New("").Parse(source)
if err != nil {
svc.log(zap.Error(err)).Error("could not parse template")
svc.log(svc.ctx, zap.Error(err)).Error("could not parse template")
return
}
err = tpl.Execute(&buf, payload)
if err != nil {
svc.log(zap.Error(err)).Error("could not render template")
svc.log(svc.ctx, zap.Error(err)).Error("could not render template")
return
}
+9 -3
View File
@@ -6,6 +6,7 @@ import (
"github.com/pkg/errors"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
@@ -14,6 +15,7 @@ import (
"github.com/cortezaproject/corteza-server/pkg/automation"
"github.com/cortezaproject/corteza-server/pkg/automation/corredor"
mailTrigger "github.com/cortezaproject/corteza-server/pkg/automation/mail"
"github.com/cortezaproject/corteza-server/pkg/logger"
"github.com/cortezaproject/corteza-server/pkg/sentry"
"github.com/cortezaproject/corteza-server/system/proto"
"github.com/cortezaproject/corteza-server/system/repository"
@@ -61,6 +63,10 @@ func AutomationRunner(opt AutomationRunnerOpt, f automationScriptsFinder, r corr
return svc
}
func (svc automationRunner) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
func (svc automationRunner) Watch(ctx context.Context) {
svc.scriptFinder.Watch(ctx)
}
@@ -119,7 +125,7 @@ func (svc automationRunner) makeMailScriptRunner(ctx context.Context, mail *type
MailMessage: proto.NewMailMessage(mail),
}
svc.logger.Debug("preparing mail script runner", zap.Any("mail", mail))
svc.log(ctx).Debug("preparing mail script runner", zap.Any("mail", mail))
return func(script *automation.Script) error {
if svc.runner == nil {
@@ -151,7 +157,7 @@ func (svc automationRunner) makeMailScriptRunner(ctx context.Context, mail *type
if err != nil {
s, ok := status.FromError(err)
if !ok {
svc.logger.Error("unexpected error type", zap.Error(err))
svc.log(ctx).Error("unexpected error type", zap.Error(err))
return err
}
@@ -168,7 +174,7 @@ func (svc automationRunner) makeMailScriptRunner(ctx context.Context, mail *type
default:
}
svc.logger.Info("script executed with errors", zap.Error(err))
svc.log(ctx).Info("script executed with errors", zap.Error(err))
if !script.Critical {
// This was not a critical call and we do not care about
+6
View File
@@ -4,10 +4,12 @@ import (
"context"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
intAuth "github.com/cortezaproject/corteza-server/internal/auth"
"github.com/cortezaproject/corteza-server/internal/permissions"
"github.com/cortezaproject/corteza-server/pkg/automation"
"github.com/cortezaproject/corteza-server/pkg/logger"
)
type (
@@ -48,6 +50,10 @@ func AutomationScript(sm automationScriptManager) automationScript {
return svc
}
func (svc automationScript) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
func (svc automationScript) FindByID(ctx context.Context, scriptID uint64) (*automation.Script, error) {
if s, err := svc.loadCombo(ctx, scriptID); err != nil {
return nil, err
+5 -3
View File
@@ -7,7 +7,9 @@ import (
"net/mail"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"github.com/cortezaproject/corteza-server/pkg/logger"
"github.com/cortezaproject/corteza-server/system/types"
)
@@ -31,9 +33,9 @@ func Mailproc() *mailproc {
}
// log() returns zap's logger with requestID from current context and fields.
// func (svc mailproc) log(fields ...zapcore.Field) *zap.Logger {
// return logger.AddRequestID(svc.ctx, svc.logger).With(fields...)
// }
func (svc mailproc) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
func (svc mailproc) ContentProcessor(ctx context.Context, m io.Reader) error {
if m, err := mailProcMessage(m); err != nil {
+5 -5
View File
@@ -5,7 +5,9 @@ import (
"github.com/titpetric/factory"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"github.com/cortezaproject/corteza-server/pkg/logger"
"github.com/cortezaproject/corteza-server/system/repository"
"github.com/cortezaproject/corteza-server/system/types"
)
@@ -51,11 +53,9 @@ func (svc organisation) With(ctx context.Context) OrganisationService {
}
}
// log() returns zap's logger with requestID from current context and fields.
// func (svc organisation) log(fields ...zapcore.Field) *zap.Logger {
// return logger.AddRequestID(svc.ctx, svc.logger).With(fields...)
// }
func (svc organisation) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
func (svc organisation) FindByID(id uint64) (*types.Organisation, error) {
// @todo: permission check if current user can read organisation
return svc.rpo.FindByID(id)
+5 -4
View File
@@ -6,8 +6,10 @@ import (
"github.com/pkg/errors"
"github.com/titpetric/factory"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"github.com/cortezaproject/corteza-server/pkg/handle"
"github.com/cortezaproject/corteza-server/pkg/logger"
"github.com/cortezaproject/corteza-server/system/repository"
"github.com/cortezaproject/corteza-server/system/types"
)
@@ -79,10 +81,9 @@ func (svc role) With(ctx context.Context) RoleService {
}
}
// log() returns zap's logger with requestID from current context and fields.
// func (svc role) log(fields ...zapcore.Field) *zap.Logger {
// return logger.AddRequestID(svc.ctx, svc.logger).With(fields...)
// }
func (svc role) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
func (svc role) FindByID(roleID uint64) (*types.Role, error) {
return svc.findByID(roleID)
+5 -4
View File
@@ -7,8 +7,10 @@ import (
"github.com/pkg/errors"
"github.com/titpetric/factory"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
internalSettings "github.com/cortezaproject/corteza-server/internal/settings"
"github.com/cortezaproject/corteza-server/pkg/logger"
"github.com/cortezaproject/corteza-server/system/repository"
)
@@ -62,10 +64,9 @@ func (svc settings) With(ctx context.Context) SettingsService {
}
}
// log() returns zap's logger with requestID from current context and fields.
// func (svc settings) log(fields ...zapcore.Field) *zap.Logger {
// return logger.AddRequestID(svc.ctx, svc.logger).With(fields...)
// }
func (svc settings) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
func (svc settings) FindByPrefix(prefix string) (vv internalSettings.ValueSet, err error) {
if !svc.ac.CanReadSettings(svc.ctx) {
+7
View File
@@ -6,6 +6,9 @@ import (
"strings"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"github.com/cortezaproject/corteza-server/pkg/logger"
)
type (
@@ -51,3 +54,7 @@ func (svc *sink) Process(ctx context.Context, contentType string, r io.Reader) (
return
}
func (svc sink) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
+3 -8
View File
@@ -83,8 +83,8 @@ func User(ctx context.Context) UserService {
}
// log() returns zap's logger with requestID from current context and fields.
func (svc user) log(fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(svc.ctx, svc.logger).With(fields...)
func (svc user) log(ctx context.Context, fields ...zapcore.Field) *zap.Logger {
return logger.AddRequestID(ctx, svc.logger).With(fields...)
}
func (svc user) With(ctx context.Context) UserService {
@@ -104,11 +104,6 @@ func (svc user) With(ctx context.Context) UserService {
}
}
// log() returns zap's logger with requestID from current context and fields.
// func (svc user) log(fields ...zapcore.Field) *zap.Logger {
// return logger.AddRequestID(svc.ctx, svc.logger).With(fields...)
// }
func (svc user) FindByID(ID uint64) (*types.User, error) {
if ID == 0 {
return nil, ErrInvalidID
@@ -283,7 +278,7 @@ func (svc user) Unsuspend(ID uint64) (err error) {
//
// Expecting setter to have permissions to update modify users and internal authentication enabled
func (svc user) SetPassword(userID uint64, newPassword string) (err error) {
log := svc.log(zap.Uint64("userID", userID))
log := svc.log(svc.ctx, zap.Uint64("userID", userID))
if !svc.settings.InternalEnabled {
return errors.New("internal authentication disabled")