django-spire 0.23.4__py3-none-any.whl

django_spire/profiling/panel.py

@@ -0,0 +1,345 @@
+from __future__ import annotations
+
+import os
+import time
+
+from dataclasses import asdict, dataclass
+from datetime import datetime
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+from debug_toolbar.panels import Panel
+from django.conf import settings
+from django.http import Http404, HttpRequest, HttpResponse, JsonResponse
+from django.urls import re_path
+from django.utils import timezone
+from django.views.decorators.csrf import csrf_exempt
+
+from django_spire.profiling import lock
+
+if TYPE_CHECKING:
+    from typing import Any
+
+
+@dataclass
+class Profile:
+    filename: str
+    path: str
+    method: str
+    duration: str
+    profile_id: str
+    size: str
+    modified: str
+    timestamp: float
+
+
+@dataclass
+class ProfileStats:
+    profiles: list[Profile]
+    count: int
+    directory: str
+    total_size: str
+    enabled: bool
+
+
+@dataclass
+class ProfileList:
+    profiles: list[dict[str, Any]]
+    count: int
+    total_size: str
+
+
+class ProfilingPanel(Panel):
+    nav_title = 'Profiles'
+    template = 'panel.html'
+    title = 'Profiling'
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        self.directory = self._get_directory()
+
+    def _format_size(self, size: int) -> str:
+        for unit in ['B', 'KB', 'MB', 'GB']:
+            if size < 1024.0:
+                return f'{size:.1f} {unit}'
+
+            size /= 1024.0
+
+        return f'{size:.1f} TB'
+
+    def _get_directory(self) -> Path:
+        location = os.getenv('PROFILING_DIR', '.profile')
+
+        if isinstance(location, str):
+            if not Path(location).is_absolute():
+                current = Path.cwd()
+                base = getattr(settings, 'BASE_DIR', current)
+                location = Path(base) / location
+            else:
+                location = Path(location)
+
+        return Path(location)
+
+    def _get_files(self) -> list[Profile]:
+        profiles = []
+
+        if not self.directory.exists():
+            return profiles
+
+        with lock:
+            files = self._list_files()
+
+            for file in files:
+                if not file.exists():
+                    continue
+
+                profile = self._parse_file(file)
+
+                if profile:
+                    profiles.append(profile)
+
+        return profiles
+
+    def _get_size(self) -> int:
+        total = 0
+
+        if self.directory.exists():
+            with lock:
+                for file in self.directory.glob('*.html'):
+                    if file.exists():
+                        total = total + file.stat().st_size
+
+        return total
+
+    def _list_files(self) -> list[Path]:
+        files = [
+            file for file in self.directory.glob('*.html')
+            if file.exists()
+        ]
+
+        files.sort(
+            key=lambda p: p.stat().st_mtime if p.exists() else 0,
+            reverse=True
+        )
+
+        return files
+
+    def _parse_file(self, file: Path) -> Profile | None:
+        stat = file.stat()
+        parts = file.stem.split('_')
+
+        timestamp, method, path_part, duration, profile_id = self._parse_filename(
+            parts,
+            stat
+        )
+
+        display = self._parse_path(path_part)
+
+        mst = timezone.get_fixed_timezone(-360)
+        modified = datetime.fromtimestamp(timestamp, tz=mst)
+
+        return Profile(
+            filename=file.name,
+            path=display,
+            method=method,
+            duration=duration,
+            profile_id=profile_id,
+            size=self._format_size(stat.st_size),
+            modified=modified.strftime('%b %d, %Y %I:%M %p MST'),
+            timestamp=timestamp
+        )
+
+    def _parse_filename(self, parts: list[str], stat: Any) -> tuple[float, str, str, str, str]:
+        if len(parts) >= 4:
+            timestamp = int(parts[0]) / 1000
+            method = parts[1]
+            path_part = '_'.join(parts[2:-2])
+            duration = parts[-2] if len(parts) > 3 else 'N/A'
+            profile_id = parts[-1] if len(parts) > 4 else 'N/A'
+        else:
+            timestamp = stat.st_mtime
+            method = 'Unknown'
+            path_part = '_'.join(parts)
+            duration = 'N/A'
+            profile_id = 'N/A'
+
+        return timestamp, method, path_part, duration, profile_id
+
+    def _parse_path(self, path_part: str) -> str:
+        if path_part == 'root':
+            return '/'
+
+        display = path_part.replace('_', '/')
+
+        if not display.startswith('/'):
+            display = '/' + display
+
+        return display
+
+    def _resolve_location(self) -> Path:
+        location = os.getenv('PROFILING_DIR', '.profile')
+
+        if not Path(location).is_absolute():
+            base = getattr(settings, 'BASE_DIR', Path.cwd())
+            location = Path(base) / location
+        else:
+            location = Path(location)
+
+        return location
+
+    def _try_delete(self, filepath: Path) -> JsonResponse | None:
+        for i in range(3):
+            try:
+                filepath.unlink()
+            except FileNotFoundError:
+                return JsonResponse({'success': True, 'is_deleted': True})
+            except PermissionError:
+                if i < 2:
+                    time.sleep(0.1)
+                    continue
+
+                return JsonResponse(
+                    {'error': 'File is in use, try again'},
+                    status=409
+                )
+            except Exception as e:
+                return JsonResponse({'error': str(e)}, status=500)
+            else:
+                return JsonResponse({'success': True})
+
+        return None
+
+    def _validate_filename(self, filename: str) -> str | None:
+        if '..' in filename or '/' in filename or '\\' in filename:
+            return 'Invalid filename'
+
+        if not filename.endswith('.html'):
+            return 'Only HTML files are allowed'
+
+        return None
+
+    def _validate_filepath(self, filepath: Path, location: Path) -> str | None:
+        if not filepath.is_file():
+            return 'Not a file'
+
+        try:
+            filepath.resolve().relative_to(location.resolve())
+        except ValueError:
+            return 'Invalid file path'
+
+        return None
+
+    @classmethod
+    def delete_file(cls, request: HttpRequest, filename: str) -> JsonResponse:
+        panel = cls(None, None)
+        error = panel._validate_filename(filename)
+
+        if error:
+            return JsonResponse({'error': error}, status=400)
+
+        location = panel._resolve_location()
+        filepath = location / filename
+
+        with lock:
+            if not filepath.exists():
+                return JsonResponse({'success': True, 'is_deleted': True})
+
+            error = panel._validate_filepath(filepath, location)
+
+            if error:
+                return JsonResponse({'error': error}, status=400)
+
+            result = panel._try_delete(filepath)
+
+            if result:
+                return result
+
+        return JsonResponse({'error': 'Could not delete file'}, status=500)
+
+    def generate_stats(self, request: HttpRequest, response: HttpResponse) -> None:
+        profiles = self._get_files()
+        profiling = os.getenv('PROFILING_ENABLED', 'False') == 'True'
+
+        stats = ProfileStats(
+            profiles=[asdict(profile) for profile in profiles],
+            count=len(profiles),
+            directory=str(self.directory),
+            total_size=self._format_size(self._get_size()),
+            enabled=profiling
+        )
+
+        self.record_stats(asdict(stats))
+
+    @classmethod
+    def get_urls(cls) -> list:
+        return [
+            re_path(
+                r'^profiling/view/(?P<filename>[^/]+)/$',
+                cls.serve_file,
+                name='profiling_view'
+            ),
+            re_path(
+                r'^profiling/delete/(?P<filename>[^/]+)/$',
+                csrf_exempt(cls.delete_file),
+                name='profiling_delete'
+            ),
+            re_path(
+                r'^profiling/list/$',
+                cls.list_files,
+                name='profiling_list'
+            ),
+        ]
+
+    @classmethod
+    def list_files(cls, request: HttpRequest) -> JsonResponse:
+        panel = cls(None, None)
+        panel.directory = panel._resolve_location()
+        profiles = panel._get_files()
+
+        response = ProfileList(
+            profiles=[asdict(profile) for profile in profiles],
+            count=len(profiles),
+            total_size=panel._format_size(panel._get_size())
+        )
+
+        return JsonResponse(asdict(response))
+
+    @property
+    def nav_subtitle(self) -> str:
+        count = 0
+
+        if self.directory.exists():
+            with lock:
+                count = sum(
+                    1 for f in self.directory.glob('*.html')
+                    if f.exists()
+                )
+
+        return f'{count} profiles'
+
+    @classmethod
+    def serve_file(cls, request: HttpRequest, filename: str) -> HttpResponse:
+        panel = cls(None, None)
+        error = panel._validate_filename(filename)
+
+        if error:
+            raise Http404(error)
+
+        location = panel._resolve_location()
+        filepath = location / filename
+
+        with lock:
+            if not filepath.exists():
+                message = 'Profile has been removed'
+                raise Http404(message)
+
+            error = panel._validate_filepath(filepath, location)
+
+            if error:
+                raise Http404(error)
+
+            with open(filepath, 'r', encoding='utf-8') as handle:
+                content = handle.read()
+
+        return HttpResponse(content, content_type='text/html')

