1+ using System ;
2+ using System . Collections . Generic ;
3+ using System . Linq ;
4+ using System . Text . RegularExpressions ;
5+ using System . Threading . Tasks ;
6+ using AsyncRedux . Middleware . Logging ;
7+ using AsyncRedux . Tests . Mock ;
8+ using AsyncRedux . Tests . Mock . Actions ;
9+ using Microsoft . Extensions . Logging ;
10+ using Shouldly ;
11+ using Xunit ;
12+
13+ namespace AsyncRedux . Tests
14+ {
15+ public class LoggingMiddlewareSpec
16+ {
17+ private readonly LoggerFactory _loggerFactory ;
18+ private readonly List < string > _logs ;
19+
20+ /// <inheritdoc />
21+ public LoggingMiddlewareSpec ( )
22+ {
23+ _logs = new List < string > ( ) ;
24+ _loggerFactory = new LoggerFactory ( ) ;
25+ _loggerFactory . Logger . GeneratedLog += ( s , e ) => _logs . Add ( e . Log ) ;
26+ }
27+
28+ [ Theory ]
29+ [ CombinatorialData ]
30+ internal async Task Middleware_Should_Be_Configurable_To_Log_Dispatch_Execution_Time (
31+ [ CombinatorialValues ( "Dispatch took {Elapsed}" , "Action handled in {Time}" ) ]
32+ string template )
33+ {
34+ // Given: a store which is configured to use logging middleware
35+ var options = LoggingMiddlewareOptions . Default ;
36+ options . LogAtStart = false ;
37+ options . LogNextState = false ;
38+ options . LogElapsedTime = true ;
39+ options . ElapsedTimeLogTemplate = template ;
40+
41+ var store = CreateStore ( options ) ;
42+
43+ // When: we dispatch an action
44+ await store . Dispatch ( "foo" ) ;
45+
46+ // Then: the execution time of the action should have been logged
47+ var expectedLogFormat = Regex . Replace ( template , @"{.*}" , @"\d{2}:\d{2}:\d{2}\.\d{7}" ) ;
48+ _logs . ShouldHaveSingleItem ( ) . ShouldMatch ( expectedLogFormat ) ;
49+ }
50+
51+ [ Fact ]
52+ internal async Task Middleware_Should_Be_Configurable_To_Log_Next_State_After_Dispatch ( )
53+ {
54+ // Given: a store which is configured to use logging middleware.
55+ var options = LoggingMiddlewareOptions . Default ;
56+ options . LogAtStart = false ;
57+ options . LogElapsedTime = false ;
58+ options . LogNextState = true ;
59+
60+ var store = StoreSetup . CreateStore < State > ( )
61+ . FromReducer ( Reducers . Replace )
62+ . WithInitialState ( new State ( 0 , false ) )
63+ . UsingLoggingMiddleware ( _loggerFactory , options )
64+ . Build ( ) ;
65+
66+ // When: we dispatch an action to change the state.
67+ await store . Dispatch ( new ChangeInt ( 5 ) ) ;
68+
69+ // Then: the new state resulting from the action should have been logged.
70+ var expectedNextState = new State ( 5 , false ) ;
71+ _logs . ShouldHaveSingleItem ( ) . ShouldContain ( expectedNextState . ToString ( ) ) ;
72+ }
73+
74+ [ Theory ]
75+ [ CombinatorialData ]
76+ internal async Task Middleware_Should_Be_Configurable_To_Log_Start_Of_Dispatch ( bool logAtStart )
77+ {
78+ // Given: a store which is configured to use logging middleware
79+ var options = LoggingMiddlewareOptions . Default ;
80+ options . LogAtStart = logAtStart ;
81+ options . LogElapsedTime = false ;
82+ options . LogNextState = false ;
83+
84+ var store = CreateStore ( options ) ;
85+
86+ // When: we start dispatching an action but don't let it complete.
87+ var tcs = new TaskCompletionSource < object > ( ) ;
88+ store . Subscribe < object > ( action => tcs . Task ) ;
89+ var _ = store . Dispatch ( "foo" ) ;
90+ await Task . Delay ( 100 ) ;
91+
92+ // Then: a log should have been generated iff the middleware should log the start of dispatches.
93+ _logs . Count . ShouldBe ( logAtStart ? 1 : 0 ) ;
94+ }
95+
96+ [ Theory ]
97+ [ CombinatorialData ]
98+ internal async Task Middleware_Should_Log_At_Specified_Log_Level ( LogLevel logLevel )
99+ {
100+ // Given: a store which is configured to use logging middleware
101+ var options = LoggingMiddlewareOptions . Default ;
102+ options . LogAtStart = true ;
103+ options . LogElapsedTime = true ;
104+ options . LogLevel = logLevel ;
105+
106+ var store = CreateStore ( options ) ;
107+
108+ // When: we dispatch an action
109+ await store . Dispatch ( "foo" ) ;
110+
111+ // Then: logs should have been generated only at the configured log level
112+ var actualLogLevels = _logs
113+ . Select ( it => Regex . Match ( it , @"\[(?<enum>.*)\]" ) . Groups [ "enum" ] . Value )
114+ . Select ( Enum . Parse < LogLevel > )
115+ . ToList ( ) ;
116+
117+ if ( logLevel == LogLevel . None )
118+ {
119+ actualLogLevels . ShouldBeEmpty ( ) ;
120+ }
121+ else
122+ {
123+ actualLogLevels . ShouldNotBeEmpty ( ) ;
124+ actualLogLevels . ShouldAllBe ( it => it == logLevel ) ;
125+ }
126+ }
127+
128+ private IObservableStore < State > CreateStore ( LoggingMiddlewareOptions options )
129+ {
130+ return StoreSetup . CreateStore < State > ( )
131+ . FromReducer ( Reducers . PassThrough )
132+ . UsingLoggingMiddleware ( _loggerFactory , options )
133+ . Build ( ) ;
134+ }
135+ }
136+ }
0 commit comments