Fix unserializable settings. Closes #16

Author: a-feld

newrelic/core/agent_protocol.py

@@ -455,7 +455,7 @@ def connect(
         settings = finalize_application_settings(configuration, settings)
 
         with cls(settings, host=redirect_host, client_cls=client_cls) as protocol:
-            protocol.send("agent_settings", (global_settings_dump(settings),))
+            protocol.send("agent_settings", (global_settings_dump(settings, serializable=True),))
 
         if "messages" in configuration:
             for item in configuration["messages"]:

newrelic/core/config.py

@@ -31,6 +31,8 @@
 
 from newrelic.core.attribute_filter import AttributeFilter
 
+import newrelic.packages.six as six
+
 try:
     import urlparse
 except ImportError:
@@ -802,7 +804,7 @@ def create_obfuscated_netloc(username, password, hostname, mask):
     return netloc
 
 
-def global_settings_dump(settings_object=None):
+def global_settings_dump(settings_object=None, serializable=False):
     """This returns dictionary of global settings flattened into a single
     key namespace rather than nested hierarchy. This is used to send the
     global settings configuration back to core application.
@@ -814,10 +816,6 @@ def global_settings_dump(settings_object=None):
 
     settings = flatten_settings(settings_object)
 
-    # Convert unserializable settings into serializable types
-    if 'attribute_filter' in settings:
-        settings['attribute_filter'] = str(settings['attribute_filter'])
-
     # Strip out any sensitive settings.
     # The license key is being sent already, but no point sending
     # it again.
@@ -863,6 +861,16 @@ def global_settings_dump(settings_object=None):
 
             settings['proxy_host'] = uri
 
+    if serializable:
+        for key, value in list(six.iteritems(settings)):
+            if not isinstance(key, six.string_types):
+                del settings[key]
+
+            if (not isinstance(value, six.string_types) and
+                    not isinstance(value, float) and
+                    not isinstance(value, six.integer_types)):
+                settings[key] = repr(value)
+
     return settings
 
 

tests/agent_unittests/test_agent_protocol.py

@@ -7,6 +7,7 @@
 
 import pytest
 
+import newrelic.packages.six as six
 from newrelic.common import certs, system_info
 from newrelic.common.agent_http import DeveloperModeClient
 from newrelic.common.encoding_utils import json_decode, serverless_payload_decode
@@ -478,6 +479,13 @@ def test_connect(
     assert agent_settings_payload["agent_run_id"] is not None
     assert protocol.configuration.agent_run_id is not None
 
+    # Verify that agent settings sent have converted null, containers, and
+    # unserializable types to string
+    assert agent_settings_payload["proxy_host"] == "None"
+    assert agent_settings_payload["attributes.include"] == "[]"
+    assert agent_settings_payload["feature_flag"] == str(set())
+    assert isinstance(agent_settings_payload["attribute_filter"], six.string_types)
+
     # Verify that the connection is closed
     assert HttpClientRecorder.STATE == 0
 
@@ -532,7 +540,7 @@ def test_serverless_protocol_finalize(capsys):
     assert payload[:2] == [1, "NR_LAMBDA_MONITORING"]
 
     data = serverless_payload_decode(payload[2])
-    assert data["data"] == {"metric_data": [1,2,3]}
+    assert data["data"] == {"metric_data": [1, 2, 3]}
 
     assert data["metadata"]["foo"] == "bar"
     assert data["metadata"]["agent_version"] != "x"
@@ -571,7 +579,9 @@ def __init__(self, *args, **kwargs):
 
 
 def test_max_payload_size_limit():
-    settings = finalize_application_settings({"max_payload_size_in_bytes": 0, "port": -1})
+    settings = finalize_application_settings(
+        {"max_payload_size_in_bytes": 0, "port": -1}
+    )
     protocol = AgentProtocol(settings, host="localhost")
     with pytest.raises(DiscardDataForRequest):
         protocol.send("metric_data")

tests/agent_unittests/test_connect_response_fields.py

@@ -15,10 +15,9 @@
 import pytest
 import functools
 import time
-from copy import deepcopy
 
 from testing_support.fixtures import override_generic_settings
-from newrelic.core.config import global_settings, global_settings_dump
+from newrelic.core.config import global_settings
 from newrelic.core.agent_protocol import AgentProtocol
 from newrelic.common.agent_http import DeveloperModeClient
 from newrelic.common.encoding_utils import json_encode
@@ -111,7 +110,6 @@ def test_no_blob_behavior(headers_map_present):
     }
 
 
-
 def test_blob():
     request_headers_map = {u'X-Foo': u'Bar'}
     connect_response_fields = {u"request_headers_map": request_headers_map}