Merge pull request #283 from philipwhiuk/optimiseSessionReset

chrjohn · web-flow · commit b18003e10694 · 2024-02-13T16:29:34.000+01:00
Optimise session reset to reduce `Calendar` creation
diff --git a/quickfixj-core/src/main/java/quickfix/CachedFileStore.java b/quickfixj-core/src/main/java/quickfix/CachedFileStore.java
@@ -162,6 +162,14 @@ public Date getCreationTime() throws IOException {
         return cache.getCreationTime();
     }
 
+    /*
+     * (non-Javadoc)
+     * @see quickfix.MessageStore#getCreationTimeCalendar()
+     */
+    public Calendar getCreationTimeCalendar() throws IOException {
+        return cache.getCreationTimeCalendar();
+    }
+
     private void initializeSequenceNumbers() throws IOException {
         sequenceNumberFile.seek(0);
         if (sequenceNumberFile.length() > 0) {
diff --git a/quickfixj-core/src/main/java/quickfix/DefaultSessionSchedule.java b/quickfixj-core/src/main/java/quickfix/DefaultSessionSchedule.java
@@ -41,10 +41,17 @@ public class DefaultSessionSchedule implements SessionSchedule {
     private final int[] weekdayOffsets;
     protected static final Logger LOG = LoggerFactory.getLogger(DefaultSessionSchedule.class);
 
+    //Cache recent time data to reduce creation of calendar objects
+    private final ThreadLocal<Calendar> threadLocalCalendar;
+    private final ThreadLocal<TimeInterval> threadLocalRecentTimeInterval;
+
     public DefaultSessionSchedule(SessionSettings settings, SessionID sessionID) throws ConfigError,
             FieldConvertError {
+        threadLocalCalendar = ThreadLocal.withInitial(SystemTime::getUtcCalendar);
+        threadLocalRecentTimeInterval = new ThreadLocal<>();
+        isNonStopSession = settings.isSetting(sessionID, Session.SETTING_NON_STOP_SESSION)
+            && settings.getBool(sessionID, Session.SETTING_NON_STOP_SESSION);
 
-        isNonStopSession = settings.isSetting(sessionID, Session.SETTING_NON_STOP_SESSION) && settings.getBool(sessionID, Session.SETTING_NON_STOP_SESSION);
         TimeZone defaultTimeZone = getDefaultTimeZone(settings, sessionID);
         if (isNonStopSession) {
             isWeekdaySession = false;
@@ -104,7 +111,7 @@ private TimeEndPoint getTimeEndPoint(SessionSettings settings, SessionID session
     }
 
     private TimeZone getDefaultTimeZone(SessionSettings settings, SessionID sessionID)
-            throws ConfigError, FieldConvertError {
+            throws ConfigError {
         TimeZone sessionTimeZone;
         if (settings.isSetting(sessionID, Session.SETTING_TIMEZONE)) {
             String sessionTimeZoneID = settings.getString(sessionID, Session.SETTING_TIMEZONE);
@@ -300,9 +307,16 @@ public boolean isSessionTime() {
         if(isNonStopSession()) {
             return true;
         }
-        Calendar now = SystemTime.getUtcCalendar();
-        TimeInterval interval = theMostRecentIntervalBefore(now);
-        return interval.isContainingTime(now);
+        Calendar now = threadLocalCalendar.get();
+        now.setTimeInMillis(SystemTime.currentTimeMillis());
+        TimeInterval mostRecentInterval = threadLocalRecentTimeInterval.get();
+        if (mostRecentInterval != null && mostRecentInterval.isContainingTime(now)) {
+            return true;
+        }
+        mostRecentInterval = theMostRecentIntervalBefore(now);
+        boolean result = mostRecentInterval.isContainingTime(now);
+        threadLocalRecentTimeInterval.set(mostRecentInterval);
+        return result;
     }
 
     public String toString() {
diff --git a/quickfixj-core/src/main/java/quickfix/FileStore.java b/quickfixj-core/src/main/java/quickfix/FileStore.java
@@ -152,6 +152,14 @@ public Date getCreationTime() throws IOException {
         return cache.getCreationTime();
     }
 
+    /* (non-Javadoc)
+     * @see quickfix.MessageStore#getCreationTimeCalendar()
+     */
+    @Override
+    public Calendar getCreationTimeCalendar() throws IOException {
+        return cache.getCreationTimeCalendar();
+    }
+
     private void initializeSequenceNumbers() throws IOException {
         senderSequenceNumberFile.seek(0);
         if (senderSequenceNumberFile.length() > 0) {
diff --git a/quickfixj-core/src/main/java/quickfix/JdbcStore.java b/quickfixj-core/src/main/java/quickfix/JdbcStore.java
@@ -159,6 +159,10 @@ public Date getCreationTime() throws IOException {
         return cache.getCreationTime();
     }
 
+    public Calendar getCreationTimeCalendar() throws IOException {
+        return cache.getCreationTimeCalendar();
+    }
+
     public int getNextSenderMsgSeqNum() throws IOException {
         return cache.getNextSenderMsgSeqNum();
     }
diff --git a/quickfixj-core/src/main/java/quickfix/MemoryStore.java b/quickfixj-core/src/main/java/quickfix/MemoryStore.java
@@ -70,6 +70,10 @@ public Date getCreationTime() throws IOException {
         return creationTime.getTime();
     }
 
+    public Calendar getCreationTimeCalendar() throws IOException {
+        return creationTime;
+    }
+
     /* package */void setCreationTime(Calendar creationTime) {
         this.creationTime = creationTime;
     }
diff --git a/quickfixj-core/src/main/java/quickfix/MessageStore.java b/quickfixj-core/src/main/java/quickfix/MessageStore.java
@@ -19,6 +19,7 @@
 
 package quickfix;
 
+import java.util.Calendar;
 import java.util.Collection;
 import java.util.Date;
 import java.io.IOException;
@@ -73,6 +74,14 @@ public interface MessageStore {
      */
     Date getCreationTime() throws IOException;
 
+    /**
+     * Get the session creation time as a calendar object.
+     *
+     * @return the session creation time.
+     * @throws IOException IO error
+     */
+    Calendar getCreationTimeCalendar() throws IOException;
+
     /**
      * Reset the message store. Sequence numbers are set back to 1 and stored
      * messages are erased. The session creation time is also set to the time of
diff --git a/quickfixj-core/src/main/java/quickfix/NoopStore.java b/quickfixj-core/src/main/java/quickfix/NoopStore.java
@@ -20,6 +20,7 @@
 
 package quickfix;
 
+import java.util.Calendar;
 import java.util.Collection;
 import java.util.Date;
 
@@ -31,6 +32,7 @@
 public class NoopStore implements MessageStore {
 
     private Date creationTime = new Date();
+    private Calendar creationTimeCalendar = SystemTime.getUtcCalendar(creationTime);
     private int nextSenderMsgSeqNum = 1;
     private int nextTargetMsgSeqNum = 1;
 
@@ -41,6 +43,10 @@ public Date getCreationTime() {
         return creationTime;
     }
 
+    public Calendar getCreationTimeCalendar() {
+        return creationTimeCalendar;
+    }
+
     public int getNextSenderMsgSeqNum() {
         return nextSenderMsgSeqNum;
     }
diff --git a/quickfixj-core/src/main/java/quickfix/Session.java b/quickfixj-core/src/main/java/quickfix/Session.java
@@ -646,7 +646,7 @@ public String getRemoteAddress() {
     private boolean isCurrentSession(final long time)
             throws IOException {
         return sessionSchedule == null || sessionSchedule.isSameSession(
-                SystemTime.getUtcCalendar(time), SystemTime.getUtcCalendar(state.getCreationTime()));
+                SystemTime.getUtcCalendar(time), state.getCreationTimeCalendar());
     }
 
     /**
diff --git a/quickfixj-core/src/main/java/quickfix/SessionState.java b/quickfixj-core/src/main/java/quickfix/SessionState.java
@@ -20,6 +20,7 @@
 package quickfix;
 
 import java.io.IOException;
+import java.util.Calendar;
 import java.util.Collection;
 import java.util.Date;
 import java.util.concurrent.TimeUnit;
@@ -490,6 +491,10 @@ public Object getLock() {
         return lock;
     }
 
+    public Calendar getCreationTimeCalendar() throws IOException {
+        return messageStore.getCreationTimeCalendar();
+    }
+
     private final static class NullLog implements Log {
         public void onOutgoing(String message) {
         }
diff --git a/quickfixj-core/src/main/java/quickfix/SleepycatStore.java b/quickfixj-core/src/main/java/quickfix/SleepycatStore.java
@@ -256,10 +256,23 @@ private void convertToIOExceptionAndRethrow(Exception e) throws IOException {
         throw ioe;
     }
 
+
+    /*
+     * (non-Javadoc)
+     * @see quickfix.MessageStore#getCreationTime()
+     */
     public Date getCreationTime() throws IOException {
         return info.getCreationTime().getTime();
     }
 
+    /*
+     * (non-Javadoc)
+     * @see quickfix.MessageStore#getCreationTimeCalendar()
+     */
+    public Calendar getCreationTimeCalendar() throws IOException {
+        return info.getCreationTime();
+    }
+
     public int getNextSenderMsgSeqNum() throws IOException {
         return info.getNextSenderMsgSeqNum();
     }
diff --git a/quickfixj-core/src/test/java/quickfix/DefaultSessionScheduleTest.java b/quickfixj-core/src/test/java/quickfix/DefaultSessionScheduleTest.java
@@ -0,0 +1,120 @@
+package quickfix;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+import java.io.ByteArrayInputStream;
+
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.when;
+
+public class DefaultSessionScheduleTest {
+
+    private SessionID sessionID;
+    @Mock
+    private SystemTimeSource mockTimeSource;
+
+    @Before
+    public void before() {
+        MockitoAnnotations.initMocks(this);
+
+        sessionID = new SessionID("FIX.4.2:A->B");
+        SystemTime.setTimeSource(mockTimeSource);
+    }
+
+    @After
+    public void after() {
+        SystemTime.setTimeSource(null);
+    }
+
+    @Test
+    public void isNonStopSession_returns_true_when_SETTING_NON_STOP_SESSION_Y() throws FieldConvertError, ConfigError {
+        String sessionSettingsString = ""
+            + "[DEFAULT]\n"
+            + "NonStopSession=Y\n"
+            + "\n"
+            + "[SESSION]\n"
+            + "BeginString=FIX.4.2\n"
+            + "SenderCompID=A\n"
+            + "TargetCompID=B\n";
+        SessionSettings sessionSettings = new SessionSettings(new ByteArrayInputStream(sessionSettingsString.getBytes()));
+        DefaultSessionSchedule schedule = new DefaultSessionSchedule(sessionSettings, sessionID);
+
+        assertTrue(schedule.isNonStopSession());
+    }
+
+    @Test
+    public void isNonStopSession_returns_false_when_SETTING_NON_STOP_SESSION_N() throws FieldConvertError, ConfigError {
+        String sessionSettingsString = ""
+            + "[DEFAULT]\n"
+            + "NonStopSession=N\n"
+            + "\n"
+            + "[SESSION]\n"
+            + "BeginString=FIX.4.2\n"
+            + "SenderCompID=A\n"
+            + "TargetCompID=B\n"
+            + "StartTime=00:00:00\n"
+            + "EndTime=00:00:01\n";
+        SessionSettings sessionSettings = new SessionSettings(new ByteArrayInputStream(sessionSettingsString.getBytes()));
+        DefaultSessionSchedule schedule = new DefaultSessionSchedule(sessionSettings, sessionID);
+
+        assertFalse(schedule.isNonStopSession());
+    }
+
+    @Test
+    public void isNonStopSession_returns_false_when_SETTING_NON_STOP_SESSION_not_present() throws FieldConvertError, ConfigError {
+        String sessionSettingsString = ""
+            + "[DEFAULT]\n"
+            + "\n"
+            + "[SESSION]\n"
+            + "BeginString=FIX.4.2\n"
+            + "SenderCompID=A\n"
+            + "TargetCompID=B\n"
+            + "StartTime=00:00:00\n"
+            + "EndTime=00:00:01\n";
+        SessionSettings sessionSettings = new SessionSettings(new ByteArrayInputStream(sessionSettingsString.getBytes()));
+        DefaultSessionSchedule schedule = new DefaultSessionSchedule(sessionSettings, sessionID);
+
+        assertFalse(schedule.isNonStopSession());
+    }
+
+    @Test
+    public void isSessionTime_returns_true_for_time_within_window() throws FieldConvertError, ConfigError {
+        when(mockTimeSource.getTime()).thenReturn(1L);
+        String sessionSettingsString = ""
+            + "[DEFAULT]\n"
+            + "\n"
+            + "[SESSION]\n"
+            + "BeginString=FIX.4.2\n"
+            + "SenderCompID=A\n"
+            + "TargetCompID=B\n"
+            + "StartTime=00:00:00\n"
+            + "EndTime=00:00:01\n";
+        SessionSettings sessionSettings = new SessionSettings(new ByteArrayInputStream(sessionSettingsString.getBytes()));
+        DefaultSessionSchedule schedule = new DefaultSessionSchedule(sessionSettings, sessionID);
+
+        assertTrue(schedule.isSessionTime());
+    }
+
+    @Test
+    public void isSessionTime_returns_false_for_time_outside_window() throws FieldConvertError, ConfigError {
+        when(mockTimeSource.getTime()).thenReturn(2000L);
+        String sessionSettingsString = ""
+            + "[DEFAULT]\n"
+            + "\n"
+            + "[SESSION]\n"
+            + "BeginString=FIX.4.2\n"
+            + "SenderCompID=A\n"
+            + "TargetCompID=B\n"
+            + "StartTime=00:00:00\n"
+            + "EndTime=00:00:01\n";
+        SessionSettings sessionSettings = new SessionSettings(new ByteArrayInputStream(sessionSettingsString.getBytes()));
+        DefaultSessionSchedule schedule = new DefaultSessionSchedule(sessionSettings, sessionID);
+
+        assertFalse(schedule.isSessionTime());
+    }
+}
diff --git a/quickfixj-core/src/test/java/quickfix/LogUtilTest.java b/quickfixj-core/src/test/java/quickfix/LogUtilTest.java
@@ -22,6 +22,7 @@
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.PrintStream;
+import java.util.Calendar;
 import java.util.Date;
 import org.junit.After;
 import static org.junit.Assert.assertTrue;
@@ -60,7 +61,7 @@ private void createSessionAndGenerateException(LogFactory mockLogFactory) throws
         Session session = new Session(null, sessionID1 -> {
             try {
                 return new MemoryStore() {
-                    public Date getCreationTime() throws IOException {
+                    public Calendar getCreationTimeCalendar() throws IOException {
                         throw new IOException("test");
                     }
                 };

Original file line number	Diff line number	Diff line change
`@@ -159,6 +159,10 @@ public Date getCreationTime() throws IOException {`
`159`	`159`	`return cache.getCreationTime();`
`160`	`160`	`}`
`161`	`161`
	`162`	`+ public Calendar getCreationTimeCalendar() throws IOException {`
	`163`	`+ return cache.getCreationTimeCalendar();`
	`164`	`+ }`
	`165`	`+`
`162`	`166`	`public int getNextSenderMsgSeqNum() throws IOException {`
`163`	`167`	`return cache.getNextSenderMsgSeqNum();`
`164`	`168`	`}`
Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,10 @@ public Date getCreationTime() throws IOException {`
`70`	`70`	`return creationTime.getTime();`
`71`	`71`	`}`
`72`	`72`
	`73`	`+ public Calendar getCreationTimeCalendar() throws IOException {`
	`74`	`+ return creationTime;`
	`75`	`+ }`
	`76`	`+`
`73`	`77`	`/* package */void setCreationTime(Calendar creationTime) {`
`74`	`78`	`this.creationTime = creationTime;`
`75`	`79`	`}`
Original file line number	Diff line number	Diff line change
`@@ -646,7 +646,7 @@ public String getRemoteAddress() {`
`646`	`646`	`private boolean isCurrentSession(final long time)`
`647`	`647`	`throws IOException {`
`648`	`648`	`return sessionSchedule == null \|\| sessionSchedule.isSameSession(`
`649`		`- SystemTime.getUtcCalendar(time), SystemTime.getUtcCalendar(state.getCreationTime()));`
	`649`	`+ SystemTime.getUtcCalendar(time), state.getCreationTimeCalendar());`
`650`	`650`	`}`
`651`	`651`
`652`	`652`	`/**`