django_spire/profiling/templates/panel.html

@@ -0,0 +1,166 @@
+{% load i18n %}
+
+<style>
+    .djdt-profiling-panel {
+        padding: 10px;
+    }
+
+    .djdt-profiling-stats {
+        display: flex;
+        gap: 30px;
+        margin-bottom: 30px;
+        align-items: center;
+        padding-bottom: 20px;
+        border-bottom: 1px solid #e0e0e0;
+    }
+
+    .djdt-profiling-stat {
+        display: flex;
+        align-items: center;
+        gap: 10px;
+    }
+
+    .djdt-profiling-stat-label {
+        opacity: 0.7;
+    }
+
+    .djdt-profiling-stat-value {
+        font-weight: bold;
+    }
+
+    .djdt-profiling-table {
+        width: 100%;
+        border-collapse: collapse;
+        font-size: 0.9em;
+    }
+
+    .djdt-profiling-table th {
+        padding: 8px;
+        text-align: left;
+        font-weight: bold;
+    }
+
+    .djdt-profiling-table td {
+        padding: 8px;
+    }
+
+    .djdt-profile-link {
+        text-decoration: none;
+        font-weight: bold;
+    }
+
+    .djdt-profile-link:hover {
+        text-decoration: underline;
+    }
+
+    .djdt-profile-delete {
+        text-decoration: none;
+        font-weight: bold;
+    }
+
+    .djdt-profile-delete:hover {
+        text-decoration: underline;
+    }
+
+    .djdt-no-profiles {
+        padding: 20px;
+        text-align: center;
+        font-style: italic;
+    }
+
+    .djdt-circular-buffer-note {
+        padding: 8px;
+        border-radius: 3px;
+        margin-bottom: 10px;
+        font-size: 3.85em;
+    }
+</style>
+
+<div class="djdt-profiling-panel">
+    <div class="djdt-profiling-stats">
+        <div class="djdt-profiling-stat">
+            <div class="djdt-profiling-stat-label">Status:</div>
+            <div class="djdt-profiling-stat-value">
+                {% if enabled %}Enabled{% else %}Disabled{% endif %}
+            </div>
+        </div>
+
+        <div class="djdt-profiling-stat">
+            <div class="djdt-profiling-stat-label">Profiles:</div>
+            <div class="djdt-profiling-stat-value" id="profile-count">{{ count }}</div>
+        </div>
+
+        <div class="djdt-profiling-stat">
+            <div class="djdt-profiling-stat-label">Size:</div>
+            <div class="djdt-profiling-stat-value" id="total-size">{{ total_size }}</div>
+        </div>
+
+        <div class="djdt-profiling-stat">
+            <div class="djdt-profiling-stat-label">Directory:</div>
+            <div class="djdt-profiling-stat-value">{{ directory }}</div>
+        </div>
+
+        <div class="djdt-profiling-stat" style="margin-left: auto;">
+            <a href="#" onclick="if(confirm('Delete all profiles?')){let rows=document.querySelectorAll('#profiling-tbody tr');let promises=[];rows.forEach(row=>{let filename=row.dataset.filename;if(filename)promises.push(fetch('/__debug__/profiling/delete/'+filename+'/').then(r=>r.json()).catch(e=>({error:e.toString()})));});Promise.all(promises).then(results=>{let success_count=0;let is_deleted=0;let failures=0;results.forEach(r=>{if(r.success)success_count++;else if(r.is_deleted)is_deleted++;else failures++;});document.getElementById('profiling-tbody').innerHTML='';document.getElementById('profiling-table').outerHTML='<div class=djdt-no-profiles>No profiles found</div>';document.getElementById('profile-count').textContent='0';document.getElementById('total-size').textContent='0 B';let panels=document.querySelectorAll('.djDebugPanelButton');panels.forEach(p=>{if(p.textContent.includes('Profiles')){let small=p.querySelector('small');if(small)small.textContent='0 profiles';}});if(failures>0){alert('Deleted '+success_count+' profiles. '+failures+' failed (may have been removed by circular buffer).');}}).catch(e=>alert('Error during bulk delete: '+e));}return false;" style="color: #d32f2f; font-weight: bold; text-decoration: none;">
+                Delete All
+            </a>
+        </div>
+    </div>
+
+    <br>
+
+    <div class="djdt-circular-buffer-note">
+        <strong>Note:</strong> The ten most recent profiles are kept, and the remainder are removed.
+    </div>
+
+    <br>
+
+    {% if not enabled %}
+        <div style="padding: 10px; margin-bottom: 15px; font-size: 0.9em; opacity: 0.7;">
+            Set PROFILING_ENABLED=True to enable profiling
+        </div>
+    {% endif %}
+
+    {% if profiles %}
+        <table class="djdt-profiling-table" id="profiling-table">
+            <thead>
+                <tr>
+                    <th>Method</th>
+                    <th>Path</th>
+                    <th>Duration</th>
+                    <th>Time</th>
+                    <th>Size</th>
+                    <th>View</th>
+                    <th>Delete</th>
+                </tr>
+            </thead>
+            <tbody id="profiling-tbody">
+                {% for profile in profiles %}
+                <tr data-filename="{{ profile.filename }}">
+                    <td>
+                        <span>{{ profile.method }}</span>
+                    </td>
+                    <td>{{ profile.path }}</td>
+                    <td>{{ profile.duration }}</td>
+                    <td>{{ profile.modified }}</td>
+                    <td>{{ profile.size }}</td>
+                    <td>
+                        <a href="{% url 'djdt:profiling_view' profile.filename %}" target="_blank" class="djdt-profile-link">
+                            View
+                        </a>
+                    </td>
+                    <td>
+                        <a href="#" onclick="if(confirm('Delete this profile?')){fetch('/__debug__/profiling/delete/{{ profile.filename }}/').then(r=>r.json()).then(d=>{if(d.success||d.is_deleted){let row=this.closest('tr');row.remove();let count=document.querySelectorAll('#profiling-tbody tr').length;document.getElementById('profile-count').textContent=count;fetch('/__debug__/profiling/list/').then(r=>r.json()).then(data=>{document.getElementById('total-size').textContent=data.total_size;});let panels=document.querySelectorAll('.djDebugPanelButton');panels.forEach(p=>{if(p.textContent.includes('Profiles')){let small=p.querySelector('small');if(small)small.textContent=count+' profiles';}});if(count===0){document.getElementById('profiling-table').outerHTML='<div class=djdt-no-profiles>No profiles found</div>';}if(d.is_deleted){alert('Profile was already removed (circular buffer)');}}else if(d.error){alert('Failed to delete: '+d.error);}}).catch(e=>{console.error('Delete error:',e);alert('Network error while deleting');});}return false;" class="djdt-profile-delete">
+                            Delete
+                        </a>
+                    </td>
+                </tr>
+                {% endfor %}
+            </tbody>
+        </table>
+    {% else %}
+        <div class="djdt-no-profiles">
+            No profiles found in {{ directory }}
+        </div>
+    {% endif %}
+</div>

