fix(sanic): fix handling of non-string arguments (backport #2699) (#2708)

* fix(sanic): fix handling of non-string arguments (#2699)

* fix(sanic): fix handling of non-string arguments

This change fixes the handling of endpoint paths that take non-string
arguments.

Fixes #2678.

* Update ddtrace/contrib/sanic/patch.py

Co-authored-by: Nicolas Vivet <[email protected]>

Co-authored-by: Nicolas Vivet <[email protected]>
(cherry picked from commit c95322a)

* fix: fix latest sanic release note (#2703)

Co-authored-by: Gabriele N. Tornetta <[email protected]>

Author: mergify[bot]

ddtrace/contrib/sanic/patch.py

@@ -78,6 +78,11 @@ def _get_path(request):
     except sanic.exceptions.SanicException:
         return path
     for key, value in match_info.items():
+        try:
+            value = str(value)
+        except Exception:
+            # Best effort
+            continue
         path = path.replace(value, f"<{key}>")
     return path
 

releasenotes/notes/fix-sanic-non-str-args-4d1b0f506bee3436.yaml

@@ -0,0 +1,4 @@
+---
+fixes:
+  - |
+    Fixed the handling of sanic endpoint paths with non-string arguments.

tests/contrib/sanic/test_sanic.py

@@ -6,6 +6,7 @@
 from sanic import Sanic
 from sanic.config import DEFAULT_CONFIG
 from sanic.exceptions import ServerError
+from sanic.exceptions import abort
 from sanic.response import json
 from sanic.response import stream
 from sanic.response import text
@@ -88,6 +89,14 @@ async def invalid(request):
     async def empty(request):
         pass
 
+    @app.route("/<n:int>/count", methods=["GET"])
+    async def count(request, n):
+        try:
+            pass
+        except Exception as e:
+            abort(500, e)
+        return json({"hello": n})
+
     @app.exception(ServerError)
     def handler_exception(request, exception):
         return text(exception.args[0], exception.status_code)
@@ -339,3 +348,9 @@ async def test_http_request_header_tracing(tracer, client, test_spans):
     assert len(spans[0]) == 2
     request_span = spans[0][0]
     assert request_span.get_tag("http.request.headers.my-header") == "my_value"
+
+
+async def test_endpoint_with_numeric_arg(tracer, client, test_spans):
+    response = await client.get("/42/count")
+    assert _response_status(response) == 200
+    assert (await _response_text(response)) == '{"hello":42}'