Fix issue with tagging non-string Flask view args (#2760) (#2761)

* Fix issue with tagging non-string Flask view args
fixes #2756

* fix test method name

* fix json decoding when we have bytes

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit 54a42fe)

Co-authored-by: Brett Langdon <[email protected]>

Author: mergify[bot]

ddtrace/contrib/flask/patch.py

@@ -481,7 +481,9 @@ def _traced_request(pin, wrapped, instance, args, kwargs):
 
             if not span.get_tag(FLASK_VIEW_ARGS) and request.view_args and config.flask.get("collect_view_args"):
                 for k, v in request.view_args.items():
-                    span._set_str_tag(u".".join((FLASK_VIEW_ARGS, k)), v)
+                    # DEV: Do not use `_set_str_tag` here since view args can be string/int/float/path/uuid/etc
+                    #      https://flask.palletsprojects.com/en/1.1.x/api/#url-route-registrations
+                    span.set_tag(u".".join((FLASK_VIEW_ARGS, k)), v)
         except Exception:
             log.debug('failed to set tags for "flask.request" span', exc_info=True)
 

releasenotes/notes/fix-flask-non-string-view-args-ed0283ddb1541e27.yaml

@@ -0,0 +1,4 @@
+---
+fixes:
+  - |
+    Fixes error with tagging non-string Flask view args.

tests/contrib/flask/test_request.py

@@ -1,6 +1,9 @@
 # -*- coding: utf-8 -*-
+import json
+
 import flask
 from flask import abort
+from flask import jsonify
 from flask import make_response
 
 from ddtrace.constants import ANALYTICS_SAMPLE_RATE_KEY
@@ -82,6 +85,50 @@ def index():
         self.assertEqual(handler_span.resource, "/")
         self.assertEqual(req_span.error, 0)
 
+    def test_route_params_request(self):
+        """
+        When making a request to an endpoint with non-string url params
+            We create the expected spans
+        """
+
+        @self.app.route("/route_params/<first>/<int:second>/<float:third>/<path:fourth>")
+        def route_params(first, second, third, fourth):
+            return jsonify(
+                {
+                    "first": first,
+                    "second": second,
+                    "third": third,
+                    "fourth": fourth,
+                }
+            )
+
+        res = self.client.get("/route_params/test/100/5.5/some/sub/path")
+        self.assertEqual(res.status_code, 200)
+        if isinstance(res.data, bytes):
+            data = json.loads(res.data.decode())
+        else:
+            data = json.loads(res.data)
+
+        assert data == {
+            "first": "test",
+            "second": 100,
+            "third": 5.5,
+            "fourth": "some/sub/path",
+        }
+
+        spans = self.get_spans()
+        self.assertEqual(len(spans), 8)
+
+        root = spans[0]
+        assert root.name == "flask.request"
+        assert root.get_tag(http.URL) == "http://localhost/route_params/test/100/5.5/some/sub/path"
+        assert root.get_tag("flask.endpoint") == "route_params"
+        assert root.get_tag("flask.url_rule") == "/route_params/<first>/<int:second>/<float:third>/<path:fourth>"
+        assert root.get_tag("flask.view_args.first") == "test"
+        assert root.get_metric("flask.view_args.second") == 100.0
+        assert root.get_metric("flask.view_args.third") == 5.5
+        assert root.get_tag("flask.view_args.fourth") == "some/sub/path"
+
     def test_request_query_string_trace(self):
         """Make sure when making a request that we create the expected spans and capture the query string."""