[CLIENT-2219] Remove deprecated client.info()

juliannguyen4 · juliannguyen4 · commit 658bb0743e59 · 2023-07-12T10:32:02.000-07:00
diff --git a/aerospike-stubs/aerospike.pyi b/aerospike-stubs/aerospike.pyi
@@ -348,7 +348,6 @@ class Client:
     def index_map_values_create(self, ns: str, set: str, bin: str, index_datatype, name: str, policy: dict = ...) -> None: ...
     def index_remove(self, ns, name: str, policy: dict = ...) -> None: ...
     def index_string_create(self, ns: str, set: str, bin: str, name: str, policy: dict = ...) -> None: ...
-    def info(self, command, hosts = ..., policy: dict = ...) -> dict: ...
     def info_all(self, command: str, policy: dict = ...) -> dict: ...
     def info_random_node(self, command: str, policy: dict = ...) -> str: ...
     def info_single_node(self, command: str, host: str, policy: dict = ...) -> str: ...
diff --git a/doc/client.rst b/doc/client.rst
@@ -778,43 +778,6 @@ Info Operations
 
         .. versionchanged:: 6.0.0
 
-    .. method:: info(command[, hosts[, policy: dict]]) -> {}
-
-        .. deprecated:: 3.0.0
-            Use :meth:`info_all` to send a request to the entire cluster.
-
-        Send an info command to all nodes in the cluster, and optionally filter responses to only include certain nodes.
-
-        :param str command: the info command. See `Info Command Reference <http://www.aerospike.com/docs/reference/info/>`_
-        :param list hosts: a :class:`list` containing ``(address, port)`` tuples. If specified, only send the command to these hosts. Example: ``[('127.0.0.1', 3000)]``
-        :param dict policy: optional :ref:`aerospike_info_policies`.
-        :rtype: :class:`dict`
-        :raises: a subclass of :exc:`~aerospike.exception.AerospikeError`.
-
-        .. code-block:: python
-
-            response = client.info(command)
-            client.close()
-            # {'BB9581F41290C00': (None, '127.0.0.1:3000\n'), 'BC3581F41290C00': (None, '127.0.0.1:3010\n')}
-
-        .. note::
-                Sending requests to specific nodes can be better handled with a simple Python function such as:
-
-                .. code-block:: python
-
-                    def info_to_host_list(client, request, hosts, policy=None):
-                        output = {}
-                        for host in hosts:
-                            try:
-                                response = client.info_single_node(request, host, policy)
-                                output[host] = response
-                            except Exception as e:
-                                #  Handle the error gracefully here
-                                output[host] = e
-                        return output
-
-        .. versionchanged:: 3.0.0
-
     .. method:: set_xdr_filter(data_center, namespace, expression_filter[, policy: dict]) -> str
 
         Set the cluster's xdr filter using an Aerospike expression.
diff --git a/examples/client/ttl.py b/examples/client/ttl.py
@@ -183,7 +183,7 @@ def test_params_for_stanza(p, contx, is_namespace):
             info_code = "set-config:context=" + \
                 contx + ";" + t[0] + "=" + str(t[1])
         try:
