Read EOF/OK packets with info message after row data

The 9 byte packet length limit applied at #179 is by itself not sufficient to differentiate between a real EOF/OK packet vs. a huge data packet. The combined EOF/OK packet can be up to max_packet_length long instead.

- added an is_eof_packet function with the logic to determine whether a packet starting with an EOF byt is an EOF/OK packet or data
- updated the corresponding conditions in row-reading functions

Author: borama

src/client.c

@@ -280,6 +280,21 @@ static int read_deprecated_eof_packet(trilogy_conn_t *conn)
     return TRILOGY_EOF;
 }
 
+bool is_eof_packet(trilogy_conn_t *conn)
+{
+    // An EOF packet first byte can mark an EOF/OK packet, a deprecated EOF packet, or a huge data packet.
+    if (current_packet_type(conn) == TRILOGY_PACKET_EOF) {
+        if (conn->capabilities & TRILOGY_CAPABILITIES_DEPRECATE_EOF) {
+            // The EOF/OK packet can contain an info message and/or session state info up to max packet length.
+            return conn->packet_buffer.len <= TRILOGY_MAX_PACKET_LEN;
+        } else {
+            // The deprecated EOF packet must be smaller than 9 bytes (one 8-byte length-encoded integer).
+            return conn->packet_buffer.len < 9;
+        }
+    }
+    return false;
+}
+
 static int read_eof_packet(trilogy_conn_t *conn)
 {
     int rc;
@@ -983,7 +998,7 @@ int trilogy_read_row(trilogy_conn_t *conn, trilogy_value_t *values_out)
         return rc;
     }
 
-    if (current_packet_type(conn) == TRILOGY_PACKET_EOF && conn->packet_buffer.len < 9) {
+    if (is_eof_packet(conn)) {
         if ((rc = read_eof_packet(conn)) != TRILOGY_OK) {
             return rc;
         }
@@ -1018,7 +1033,7 @@ int trilogy_drain_results(trilogy_conn_t *conn)
             return rc;
         }
 
-        if (current_packet_type(conn) == TRILOGY_PACKET_EOF && conn->packet_buffer.len < 9) {
+        if (is_eof_packet(conn)) {
             read_eof_packet(conn);
             return TRILOGY_OK;
         }
@@ -1261,7 +1276,7 @@ int trilogy_stmt_read_row(trilogy_conn_t *conn, trilogy_stmt_t *stmt, trilogy_co
         return rc;
     }
 
-    if (current_packet_type(conn) == TRILOGY_PACKET_EOF && conn->packet_buffer.len < 9) {
+    if (is_eof_packet(conn)) {
         if ((rc = read_eof_packet(conn)) != TRILOGY_OK) {
             return rc;
         }

test/client/eof_packet_test.c

@@ -0,0 +1,100 @@
+#include <stdint.h>
+
+#include "../test.h"
+
+#include "trilogy/client.h"
+#include "trilogy/protocol.h"
+
+bool is_eof_packet(trilogy_conn_t *conn);
+
+static int setup_conn_packet(trilogy_conn_t *conn, uint8_t packet_type, size_t packet_len, uint32_t capabilities)
+{
+    int err = trilogy_init(conn);
+    if (err != TRILOGY_OK) {
+        return err;
+    }
+
+    conn->packet_buffer.buff[0] = packet_type;
+    conn->packet_buffer.len = packet_len;
+    conn->capabilities = capabilities;
+
+    return TRILOGY_OK;
+}
+
+TEST test_is_eof_packet_no_eof_marker()
+{
+    trilogy_conn_t conn;
+
+    int err = setup_conn_packet(&conn, TRILOGY_PACKET_ERR, 1, 0);
+    ASSERT_OK(err);
+
+    ASSERT_EQ(false, is_eof_packet(&conn));
+
+    trilogy_free(&conn);
+    PASS();
+}
+
+TEST test_is_eof_packet_deprecated_eof_packet()
+{
+    trilogy_conn_t conn;
+
+    int err = setup_conn_packet(&conn, TRILOGY_PACKET_EOF, 8, 0);
+    ASSERT_OK(err);
+
+    ASSERT_EQ(true, is_eof_packet(&conn));
+
+    trilogy_free(&conn);
+    PASS();
+}
+
+TEST test_is_eof_packet_data_without_deprecated_eof_support()
+{
+    trilogy_conn_t conn;
+
+    int err = setup_conn_packet(&conn, TRILOGY_PACKET_EOF, 9, 0);
+    ASSERT_OK(err);
+
+    ASSERT_EQ(false, is_eof_packet(&conn));
+
+    trilogy_free(&conn);
+    PASS();
+}
+
+TEST test_is_eof_packet_max_length_ok_packet_with_eof_marker()
+{
+    trilogy_conn_t conn;
+
+    int err = setup_conn_packet(&conn, TRILOGY_PACKET_EOF, TRILOGY_MAX_PACKET_LEN,
+                                TRILOGY_CAPABILITIES_DEPRECATE_EOF);
+    ASSERT_OK(err);
+
+    ASSERT_EQ(true, is_eof_packet(&conn));
+
+    trilogy_free(&conn);
+    PASS();
+}
+
+TEST test_is_eof_packet_data_with_deprecated_eof_support()
+{
+    trilogy_conn_t conn;
+
+    int err = setup_conn_packet(&conn, TRILOGY_PACKET_EOF, TRILOGY_MAX_PACKET_LEN + 1,
+                                TRILOGY_CAPABILITIES_DEPRECATE_EOF);
+    ASSERT_OK(err);
+
+    ASSERT_EQ(false, is_eof_packet(&conn));
+
+    trilogy_free(&conn);
+    PASS();
+}
+
+int client_eof_packet_test()
+{
+    RUN_TEST(test_is_eof_packet_no_eof_marker);
+    RUN_TEST(test_is_eof_packet_deprecated_eof_packet);
+    RUN_TEST(test_is_eof_packet_data_without_deprecated_eof_support);
+    RUN_TEST(test_is_eof_packet_max_length_ok_packet_with_eof_marker);
+    RUN_TEST(test_is_eof_packet_data_with_deprecated_eof_support);
+
+    return 0;
+}

test/runner.c

@@ -49,6 +49,7 @@ const trilogy_sockopt_t *get_connopt(void) { return &connopt; }
     SUITE(client_stmt_execute_test)                                                                                    \
     SUITE(client_stmt_reset_test)                                                                                      \
     SUITE(client_stmt_close_test)                                                                                      \
+    SUITE(client_eof_packet_test)                                                                                      \
 
 #define XX(name) extern int name();
 ALL_SUITES(XX)