# pylint: disable=W0613
"""
This module contains views to implement the React.
Proxy list view in the Smarter Dashboard.
"""
from django.conf import settings
from django.core.handlers.asgi import ASGIRequest
from django.shortcuts import render
from smarter.apps.proxy.models import Proxy
from smarter.lib import logging
from smarter.lib.django.shortcuts import reverse
from smarter.lib.django.views import SmarterAuthenticatedNeverCachedWebView
from smarter.lib.django.waffle import SmarterWaffleSwitches, switch_is_active
logger = logging.getSmarterLogger(__name__, any_switches=[SmarterWaffleSwitches.PROXY_LOGGING])
[docs]
class ProxyListView(SmarterAuthenticatedNeverCachedWebView):
"""
Render the proxy list view for the Smarter Workbench web console.
This view renders the React app, @smarter/proxy-list, which lists the Proxies that the user may use, in a table or as cards.
:param request: Django HTTP request object.
:type request: ASGIRequest
:param args: Additional positional arguments.
:type args: tuple
:param kwargs: Additional keyword arguments.
:type kwargs: dict
:returns: The rendered page.
:rtype: HttpResponse
"""
template_path = "react/proxy-list.html"
proxies: list[Proxy]
@property
def formatted_class_name(self) -> str:
"""Returns a formatted string of the class name for logging purposes."""
class_name = f"{__name__}.{ProxyListView.__name__}[{id(self)}]"
return self.formatted_text(class_name)
[docs]
def get(self, request: ASGIRequest, *args, **kwargs):
# pylint: disable=C0415
from smarter.apps.proxy.urls import ProxyReverseNames
context = {
"proxy_list": {
"root_id": "smarter-proxy-list-root",
"django_csrf_cookie_name": settings.CSRF_COOKIE_NAME, # this is the CSRF token cookie that should be included in the header of the POST request from the frontend.
"django_session_cookie_name": settings.SESSION_COOKIE_NAME, # this is the Django session.
"cookie_domain": settings.SESSION_COOKIE_DOMAIN,
"proxy_list_api_url": reverse(ProxyReverseNames.namespace, ProxyReverseNames.listview_api_all),
"react_debug_mode": switch_is_active(SmarterWaffleSwitches.ENABLE_REACTAPP_DEBUG_MODE),
"smarter_request_id": self.generate_smarter_request_id(),
}
}
logger.debug(
"%s.get() called for %s with args %s, kwargs %s with context %s",
self.formatted_class_name,
request,
args,
kwargs,
logging.formatted_json(context),
)
return render(request, template_name=self.template_path, context=context)