|
| 1 | +"""``JobAdmin`` — the custom-form fixture that proves the legacy-iframe escape. |
| 2 | +
|
| 3 | +This admin uses *only* documented Django ``ModelAdmin`` hooks — no |
| 4 | +django-admin-react / -rest-api / -mcp-specific API. The point: if this runs |
| 5 | +on the React admin at ``/admin-react/`` with at most a single-view iframe |
| 6 | +fallback, then any legacy ``/admin/`` ModelAdmin does too. |
| 7 | +
|
| 8 | +Two rendering paths: |
| 9 | +
|
| 10 | +* **Path A** — ``/admin-react/jobs/job/<pk>/change/`` (no query). The stock |
| 11 | + change form, fully describable by the form-spec contract. |
| 12 | + ``formfield_for_dbfield`` swaps ``metadata`` to a large textarea, which |
| 13 | + the SPA renders natively from ``widget.kind == "textarea"``. |
| 14 | +* **Path B** — ``?run_custom=1``. ``change_view`` returns a hand-rolled |
| 15 | + dual-listbox template (not a ModelForm, not fieldsets). The form-spec |
| 16 | + resolver detects the custom render and returns |
| 17 | + ``{renderer: "legacy-iframe", legacy_url: …}``; the SPA embeds the legacy |
| 18 | + page in an iframe inside its own chrome. |
| 19 | +""" |
| 20 | + |
| 21 | +from __future__ import annotations |
| 22 | + |
| 23 | +from django.contrib import admin |
| 24 | +from django.contrib import messages |
| 25 | +from django.http import HttpResponseRedirect |
| 26 | +from django.shortcuts import redirect |
| 27 | +from django.shortcuts import render |
| 28 | +from django.urls import reverse |
| 29 | + |
| 30 | +from examples.jobs.models import Job |
| 31 | + |
| 32 | + |
| 33 | +def get_step_registry() -> list[dict]: |
| 34 | + """The catalogue of pipeline steps a Job can run (plain demo data).""" |
| 35 | + return [ |
| 36 | + {"name": "fetch", "label": "Fetch inputs", "default_order": 1, "is_default": True}, |
| 37 | + {"name": "validate", "label": "Validate", "default_order": 2, "is_default": True}, |
| 38 | + {"name": "transform", "label": "Transform", "default_order": 3, "is_default": True}, |
| 39 | + {"name": "dry_run", "label": "Dry run", "default_order": 4, "is_default": False}, |
| 40 | + {"name": "notify", "label": "Notify stakeholders", "default_order": 5, "is_default": False}, |
| 41 | + {"name": "archive", "label": "Archive outputs", "default_order": 6, "is_default": False}, |
| 42 | + ] |
| 43 | + |
| 44 | + |
| 45 | +@admin.register(Job) |
| 46 | +class JobAdmin(admin.ModelAdmin): |
| 47 | + list_display = ("name", "status") |
| 48 | + actions = ["run_with_custom_steps"] |
| 49 | + |
| 50 | + # 1) request-aware widget override on a single DB field (Path A). |
| 51 | + def formfield_for_dbfield(self, db_field, request, **kwargs): # noqa: ANN001 |
| 52 | + if db_field.name == "metadata": |
| 53 | + kwargs["widget"] = admin.widgets.AdminTextareaWidget(attrs={"class": "vLargeTextField"}) |
| 54 | + return super().formfield_for_dbfield(db_field, request, **kwargs) |
| 55 | + |
| 56 | + # 2) action that redirects to the ?run_custom=1 variant of the change page. |
| 57 | + @admin.action(description="Run (Custom)") |
| 58 | + def run_with_custom_steps(self, request, queryset): # noqa: ANN001 |
| 59 | + if queryset.count() != 1: |
| 60 | + self.message_user(request, "Pick exactly one row.", level=messages.ERROR) |
| 61 | + return None |
| 62 | + obj = queryset.get() |
| 63 | + return HttpResponseRedirect( |
| 64 | + reverse("admin:jobs_job_change", args=[obj.pk]) + "?run_custom=1" |
| 65 | + ) |
| 66 | + |
| 67 | + # 3) change_view override branching on request.GET. |
| 68 | + def change_view(self, request, object_id, form_url="", extra_context=None): # noqa: ANN001 |
| 69 | + if request.GET.get("run_custom") == "1": |
| 70 | + return self.run_custom_view(request, object_id) |
| 71 | + return super().change_view(request, object_id, form_url, extra_context) |
| 72 | + |
| 73 | + # 4) custom view rendering a custom template — not a ModelForm / fieldsets. |
| 74 | + def run_custom_view(self, request, object_id): # noqa: ANN001 |
| 75 | + obj = self.get_object(request, object_id) |
| 76 | + |
| 77 | + if request.method == "POST": |
| 78 | + selected = request.POST.getlist("selected_steps") # ordered list |
| 79 | + if not selected: |
| 80 | + messages.error(request, "Pick at least one step.") |
| 81 | + return redirect(request.get_full_path()) |
| 82 | + messages.success(request, f"Queued {' → '.join(selected)}") |
| 83 | + return redirect("admin:jobs_job_change", object_id) |
| 84 | + |
| 85 | + all_steps = get_step_registry() |
| 86 | + selected_steps = sorted( |
| 87 | + (s for s in all_steps if s["is_default"]), |
| 88 | + key=lambda s: s["default_order"], |
| 89 | + ) |
| 90 | + available_steps = [s for s in all_steps if not s["is_default"]] |
| 91 | + |
| 92 | + context = dict( |
| 93 | + self.admin_site.each_context(request), |
| 94 | + title=f"Configure Step Sequence: {obj.name}", |
| 95 | + item_type="Job", |
| 96 | + item_name=obj.name, |
| 97 | + obj=obj, |
| 98 | + available_steps=available_steps, |
| 99 | + selected_steps=selected_steps, |
| 100 | + all_steps=sorted(all_steps, key=lambda s: s["default_order"]), |
| 101 | + back_url=reverse("admin:jobs_job_changelist"), |
| 102 | + cancel_url=reverse("admin:jobs_job_change", args=[obj.pk]), |
| 103 | + opts=self.model._meta, |
| 104 | + preserved_filters=self.get_preserved_filters(request), |
| 105 | + ) |
| 106 | + return render(request, "admin/jobs/job/run_custom.html", context) |
0 commit comments