-            v = list(client.info(info_code).items())
+            v = list(client.info_all(info_code).items())
             res = v[0][1][1]
             if res != "ok\n":
                 print(
@@ -319,7 +319,7 @@ def write_records():
 print("service parameters passed")
 
 print("getting initial ttl values")
-info = client.info("namespace/" + options.namespace)
+info = client.info_all("namespace/" + options.namespace)
 default_ttl = 0
 max_ttl = 0
 for key, value in list(info.items()):
diff --git a/src/include/client.h b/src/include/client.h
@@ -556,15 +556,6 @@ PyObject *AerospikeClient_GetExpressionBase64(AerospikeClient *self,
 PyObject *AerospikeClient_InfoAll(AerospikeClient *self, PyObject *args,
                                   PyObject *kwds);
 
-/**
-* Perform info operation on the database.
-*
-* client.info((x,y,z))
-*
-*/
-PyObject *AerospikeClient_Info(AerospikeClient *self, PyObject *args,
-                               PyObject *kwds);
-
 /**
 * Perform get nodes operation on the database.
 *
diff --git a/src/main/client/info.c b/src/main/client/info.c
@@ -44,182 +44,6 @@ static PyObject *AerospikeClient_InfoAll_Invoke(AerospikeClient *self,
                                                 PyObject *py_policy);
 
 static PyObject *get_formatted_info_response(const char *response);
-/**
- ********************************************************************************************************
- * Macros for Info API.
- ********************************************************************************************************
- */
-#define INET_ADDRSTRLEN 16
-#define INET6_ADDRSTRLEN 46
-#define INET_PORT 5
-#define IP_PORT_SEPARATOR_LEN 1
-// Add 2 to the length to facilitate [] around the edges
-#define IP_PORT_MAX_LEN INET6_ADDRSTRLEN + INET_PORT + IP_PORT_SEPARATOR_LEN + 2
-
-/**
- *******************************************************************************************************
- * Callback for as_info_foreach().
- *
- * @param err                   The as_error to be populated by the function
- *                              with the encountered error if any.
- * @param node                  The current as_node object for which the
- *                              callback is fired by c client.
- * @param req                   The info request string.
- * @param res                   The info response string for current node.
- * @pram udata                  The callback udata containing the host_lookup
- *                              array and the return zval to be populated with
- *                              an entry for current node's info response with
- *                              the node's ID as the key.
- *
- * Returns true if callback is successful, Otherwise false.
- *******************************************************************************************************
- */
-static bool AerospikeClient_Info_each(as_error *err, const as_node *node,
-                                      const char *req, char *res, void *udata)
-{
-    PyObject *py_err = NULL;
-    PyObject *py_ustr = NULL;
-    PyObject *py_out = NULL;
-    foreach_callback_info_udata *udata_ptr =
-        (foreach_callback_info_udata *)udata;
-    as_address *addr = NULL;
-
-    // Need to make sure we have the GIL since we're back in python land now
-    PyGILState_STATE gil_state = PyGILState_Ensure();
-
-    if (err && err->code != AEROSPIKE_OK) {
-        as_error_update(err, err->code, NULL);
-        goto CLEANUP;
-    }
-    else if (res) {
-        char *out = strchr(res, '\t');
-        if (out) {
-            out++;
-            py_out = PyUnicode_FromString(out);
-        }
-        else {
-            py_out = PyUnicode_FromString(res);
-        }
-    }
-
-    if (!py_err) {
-        Py_INCREF(Py_None);
-        py_err = Py_None;
-    }
-
-    if (!py_out) {
-        Py_INCREF(Py_None);
-        py_out = Py_None;
-    }
-
-    PyObject *py_res = PyTuple_New(2);
-    PyTuple_SetItem(py_res, 0, py_err);
-    PyTuple_SetItem(py_res, 1, py_out);
-
-    if (udata_ptr->host_lookup_p) {
-        PyObject *py_hosts = (PyObject *)udata_ptr->host_lookup_p;
-        if (py_hosts && PyList_Check(py_hosts)) {
-            addr = as_node_get_address((as_node *)node);
-            int size = (int)PyList_Size(py_hosts);
-            for (int i = 0; i < size; i++) {
-                char *host_addr = NULL;
-                int port = -1;
-                PyObject *py_host = PyList_GetItem(py_hosts, i);
-                if (PyTuple_Check(py_host) && PyTuple_Size(py_host) == 2) {
-                    PyObject *py_addr = PyTuple_GetItem(py_host, 0);
-                    PyObject *py_port = PyTuple_GetItem(py_host, 1);
-                    if (PyUnicode_Check(py_addr)) {
-                        py_ustr = PyUnicode_AsUTF8String(py_addr);
-                        host_addr = PyBytes_AsString(py_ustr);
-                    }
-                    else {
-                        as_error_update(&udata_ptr->error, AEROSPIKE_ERR_PARAM,
-                                        "Host address is of type incorrect");
-                        if (py_res) {
-                            Py_DECREF(py_res);
-                        }
-                        PyGILState_Release(gil_state);
-                        return false;
-                    }
-                    if (PyLong_Check(py_port)) {
-                        port = (uint16_t)PyLong_AsLong(py_port);
-                    }
-                    else {
-                        break;
-                    }
-                    char ip_port[IP_PORT_MAX_LEN];
-                    // If the address is longer than the max length of an ipv6 address, raise an error and exit
-                    if (strnlen(host_addr, INET6_ADDRSTRLEN) >=
-                        INET6_ADDRSTRLEN) {
-                        as_error_update(&udata_ptr->error, AEROSPIKE_ERR_PARAM,
-                                        "Host address is too long");
-                        if (py_res) {
-                            Py_DECREF(py_res);
-                        }
-                        goto CLEANUP;
-                    }
-                    sprintf(ip_port, "%s:%d", host_addr, port);
-                    if (!strcmp(ip_port, addr->name)) {
-                        PyObject *py_nodes = (PyObject *)udata_ptr->udata_p;
-                        PyDict_SetItemString(py_nodes, node->name, py_res);
-                    }
-                    else {
-                        sprintf(ip_port, "[%s]:%d", host_addr, port);
-                        if (!strcmp(ip_port, addr->name)) {
-                            PyObject *py_nodes = (PyObject *)udata_ptr->udata_p;
-                            PyDict_SetItemString(py_nodes, node->name, py_res);
-                        }
-                    }
-                }
-
-                if (py_ustr) {
-                    Py_DECREF(py_ustr);
-                    py_ustr = NULL;
-                }
-            }
-        }
-        else if (!PyList_Check(py_hosts)) {
-            as_error_update(&udata_ptr->error, AEROSPIKE_ERR_PARAM,
-                            "Hosts should be specified in a list.");
-            if (py_res) {
-                Py_DECREF(py_res);
-            }
-            goto CLEANUP;
-        }
-    }
-    else {
-        PyObject *py_nodes = (PyObject *)udata_ptr->udata_p;
-        PyDict_SetItemString(py_nodes, node->name, py_res);
-    }
-
-    Py_DECREF(py_res);
-
-CLEANUP:
-    if (py_ustr) {
-        Py_DECREF(py_ustr);
-    }
-    if (udata_ptr->error.code != AEROSPIKE_OK) {
-        PyObject *py_err = NULL;
-        error_to_pyobject(&udata_ptr->error, &py_err);
-        PyObject *exception_type = raise_exception_old(&udata_ptr->error);
-        PyErr_SetObject(exception_type, py_err);
-        Py_DECREF(py_err);
-        PyGILState_Release(gil_state);
-        return NULL;
-    }
-    if (err->code != AEROSPIKE_OK) {
-        PyObject *py_err = NULL;
-        error_to_pyobject(err, &py_err);
-        PyObject *exception_type = raise_exception_old(err);
-        PyErr_SetObject(exception_type, py_err);
-        Py_DECREF(py_err);
-        PyGILState_Release(gil_state);
-        return NULL;
-    }
-
-    PyGILState_Release(gil_state);
-    return true;
-}
 
 /**
  *******************************************************************************************************
@@ -297,110 +121,6 @@ static bool AerospikeClient_InfoAll_each(as_error *err, const as_node *node,
     return true;
 }
 
-/**
- *******************************************************************************************************
- * Sends an info request to all the nodes in a cluster.
- *
- * @param self                  AerospikeClient object
- * @param args                  The args is a tuple object containing an argument
- *                              list passed from Python to a C function
- * @param kwds                  Dictionary of keywords
- *
- * Returns a server response for the particular request string.
- * In case of error,appropriate exceptions will be raised.
- *******************************************************************************************************
- */
-PyObject *AerospikeClient_Info(AerospikeClient *self, PyObject *args,
-                               PyObject *kwds)
-{
-    PyObject *py_req = NULL;
-    PyObject *py_policy = NULL;
-    PyObject *py_hosts = NULL;
-    PyObject *py_nodes = NULL;
-    PyObject *py_ustr = NULL;
-    foreach_callback_info_udata info_callback_udata;
-
-    static char *kwlist[] = {"command", "hosts", "policy", NULL};
-
-    if (PyArg_ParseTupleAndKeywords(args, kwds, "O|OO:info", kwlist, &py_req,
-                                    &py_hosts, &py_policy) == false) {
-        return NULL;
-    }
-
-    as_error err;
-    as_error_init(&err);
-
-    as_policy_info info_policy;
-    as_policy_info *info_policy_p = NULL;
-    py_nodes = PyDict_New();
-    info_callback_udata.udata_p = py_nodes;
-    info_callback_udata.host_lookup_p = py_hosts;
-    as_error_init(&info_callback_udata.error);
-
-    if (!self || !self->as) {
-        as_error_update(&err, AEROSPIKE_ERR_PARAM, "Invalid aerospike object");
-        goto CLEANUP;
-    }
-    if (!self->is_conn_16) {
-        as_error_update(&err, AEROSPIKE_ERR_CLUSTER,
-                        "No connection to aerospike cluster");
-        goto CLEANUP;
-    }
-
-    // Convert python policy object to as_policy_info
-    pyobject_to_policy_info(&err, py_policy, &info_policy, &info_policy_p,
-                            &self->as->config.policies.info);
-    if (err.code != AEROSPIKE_OK) {
-        goto CLEANUP;
-    }
-    char *req = NULL;
-    if (PyUnicode_Check(py_req)) {
-        py_ustr = PyUnicode_AsUTF8String(py_req);
-        req = PyBytes_AsString(py_ustr);
-    }
-    else {
-        as_error_update(&err, AEROSPIKE_ERR_PARAM, "Request must be a string");
-        goto CLEANUP;
-    }
-
-    Py_BEGIN_ALLOW_THREADS
-    aerospike_info_foreach(
-        self->as, &err, info_policy_p, req,
-        (aerospike_info_foreach_callback)AerospikeClient_Info_each,
-        &info_callback_udata);
-    Py_END_ALLOW_THREADS
-
-    if (info_callback_udata.error.code != AEROSPIKE_OK) {
-        as_error_update(&err, err.code, NULL);
-        goto CLEANUP;
-    }
-CLEANUP:
-    if (py_ustr) {
-        Py_DECREF(py_ustr);
-    }
-    if (info_callback_udata.error.code != AEROSPIKE_OK) {
-        PyObject *py_err = NULL;
-        error_to_pyobject(&info_callback_udata.error, &py_err);
-        PyObject *exception_type =
-            raise_exception_old(&info_callback_udata.error);
-        PyErr_SetObject(exception_type, py_err);
-        Py_DECREF(py_err);
-        if (py_nodes) {
-            Py_DECREF(py_nodes);
-        }
-        return NULL;
-    }
-    if (err.code != AEROSPIKE_OK) {
-        raise_exception(&err);
-        if (py_nodes) {
-            Py_DECREF(py_nodes);
-        }
-        return NULL;
-    }
-
-    return info_callback_udata.udata_p;
-}
-
 /**
  *******************************************************************************************************
  * Sends an info request to all the nodes in a cluster.
diff --git a/src/main/client/type.c b/src/main/client/type.c
@@ -163,10 +163,6 @@ PyDoc_STRVAR(
 \n\
 Initiate a background scan and apply a record UDF to each record matched by the scan.");
 
-PyDoc_STRVAR(info_doc, "info(command[, hosts[, policy]]) -> {}\n\
-\n\
-Send an info command to multiple nodes specified in a hosts list.");
-
 PyDoc_STRVAR(
     set_xdr_filter_doc,
     "set_xdr_filter(data_center, namespace, expression_filter[, policy]) -> {}\n\
@@ -458,8 +454,6 @@ static PyMethodDef AerospikeClient_Type_Methods[] = {
 
     // INFO OPERATIONS
 
-    {"info", (PyCFunction)AerospikeClient_Info, METH_VARARGS | METH_KEYWORDS,
-     info_doc},
     {"set_xdr_filter", (PyCFunction)AerospikeClient_SetXDRFilter,
      METH_VARARGS | METH_KEYWORDS, set_xdr_filter_doc},
     {"get_expression_base64", (PyCFunction)AerospikeClient_GetExpressionBase64,
diff --git a/test/new_tests/test_info.py b/test/new_tests/test_info.py
diff --git a/test/new_tests/test_info_single_node.py b/test/new_tests/test_info_single_node.py
diff --git a/test/new_tests/test_user_serializer.py b/test/new_tests/test_user_serializer.py
