chore(integrations): avoids using deprecated apis in ddtrace.patch(…) [backports 2.20] (#12153)

Backports:  #12107

# Checklist 1
- [x] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

# Checklist 2
- [x] Reviewer has checked that all the criteria below are met
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance

policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

Author: mabdinur

ddtrace/_monkey.py

@@ -157,9 +157,6 @@
 }
 
 
-DEFAULT_MODULES_PREFIX = "ddtrace.contrib"
-
-
 class PatchException(Exception):
     """Wraps regular `Exception` class when patching modules"""
 
@@ -170,19 +167,14 @@ class ModuleNotFoundException(PatchException):
     pass
 
 
-def _on_import_factory(module, prefix="ddtrace.contrib", raise_errors=True, patch_indicator=True):
+def _on_import_factory(module, path_f, raise_errors=True, patch_indicator=True):
     # type: (str, str, bool, Union[bool, List[str]]) -> Callable[[Any], None]
     """Factory to create an import hook for the provided module name"""
 
     def on_import(hook):
         # Import and patch module
         try:
-            try:
-                imported_module = importlib.import_module("%s.internal.%s.patch" % (prefix, module))
-            except ImportError:
-                # Some integrations do not have an internal patch module, so we use the public one
-                # FIXME: This is a temporary solution until we refactor the patching logic.
-                imported_module = importlib.import_module("%s.%s" % (prefix, module))
+            imported_module = importlib.import_module(path_f % (module,))
             imported_module.patch()
             if hasattr(imported_module, "patch_submodules"):
                 imported_module.patch_submodules(patch_indicator)
@@ -209,7 +201,7 @@ def on_import(hook):
                         name, True, PATCH_MODULES.get(module) is True, "", version=v
                     )
             elif hasattr(imported_module, "get_version"):
