Skip to content

Commit cf0dd40

Browse files
committed
Refactor TracedConnectionProxy
Fixes #1077
1 parent 10659f8 commit cf0dd40

File tree

2 files changed

+37
-23
lines changed

2 files changed

+37
-23
lines changed

instrumentation/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi/__init__.py

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -214,8 +214,8 @@ def uninstrument_connection(connection):
214214
Returns:
215215
An uninstrumented connection.
216216
"""
217-
if isinstance(connection, wrapt.ObjectProxy):
218-
return connection.__wrapped__
217+
if isinstance(connection, _TracedConnectionProxy):
218+
return connection._connection
219219

220220
_logger.warning("Connection is not instrumented")
221221
return connection
@@ -300,28 +300,36 @@ def get_connection_attributes(self, connection):
300300
self.span_attributes[SpanAttributes.NET_PEER_PORT] = port
301301

302302

303+
class _TracedConnectionProxy:
304+
pass
305+
306+
303307
def get_traced_connection_proxy(
304308
connection, db_api_integration, *args, **kwargs
305309
):
306310
# pylint: disable=abstract-method
307-
class TracedConnectionProxy(wrapt.ObjectProxy):
308-
# pylint: disable=unused-argument
309-
def __init__(self, connection, *args, **kwargs):
310-
wrapt.ObjectProxy.__init__(self, connection)
311+
class TracedConnectionProxy(type(connection), _TracedConnectionProxy):
312+
def __init__(self, connection):
313+
self._connection = connection
311314

312-
def cursor(self, *args, **kwargs):
313-
return get_traced_cursor_proxy(
314-
self.__wrapped__.cursor(*args, **kwargs), db_api_integration
315+
def __getattr__(self, name):
316+
return object.__getattribute__(
317+
object.__getattribute__(self, "_connection"), name
315318
)
316319

317320
def __enter__(self):
318-
self.__wrapped__.__enter__()
319-
return self
321+
self._connection.__enter__()
322+
return self._connection
320323

321-
def __exit__(self, *args, **kwargs):
322-
self.__wrapped__.__exit__(*args, **kwargs)
324+
def __exit__(self, exc_type, exc_value, traceback):
325+
self._connection.__exit__(exc_type, exc_value, traceback)
326+
327+
def cursor(self, *args, **kwargs):
328+
return get_traced_cursor_proxy(
329+
self._connection.cursor(*args, **kwargs), db_api_integration
330+
)
323331

324-
return TracedConnectionProxy(connection, *args, **kwargs)
332+
return TracedConnectionProxy(connection)
325333

326334

327335
class CursorTracer:

instrumentation/opentelemetry-instrumentation-dbapi/tests/test_dbapi_integration.py

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -262,14 +262,14 @@ def test_callproc(self):
262262

263263
@mock.patch("opentelemetry.instrumentation.dbapi")
264264
def test_wrap_connect(self, mock_dbapi):
265-
dbapi.wrap_connect(self.tracer, mock_dbapi, "connect", "-")
265+
dbapi.wrap_connect(self.tracer, MockConnectionEmpty(), "connect", "-")
266266
connection = mock_dbapi.connect()
267267
self.assertEqual(mock_dbapi.connect.call_count, 1)
268-
self.assertIsInstance(connection.__wrapped__, mock.Mock)
268+
self.assertIsInstance(connection._connection, mock.Mock)
269269

270270
@mock.patch("opentelemetry.instrumentation.dbapi")
271271
def test_unwrap_connect(self, mock_dbapi):
272-
dbapi.wrap_connect(self.tracer, mock_dbapi, "connect", "-")
272+
dbapi.wrap_connect(self.tracer, MockConnectionEmpty(), "connect", "-")
273273
connection = mock_dbapi.connect()
274274
self.assertEqual(mock_dbapi.connect.call_count, 1)
275275

@@ -279,19 +279,19 @@ def test_unwrap_connect(self, mock_dbapi):
279279
self.assertIsInstance(connection, mock.Mock)
280280

281281
def test_instrument_connection(self):
282-
connection = mock.Mock()
282+
connection = MockConnectionEmpty()
283283
# Avoid get_attributes failing because can't concatenate mock
284284
connection.database = "-"
285285
connection2 = dbapi.instrument_connection(self.tracer, connection, "-")
286-
self.assertIs(connection2.__wrapped__, connection)
286+
self.assertIs(connection2._connection, connection)
287287

288288
def test_uninstrument_connection(self):
289-
connection = mock.Mock()
289+
connection = MockConnectionEmpty()
290290
# Set connection.database to avoid a failure because mock can't
291291
# be concatenated
292292
connection.database = "-"
293293
connection2 = dbapi.instrument_connection(self.tracer, connection, "-")
294-
self.assertIs(connection2.__wrapped__, connection)
294+
self.assertIs(connection2._connection, connection)
295295

296296
connection3 = dbapi.uninstrument_connection(connection2)
297297
self.assertIs(connection3, connection)
@@ -307,10 +307,12 @@ def mock_connect(*args, **kwargs):
307307
server_host = kwargs.get("server_host")
308308
server_port = kwargs.get("server_port")
309309
user = kwargs.get("user")
310-
return MockConnection(database, server_port, server_host, user)
310+
return MockConnectionWithAttributes(
311+
database, server_port, server_host, user
312+
)
311313

312314

313-
class MockConnection:
315+
class MockConnectionWithAttributes:
314316
def __init__(self, database, server_port, server_host, user):
315317
self.database = database
316318
self.server_port = server_port
@@ -343,3 +345,7 @@ def executemany(self, query, params=None, throw_exception=False):
343345
def callproc(self, query, params=None, throw_exception=False):
344346
if throw_exception:
345347
raise Exception("Test Exception")
348+
349+
350+
class MockConnectionEmpty:
351+
pass

0 commit comments

Comments
 (0)