django_spire/settings.py

@@ -0,0 +1,25 @@
+DJANGO_SPIRE_AUTH_CONTROLLERS = {
+    'ai_chat': 'django_spire.ai.chat.auth.controller.BaseAiChatAuthController',
+    'help_desk': 'django_spire.help_desk.auth.controller.BaseHelpDeskAuthController',
+    'knowledge': 'django_spire.knowledge.auth.controller.BaseKnowledgeAuthController',
+}
+
+# AI Settings
+DJANGO_SPIRE_AI_PERSONA_NAME = 'AI Assistant'
+DJANGO_SPIRE_AI_DEFAULT_CHAT_ROUTER = 'SPIRE'
+
+DJANGO_SPIRE_AI_CHAT_ROUTERS = {
+    'SPIRE': 'django_spire.ai.chat.router.SpireChatRouter',
+}
+
+DJANGO_SPIRE_AI_INTENT_CHAT_ROUTERS = {
+    'KNOWLEDGE_SEARCH': {
+        'INTENT_DESCRIPTION': 'The user is asking about information, help or support that could be found in knowledge base.',
+        'REQUIRED_PERMISSION': 'django_spire_knowledge.view_collection',
+        'CHAT_ROUTER': 'django_spire.knowledge.intelligence.router.KnowledgeSearchRouter',
+    },
+}
+
+# Theme Settings
+DJANGO_SPIRE_DEFAULT_THEME = 'default-light'
+DJANGO_SPIRE_THEME_PATH = '/static/django_spire/css/themes/{family}/app-{mode}.css'

