docs(readme): honest hooks-carry-through + hardening + cross-origin sections (#623 #624 #633 #634 #635)#640
Merged
Conversation
…ections Five audit findings, all README-only — no code change: - **#623 / #624 / #625 / #626 / #627 / #628 / #630 / #622:** Add a "Stock-Django ModelAdmin hooks that do NOT carry through to the SPA" table. Documents the silent-noop hooks (template overrides, formfield_overrides, filter_horizontal, GFK, i18n) and the partially-honoured hints (raw_id_fields + radio_fields — the API emits the hint, the SPA still renders autocomplete / dropdown). Corrects the existing feature-status table where `raw_id_fields` was incorrectly marked ✅. - **#633:** "Writing safe `list_display` callables" — bans the `mark_safe(f"...")` foot-gun + shows the `format_html` auto-escape equivalent. Same advice applies on legacy `/admin/` too, but the SPA's `dangerouslySetInnerHTML` render path makes the consequence visible end-to-end. - **#634:** "Hardening" section with a worked `django-axes` integration pointed at the SPA's JSON login endpoint. - **#635:** "Mounting the API on a different origin (CORS + cookies)" — the three-setting matrix consumers have to configure together (`SESSION_COOKIE_SAMESITE = None` + secure, CORS, CSRF_TRUSTED_ORIGINS). Tracking issues stay open until each underlying gap closes; the README now sets honest expectations so consumers don't ship a release thinking these all work invisibly. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This was referenced May 31, 2026
Closed
MartinCastroAlvarez
added a commit
that referenced
this pull request
May 31, 2026
….4.13 (#643) A ModelAdmin action that returns ``HttpResponseRedirect(some_url)`` was looking silently no-op'd to the operator: the click ran, the toast didn't appear, and nothing visible happened. The diagnosis in the issue blamed the API for swallowing the response, but the API correctly extracts ``response["Location"]`` into the JSON envelope's ``redirect`` field (``api/views/actions.py:256``). The actual bug was on the SPA: ``DetailPage`` piped the redirect URL straight into React Router's ``navigate`` — which is scoped to the SPA's ``BrowserRouter`` ``basename``, so any URL outside the SPA mount silently no-op'd: - legacy admin paths (``/admin/<app>/<model>/<pk>/change/``) - hijack / impersonate URLs (``/hijack/release-user/?next=…``) - cross-origin downloads (signed S3 URLs) New ``followActionRedirect`` helper (`apps/web/src/action-redirect.ts`) picks the right primitive per URL: ``navigate`` for same-origin paths inside the SPA mount (no full reload), ``window.location.assign`` for everything else. Returns a stripped basename-relative path to the navigate call so BrowserRouter doesn't double-prefix. The helper is dependency-injected (``currentOrigin``, ``assignLocation``) so the test suite can lock the routing logic without touching jsdom's non-configurable ``window.location``. Locks: 6 new vitests in `action-redirect.test.ts` cover the SPA- internal path, search + hash preservation, the legacy-admin path, cross-origin URLs, the hijack pattern, and a malformed-URL fallback. Release 1.4.13 bundles this with the unreleased changes since 1.4.12 (all already merged on main): - #631 / PR #641 — ``PRIMARY_COLOR`` reads ``site_primary_color`` off the configured ``AdminSite`` before falling back to the setting + default. - #626 / PR #642 — ``raw_id_fields`` and ``radio_fields`` now render their intended widgets (plain-pk text input + lookup link, inline radio bank) instead of falling through to autocomplete / ``<select>``. - #623 / #624 / #633 / #634 / #635 — README "Stock-Django hooks that do NOT carry through" / "Writing safe ``list_display`` callables" / "Hardening" / "Mounting the API on a different origin" sections (PR #640). - PR #638 — ``release.yml`` → ``publish.yml`` rename so PyPI's Trusted Publisher config matches the workflow filename. Closes #620. Co-authored-by: Martin Castro Laminrs <mcastro@laminr.ai> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
README-only — no code change, but closes the doc-only audit issues and corrects an existing misleading row in the feature table.
What's new
raw_id_fields ✅was misleading. Split intoautocomplete_fields ✅+raw_id_fields 🟡 #626so the table matches observable behaviour.list_displaycallables" section — closes [security] XSS via mark_safe / format_html in list_display callables — document the transitive risk + recommend safe pattern #633 (XSS guidance). Bansmark_safe(f"..."), showsformat_htmlauto-escape.django-axesintegration — closes [security] No login throttling on /api/v1/login/ — document recommended brute-force defense + verify django-axes integration #634 (login throttling guidance).Verification
README-only; no code paths touched.
Side effects
The README gets longer (+118 lines), but the lines are organised under named subsections so the existing reading flow is preserved.
Closes #623, closes #624, closes #633, closes #634, closes #635.
🤖 Generated with Claude Code