-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: refactor - add ReportDispatcher (#86)
* chore: refactor - add ReportDispatcher * chore: added MutesManager.IsEntryMuted * chore: SendReport -> SendReportEntry * chore: moved muting to ReportDispatcher * chore: add tests for ReportDispatcher * chore: fixed linting * chore: more tests
- Loading branch information
1 parent
aa15dc7
commit 3338726
Showing
9 changed files
with
327 additions
and
99 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| package report | ||
|
|
||
| import ( | ||
| mutes "main/pkg/mutes" | ||
| reportersPkg "main/pkg/reporters" | ||
|
|
||
| "github.com/rs/zerolog" | ||
| ) | ||
|
|
||
| type Dispatcher struct { | ||
| Logger zerolog.Logger | ||
| MutesManager *mutes.Manager | ||
| Reporters []reportersPkg.Reporter | ||
| } | ||
|
|
||
| func NewDispatcher( | ||
| logger *zerolog.Logger, | ||
| mutesManager *mutes.Manager, | ||
| reporters []reportersPkg.Reporter, | ||
| ) *Dispatcher { | ||
| return &Dispatcher{ | ||
| Logger: logger.With().Str("component", "report_dispatcher").Logger(), | ||
| MutesManager: mutesManager, | ||
| Reporters: reporters, | ||
| } | ||
| } | ||
|
|
||
| func (d *Dispatcher) Init() error { | ||
| d.MutesManager.Load() | ||
|
|
||
| for _, reporter := range d.Reporters { | ||
| if err := reporter.Init(); err != nil { | ||
| d.Logger.Error().Err(err). | ||
| Str("name", reporter.Name()). | ||
| Msg("Error initializing reporter") | ||
| return err | ||
| } | ||
| if reporter.Enabled() { | ||
| d.Logger.Info().Str("name", reporter.Name()).Msg("Init reporter") | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (d *Dispatcher) SendReport(report reportersPkg.Report) { | ||
| if report.Empty() { | ||
| d.Logger.Debug().Msg("Empty report, not sending.") | ||
| return | ||
| } | ||
|
|
||
| d.Logger.Debug().Int("len", len(report.Entries)).Msg("Got non-empty report") | ||
|
|
||
| for _, reporter := range d.Reporters { | ||
| if !reporter.Enabled() { | ||
| d.Logger.Debug(). | ||
| Str("name", reporter.Name()). | ||
| Msg("Reporter is disabled, not sending report") | ||
| continue | ||
| } | ||
|
|
||
| d.Logger.Debug(). | ||
| Str("name", reporter.Name()). | ||
| Msg("Sending report...") | ||
|
|
||
| for _, reportEntry := range report.Entries { | ||
| if d.MutesManager.IsEntryMuted(reportEntry) { | ||
| d.Logger.Debug(). | ||
| Str("entry", reportEntry.Name()). | ||
| Msg("Notifications are muted, not sending.") | ||
| continue | ||
| } | ||
|
|
||
| if err := reporter.SendReportEntry(reportEntry); err != nil { | ||
| d.Logger.Error(). | ||
| Err(err). | ||
| Str("name", reporter.Name()). | ||
| Str("entry", reportEntry.Name()). | ||
| Msg("Failed to send report entry") | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| package report | ||
|
|
||
| import ( | ||
| "main/pkg/events" | ||
| "main/pkg/fs" | ||
| "main/pkg/logger" | ||
| mutes "main/pkg/mutes" | ||
| "main/pkg/report/entry" | ||
| reportersPkg "main/pkg/reporters" | ||
| "main/pkg/types" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestReportDispatcherInitFail(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| mutesManager := mutes.NewMutesManager("./state.json", &fs.TestFS{}, logger.GetNopLogger()) | ||
| dispatcher := NewDispatcher(logger.GetNopLogger(), mutesManager, []reportersPkg.Reporter{ | ||
| &reportersPkg.TestReporter{WithInitFail: true}, | ||
| }) | ||
|
|
||
| err := dispatcher.Init() | ||
| require.Error(t, err) | ||
| } | ||
|
|
||
| func TestReportDispatcherInitOk(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| mutesManager := mutes.NewMutesManager("./state.json", &fs.TestFS{}, logger.GetNopLogger()) | ||
| dispatcher := NewDispatcher(logger.GetNopLogger(), mutesManager, []reportersPkg.Reporter{ | ||
| &reportersPkg.TestReporter{}, | ||
| }) | ||
|
|
||
| err := dispatcher.Init() | ||
| require.NoError(t, err) | ||
| } | ||
|
|
||
| func TestReportDispatcherSendEmptyReport(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| mutesManager := mutes.NewMutesManager("./state.json", &fs.TestFS{}, logger.GetNopLogger()) | ||
| dispatcher := NewDispatcher(logger.GetNopLogger(), mutesManager, []reportersPkg.Reporter{ | ||
| &reportersPkg.TestReporter{}, | ||
| }) | ||
|
|
||
| err := dispatcher.Init() | ||
| require.NoError(t, err) | ||
|
|
||
| dispatcher.SendReport(reportersPkg.Report{Entries: make([]entry.ReportEntry, 0)}) | ||
| } | ||
|
|
||
| func TestReportDispatcherSendReportDisabledReporter(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| mutesManager := mutes.NewMutesManager("./state.json", &fs.TestFS{}, logger.GetNopLogger()) | ||
| dispatcher := NewDispatcher(logger.GetNopLogger(), mutesManager, []reportersPkg.Reporter{ | ||
| &reportersPkg.TestReporter{WithDisabled: true}, | ||
| }) | ||
|
|
||
| err := dispatcher.Init() | ||
| require.NoError(t, err) | ||
|
|
||
| dispatcher.SendReport(reportersPkg.Report{Entries: []entry.ReportEntry{ | ||
| events.ProposalsQueryErrorEvent{}, | ||
| }}) | ||
| } | ||
|
|
||
| func TestReportDispatcherSendReportMuted(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| mutesManager := mutes.NewMutesManager("./state.json", &fs.TestFS{}, logger.GetNopLogger()) | ||
| dispatcher := NewDispatcher(logger.GetNopLogger(), mutesManager, []reportersPkg.Reporter{ | ||
| &reportersPkg.TestReporter{}, | ||
| }) | ||
|
|
||
| err := dispatcher.Init() | ||
| require.NoError(t, err) | ||
|
|
||
| mutesManager.AddMute(&mutes.Mute{Expires: time.Now().Add(time.Minute)}) | ||
|
|
||
| dispatcher.SendReport(reportersPkg.Report{Entries: []entry.ReportEntry{ | ||
| events.NotVotedEvent{ | ||
| Chain: &types.Chain{Name: "chain"}, | ||
| Proposal: types.Proposal{ID: "proposal"}, | ||
| }, | ||
| }}) | ||
| } | ||
|
|
||
| func TestReportDispatcherSendReportErrorSending(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| mutesManager := mutes.NewMutesManager("./state.json", &fs.TestFS{}, logger.GetNopLogger()) | ||
| dispatcher := NewDispatcher(logger.GetNopLogger(), mutesManager, []reportersPkg.Reporter{ | ||
| &reportersPkg.TestReporter{WithErrorSending: true}, | ||
| }) | ||
|
|
||
| err := dispatcher.Init() | ||
| require.NoError(t, err) | ||
|
|
||
| dispatcher.SendReport(reportersPkg.Report{Entries: []entry.ReportEntry{ | ||
| events.ProposalsQueryErrorEvent{}, | ||
| }}) | ||
| } | ||
|
|
||
| func TestReportDispatcherSendReportOk(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| mutesManager := mutes.NewMutesManager("./state.json", &fs.TestFS{}, logger.GetNopLogger()) | ||
| dispatcher := NewDispatcher(logger.GetNopLogger(), mutesManager, []reportersPkg.Reporter{ | ||
| &reportersPkg.TestReporter{}, | ||
| }) | ||
|
|
||
| err := dispatcher.Init() | ||
| require.NoError(t, err) | ||
|
|
||
| dispatcher.SendReport(reportersPkg.Report{Entries: []entry.ReportEntry{ | ||
| events.ProposalsQueryErrorEvent{}, | ||
| }}) | ||
| } |
Oops, something went wrong.