1
0
Fork 0
mirror of https://github.com/retspen/webvirtcloud synced 2026-11-08 19:26:48 +00:00
webvirtcloud/operations/api/serializers.py
catborise 1e66367bb4 feat(operations): a job's error and warning show in the reader's language
A job stored its error and its result's warning as English text, much
of it built with the values in it (volume paths, a disk, libvirt's
error), so no catalog could translate it, and the job pages and panel
showed English whatever the language.

A job now stores them as messages: our English text, marked for
translation, and its values; libvirt's own text is a message without
values and is shown as it is. The jobs API and pages put them in the
reader's language. OperationError keeps its text and values apart for
the same reason, so a refusal raised while a job is submitted is shown
translated too. Messages one after another still read as sentences.

Errors stored before are kept as one message each, shown as they were.
2026-11-02 23:49:45 +03:00

72 lines
2.8 KiB
Python

from datetime import timedelta
from django.utils import timezone
from django.utils.translation import gettext as _
from rest_framework import serializers
from operations.jobs import KINDS, label_of
from operations.models import Operation
from operations.utils import shown_label, words
class OperationSerializer(serializers.ModelSerializer):
label = serializers.SerializerMethodField()
phase = serializers.SerializerMethodField()
error = serializers.SerializerMethodField()
result = serializers.SerializerMethodField()
resource_label = serializers.SerializerMethodField()
cancellable = serializers.SerializerMethodField()
in_request = serializers.SerializerMethodField()
class Meta:
model = Operation
fields = ["id", "kind", "label", "username", "resource", "resource_label", "state", "phase",
"progress_done", "progress_total", "result", "error", "created_at", "started_at",
"finished_at", "cancel_requested", "cancellable", "in_request", "resolution", "resolution_note"]
read_only_fields = fields
def get_label(self, op) -> str:
return str(_(label_of(op.kind)))
def get_phase(self, op) -> str:
"""The phase in the viewer's language; a job running past its time
limit says so (one that can be cancelled is cancelled instead)."""
phase = _(op.phase) if op.phase else ""
if op.state == Operation.RUNNING and op.time_limit and op.started_at \
and timezone.now() - op.started_at > timedelta(seconds=op.time_limit):
return (_("%(phase)s (over its time limit)") % {"phase": phase}).strip()
return phase
def get_error(self, op) -> str:
return words(op.error)
def get_result(self, op) -> dict:
"""What the job made; its warning in the viewer's language."""
if op.result.get("warning"):
return {**op.result, "warning": words(op.result["warning"])}
return op.result
def get_resource_label(self, op) -> str:
return shown_label(op, self.context["request"].user)
def get_cancellable(self, op) -> bool:
kind = KINDS.get(op.kind)
return op.state == Operation.QUEUED or bool(kind and kind.cancellable and op.state == Operation.RUNNING)
def get_in_request(self, op) -> bool:
"""A request runs it: it does not wait for the worker."""
return op.in_request
class OperationSummarySerializer(serializers.Serializer):
kind = serializers.CharField()
label = serializers.CharField()
state = serializers.CharField()
since = serializers.DateTimeField()
class ResourceJobsSerializer(serializers.Serializer):
jobs = OperationSerializer(many=True)
others = OperationSummarySerializer(many=True)
short_operation = serializers.BooleanField()
worker_last_seen = serializers.DateTimeField(allow_null=True)