django_spire/testing/playwright/__init__.py

@@ -0,0 +1,64 @@
+from django_spire.testing.playwright.components import (
+    Accordion,
+    AttributeElement,
+    AttributeList,
+    Breadcrumb,
+    Card,
+    DeleteModal,
+    Dropdown,
+    EllipsisDropdown,
+    EllipsisModalDropdown,
+    EllipsisTableDropdown,
+    FilterForm,
+    FormCard,
+    FormModal,
+    InfiniteScroll,
+    InfiniteScrollCard,
+    InfiniteScrollList,
+    InfiniteScrollTable,
+    LazyTab,
+    Modal,
+    NavAccordion,
+    NotificationBell,
+    SideNavigation,
+    ThemeSelector,
+    TitleCard,
+    TitleModal,
+    Toast,
+    TopNavigation,
+    UserMenu,
+)
+from django_spire.testing.playwright.pages import BasePage
+
+
+__all__ = [
+    'Accordion',
+    'AttributeElement',
+    'AttributeList',
+    'BasePage',
+    'Breadcrumb',
+    'Card',
+    'DeleteModal',
+    'Dropdown',
+    'EllipsisDropdown',
+    'EllipsisModalDropdown',
+    'EllipsisTableDropdown',
+    'FilterForm',
+    'FormCard',
+    'FormModal',
+    'InfiniteScroll',
+    'InfiniteScrollCard',
+    'InfiniteScrollList',
+    'InfiniteScrollTable',
+    'LazyTab',
+    'Modal',
+    'NavAccordion',
+    'NotificationBell',
+    'SideNavigation',
+    'ThemeSelector',
+    'TitleCard',
+    'TitleModal',
+    'Toast',
+    'TopNavigation',
+    'UserMenu',
+]

