Added support for detecting the end of a request.

Author: anthony-tuininga

doc/src/release_notes.rst

@@ -25,6 +25,8 @@ Thin Mode Changes
     for string variables.
 #)  User-defined errors raised by the database no longer display an error help
     portal URL.
+#)  Improved handling of packets with :ref:`asyncio <asyncio>` for recent
+    database versions.
 #)  Fixed potential cursor issues when using :ref:`drcp`.
 #)  Fixed regression when using :ref:`IAM token authentication <iamauth>`
     (`issue 288 <https://github.com/oracle/python-oracledb/issues/288>`__).

src/oracledb/impl/thin/capabilities.pyx

@@ -41,6 +41,7 @@ cdef class Capabilities:
         uint32_t max_string_size
         bint supports_fast_auth
         bint supports_oob
+        bint supports_end_of_request
         uint32_t sdu
 
     def __init__(self):
@@ -58,6 +59,9 @@ cdef class Capabilities:
         if server_caps[TNS_CCAP_FIELD_VERSION] < self.ttc_field_version:
             self.ttc_field_version = server_caps[TNS_CCAP_FIELD_VERSION]
             self.compile_caps[TNS_CCAP_FIELD_VERSION] = self.ttc_field_version
+        if self.ttc_field_version < TNS_CCAP_FIELD_VERSION_19_1 \
+                or not server_caps[TNS_CCAP_TTC4] & TNS_CCAP_END_OF_REQUEST:
+            self.compile_caps[TNS_CCAP_TTC4] ^= TNS_CCAP_END_OF_REQUEST
 
     @cython.boundscheck(False)
     cdef void _adjust_for_server_runtime_caps(self, bytearray server_caps):
@@ -75,6 +79,15 @@ cdef class Capabilities:
             errors._raise_err(errors.ERR_NCHAR_CS_NOT_SUPPORTED,
                               charset_id=self.ncharset_id)
 
+    cdef void _check_supports_end_of_request(self):
+        """
+        Checks whether the end of request flag is sent and sets a boolean to
+        avoid calculating it each time.
+        """
+        if self.ttc_field_version >= TNS_CCAP_FIELD_VERSION_19_1 \
+                and self.compile_caps[TNS_CCAP_TTC4] & TNS_CCAP_END_OF_REQUEST:
+            self.supports_end_of_request = True
+
     @cython.boundscheck(False)
     cdef void _init_compile_caps(self):
         self.ttc_field_version = TNS_CCAP_FIELD_VERSION_MAX
@@ -109,7 +122,8 @@ cdef class Capabilities:
         self.compile_caps[TNS_CCAP_TTC2] = TNS_CCAP_ZLNP
         self.compile_caps[TNS_CCAP_OCI2] = TNS_CCAP_DRCP
         self.compile_caps[TNS_CCAP_CLIENT_FN] = TNS_CCAP_CLIENT_FN_MAX
-        self.compile_caps[TNS_CCAP_TTC4] = TNS_CCAP_INBAND_NOTIFICATION
+        self.compile_caps[TNS_CCAP_TTC4] = TNS_CCAP_INBAND_NOTIFICATION | \
+                TNS_CCAP_END_OF_REQUEST
         self.compile_caps[TNS_CCAP_TTC5] = TNS_CCAP_VECTOR_SUPPORT
 
     @cython.boundscheck(False)

src/oracledb/impl/thin/constants.pxi

@@ -411,6 +411,7 @@ cdef enum:
     TNS_MSG_TYPE_ONEWAY_FN = 26
     TNS_MSG_TYPE_IMPLICIT_RESULTSET = 27
     TNS_MSG_TYPE_RENEGOTIATE = 28
+    TNS_MSG_TYPE_END_OF_REQUEST = 29
     TNS_MSG_TYPE_FAST_AUTH = 34
 
 # parameter keyword numbers
@@ -704,6 +705,7 @@ cdef enum:
     TNS_CCAP_DRCP = 0x10
     TNS_CCAP_ZLNP = 0x04
     TNS_CCAP_INBAND_NOTIFICATION = 0x04
+    TNS_CCAP_END_OF_REQUEST = 0x20
     TNS_CCAP_CLIENT_FN_MAX = 12
     TNS_CCAP_VECTOR_SUPPORT = 0x08
 

src/oracledb/impl/thin/messages.pyx

@@ -51,7 +51,6 @@ cdef class Message:
         uint16_t end_to_end_seq_num
         bint error_occurred
         bint flush_out_binds
-        bint end_of_request
         bint resend
         bint retry
         object warning
