diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 1ad4c890..a7f2de7b 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -11,6 +11,16 @@ Change Log .. There should always be an "Unreleased" section for changes pending release. +Unreleased +---------- + + +7.2.0 - 2025-02-26 +------------------ +Removed +~~~~~~~ +* Removed deprecated monitoring middleware Classes + 7.1.0 - 2024-12-05 ------------------ Added diff --git a/edx_django_utils/__init__.py b/edx_django_utils/__init__.py index a2e76089..536a76ff 100644 --- a/edx_django_utils/__init__.py +++ b/edx_django_utils/__init__.py @@ -2,7 +2,7 @@ EdX utilities for Django Application development.. """ -__version__ = "7.1.0" +__version__ = "7.2.0" default_app_config = ( "edx_django_utils.apps.EdxDjangoUtilsConfig" diff --git a/edx_django_utils/monitoring/middleware.py b/edx_django_utils/monitoring/middleware.py deleted file mode 100644 index 1c9a8138..00000000 --- a/edx_django_utils/monitoring/middleware.py +++ /dev/null @@ -1,48 +0,0 @@ -""" -Deprecated Middleware for backward-compatibility. - -IMPORTANT: No new classes should be added to this file. -TODO: Remove this file once these classes are no longer used. - -""" -import warnings - -from .internal.middleware import CachedCustomMonitoringMiddleware as InternalCachedCustomMonitoringMiddleware -from .internal.middleware import MonitoringMemoryMiddleware as InternalMonitoringMemoryMiddleware -from .internal.utils import set_custom_attribute - - -class CachedCustomMonitoringMiddleware(InternalCachedCustomMonitoringMiddleware): - """ - Deprecated class for handling middleware. Class has been moved to public API. - """ - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - msg = "Use 'edx_django_utils.monitoring.CachedCustomMonitoringMiddleware' in place of " \ - "'edx_django_utils.monitoring.middleware.CachedCustomMonitoringMiddleware'." - warnings.warn(msg, DeprecationWarning) - set_custom_attribute('deprecated_monitoring_middleware', 'CachedCustomMonitoringMiddleware') - - -class MonitoringCustomMetricsMiddleware(InternalCachedCustomMonitoringMiddleware): - """ - Deprecated class for handling middleware. Class has been renamed to CachedCustomMonitoringMiddleware. - """ - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - msg = "Use 'edx_django_utils.monitoring.CachedCustomMonitoringMiddleware' in place of " \ - "'edx_django_utils.monitoring.middleware.MonitoringCustomMetricsMiddleware'." - warnings.warn(msg, DeprecationWarning) - set_custom_attribute('deprecated_monitoring_middleware', 'MonitoringCustomMetricsMiddleware') - - -class MonitoringMemoryMiddleware(InternalMonitoringMemoryMiddleware): - """ - Deprecated class for handling middleware. Class has been moved to public API. - """ - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - msg = "Use 'edx_django_utils.monitoring.MonitoringMemoryMiddleware' in place of " \ - "'edx_django_utils.monitoring.middleware.MonitoringMemoryMiddleware'." - warnings.warn(msg, DeprecationWarning) - set_custom_attribute('deprecated_monitoring_middleware', 'MonitoringMemoryMiddleware') diff --git a/edx_django_utils/monitoring/tests/test_monitoring_support.py b/edx_django_utils/monitoring/tests/test_monitoring_support.py index 4de61344..41a6f5eb 100644 --- a/edx_django_utils/monitoring/tests/test_monitoring_support.py +++ b/edx_django_utils/monitoring/tests/test_monitoring_support.py @@ -10,15 +10,18 @@ from django.test import TestCase, override_settings from edx_django_utils.cache import RequestCache -from edx_django_utils.monitoring import MonitoringSupportMiddleware, accumulate, increment +from edx_django_utils.monitoring import ( + CachedCustomMonitoringMiddleware, + MonitoringSupportMiddleware, + accumulate, + increment +) from edx_django_utils.monitoring.signals import ( monitoring_support_process_exception, monitoring_support_process_request, monitoring_support_process_response ) -from ..middleware import CachedCustomMonitoringMiddleware as DeprecatedCachedCustomMonitoringMiddleware -from ..middleware import MonitoringCustomMetricsMiddleware as DeprecatedMonitoringCustomMetricsMiddleware from ..utils import accumulate as deprecated_accumulate from ..utils import increment as deprecated_increment from ..utils import set_custom_attribute as deprecated_set_custom_attribute @@ -39,8 +42,7 @@ def setUp(self): @ddt.data( (MonitoringSupportMiddleware, False, 'process_response'), (MonitoringSupportMiddleware, False, 'process_exception'), - (DeprecatedCachedCustomMonitoringMiddleware, True, 'process_response'), - (DeprecatedMonitoringCustomMetricsMiddleware, True, 'process_response'), + (CachedCustomMonitoringMiddleware, False, 'process_response'), ) @ddt.unpack def test_accumulate_and_increment( @@ -83,8 +85,7 @@ def test_accumulate_and_increment( @patch('newrelic.agent') @ddt.data( (MonitoringSupportMiddleware, False), - (DeprecatedCachedCustomMonitoringMiddleware, True), - (DeprecatedMonitoringCustomMetricsMiddleware, True), + (CachedCustomMonitoringMiddleware, False), ) @ddt.unpack def test_accumulate_with_illegal_value(