django_spire/testing/playwright/components/__init__.py

@@ -0,0 +1,45 @@
+from django_spire.testing.playwright.components.accordion import Accordion, NavAccordion
+from django_spire.testing.playwright.components.attribute_element import AttributeElement, AttributeList
+from django_spire.testing.playwright.components.base_session_filter_form import FilterForm
+from django_spire.testing.playwright.components.breadcrumb_element import Breadcrumb
+from django_spire.testing.playwright.components.card import Card, FormCard, InfiniteScrollCard, TitleCard
+from django_spire.testing.playwright.components.dropdown import Dropdown, EllipsisDropdown, EllipsisModalDropdown, EllipsisTableDropdown
+from django_spire.testing.playwright.components.infinite_scroll import InfiniteScroll, InfiniteScrollList, InfiniteScrollTable
+from django_spire.testing.playwright.components.lazy_tab import LazyTab
+from django_spire.testing.playwright.components.modal import DeleteModal, FormModal, Modal, TitleModal
+from django_spire.testing.playwright.components.navigation import SideNavigation, TopNavigation, UserMenu
+from django_spire.testing.playwright.components.notification_bell import NotificationBell
+from django_spire.testing.playwright.components.theme_selector import ThemeSelector
+from django_spire.testing.playwright.components.toast import Toast
+
+
+__all__ = [
+    'Accordion',
+    'AttributeElement',
+    'AttributeList',
+    'Breadcrumb',
+    'Card',
+    'DeleteModal',
+    'Dropdown',
+    'EllipsisDropdown',
+    'EllipsisModalDropdown',
+    'EllipsisTableDropdown',
+    'FilterForm',
+    'FormCard',
+    'FormModal',
+    'InfiniteScroll',
+    'InfiniteScrollCard',
+    'InfiniteScrollList',
+    'InfiniteScrollTable',
+    'LazyTab',
+    'Modal',
+    'NavAccordion',
+    'NotificationBell',
+    'SideNavigation',
+    'ThemeSelector',
+    'TitleCard',
+    'TitleModal',
+    'Toast',
+    'TopNavigation',
+    'UserMenu',
+]