[Django] #25553: Add lazy version of admin_static's static
Django
-------------------------------+--------------------
Reporter: dsanders11 | Owner: nobody
Type: New feature | Status: new
Component: contrib.admin | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 1
Easy pickings: 1 | UI/UX: 0
-------------------------------+--------------------
To be CDN-friendly (with hashed static file names) it's important to run
[https://docs.djangoproject.com/en/1.8/topics/forms/media/ form assets]
through the static templatetag to get the correct filename. This can be
done via django.contrib.admin.templatetag.admin_static.static, but if any
chain of imports leads to static being invoked during a management command
when the staticfiles are inaccessible (e.g. before collectstatic is
performed) then it will fail to find the file and the command will error.
Lazy version can be used in these situations to lazily get the correct
filename for form assets so that it is not resolved during management
commands.
--
Ticket URL: <https://code.djangoproject.com/ticket/25553>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: dsanders11 | Owner: nobody
Type: New feature | Status: new
Component: contrib.admin | Version: master
Keywords: | Triage Stage: Unreviewed
Has patch: 1 | Easy pickings: 1
UI/UX: 0 |
Changes (by dsanders11):
* Attachment "lazy_admin_static_static.patch" added.
Django
Reporter: dsanders11 | Owner: nobody
Type: New feature | Status: new
Component: contrib.admin | Version: master
Keywords: | Triage Stage: Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by timgraham):
* needs_better_patch: => 0
* needs_tests: => 0
* needs_docs: => 0
Comment:
I don't see why you would execute a management command (presumably in
production) before finishing your deployment which should involve running
`collectstatic`? Could you explain a bit more and expand on the rationale
for this living in Django core and not in your app that requires the
seemingly unusual use case?
--
Ticket URL: <https://code.djangoproject.com/ticket/25553#comment:1>
Django
Reporter: dsanders11 | Owner: nobody
Type: New feature | Status: new
Component: contrib.admin | Version: master
Keywords: | Triage Stage: Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Comment (by dsanders11):
I could see the need to execute a management command before collectstatic,
such as `manage.py migrate --dry-run` to see which migrations will be
applied.
However, the bigger concern is that collectstatic is itself a management
command so it can't run either.
If there's a situation where a models.py file imports a file which uses
the non-lazy static, this causes the management command (including
collectstatic) to fail since it is unable to find the path to the
collected static since it hasn't been collected yet.
Currently the static templatetag in admin_static contains fallback logic
if django.contrib.staticfiles isn't in INSTALLED_APPS. This is useful for
thirdparty apps which can't rely on it being installed. While Django only
uses it in a few admin files it is useful anywhere that uses
[https://docs.djangoproject.com/en/1.8/topics/forms/media/ form assets] to
get this same fallback logic. Using it for regular forms increases the
odds this type of scenario will occur where it is evaluated during model
collection in the app registry.
The docs don't really touch on using the static templatetag to ensure form
assets have the correct filename, but it's important for having them work
well with CachedStaticFilesStorage or ManifestStaticFilesStorage out of
the box, otherwise they use unhashed filenames and may get cached (CDN or
browser) without the developer realizing.
Long winded, but just trying to make the use case clear.
--
Ticket URL: <https://code.djangoproject.com/ticket/25553#comment:2>
Django
Reporter: dsanders11 | Owner: nobody
Type: New feature | Status: closed
Component: contrib.admin | Version: master
Severity: Normal | Resolution: wontfix
Keywords: | Triage Stage: Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Changes (by timgraham):
* status: new => closed
* resolution: => wontfix
Comment:
Problem acknowledged -- it looks like #21221 describes the same issue. As
I don't think the admin static template tag is the right place to address
the issue I'll close this ticket as "wontfix" for that approach, and we
can continue the discussion about a possible solution on the other ticket.
Maybe a solution could be for the `BaseForm.media` property to do the
`static` transformation instead?
--
Ticket URL: <https://code.djangoproject.com/ticket/25553#comment:3>
Django
Reporter: dsanders11 | Owner: nobody
Type: New feature | Status: closed
Component: contrib.admin | Version: master
Severity: Normal | Resolution: wontfix
Keywords: | Triage Stage: Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Comment (by dsanders11):
Replying to [comment:3 timgraham]:
> Problem acknowledged -- it looks like #21221 describes the same issue.
As I don't think the admin static template tag is the right place to
address the issue I'll close this ticket as "wontfix" for that approach,
and we can continue the discussion about a possible solution on the other
ticket. Maybe a solution could be for the `BaseForm.media` property to do
the `static` transformation instead?
Fair enough. I figured this was a known issue (since many of the admin
forms use the `static` template tag to get around it), so this was more of
a quick fix patch for a corner case. Ideally `BaseForm.media` should do it
so that it just works out of the box, but since #21221 is over 2 years old
it doesn't seem like there's much motivation to fix the underlying issue.
--
Ticket URL: <https://code.djangoproject.com/ticket/25553#comment:4>
Django
Reporter: dsanders11 | Owner: nobody
Type: New feature | Status: closed
Component: contrib.admin | Version: master
Severity: Normal | Resolution: wontfix
Keywords: | Triage Stage: Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Comment (by thatandromeda):
FYI, I ran across this ticket when I found myself also needing a lazy
version of `static()` thusly:
* A model property used `static()` to grab the URLs of images used to
illustrate model instances (they're icons representing model field
choices);
* Then I pushed to Heroku, where I'm using Whitenoise (per copy/paste from
Heroku docs) to serve static images;
* The `app_config.import_models(all_models)` call failed because the
`static()` call in the model did not yet resolve to anything because
collectstatic hadn't yet been run, so the push was rejected;
* However, I can't run collectstatic until after the push makes it onto
Heroku!
I've now hardcoded my URLs (so it works, but I feel like a bad person,
having added a smidgen more technical debt to the world).
--
Ticket URL: <https://code.djangoproject.com/ticket/25553#comment:5>