@@ -118,7 +117,7 @@ cdef class Message:
         buf.read_ub4(&num_bytes)            # oerrdd (logical rowid)
         if num_bytes > 0:
             buf.skip_raw_bytes_chunked()
-        self.end_of_request = True
+        buf._in_request = False
 
         # batch error codes
         buf.read_ub2(&num_errors)           # batch error codes array
@@ -187,6 +186,8 @@ cdef class Message:
             self._process_return_parameters(buf)
         elif message_type == TNS_MSG_TYPE_SERVER_SIDE_PIGGYBACK:
             self._process_server_side_piggyback(buf)
+        elif message_type == TNS_MSG_TYPE_END_OF_REQUEST:
+            buf._in_request = False
         else:
             errors._raise_err(errors.ERR_MESSAGE_TYPE_UNKNOWN,
                               message_type=message_type,
@@ -301,7 +302,7 @@ cdef class Message:
     cdef int process(self, ReadBuffer buf) except -1:
         cdef uint8_t message_type
         self.flush_out_binds = False
-        self.end_of_request = False
+        buf._in_request = True
         self._preprocess()
         while self._has_more_data(buf):
             buf.save_point()
@@ -391,7 +392,7 @@ cdef class MessageWithData(Message):
         memcpy(<void*> self.bit_vector, ptr, num_bytes)
 
     cdef bint _has_more_data(self, ReadBuffer buf):
-        return not self.end_of_request and not self.flush_out_binds
+        return buf._in_request and not self.flush_out_binds
 
     cdef bint _is_duplicate_data(self, uint32_t column_num):
         """
@@ -1918,6 +1919,7 @@ cdef class DataTypesMessage(Message):
             buf.read_uint16(&conv_data_type)
             if conv_data_type != 0:
                 buf.skip_raw_bytes(4)
+        buf._caps._check_supports_end_of_request()
 
     cdef int _write_message(self, WriteBuffer buf) except -1:
         cdef:
@@ -2215,7 +2217,7 @@ cdef class LobOpMessage(Message):
         object data
 
     cdef bint _has_more_data(self, ReadBuffer buf):
-        return not self.end_of_request
+        return buf._in_request
 
     cdef int _initialize_hook(self) except -1:
         """
@@ -2402,7 +2404,7 @@ cdef class FastAuthMessage(Message):
         bint renegotiate
 
     cdef bint _has_more_data(self, ReadBuffer buf):
-        return not self.end_of_request
+        return buf._in_request
 
     cdef int _process_message(self, ReadBuffer buf,
                               uint8_t message_type) except -1:
@@ -2419,7 +2421,7 @@ cdef class FastAuthMessage(Message):
                                               message_type)
         else:
             AuthMessage._process_message(self.auth_message, buf, message_type)
-            self.end_of_request = True
+            buf._in_request = False
 
     cdef int _write_message(self, WriteBuffer buf) except -1:
         """

src/oracledb/impl/thin/packet.pyx

@@ -55,6 +55,15 @@ cdef class Packet:
         uint8_t packet_flags
         bytes buf
 
+    cdef inline bint has_end_of_request(self):
+        """
+        Returns a boolean indicating if the end of request byte is found at the
+        end of the packet.
+        """
+        cdef char *ptr = cpython.PyBytes_AS_STRING(self.buf)
+        return ptr[self.packet_size - 1] == TNS_MSG_TYPE_END_OF_REQUEST
+
+
 @cython.final
 cdef class ChunkedBytesBuffer:
 
@@ -186,6 +195,7 @@ cdef class ReadBuffer(Buffer):
         Transport _transport
         list _saved_packets
         Capabilities _caps
+        bint _in_request
         object _waiter
         object _loop
 
@@ -314,14 +324,20 @@ cdef class ReadBuffer(Buffer):
         """
         Processes a packet. If the packet is a control packet it is processed
         immediately and discarded; otherwise, it is added to the list of saved
-        packets for this response.
+        packets for this response. If the protocol supports sending the end of
+        request notification we wait for that message type to be returned at
+        the end of the packet.
         """
         if packet.packet_type == TNS_PACKET_TYPE_CONTROL:
             self._process_control_packet(packet)
             notify_waiter[0] = False
         else:
             self._saved_packets.append(packet)
-            notify_waiter[0] = True
+            notify_waiter[0] = \
+                    packet.packet_type != TNS_PACKET_TYPE_DATA \
+                    or not self._in_request \
+                    or not self._caps.supports_end_of_request \
+                    or packet.has_end_of_request()
 
     cdef int _read_raw_bytes_and_length(self, const char_type **ptr,
                                         ssize_t *num_bytes) except -1: