Ensure plugin configs handled in proper order

rnpridgeon · Ryan P · commit d6c85393e3df · 2018-06-21T12:44:03.000-04:00
diff --git a/confluent_kafka/src/confluent_kafka.c b/confluent_kafka/src/confluent_kafka.c
@@ -1568,6 +1568,47 @@ rd_kafka_conf_t *common_conf_setup (rd_kafka_type_t ktype,
         /* Enable valid offsets in delivery reports */
         rd_kafka_topic_conf_set(tconf, "produce.offset.report", "true", NULL, 0);
 
+       /*
+        * Plugins must be configured prior to handling any of their configuration properties.
+        * Dicts are unordered so we explicitly check for, set, and delete the plugin paths here.
+        * This ensures all configuration properties are handled in the right order.
+        */
+        if ((vo = PyDict_GetItemString(confdict, "plugin.library.paths"))) {
+                const char *v;
+                char errstr[256];
+                PyObject *vs = NULL, *vs8 = NULL;
+
+                if (!(vs = cfl_PyObject_Unistr(vo))) {
+                        PyErr_SetString(PyExc_TypeError,
+                                "expected configuration property name "
+                                "as type unicode string");
+                        rd_kafka_topic_conf_destroy(tconf);
+                        rd_kafka_conf_destroy(conf);
+                        return NULL;
+                }
+
+                v = cfl_PyUnistr_AsUTF8(vs, &vs8);
+
+                if (rd_kafka_conf_set(conf, "plugin.library.paths", v, errstr, sizeof(errstr))
+                   != RD_KAFKA_CONF_OK) {
+                        cfl_PyErr_Format(RD_KAFKA_RESP_ERR__INVALID_ARG,
+                                "%s", NULL);
+
+                        rd_kafka_topic_conf_destroy(tconf);
+                        rd_kafka_conf_destroy(conf);
+
+                        Py_XDECREF(vs8);
+                        Py_XDECREF(vs);
+
+                        return NULL;
+                }
+
+                Py_XDECREF(vs8);
+                Py_DECREF(vs);
+
+                PyDict_DelItemString(confdict, "plugin.library.paths");
+        }
+
 	/* Convert config dict to config key-value pairs. */
 	while (PyDict_Next(confdict, &pos, &ko, &vo)) {
 		PyObject *ks, *ks8;
diff --git a/tests/test_misc.py b/tests/test_misc.py
@@ -3,6 +3,7 @@
 import confluent_kafka
 import json
 import pytest
+import os
 
 
 def test_version():
@@ -123,3 +124,23 @@ def test_throttle_event_types():
     assert isinstance(throttle_event.broker_id, int) and throttle_event.broker_id == 0
     assert isinstance(throttle_event.throttle_time, float) and throttle_event.throttle_time == 10.0
     assert str(throttle_event) == "broker/0 throttled for 10000 ms"
+
+
+@pytest.mark.skipif(len([True for x in (".so", ".dylib", ".dll")
+                         if os.path.exists("monitoring-interceptor" + x)]) == 0,
+                    reason="requires confluent-librdkafka-plugins be installed and copied to the current directory")
+@pytest.mark.parametrize("init_func", [
+    (confluent_kafka.Consumer),
+    (confluent_kafka.Producer),
+    (confluent_kafka.admin.AdminClient),
+])
+def test_unordered_dict(init_func):
+    """
+    Interceptor configs can only be handled after the plugin has been loaded not before.
+    """
+    init_func({'confluent.monitoring.interceptor.publishMs': 1000,
+               'confluent.monitoring.interceptor.sessionDurationMs': 1000,
+               'plugin.library.paths': 'monitoring-interceptor',
+               'confluent.monitoring.interceptor.topic': 'confluent-kafka-testing',
+               'confluent.monitoring.interceptor.icdebug': False
+               })
