Merge remote-tracking branch 'origin/stage' into CLIENT-5298-address-query-and-scan-foreach-and-results-possibly-missing-records-during-paginated-query-disruption

Author: juliannguyen4

.github/workflows/smoke-tests.yml

@@ -268,7 +268,7 @@ jobs:
         num-nodes: 1
         oidc-provider: ${{ vars.OIDC_PROVIDER_NAME }}
         oidc-audience: ${{ vars.OIDC_AUDIENCE }}
-        server-tag: ${{ matrix.test == 'code-examples' && '8.1.3.0-35-20260629033923' || needs.get-env-vars.outputs.server-tag }}
+        server-tag: ${{ matrix.test == 'code-examples' && '8.2.0.0-20260908214755' || needs.get-env-vars.outputs.server-tag }}
         server-container-repo: database-docker-virtual/aerospike-server${{ matrix.test == 'ee-code-examples' && '-enterprise' || '' }}
         tools-tag: 13.0.2_1
         config-file: ${{ (matrix.test == 'doctest' || matrix.test == 'ce-code-examples') && './.github/workflows/aerospike-ce.conf' || '' }}

aerospike_helpers/expressions/string.py

@@ -18,7 +18,7 @@
 
 These expressions mirror the operations from :mod:`String API <aerospike_helpers.operations.string_operations>`.
 
-Requires server version 8.1.3 or later.
+Requires server version 8.2.0 or later.
 
 Unlike operate-level string ops, these macros do not take a ``ctx`` parameter. To target
 a string nested inside a list or map, extract the leaf with

aerospike_helpers/operations/bitwise_operations.py

@@ -148,6 +148,8 @@
 .. seealso:: `Bits (Data Types) <https://aerospike.com/docs/develop/data-types/blob#bitwise-operations>`_.
 """
 import aerospike
+import warnings
+
 
 BIN_KEY = "bin"
 BYTE_SIZE_KEY = "byte_size"
@@ -229,14 +231,21 @@ def bit_set(bin_name: str, bit_offset, bit_size, value_byte_size, value, policy=
         bin_name (str): The name of the bin containing the map.
         bit_offset (int): The offset where the bits will be set.
         bit_size (int): How many bits of value to write.
-        value_byte_size (int): Size of value in bytes.
+        value_byte_size (int): Deprecated. Size of value in bytes.
+            This is ignored and ``value``'s size is calculated automatically now.
         value (bytes, bytearray): The value to be set.
         policy (dict): The :ref:`bit_policy <aerospike_bit_policies>` dictionary. default: None.
 
     Returns:
         A dictionary usable in operate or operate_ordered. The format of the dictionary
         should be considered an internal detail, and subject to change.
     """
