Merge pull request #455 from michaelwilner/fqual

Expose configuration options for useful overrides

Author: ackleymi

config/configuration.go

@@ -47,6 +47,7 @@ const (
 	LogoutTimeout                string = "LogoutTimeout"
 	LogonTimeout                 string = "LogonTimeout"
 	HeartBtInt                   string = "HeartBtInt"
+	HeartBtIntOverride           string = "HeartBtIntOverride"
 	FileLogPath                  string = "FileLogPath"
 	FileStorePath                string = "FileStorePath"
 	SQLStoreDriver               string = "SQLStoreDriver"

config/doc.go

@@ -244,7 +244,15 @@ Defaults to 10
 
 HeartBtInt
 
-Heartbeat interval in seconds. Only used for initiators.	Value must be positive integer.
+Heartbeat interval in seconds. Only used for initiators (unless HeartBtIntOverride is Y).	Value must be positive integer.
+
+HeartBtIntOverride
+
+If set to Y, will use the HeartBtInt interval rather than what the initiator dictates. Only used for acceptors. Valid Values:
+ Y
+ N
+
+Defaults to N.
 
 SocketConnectPort
 

internal/session_settings.go

@@ -9,6 +9,7 @@ type SessionSettings struct {
 	ResetOnLogout                bool
 	ResetOnDisconnect            bool
 	HeartBtInt                   time.Duration
+	HeartBtIntOverride           bool
 	SessionTime                  *TimeRange
 	InitiateLogon                bool
 	ResendRequestChunkSize       int

logon_state_test.go

@@ -76,12 +76,14 @@ func (s *LogonStateTestSuite) TestFixMsgInLogon() {
 	s.MockApp.On("FromAdmin").Return(nil)
 	s.MockApp.On("OnLogon")
 	s.MockApp.On("ToAdmin")
+	s.Zero(s.session.HeartBtInt)
 	s.fixMsgIn(s.session, logon)
 
 	s.MockApp.AssertExpectations(s.T())
 
 	s.State(inSession{})
-	s.Equal(32*time.Second, s.session.HeartBtInt)
+	s.Equal(32*time.Second, s.session.HeartBtInt)  //should be written from logon message
+	s.False(s.session.HeartBtIntOverride)
 
 	s.LastToAdminMessageSent()
 	s.MessageType(string(msgTypeLogon), s.MockApp.lastToAdmin)
@@ -91,6 +93,35 @@ func (s *LogonStateTestSuite) TestFixMsgInLogon() {
 	s.NextSenderMsgSeqNum(3)
 }
 
+func (s *LogonStateTestSuite) TestFixMsgInLogonHeartBtIntOverride() {
+	s.IncrNextSenderMsgSeqNum()
+	s.MessageFactory.seqNum = 1
+	s.IncrNextTargetMsgSeqNum()
+
+	logon := s.Logon()
+	logon.Body.SetField(tagHeartBtInt, FIXInt(32))
+
+	s.MockApp.On("FromAdmin").Return(nil)
+	s.MockApp.On("OnLogon")
+	s.MockApp.On("ToAdmin")
+	s.session.HeartBtIntOverride = true
+	s.session.HeartBtInt = time.Second
+	s.fixMsgIn(s.session, logon)
+
+	s.MockApp.AssertExpectations(s.T())
+
+	s.State(inSession{})
+	s.Equal(time.Second, s.session.HeartBtInt) //should not have changed
+	s.True(s.session.HeartBtIntOverride)
+
+	s.LastToAdminMessageSent()
+	s.MessageType(string(msgTypeLogon), s.MockApp.lastToAdmin)
+	s.FieldEquals(tagHeartBtInt, 1, s.MockApp.lastToAdmin.Body)
+
+	s.NextTargetMsgSeqNum(3)
+	s.NextSenderMsgSeqNum(3)
+}
+
 func (s *LogonStateTestSuite) TestFixMsgInLogonEnableLastMsgSeqNumProcessed() {
 	s.session.EnableLastMsgSeqNumProcessed = true
 

session.go

@@ -441,9 +441,11 @@ func (s *session) handleLogon(msg *Message) error {
 	}
 
 	if !s.InitiateLogon {
-		var heartBtInt FIXInt
-		if err := msg.Body.GetField(tagHeartBtInt, &heartBtInt); err == nil {
-			s.HeartBtInt = time.Duration(heartBtInt) * time.Second
+		if !s.HeartBtIntOverride {
+			var heartBtInt FIXInt
+			if err := msg.Body.GetField(tagHeartBtInt, &heartBtInt); err == nil {
+				s.HeartBtInt = time.Duration(heartBtInt) * time.Second
+			}
 		}
 
 		s.log.OnEvent("Responding to logon request")

session_factory.go

@@ -286,6 +286,8 @@ func (f sessionFactory) newSession(
 		if err = f.buildInitiatorSettings(s, settings); err != nil {
 			return
 		}
+	} else if err = f.buildAcceptorSettings(s, settings); err != nil {
+		return
 	}
 
 	if s.log, err = logFactory.CreateSessionLog(s.sessionID); err != nil {
@@ -303,19 +305,20 @@ func (f sessionFactory) newSession(
 	return
 }
 
+func (f sessionFactory) buildAcceptorSettings(session *session, settings *SessionSettings) error {
+	if err := f.buildHeartBtIntSettings(session, settings, false); err != nil {
+		return err
+	}
+	return nil
+}
+
 func (f sessionFactory) buildInitiatorSettings(session *session, settings *SessionSettings) error {
 	session.InitiateLogon = true
 
-	heartBtInt, err := settings.IntSetting(config.HeartBtInt)
-	if err != nil {
+	if err := f.buildHeartBtIntSettings(session, settings, true); err != nil {
 		return err
 	}
 
-	if heartBtInt <= 0 {
-		return errors.New("Heartbeat must be greater than zero")
-	}
-	session.HeartBtInt = time.Duration(heartBtInt) * time.Second
-
 	session.ReconnectInterval = 30 * time.Second
 	if settings.HasSetting(config.ReconnectInterval) {
 
@@ -394,3 +397,23 @@ func (f sessionFactory) configureSocketConnectAddress(session *session, settings
 		i++
 	}
 }
+
+func (f sessionFactory) buildHeartBtIntSettings(session *session, settings *SessionSettings, mustProvide bool) (err error) {
+	if settings.HasSetting(config.HeartBtIntOverride) {
+		if session.HeartBtIntOverride, err = settings.BoolSetting(config.HeartBtIntOverride); err != nil {
+			return
+		}
+	}
+	
+	if session.HeartBtIntOverride || mustProvide {
+		var heartBtInt int
+		if heartBtInt, err = settings.IntSetting(config.HeartBtInt); err != nil {
+			return
+		} else if heartBtInt <= 0 {
+			err = errors.New("Heartbeat must be greater than zero")
+			return
+		}
+		session.HeartBtInt = time.Duration(heartBtInt) * time.Second
+	}
+	return
+}

session_factory_test.go

@@ -51,6 +51,7 @@ func (s *SessionFactorySuite) TestDefaults() {
 	s.Equal(Millis, session.timestampPrecision)
 	s.Equal(120*time.Second, session.MaxLatency)
 	s.False(session.DisableMessagePersist)
+	s.False(session.HeartBtIntOverride)
 }
 
 func (s *SessionFactorySuite) TestResetOnLogon() {
@@ -358,9 +359,47 @@ func (s *SessionFactorySuite) TestNewSessionBuildInitiators() {
 	s.Equal("127.0.0.1:5000", session.SocketConnectAddress[0])
 }
 
+func (s *SessionFactorySuite) TestNewSessionBuildAcceptors() {
+	s.sessionFactory.BuildInitiators = false
+	s.SessionSettings.Set(config.HeartBtInt, "34")
+
+	session, err := s.newSession(s.SessionID, s.MessageStoreFactory, s.SessionSettings, s.LogFactory, s.App)
+	s.Nil(err)
+	s.False(session.InitiateLogon)
+	s.Zero(session.HeartBtInt)
+	s.False(session.HeartBtIntOverride)
+
+	s.SessionSettings.Set(config.HeartBtIntOverride, "Y")
+	session, err = s.newSession(s.SessionID, s.MessageStoreFactory, s.SessionSettings, s.LogFactory, s.App)
+	s.Nil(err)
+	s.False(session.InitiateLogon)
+	s.Equal(34*time.Second, session.HeartBtInt)
+	s.True(session.HeartBtIntOverride)
+}
+
 func (s *SessionFactorySuite) TestNewSessionBuildInitiatorsValidHeartBtInt() {
 	s.sessionFactory.BuildInitiators = true
 
+	_, err := s.newSession(s.SessionID, s.MessageStoreFactory, s.SessionSettings, s.LogFactory, s.App)
+	s.NotNil(err, "HeartBtInt should be required for acceptors with override defined")
+
+	s.SessionSettings.Set(config.HeartBtInt, "not a number")
+	_, err = s.newSession(s.SessionID, s.MessageStoreFactory, s.SessionSettings, s.LogFactory, s.App)
+	s.NotNil(err, "HeartBtInt must be a number")
+
+	s.SessionSettings.Set(config.HeartBtInt, "0")
+	_, err = s.newSession(s.SessionID, s.MessageStoreFactory, s.SessionSettings, s.LogFactory, s.App)
+	s.NotNil(err, "HeartBtInt must be greater than zero")
+
+	s.SessionSettings.Set(config.HeartBtInt, "-20")
+	_, err = s.newSession(s.SessionID, s.MessageStoreFactory, s.SessionSettings, s.LogFactory, s.App)
+	s.NotNil(err, "HeartBtInt must be greater than zero")
+}
+
+func (s *SessionFactorySuite) TestNewSessionBuildAcceptorsValidHeartBtInt() {
+	s.sessionFactory.BuildInitiators = false
+
+	s.SessionSettings.Set(config.HeartBtIntOverride, "Y")
 	_, err := s.newSession(s.SessionID, s.MessageStoreFactory, s.SessionSettings, s.LogFactory, s.App)
 	s.NotNil(err, "HeartBtInt should be required for initiators")