-                # TODO: Ensure every integration defines either get_version or get_versions in their patch.py module
+                # Some integrations/iast patchers do not define get_version
                 version = imported_module.get_version()
                 telemetry.telemetry_writer.add_integration(
                     module, True, PATCH_MODULES.get(module) is True, "", version=version
@@ -258,8 +250,8 @@ def patch_all(**patch_modules):
     load_common_appsec_modules()
 
 
-def patch(raise_errors=True, patch_modules_prefix=DEFAULT_MODULES_PREFIX, **patch_modules):
-    # type: (bool, str, Union[List[str], bool]) -> None
+def patch(raise_errors=True, **patch_modules):
+    # type: (bool, Union[List[str], bool]) -> None
     """Patch only a set of given modules.
 
     :param bool raise_errors: Raise error if one patch fail.
@@ -270,17 +262,22 @@ def patch(raise_errors=True, patch_modules_prefix=DEFAULT_MODULES_PREFIX, **patc
     contribs = {c: patch_indicator for c, patch_indicator in patch_modules.items() if patch_indicator}
     for contrib, patch_indicator in contribs.items():
         # Check if we have the requested contrib.
-        if not os.path.isfile(os.path.join(os.path.dirname(__file__), "contrib", contrib, "__init__.py")):
+        if not os.path.isfile(os.path.join(os.path.dirname(__file__), "contrib", "internal", contrib, "patch.py")):
             if raise_errors:
                 raise ModuleNotFoundException(
-                    "integration module ddtrace.contrib.%s does not exist, "
-                    "module will not have tracing available" % contrib
+                    "integration module ddtrace.contrib.internal.%s.patch does not exist, "
+                    "automatic instrumentation is disabled for this library" % contrib
                 )
         modules_to_patch = _MODULES_FOR_CONTRIB.get(contrib, (contrib,))
         for module in modules_to_patch:
             # Use factory to create handler to close over `module` and `raise_errors` values from this loop
             when_imported(module)(
-                _on_import_factory(contrib, raise_errors=raise_errors, patch_indicator=patch_indicator)
+                _on_import_factory(
+                    contrib,
+                    "ddtrace.contrib.internal.%s.patch",
+                    raise_errors=raise_errors,
+                    patch_indicator=patch_indicator,
+                )
             )
 
         # manually add module to patched modules

ddtrace/appsec/_iast/_patch_modules.py

@@ -19,10 +19,6 @@ def patch_iast(patch_modules=IAST_PATCH):
     from ddtrace._monkey import _on_import_factory
 
     for module in (m for m, e in patch_modules.items() if e):
-        when_imported("hashlib")(
-            _on_import_factory(module, prefix="ddtrace.appsec._iast.taint_sinks", raise_errors=False)
-        )
+        when_imported("hashlib")(_on_import_factory(module, "ddtrace.appsec._iast.taint_sinks.%s", raise_errors=False))
 
-    when_imported("json")(
-        _on_import_factory("json_tainting", prefix="ddtrace.appsec._iast._patches", raise_errors=False)
-    )
+    when_imported("json")(_on_import_factory("json_tainting", "ddtrace.appsec._iast._patches.%s", raise_errors=False))

ddtrace/contrib/cherrypy/__init__.py

@@ -54,8 +54,8 @@ def index(self):
 """
 
 
-from ddtrace.contrib.internal.cherrypy.middleware import TraceMiddleware
-from ddtrace.contrib.internal.cherrypy.middleware import get_version  # noqa: F401
+from ddtrace.contrib.internal.cherrypy.patch import TraceMiddleware
+from ddtrace.contrib.internal.cherrypy.patch import get_version  # noqa: F401
 from ddtrace.internal.utils.deprecations import DDTraceDeprecationWarning
 from ddtrace.vendor.debtcollector import deprecate
 

ddtrace/contrib/flask_cache/__init__.py

@@ -45,8 +45,8 @@ def counter():
 """
 
 
-from ddtrace.contrib.internal.flask_cache.tracers import get_traced_cache
-from ddtrace.contrib.internal.flask_cache.tracers import get_version  # noqa: F401
+from ddtrace.contrib.internal.flask_cache.patch import get_traced_cache
+from ddtrace.contrib.internal.flask_cache.patch import get_version  # noqa: F401
 from ddtrace.internal.utils.deprecations import DDTraceDeprecationWarning
 from ddtrace.vendor.debtcollector import deprecate
 

ddtrace/contrib/internal/aioredis/patch.py

@@ -12,9 +12,9 @@
 from ddtrace.constants import _SPAN_MEASURED_KEY
 from ddtrace.constants import SPAN_KIND
 from ddtrace.contrib import trace_utils
+from ddtrace.contrib.internal.redis_utils import ROW_RETURNING_COMMANDS
 from ddtrace.contrib.internal.redis_utils import _run_redis_command_async
-from ddtrace.contrib.redis_utils import ROW_RETURNING_COMMANDS
-from ddtrace.contrib.redis_utils import determine_row_count
+from ddtrace.contrib.internal.redis_utils import determine_row_count
 from ddtrace.ext import SpanKind
 from ddtrace.ext import SpanTypes
 from ddtrace.ext import db

ddtrace/contrib/internal/cassandra/patch.py

@@ -1,14 +1,2 @@
-from ddtrace.internal.utils.deprecations import DDTraceDeprecationWarning
-from ddtrace.vendor.debtcollector import deprecate
-
 from .session import patch  # noqa: F401
 from .session import unpatch  # noqa: F401
-
-
-deprecate(
-    ("%s is deprecated" % (__name__)),
-    message="Avoid using this package directly. "
-    "Use ``import ddtrace.auto`` or the ``ddtrace-run`` command to enable and configure this integration.",
-    category=DDTraceDeprecationWarning,
-    removal_version="3.0.0",
-)

ddtrace/contrib/internal/cherrypy/middleware.py renamed to ddtrace/contrib/internal/cherrypy/patch.py

@@ -10,7 +10,7 @@
 from ddtrace.contrib.internal.asgi.middleware import TraceMiddleware
 from ddtrace.contrib.internal.starlette.patch import _trace_background_tasks
 from ddtrace.contrib.internal.starlette.patch import traced_handler
-from ddtrace.contrib.starlette.patch import traced_route_init
+from ddtrace.contrib.internal.starlette.patch import traced_route_init
 from ddtrace.internal.logger import get_logger
 from ddtrace.internal.schema import schematize_service_name
 from ddtrace.internal.utils.wrappers import unwrap as _u

ddtrace/contrib/internal/fastapi/patch.py

@@ -7,9 +7,9 @@
 from ddtrace import DDTraceDeprecationWarning
 from ddtrace import config as dd_config
 from ddtrace._monkey import patch
-from ddtrace.contrib.coverage import patch as patch_coverage
 from ddtrace.contrib.internal.coverage.constants import PCT_COVERED_KEY
 from ddtrace.contrib.internal.coverage.data import _coverage_data
+from ddtrace.contrib.internal.coverage.patch import patch as patch_coverage
 from ddtrace.contrib.internal.coverage.patch import run_coverage_report
 from ddtrace.contrib.internal.coverage.utils import _is_coverage_invoked_by_coverage_run
 from ddtrace.contrib.internal.coverage.utils import _is_coverage_patched