+    warnings.warn(
+        "value_byte_size is deprecated and will be removed in the next major client release",
+        DeprecationWarning,
+        stacklevel=2
+    )
+
     return {
         OP_KEY: aerospike.OP_BIT_SET,
         BIN_KEY: bin_name,
@@ -336,14 +345,21 @@ def bit_and(bin_name: str, bit_offset, bit_size, value_byte_size, value, policy=
         bin_name (str): The name of the bin containing the map.
         bit_offset (int): The offset where the bits will be modified.
         bit_size (int): How many bits of value to and.
-        value_byte_size (int): Length of value in bytes.
+        value_byte_size (int): Deprecated. Length of value in bytes.
+            This is ignored and ``value``'s size is calculated automatically now.
         value (bytes, bytearray): Bytes to be used in and operation.
         policy (dict): The :ref:`bit_policy <aerospike_bit_policies>` dictionary. default: None.
 
     Returns:
         A dictionary usable in :meth:`~aerospike.Client.operate` or :meth:`~aerospike.Client.operate_ordered`. The
         format of the dictionary should be considered an internal detail, and subject to change.
     """
+    warnings.warn(
+        "value_byte_size is deprecated and will be removed in the next major client release",
+        DeprecationWarning,
+        stacklevel=2
+    )
+
     return {
         OP_KEY: aerospike.OP_BIT_AND,
         BIN_KEY: bin_name,
@@ -406,7 +422,8 @@ def bit_insert(bin_name: str, byte_offset, value_byte_size, value, policy=None):
     Args:
         bin_name (str): The name of the bin containing the map.
         byte_offset (int): The offset where the bytes will be inserted.
-        value_byte_size (int): Size of value in bytes.
+        value_byte_size (int): Deprecated. Size of value in bytes.
+            This is ignored and ``value``'s size is calculated automatically now.
         value (bytes, bytearray): The value to be inserted.
         policy (dict): The :ref:`bit_policy <aerospike_bit_policies>` dictionary. default: None.
 
@@ -415,6 +432,12 @@ def bit_insert(bin_name: str, byte_offset, value_byte_size, value, policy=None):
         A dictionary usable in :meth:`~aerospike.Client.operate` or :meth:`~aerospike.Client.operate_ordered`. The
         format of the dictionary should be considered an internal detail, and subject to change.
     """
+    warnings.warn(
+        "value_byte_size is deprecated and will be removed in the next major client release",
+        DeprecationWarning,
+        stacklevel=2
+    )
+
     return {
         OP_KEY: aerospike.OP_BIT_INSERT,
         BIN_KEY: bin_name,
@@ -515,14 +538,21 @@ def bit_or(bin_name: str, bit_offset, bit_size, value_byte_size, value, policy=N
         bin_name (str): The name of the bin containing the map.
         bit_offset (int): The offset where the bits will start being compared.
         bit_size (int): How many bits of value to or.
-        value_byte_size (int): Length of value in bytes.
+        value_byte_size (int): Deprecated. Length of value in bytes.
+            This is ignored and ``value``'s size is calculated automatically now.
         value (bytes | bytearray): Value to be used in or operation.
         policy (dict): The :ref:`bit_policy <aerospike_bit_policies>` dictionary. default: None.
 
     Returns:
         A dictionary usable in :meth:`~aerospike.Client.operate` or :meth:`~aerospike.Client.operate_ordered`. The
         format of the dictionary should be considered an internal detail, and subject to change.
     """
+    warnings.warn(
+        "value_byte_size is deprecated and will be removed in the next major client release",
+        DeprecationWarning,
+        stacklevel=2
+    )
+
     return {
         OP_KEY: aerospike.OP_BIT_OR,
         BIN_KEY: bin_name,
@@ -632,14 +662,21 @@ def bit_xor(bin_name: str, bit_offset, bit_size, value_byte_size, value, policy=
         bin_name (str): The name of the bin containing the map.
         bit_offset (int): The offset where the bits will start being compared.
         bit_size (int): How many bits of value to xor.
-        value_byte_size (int): Length of value in bytes.
+        value_byte_size (int): Deprecated. Length of value in bytes.
+            This is ignored and ``value``'s size is calculated automatically now.
         value (bytes | bytearray): Value to be used in xor operation.
         policy (dict): The :ref:`bit_policy <aerospike_bit_policies>` dictionary. default: None.
 
     Returns:
         A dictionary usable in :meth:`~aerospike.Client.operate` or :meth:`~aerospike.Client.operate_ordered`. The
         format of the dictionary should be considered an internal detail, and subject to change.
     """
+    warnings.warn(
+        "value_byte_size is deprecated and will be removed in the next major client release.",
+        DeprecationWarning,
+        stacklevel=2
+    )
+
     return {
         OP_KEY: aerospike.OP_BIT_XOR,
         BIN_KEY: bin_name,
@@ -661,7 +698,7 @@ def bit_b64_encode(
     """
     Create bit "b64 encode" operation that returns the base64 text of ``byte_size`` bytes starting from ``byte_offset``.
 
-    Requires server version 8.1.3 or later.
+    Requires server version 8.2.0 or later.
 
     Args:
         bin_name (str): The name of the bin containing the map.

aerospike_helpers/operations/list_operations.py

@@ -1178,7 +1178,7 @@ def list_join(
     An empty list yields an empty string, and a single-item list yields that item with no separator applied.
     This is the inverse of :py:meth:`~aerospike_helpers.operations.string_operations.split_separator`.
 
-    Requires server version 8.1.3 or later.
+    Requires server version 8.2.0 or later.
 
     Args:
         bin_name (str): The name of the bin containing the list.
@@ -1192,7 +1192,7 @@ def list_join(
         format of the dictionary should be considered an internal detail, and subject to change.
 
     Note:
-        This operation requires server version 8.1.3.0 or greater.
+        This operation requires server version 8.2.0 or greater.
     """
     op_dict = {
         OP_KEY: aerospike._OP_LIST_JOIN,

aerospike_helpers/operations/string_operations.py

@@ -21,7 +21,7 @@
 Negative indexes count from the end of the string (-1 is the last
 codepoint). Out-of-bounds indexes are clamped by the server.
 
-String operations require server version 8.1.3 or later. When ctx is not
+String operations require server version 8.2.0 or later. When ctx is not
 :py:obj:`None` and not empty, the operation targets a string nested inside a list or
 map. The ctx-navigated leaf must already be an Aerospike string; operations
 on non-string leaves return :exc:`~aerospike.exception.BinIncompatibleType`.

doc/aerospike.rst

@@ -515,6 +515,14 @@ Only the `hosts` key is required; the rest of the keys are optional.
                 Traceback (most recent call last):
                 aerospike.exception.ParamError: "key_policy" is an invalid policy dictionary key
 
+            .. note::
+                **Known exception:** :meth:`~aerospike.Client.remove_bin` raises
+                :py:class:`~aerospike.exception.ClientError` instead of
+                :py:class:`~aerospike.exception.ParamError` for an invalid policy
+                dictionary key. This is scheduled to be fixed in the next major
+                client release; see :meth:`~aerospike.Client.remove_bin` for
+                details.
+
         * **hosts** (:class:`list`)
             A list identifying a node (or multiple nodes) in the cluster. Each entry may be
             either a tuple or a string.

doc/client.rst

@@ -493,6 +493,16 @@ Record Commands
 
         :raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.
 
+        .. note::
+            **Known issue:** if the client config's ``validate_keys`` option is :py:obj:`True` and
+            *policy* contains an invalid dictionary key, this method raises
+            :py:class:`~aerospike.exception.ClientError` instead of the
+            :py:class:`~aerospike.exception.ParamError` that every other method raises in this
+            situation (see :func:`aerospike.client`'s ``validate_keys`` option). Changing this
+            outright would be a breaking change, so it is deferred to the next major client
+            release. A :exc:`DeprecationWarning` is raised in the meantime to warn ahead of that
+            change.
+
         .. testcode::
 
             # Insert record

pyproject.toml

@@ -58,10 +58,15 @@ dirty = "{base_version}+{distance}.{vcs}{rev}.dirty"
 distance-dirty = "{base_version}+{distance}.{vcs}{rev}.dirty"
 # Example formatted version: 1.2.3+42.ge174a1f.dirty
 
-# These operations are still supported in server < 8.1.3,
-# and these operations are used in many places throughout the test suite.
 [tool.pytest.ini_options]
 filterwarnings = [
+    # These operations are still supported in server < 8.2.0,
+    # and these operations are used in many places throughout the test suite.
     "ignore:.*aerospike_helpers\\.operations\\.operations\\.append.*string.*:DeprecationWarning",
     "ignore:.*aerospike_helpers\\.operations\\.operations\\.prepend.*string.*:DeprecationWarning",
+    "ignore:.*aerospike_helpers\\.operations\\.bitwise_operations\\.bit_xor.*value_byte_size.*:DeprecationWarning",
+    "ignore:.*aerospike_helpers\\.operations\\.bitwise_operations\\.bit_and.*value_byte_size.*:DeprecationWarning",
+    "ignore:.*aerospike_helpers\\.operations\\.bitwise_operations\\.bit_insert.*value_byte_size.*:DeprecationWarning",
+    "ignore:.*aerospike_helpers\\.operations\\.bitwise_operations\\.bit_or.*value_byte_size.*:DeprecationWarning",
+    "ignore:.*aerospike_helpers\\.operations\\.bitwise_operations\\.bit_xor.*value_byte_size.*:DeprecationWarning",
 ]

src/include/client.h

@@ -597,3 +597,12 @@ PyObject *AerospikeClient_Abort(AerospikeClient *self, PyObject *args,
     "Operations and bin names are mutually exclusive."                         \
     "In the next major client release, when this %s object is executed, a "    \
     "ParamError will be raised."
+
+// remove_bin() raises ClientError instead of ParamError when validate_keys
+// is True and an invalid policy dictionary key is passed. Fixing this
+// outright would be a breaking change, so for now we keep the existing
+// (incorrect) behavior and just warn ahead of the next major release.
+#define REMOVE_BIN_INVALID_POLICY_KEY_MESSAGE                                  \
+    "remove_bin() raised a ClientError because the policy dictionary "         \
+    "contained an invalid key. In the next major client release, a "           \
+    "ParamError will be raised instead."

src/include/policy.h

@@ -68,8 +68,7 @@ enum Aerospike_send_bool_as_values {
         X(LIST_JOIN_SEPARATOR)
 
 // clang-format off
-#define STRING_OP_NAMES                                                        \
-    X(STRING_STRLEN), \
+#define STRING_OP_NAMES_EXCEPT_STRLEN                                                        \
     X(STRING_SUBSTR), \
     X(STRING_SUBSTR_RANGE), \
     X(STRING_CHAR_AT), \
@@ -114,7 +113,8 @@ enum {
 #define X(op_name) OP_##op_name
     X(LIST_APPEND) = 1001,
     LIST_OP_NAMES_EXCEPT_LIST_APPEND,
-    STRING_OP_NAMES
+    X(STRING_STRLEN) = 1200,
+    STRING_OP_NAMES_EXCEPT_STRLEN
 #undef X
 };