From 0d3a8ae55cf0980b9cc3270eefc3d480ee491f6a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20=C4=8Ciha=C5=99?= Date: Mon, 20 Jul 2026 20:53:32 +0200 Subject: [PATCH] feat(workspaces): add statistics and metrics Expose aggregate translation health and historical trends at workspace scope. Keep metric lookups integer-indexed and batch the management listing to avoid per-workspace queries. --- docs/changes.rst | 1 + weblate/billing/models.py | 10 ++ weblate/billing/views.py | 10 +- weblate/metrics/models.py | 62 ++++++++- weblate/metrics/tasks.py | 3 + weblate/metrics/templatetags/metrics.py | 3 + weblate/metrics/tests.py | 38 ++++++ weblate/templates/manage/workspaces.html | 43 +----- weblate/templates/snippets/info.html | 32 ++++- weblate/templates/snippets/list-objects.html | 50 +++++-- weblate/templates/workspace.html | 9 +- weblate/trans/mixins.py | 4 +- weblate/trans/models/project.py | 14 ++ weblate/trans/templatetags/translations.py | 4 + weblate/utils/stats.py | 54 +++++++- weblate/utils/tasks.py | 22 +++- weblate/wladmin/tests.py | 33 ++++- weblate/wladmin/views.py | 88 ++++++++++++- .../migrations/0004_workspace_metric_id.py | 32 +++++ weblate/workspaces/models.py | 23 +++- weblate/workspaces/tests.py | 123 +++++++++++++++++- 21 files changed, 586 insertions(+), 72 deletions(-) create mode 100644 weblate/workspaces/migrations/0004_workspace_metric_id.py diff --git a/docs/changes.rst b/docs/changes.rst index 8db367bcaee9..a041dad9096b 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -5,6 +5,7 @@ Weblate 2026.8 .. rubric:: New features +* Workspaces now provide aggregate translation statistics and historical metrics. * Added API endpoints for listing, adding, accepting, rejecting, and voting on translation suggestions. * :doc:`Translation reports ` are now generated in the background, stored for later download, available at workspace scope, and include translator work analysis. * Added :guilabel:`Use keywords exclusively` option to :ref:`addon-weblate.gettext.xgettext`, allowing projects to disable xgettext default keywords and rely only on a custom keyword. diff --git a/weblate/billing/models.py b/weblate/billing/models.py index e1f20e1bd11a..b2a28997c3f6 100644 --- a/weblate/billing/models.py +++ b/weblate/billing/models.py @@ -498,6 +498,16 @@ def _set_project_workspace( project_objects = project_objects.db_manager(database) if not project_objects.filter(pk=project.pk).update(workspace=self.workspace): raise Project.DoesNotExist + # ruff: ignore[import-outside-top-level] + from weblate.utils.tasks import update_workspace_stats + + update_workspace_stats.delay_on_commit( + [ + str(workspace_id) + for workspace_id in (previous_workspace_id, self.workspace_id) + if workspace_id is not None + ] + ) project.workspace = self.workspace project.billing_original_workspace_id = self.workspace_id self.update_workspace_name() diff --git a/weblate/billing/views.py b/weblate/billing/views.py index 377a687ee87b..e5e4475579a8 100644 --- a/weblate/billing/views.py +++ b/weblate/billing/views.py @@ -307,7 +307,15 @@ def merge(request: AuthenticatedHttpRequest, pk) -> HttpResponse: if "all" in billing.payment: other.payment.setdefault("all", []).extend(billing.payment["all"]) other.save() - billing.get_projects_queryset().update(workspace=other.workspace) + moved_projects = billing.get_projects_queryset() + projects_moved = moved_projects.update(workspace=other.workspace) + if projects_moved: + # ruff: ignore[import-outside-top-level] + from weblate.utils.tasks import update_workspace_stats + + update_workspace_stats.delay_on_commit( + [str(billing.workspace_id), str(other.workspace_id)] + ) other.update_workspace_name() merge_workspace_access(billing, other) billing.invoice_set.update(billing=other) diff --git a/weblate/metrics/models.py b/weblate/metrics/models.py index f02b83d57f5d..845a4a033802 100644 --- a/weblate/metrics/models.py +++ b/weblate/metrics/models.py @@ -37,6 +37,7 @@ ProjectLanguage, prefetch_stats, ) +from weblate.workspaces.models import Workspace if TYPE_CHECKING: from weblate.trans.models.change import ChangeQuerySet @@ -208,7 +209,8 @@ def calculate_changes( | User | Language | ProjectLanguage - | CategoryLanguage, + | CategoryLanguage + | Workspace, ): changes = cast("ChangeQuerySet", obj.change_set.all()) # type: ignore[misc] elif isinstance(obj, ComponentList): @@ -234,6 +236,8 @@ def collect_auto(self, obj): return self.collect_component(obj) if isinstance(obj, Project): return self.collect_project(obj) + if isinstance(obj, Workspace): + return self.collect_workspace(obj) if isinstance(obj, Category): return self.collect_category(obj) if isinstance(obj, ComponentList): @@ -407,6 +411,44 @@ def collect_project(self, project: Project): data, project.stats, SOURCE_KEYS, Metric.SCOPE_PROJECT, project.pk ) + @transaction.atomic + def collect_workspace(self, workspace: Workspace): + workspace_scope = MemoryScope.objects.filter( + memory_id=OuterRef("pk"), + workspace=workspace, + scope=MemoryScope.SCOPE_WORKSPACE, + ) + changes = workspace.change_set.all() + data = { + "projects": workspace.projects.count(), + "components": Component.objects.filter( + project__workspace=workspace + ).count(), + "translations": Translation.objects.filter( + component__project__workspace=workspace + ).count(), + "memory": Memory.objects.alias(has_workspace_scope=Exists(workspace_scope)) + .filter(has_workspace_scope=True) + .count(), + "screenshots": Screenshot.objects.filter( + translation__component__project__workspace=workspace + ).count(), + "changes": changes.filter_by_day( + timezone.now().date() - datetime.timedelta(days=1) + ).count(), + "contributors": changes.since_day( + timezone.now().date() - datetime.timedelta(days=30) + ).count_users(), + "contributors_total": changes.count_users(), + } + return self.create_metrics( + data, + workspace.stats, + SOURCE_KEYS, + Metric.SCOPE_WORKSPACE, + workspace.metric_id, + ) + @transaction.atomic def collect_component(self, component: Component): data = { @@ -520,6 +562,7 @@ class Metric(models.Model): SCOPE_LANGUAGE = 7 SCOPE_CATEGORY = 8 SCOPE_CATEGORY_LANGUAGE = 9 + SCOPE_WORKSPACE = 10 id = models.BigAutoField(primary_key=True) date = models.DateField(default=datetime.date.today) @@ -559,6 +602,15 @@ def create_metrics_project(sender, instance, created=False, **kwargs) -> None: ) +@receiver(post_save, sender=Workspace) +@disable_for_loaddata +def create_metrics_workspace(sender, instance, created=False, **kwargs) -> None: + if created: + Metric.objects.initialize_metrics( + scope=Metric.SCOPE_WORKSPACE, relation=instance.metric_id + ) + + @receiver(post_save, sender=Category) @disable_for_loaddata def create_metrics_category(sender, instance, created=False, **kwargs) -> None: @@ -602,6 +654,14 @@ def delete_metrics_category(sender, instance, **kwargs) -> None: ).delete() +@receiver(post_delete, sender=Workspace) +@disable_for_loaddata +def delete_metrics_workspace(sender, instance, **kwargs) -> None: + Metric.objects.filter( + scope=Metric.SCOPE_WORKSPACE, relation=instance.metric_id + ).delete() + + @receiver(post_delete, sender=Project) @disable_for_loaddata def delete_metrics_project(sender, instance, **kwargs) -> None: diff --git a/weblate/metrics/tasks.py b/weblate/metrics/tasks.py index b4ea4b27fd50..79df7797f909 100644 --- a/weblate/metrics/tasks.py +++ b/weblate/metrics/tasks.py @@ -19,6 +19,7 @@ ) from weblate.utils.celery import app from weblate.utils.stats import iter_prefetch_stats +from weblate.workspaces.models import Workspace @app.task(trail=False) @@ -26,6 +27,8 @@ def collect_metrics() -> None: Metric.objects.collect_global() for project in iter_prefetch_stats(Project.objects.all()): Metric.objects.collect_project(project) + for workspace in iter_prefetch_stats(Workspace.objects.all()): + Metric.objects.collect_workspace(workspace) for category in iter_prefetch_stats(Category.objects.all()): Metric.objects.collect_category(category) for component in iter_prefetch_stats(Component.objects.all()): diff --git a/weblate/metrics/templatetags/metrics.py b/weblate/metrics/templatetags/metrics.py index c5d8d8cfc6cb..10125eb9a418 100644 --- a/weblate/metrics/templatetags/metrics.py +++ b/weblate/metrics/templatetags/metrics.py @@ -16,6 +16,7 @@ Translation, ) from weblate.utils.stats import CategoryLanguage, ProjectLanguage +from weblate.workspaces.models import Workspace register = template.Library() @@ -30,6 +31,8 @@ def metrics(obj): return MetricsWrapper(obj, Metric.SCOPE_COMPONENT, obj.pk) if isinstance(obj, Project): return MetricsWrapper(obj, Metric.SCOPE_PROJECT, obj.pk) + if isinstance(obj, Workspace): + return MetricsWrapper(obj, Metric.SCOPE_WORKSPACE, obj.metric_id) if isinstance(obj, ComponentList): return MetricsWrapper(obj, Metric.SCOPE_COMPONENT_LIST, obj.pk) if isinstance(obj, ProjectLanguage): diff --git a/weblate/metrics/tests.py b/weblate/metrics/tests.py index df3f70bd38ce..a495aaf0094f 100644 --- a/weblate/metrics/tests.py +++ b/weblate/metrics/tests.py @@ -15,6 +15,7 @@ from weblate.trans.models import Category, ComponentLink, Project from weblate.trans.models.change import Change from weblate.trans.tests.test_views import FixtureComponentTestCase +from weblate.workspaces.models import Workspace class MetricTestCase(FixtureComponentTestCase): @@ -112,6 +113,43 @@ def test_collect_global(self) -> None: Metric.objects.collect_global() self.assertNotEqual(Metric.objects.count(), 0) + def test_collect_workspace(self) -> None: + workspace = Workspace.objects.create(name="Metrics workspace") + self.project.workspace = workspace + self.project.save(update_fields=["workspace"]) + + metric = Metric.objects.collect_workspace(workspace) + + self.assertEqual(metric.scope, Metric.SCOPE_WORKSPACE) + self.assertEqual(metric.relation, workspace.metric_id) + self.assertEqual(metric.dict_data["projects"], 1) + self.assertEqual(metric.dict_data["components"], 1) + self.assertEqual( + metric.dict_data["translations"], + self.component.translation_set.count(), + ) + self.assertEqual(metric.dict_data["all"], self.project.stats.all) + + def test_workspace_metric_lifecycle(self) -> None: + workspace = Workspace.objects.create(name="Metric lifecycle workspace") + relation = workspace.metric_id + + self.assertTrue( + Metric.objects.filter( + scope=Metric.SCOPE_WORKSPACE, + relation=relation, + ).exists() + ) + + workspace.delete() + + self.assertFalse( + Metric.objects.filter( + scope=Metric.SCOPE_WORKSPACE, + relation=relation, + ).exists() + ) + def test_wrapper_prefers_today_metric(self) -> None: today = timezone.now().date() yesterday = today - timedelta(days=1) diff --git a/weblate/templates/manage/workspaces.html b/weblate/templates/manage/workspaces.html index e5b0913fd11f..22923d162e27 100644 --- a/weblate/templates/manage/workspaces.html +++ b/weblate/templates/manage/workspaces.html @@ -1,6 +1,6 @@ {% extends "base.html" %} -{% load humanize i18n %} +{% load i18n %} {% block breadcrumbs %}
  • @@ -32,47 +32,8 @@

    {% translate "Manage workspaces" %}

    {% if search_form.q.errors %}
    {{ search_form.q.errors }}
    {% endif %} + {% include "snippets/list-objects.html" with objects=object_list label=_("Workspace") show_workspace_details=True empty_message=_("No workspaces found.") %} - - - - - - {% if billing_enabled %} - - {% endif %} - - - - {% for workspace in object_list %} - - - - {% if billing_enabled %} - - {% endif %} - - {% empty %} - - - - {% endfor %} - -
    {% translate "Name" %}{% translate "Projects" %}{% translate "Billing" %}
    - {{ workspace }} - {{ workspace.projects__count|intcomma }} - {% if workspace.billing %} - - {% if workspace.billing.customer_name %} - {{ workspace.billing.customer_name }} - {% else %} - {% blocktranslate with id=workspace.billing.pk %}Billing #{{ id }}{% endblocktranslate %} - {% endif %} - - {% else %} - {% translate "Not available" %} - {% endif %} -
    {% translate "No workspaces found." %}
    {% include "paginator.html" %}
    diff --git a/weblate/templates/snippets/info.html b/weblate/templates/snippets/info.html index 749dfa9842db..e12241794dbd 100644 --- a/weblate/templates/snippets/info.html +++ b/weblate/templates/snippets/info.html @@ -483,12 +483,40 @@

    {% translate "Quick numbers" %}

    - + {% if not workspace %} + + {% endif %}
    {{ metrics.contributors_total|number_format }}
    {% translate "Contributors" %}
    -     + {% if not workspace %}{% endif %}
    + {% if workspace %} +
    +
    +
    {{ metrics.projects|number_format }}
    +
    {% translate "Projects" %}
    +
    +
    +
    +
    +
    {{ metrics.components|number_format }}
    +
    {% translate "Components" %}
    +
    +
    +
    +
    +
    {{ metrics.languages|number_format }}
    +
    {% translate "Languages" %}
    +
    +
    +
    +
    +
    {{ metrics.translations|number_format }}
    +
    {% translate "Translations" %}
    +
    +
    + {% endif %} {% if project and not language %}
    diff --git a/weblate/templates/snippets/list-objects.html b/weblate/templates/snippets/list-objects.html index cdb6273110c9..eba55f89d39a 100644 --- a/weblate/templates/snippets/list-objects.html +++ b/weblate/templates/snippets/list-objects.html @@ -1,7 +1,7 @@ {% load humanize i18n icons permissions translations %} {% if objects or list_categories %} - 1 %} class="table progress-table autocolspan table-listing" {% else %} class="sort table progress-table autocolspan table-listing" {% endif %}> +
    {% if not hide_details and not hide_header %} @@ -45,17 +45,23 @@ + {% if show_workspace_details %} + + {% if billing_enabled %} + + {% endif %} + {% endif %} {% if show_review_columns or project and project.enable_review %} + {% if show_workspace_details %} + + {% if billing_enabled %} + + {% endif %} + {% endif %} {% if show_review_columns or project and project.enable_review %} {% if object.stats.has_review %} {% review_percent object.stats %} diff --git a/weblate/templates/workspace.html b/weblate/templates/workspace.html index d934f62425c8..510a84f2bc5e 100644 --- a/weblate/templates/workspace.html +++ b/weblate/templates/workspace.html @@ -1,6 +1,6 @@ {% extends "base.html" %} -{% load crispy_forms_tags i18n translations %} +{% load crispy_forms_tags i18n metrics translations %} {% block nav_pills %}
      @@ -19,6 +19,9 @@ href="#">{% translate "Diagnostics" %} {% endif %} +
    • + {% translate "Overview" %} +
    • {% translate "Search" %}
      • @@ -113,6 +116,10 @@ {% include "paginator.html" with page_obj=projects anchor="projects" %} +
      + {% show_info workspace=workspace stats=workspace.stats metrics=workspace|metrics show_source=True %} +
      + {% if user.is_authenticated %}

      {% translate "Loading…" %}

      diff --git a/weblate/trans/mixins.py b/weblate/trans/mixins.py index 4fb268b397a7..6f601748cdfe 100644 --- a/weblate/trans/mixins.py +++ b/weblate/trans/mixins.py @@ -18,6 +18,8 @@ from weblate.utils.files import remove_tree if TYPE_CHECKING: + from uuid import UUID + from weblate.auth.models import User from weblate.trans.models import Category, Project @@ -29,7 +31,7 @@ def user(self) -> User | None: ... class _HasOptionalId(Protocol): @property - def id(self) -> int | None: ... + def id(self) -> int | UUID | None: ... class _HasComponentCategoryAttrs(Protocol): diff --git a/weblate/trans/models/project.py b/weblate/trans/models/project.py index acb0b2430b33..275c6599ca4a 100644 --- a/weblate/trans/models/project.py +++ b/weblate/trans/models/project.py @@ -594,6 +594,9 @@ def save(self, *args, **kwargs) -> None: # ruff: ignore[import-outside-top-level] from weblate.trans.tasks import component_alerts + # ruff: ignore[import-outside-top-level] + from weblate.utils.tasks import update_workspace_stats + update_tm = self.contribute_shared_tm or self.effective_contribute_workspace_tm # Renaming detection @@ -675,6 +678,17 @@ def save(self, *args, **kwargs) -> None: old_workspace_id, update_tm, ) + if ( + should_track_field(self, "workspace", update_fields) + and old_workspace_id != self.workspace_id + ): + update_workspace_stats.delay_on_commit( + [ + str(workspace_id) + for workspace_id in (old_workspace_id, self.workspace_id) + if workspace_id is not None + ] + ) # Update translation memory on enabled sharing if update_tm: diff --git a/weblate/trans/templatetags/translations.py b/weblate/trans/templatetags/translations.py index 1e3b4215c33f..a50dd2ebf85c 100644 --- a/weblate/trans/templatetags/translations.py +++ b/weblate/trans/templatetags/translations.py @@ -1217,6 +1217,7 @@ def get_alerts( | Component | ProjectLanguage | Project + | Workspace | GhostProjectLanguageStats | GhostCategoryLanguageStats, translation: Translation | GhostTranslation | None, @@ -1296,6 +1297,7 @@ def indicate_alerts( | Component | ProjectLanguage | Project + | Workspace | GhostProjectLanguageStats | GhostCategoryLanguageStats, ) -> str: @@ -1704,6 +1706,7 @@ def list_objects_percent( def show_info( # ruff: ignore[too-many-arguments] context: Context, *, + workspace: Workspace | None = None, project: Project | None = None, component: Component | None = None, translation: Translation | None = None, @@ -1724,6 +1727,7 @@ def show_info( # ruff: ignore[too-many-arguments] """ return { "user": context["user"], + "workspace": workspace, "project": project, "component": component, "translation": translation, diff --git a/weblate/utils/stats.py b/weblate/utils/stats.py index 9ba76879b898..c8c79ed1353c 100644 --- a/weblate/utils/stats.py +++ b/weblate/utils/stats.py @@ -237,6 +237,12 @@ def stats(self): def is_loaded(self) -> bool: return self._loaded + @property + def has_cached_data(self) -> bool: + """Whether basic statistics are available in the cache.""" + self.ensure_loaded() + return "all" in self._data + def set_data(self, data: StatDict) -> None: self._loaded = True self._data = data @@ -1056,9 +1062,11 @@ def get_update_objects(self, *, full: bool = True) -> Generator[BaseStats]: yield from yield_stats(self._object.componentlist_set.only("id", "slug")) # Projects and categories this component is shared to. + linked_projects = [] for link in self._object.componentlink_set.select_related( - "project", "category__category__category" + "project__workspace", "category__category__category" ): + linked_projects.append(link.project) if link.category_id: category = link.category while category: @@ -1073,6 +1081,12 @@ def get_update_objects(self, *, full: bool = True) -> Generator[BaseStats]: category = category.category yield self._object.project.stats + # Workspaces aggregate projects, so update them after every affected + # project and before the site-wide aggregate. + for project in (*linked_projects, self._object.project): + if project.workspace_id: + yield project.workspace.stats + # Every project has to be refreshed before the shared global parent. yield GlobalStats() @@ -1553,6 +1567,11 @@ def get_child_objects(self): return (own | shared).distinct() return own + def get_update_objects(self, *, full: bool = True) -> Generator[BaseStats]: + if self._object.workspace_id: + yield self._object.workspace.stats + yield GlobalStats() + def get_single_language_stats(self, language: Language) -> ProjectLanguageStats: return ProjectLanguageStats(ProjectLanguage(self._object, language)) @@ -1567,6 +1586,37 @@ def _calculate_basic(self) -> None: self.store("languages", self._object.get_languages_count()) +class WorkspaceStats(ParentAggregatingStats): + @cached_property + def has_review(self): + if hasattr(self._object, "stats_has_review"): + return self._object.stats_has_review + return self._object.projects.filter( + Q(source_review=True) | Q(translation_review=True) + ).exists() + + def get_child_objects(self): + if "projects" in getattr(self._object, "_prefetched_objects_cache", {}): + return self._object.projects.all() + return self._object.projects.only("id", "slug") + + def _calculate_basic(self) -> None: + # ruff: ignore[import-outside-top-level] + from weblate.trans.models import Translation + + super()._calculate_basic() + if self._object.stats_languages is not None: + self.store("languages", self._object.stats_languages) + return + owned_languages = Translation.objects.filter( + component__project__workspace=self._object + ).values_list("language_id", flat=True) + shared_languages = Translation.objects.filter( + component__links__workspace=self._object + ).values_list("language_id", flat=True) + self.store("languages", owned_languages.union(shared_languages).count()) + + class ComponentListStats(ParentAggregatingStats): def get_child_objects(self): return self._object.components.only( @@ -1658,6 +1708,8 @@ def _stats_update_priority(stats: BaseStats) -> tuple[int, int]: """Return a stable child-before-parent ordering for topology updates.""" if isinstance(stats, GlobalStats): return (100, 0) + if isinstance(stats, WorkspaceStats): + return (95, 0) if isinstance(stats, ProjectStats): return (90, 0) if isinstance(stats, CategoryStats): diff --git a/weblate/utils/tasks.py b/weblate/utils/tasks.py index 386b1f1214e3..426acd196923 100644 --- a/weblate/utils/tasks.py +++ b/weblate/utils/tasks.py @@ -115,6 +115,20 @@ def update_project_stats_link(pk: int) -> None: project.stats.update_stats() +@app.task(trail=False) +def update_workspace_stats(workspace_ids: list[str]) -> None: + """Refresh workspace aggregates after projects move between workspaces.""" + # ruff: ignore[import-outside-top-level] + from weblate.utils.stats import update_stats_objects + + # ruff: ignore[import-outside-top-level] + from weblate.workspaces.models import Workspace + + update_stats_objects( + workspace.stats for workspace in Workspace.objects.filter(pk__in=workspace_ids) + ) + + @app.task(trail=False) def update_component_topology_stats( component_ids: list[int], project_ids: list[int], category_ids: list[int] @@ -140,7 +154,9 @@ def update_component_topology_stats( affected_project_ids.add(category.project_id) category = category.category - projects = list(Project.objects.filter(pk__in=affected_project_ids)) + projects = list( + Project.objects.filter(pk__in=affected_project_ids).select_related("workspace") + ) languages = Language.objects.filter( pk__in=Translation.objects.filter(component_id__in=component_ids).values_list( "language_id", flat=True @@ -158,6 +174,10 @@ def update_component_topology_stats( ) stats_objects.extend(category.stats for category in categories.values()) stats_objects.extend(project.stats for project in projects) + for project in projects: + workspace = project.workspace + if workspace is not None: + stats_objects.append(workspace.stats) stats_objects.append(GlobalStats()) update_stats_objects(stats_objects) diff --git a/weblate/wladmin/tests.py b/weblate/wladmin/tests.py index 5e7eac374af6..8f3869217c64 100644 --- a/weblate/wladmin/tests.py +++ b/weblate/wladmin/tests.py @@ -765,6 +765,34 @@ def test_workspaces(self) -> None: self.assertContains(response, workspace.name) self.assertContains(response, workspace.get_absolute_url()) self.assertContains(response, ">1<") + self.assertContains(response, "table-striped") + self.assertContains(response, "Translated") + self.assertContains(response, "Unfinished words") + + def test_workspaces_stats_sort_preserves_search(self) -> None: + workspaces = Workspace.objects.bulk_create( + [ + Workspace(name=f"Sortable localization workspace {index:02}") + for index in range(51) + ] + ) + Workspace.objects.create(name="Unrelated documentation workspace") + + response = self.client.get( + reverse("manage-workspaces"), + {"q": "localization", "sort_by": "translated"}, + ) + + self.assertEqual(len(response.context["object_list"]), 50) + self.assertEqual( + set(response.context["object_list"]), + set(workspaces[:50]), + ) + self.assertContains(response, "sort_by=-translated&q=localization") + self.assertEqual( + response.context["object_list"].paginator.sort_by, + "translated", + ) def test_alerts_are_ordered(self) -> None: zulu_project = self.create_project(name="Zulu", slug="zulu") @@ -859,7 +887,7 @@ def test_workspaces_pagination(self) -> None: self.assertTrue(response.context["is_paginated"]) self.assertEqual(len(response.context["object_list"]), 50) - def test_workspaces_avoid_billing_display_queries(self) -> None: + def test_workspaces_batch_project_stats_queries(self) -> None: # ruff: ignore[import-outside-top-level] from weblate.billing.models import Billing, Plan @@ -894,7 +922,8 @@ def test_workspaces_avoid_billing_display_queries(self) -> None: and f'WHERE "{project_table}"."workspace_id"' in query["sql"] ) ] - self.assertEqual(project_queries, []) + self.assertEqual(len(project_queries), 1) + self.assertIn('"workspace_id" IN', project_queries[0]) def test_ssh(self) -> None: response = self.client.get(reverse("manage-ssh")) diff --git a/weblate/wladmin/views.py b/weblate/wladmin/views.py index b68ff5af2599..bc6c96beb083 100644 --- a/weblate/wladmin/views.py +++ b/weblate/wladmin/views.py @@ -17,7 +17,14 @@ from django.core.exceptions import PermissionDenied from django.core.mail import send_mail from django.db import transaction -from django.db.models import Count, Max, Q +from django.db.models import ( + Count, + Exists, + Max, + OuterRef, + Prefetch, + Q, +) from django.http import Http404, HttpResponse from django.shortcuts import redirect, render from django.urls import reverse @@ -53,7 +60,14 @@ from weblate.trans.actions import ActionEvents from weblate.trans.alerts.base import AlertSeverity from weblate.trans.forms import AnnouncementForm -from weblate.trans.models import Alert, Announcement, Change, Component, Project +from weblate.trans.models import ( + Alert, + Announcement, + Change, + Component, + Project, + Translation, +) from weblate.trans.util import redirect_param from weblate.utils import messages from weblate.utils.cache import measure_cache_latency @@ -72,7 +86,7 @@ from weblate.utils.tasks import database_backup, settings_backup from weblate.utils.token import get_token from weblate.utils.version import GIT_LINK, GIT_REVISION -from weblate.utils.views import show_form_errors +from weblate.utils.views import get_paginator, show_form_errors from weblate.utils.zammad import ZammadError, submit_zammad_ticket from weblate.vcs.ssh import ( KeyType, @@ -104,6 +118,9 @@ from weblate.workspaces.models import Workspace if TYPE_CHECKING: + from collections.abc import Iterable + from uuid import UUID + from django.db.models import QuerySet from django.http.request import QueryDict from django_stubs_ext import StrOrPromise @@ -1033,15 +1050,30 @@ def form_valid(self, form: SitewideTeamForm) -> HttpResponse: @method_decorator(management_access, name="dispatch") class WorkspaceListView(ListView): template_name = "manage/workspaces.html" - paginate_by = 50 model = Workspace + request: AuthenticatedHttpRequest def setup(self, request: AuthenticatedHttpRequest, *args, **kwargs) -> None: # type: ignore[override] super().setup(request, *args, **kwargs) self.search_form = WorkspaceSearchForm(request.GET) def get_queryset(self) -> QuerySet[Workspace]: - queryset = Workspace.objects.annotate(Count("projects")).order() + review_projects = Project.objects.filter(workspace_id=OuterRef("pk")).filter( + Q(source_review=True) | Q(translation_review=True) + ) + queryset = ( + Workspace.objects.annotate( + Count("projects"), + stats_has_review=Exists(review_projects), + ) + .prefetch_related( + Prefetch( + "projects", + queryset=Project.objects.only("id", "slug", "workspace"), + ) + ) + .order() + ) billing_enabled = "weblate.billing" in settings.INSTALLED_APPS if self.search_form.is_valid() and ( query := self.search_form.cleaned_data["q"].strip() @@ -1054,8 +1086,49 @@ def get_queryset(self) -> QuerySet[Workspace]: queryset = queryset.select_related("billing") return queryset + @staticmethod + def prepare_workspace_stats(workspaces: Iterable[Workspace]) -> None: + """Batch language counts needed to initialize uncached workspace stats.""" + missing = [ + workspace for workspace in workspaces if not workspace.stats.has_cached_data + ] + if not missing: + return + + language_ids: dict[UUID, set[int]] = { + workspace.pk: set() for workspace in missing + } + workspace_ids = language_ids.keys() + owned_languages = Translation.objects.filter( + component__project__workspace_id__in=workspace_ids + ).values_list("component__project__workspace_id", "language_id") + shared_languages = Translation.objects.filter( + component__links__workspace_id__in=workspace_ids + ).values_list("component__links__workspace_id", "language_id") + for workspace_id, language_id in owned_languages.union(shared_languages): + language_ids[workspace_id].add(language_id) + for workspace in missing: + workspace.stats_languages = len(language_ids[workspace.pk]) + def get_context_data(self, **kwargs) -> dict[str, Any]: result = super().get_context_data(**kwargs) + queryset = result["object_list"] + sort_by = self.request.GET.get("sort_by") + if sort_by and sort_by.lstrip("-") != "name": + queryset = prefetch_stats(queryset) + self.prepare_workspace_stats(queryset) + workspaces = get_paginator( + self.request, + queryset, + page_limit=50, + stats=True, + sort_by=sort_by, + ) + self.prepare_workspace_stats(workspaces) + result["object_list"] = workspaces + result["page_obj"] = workspaces + result["paginator"] = workspaces.paginator + result["is_paginated"] = workspaces.paginator.num_pages > 1 search_query = "" if self.search_form.is_valid(): search_query = self.search_form.cleaned_data["q"].strip() @@ -1068,6 +1141,11 @@ def get_context_data(self, **kwargs) -> dict[str, Any]: result["search_query"] = search_query result["search_items"] = search_items result["query_string"] = urlencode(search_items) + result["show_review_columns"] = ( + Project.objects.filter(workspace__in=queryset) + .filter(Q(source_review=True) | Q(translation_review=True)) + .exists() + ) return result diff --git a/weblate/workspaces/migrations/0004_workspace_metric_id.py b/weblate/workspaces/migrations/0004_workspace_metric_id.py new file mode 100644 index 000000000000..94a8e23ff3be --- /dev/null +++ b/weblate/workspaces/migrations/0004_workspace_metric_id.py @@ -0,0 +1,32 @@ +# Copyright © Michal Čihař +# +# SPDX-License-Identifier: GPL-3.0-or-later + +from __future__ import annotations + +from django.db import migrations, models +from django.db.models.expressions import RawSQL + + +class Migration(migrations.Migration): + dependencies = [ + ("workspaces", "0003_workspace_translation_memory"), + ] + + operations = [ + migrations.RunSQL( + sql="CREATE SEQUENCE workspaces_workspace_metric_id_seq AS integer", + reverse_sql="DROP SEQUENCE workspaces_workspace_metric_id_seq", + ), + migrations.AddField( + model_name="workspace", + name="metric_id", + field=models.IntegerField( + db_default=RawSQL( + "nextval('workspaces_workspace_metric_id_seq'::regclass)", () + ), + editable=False, + unique=True, + ), + ), + ] diff --git a/weblate/workspaces/models.py b/weblate/workspaces/models.py index 2194c09976cc..44d16f226431 100644 --- a/weblate/workspaces/models.py +++ b/weblate/workspaces/models.py @@ -11,6 +11,7 @@ from django.conf import settings from django.core.exceptions import ObjectDoesNotExist from django.db import models, transaction +from django.db.models.expressions import RawSQL from django.db.models.signals import pre_delete from django.dispatch import receiver from django.urls import reverse @@ -24,6 +25,7 @@ LANGUAGE_CODE_STYLE_CHOICES, NEW_LANG_CHOICES, ) +from weblate.trans.mixins import CacheKeyMixin from weblate.trans.validators import validate_check_flags from weblate.utils.licenses import get_license_choices from weblate.utils.render import ( @@ -31,6 +33,7 @@ validate_render_commit, validate_render_component, ) +from weblate.utils.stats import WorkspaceStats if TYPE_CHECKING: from collections.abc import Collection @@ -39,6 +42,7 @@ from django.db.models.base import Deferred from weblate.auth.models import Group, User + from weblate.billing.models import Billing WORKSPACE_NAME_LENGTH = 100 @@ -60,7 +64,7 @@ def defer_huge(self) -> Self: return self.defer(*HUGE_INHERITABLE_SETTINGS) -class Workspace(models.Model): +class Workspace(models.Model, CacheKeyMixin): AUDIT_SETTINGS: ClassVar[tuple[str, ...]] = ( "name", "use_workspace_tm", @@ -78,8 +82,14 @@ class Workspace(models.Model): workspace_original_name: str | Deferred # Name management flag loaded with this instance if the field is not deferred. workspace_original_name_managed: bool | Deferred - id = models.UUIDField(primary_key=True, default=uuid4, editable=False) + metric_id = models.IntegerField( + db_default=RawSQL( + "nextval('workspaces_workspace_metric_id_seq'::regclass)", () + ), + editable=False, + unique=True, + ) name = models.CharField( verbose_name=gettext_lazy("Workspace name"), max_length=WORKSPACE_NAME_LENGTH, @@ -229,6 +239,8 @@ def __init__(self, *args, **kwargs) -> None: "name_managed", models.DEFERRED ) self.acting_user: User | None = None + self.stats_languages: int | None = None + self.stats = WorkspaceStats(self) def __str__(self) -> str: return self.name @@ -290,6 +302,13 @@ def save(self, *args, **kwargs) -> None: def get_absolute_url(self) -> str: return reverse("workspace", kwargs={"pk": self.pk}) + @property + def billing_or_none(self) -> Billing | None: + """Associated billing, or none for unbilled workspaces.""" + with suppress(AttributeError, ObjectDoesNotExist): + return self.billing + return None + def get_url_path(self) -> tuple[str, ...]: return ("-", "workspace", str(self.pk)) diff --git a/weblate/workspaces/tests.py b/weblate/workspaces/tests.py index 8e2404541c98..0324095fc961 100644 --- a/weblate/workspaces/tests.py +++ b/weblate/workspaces/tests.py @@ -4,7 +4,7 @@ from __future__ import annotations -from unittest.mock import patch +from unittest.mock import PropertyMock, patch from django.contrib.admin.sites import AdminSite from django.core.exceptions import ValidationError @@ -20,9 +20,10 @@ from weblate.lang.models import Language from weblate.memory.models import Memory, MemoryScope from weblate.trans.actions import ActionEvents -from weblate.trans.models import Change, Project +from weblate.trans.models import Change, ComponentLink, Project from weblate.trans.templatetags.translations import get_breadcrumbs from weblate.trans.tests.test_models import BaseTestCase +from weblate.trans.tests.test_views import FixtureComponentTestCase from weblate.trans.tests.utils import ( create_another_user, create_test_billing, @@ -54,6 +55,25 @@ def create_project( translation_review=translation_review, ) + def test_metric_ids_are_generated_without_replacing_uuid_primary_key(self) -> None: + first = Workspace.objects.create(name="First metric workspace") + second = Workspace.objects.create(name="Second metric workspace") + + self.assertNotEqual(first.metric_id, second.metric_id) + self.assertIsInstance(first.metric_id, int) + self.assertNotEqual(first.pk, first.metric_id) + + def test_billing_or_none_without_billing_relation(self) -> None: + workspace = Workspace.objects.create(name="Unbilled workspace") + + with patch.object( + Workspace, + "billing", + new_callable=PropertyMock, + side_effect=AttributeError, + ): + self.assertIsNone(workspace.billing_or_none) + def test_workspace_lists_accessible_projects(self) -> None: workspace = Workspace.objects.create(name="Test workspace") visible = self.create_project( @@ -747,6 +767,105 @@ def test_workspace_team_save_normalizes_languages(self) -> None: self.assertEqual(group.language_selection, SELECTION_ALL) +class WorkspaceStatsTest(FixtureComponentTestCase): + def test_workspace_stats_sum_shared_component_for_each_project(self) -> None: + workspace = Workspace.objects.create(name="Statistics workspace") + self.project.workspace = workspace + self.project.save(update_fields=["workspace"]) + shared_project = Project.objects.create( + workspace=workspace, + name="Shared statistics project", + slug="shared-statistics-project", + web="https://example.com/", + ) + ComponentLink.objects.create( + component=self.component, + project=shared_project, + ) + + self.assertEqual(workspace.stats.all, self.component.stats.all * 2) + self.assertEqual( + workspace.stats.languages, + self.component.translation_set.values("language_id").distinct().count(), + ) + + def test_component_sharing_refreshes_workspace_stats(self) -> None: + workspace = Workspace.objects.create(name="Updated statistics workspace") + self.project.workspace = workspace + self.project.save(update_fields=["workspace"]) + shared_project = Project.objects.create( + workspace=workspace, + name="Updated shared statistics project", + slug="updated-shared-statistics-project", + web="https://example.com/", + ) + self.assertEqual(workspace.stats.all, self.component.stats.all) + + with self.captureOnCommitCallbacks(execute=True): + ComponentLink.objects.create( + component=self.component, + project=shared_project, + ) + + refreshed = Workspace.objects.get(pk=workspace.pk) + self.assertEqual(refreshed.stats.all, self.component.stats.all * 2) + + def test_workspace_overview_includes_inaccessible_project_stats(self) -> None: + workspace = Workspace.objects.create(name="Overview workspace") + self.project.workspace = workspace + self.project.save(update_fields=["workspace"]) + hidden = Project.objects.create( + workspace=workspace, + name="Hidden statistics project", + slug="hidden-statistics-project", + web="https://example.com/", + access_control=Project.ACCESS_PRIVATE, + ) + ComponentLink.objects.create(component=self.component, project=hidden) + + response = self.client.get(workspace.get_absolute_url()) + + self.assertNotContains(response, hidden.name, status_code=200) + self.assertContains(response, 'data-bs-target="#information"') + self.assertContains(response, ">Overview") + self.assertContains(response, "String statistics") + self.assertEqual( + response.context["workspace"].stats.all, + self.component.stats.all * 2, + ) + + def test_workspace_tab_order_matches_project_navigation(self) -> None: + workspace = Workspace.objects.create(name="Navigation workspace") + self.project.workspace = workspace + self.project.save(update_fields=["workspace"]) + self.client.login(username="testuser", password="testpassword") + + response = self.client.get(workspace.get_absolute_url()) + + content = response.content + tab_targets = [ + content.index(f'data-bs-target="#{target}"'.encode()) + for target in ("projects", "diagnostics", "information", "search") + ] + self.assertEqual(tab_targets, sorted(tab_targets)) + + def test_project_move_schedules_workspace_stats(self) -> None: + old_workspace = Workspace.objects.create(name="Old statistics workspace") + new_workspace = Workspace.objects.create(name="New statistics workspace") + self.project.workspace = old_workspace + self.project.save(update_fields=["workspace"]) + + with patch( + "weblate.utils.tasks.update_workspace_stats.delay_on_commit" + ) as update_workspace_stats: + self.project.workspace = new_workspace + self.project.save(update_fields=["workspace"]) + + update_workspace_stats.assert_called_once_with( + [str(old_workspace.pk), str(new_workspace.pk)] + ) + + class WorkspaceAdminTest(BaseTestCase): def setUp(self) -> None: super().setUp()
    {% if objects.paginator.num_pages > 1 %} - + {% endif %} {{ label|default:_("Project") }} {% if objects.paginator.num_pages > 1 %}{% endif %} {% translate "Projects" %}{% translate "Billing" %} {% if objects.paginator.num_pages > 1 %} - + {% endif %} {% translate "Approved" %} @@ -64,7 +70,7 @@ {% endif %} {% if objects.paginator.num_pages > 1 %} - + {% endif %} {% translate "Translated" %} @@ -74,7 +80,7 @@ {% if objects.paginator.num_pages > 1 %} - + {% endif %} {% translate "Unreviewed" %} @@ -84,7 +90,7 @@ {% if objects.paginator.num_pages > 1 %} - + {% endif %} {% translate "Unfinished" %} @@ -93,7 +99,7 @@ {% if objects.paginator.num_pages > 1 %} - + {% endif %} {% translate "Unfinished words" %} @@ -102,7 +108,7 @@ {% if objects.paginator.num_pages > 1 %} - + {% endif %} {% translate "Unfinished characters" %} @@ -111,7 +117,7 @@ {% if objects.paginator.num_pages > 1 %} - + {% endif %} {% translate "Untranslated" %} @@ -120,7 +126,7 @@ {% if objects.paginator.num_pages > 1 %} - + {% endif %} {% translate "Checks" %} @@ -129,7 +135,7 @@ {% if objects.paginator.num_pages > 1 %} - + {% endif %} {% translate "Suggestions" %} @@ -138,7 +144,7 @@ {% if objects.paginator.num_pages > 1 %} - + {% endif %} {% translate "Comments" %} @@ -286,6 +292,26 @@ {% translate "Customized workflow" %} {% endif %} {{ object.projects__count|intcomma }} + {% with workspace_billing=object.billing_or_none %} + {% if workspace_billing %} + + {% if workspace_billing.customer_name %} + {{ workspace_billing.customer_name }} + {% else %} + {% blocktranslate with id=workspace_billing.pk %}Billing #{{ id }}{% endblocktranslate %} + {% endif %} + + {% else %} + {% translate "Not available" %} + {% endif %} + {% endwith %} +