Skip to content

Commit

Permalink
Fix get_as_tags to return a list and fix get_files on Jinja2
Browse files Browse the repository at this point in the history
  • Loading branch information
@fjsj
fjsj committed Jan 15, 2024
1 parent 9b97987 commit f409a2a
Show file tree
Hide file tree
Showing 4 changed files with 81 additions and 32 deletions.
2 changes: 2 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -447,6 +447,8 @@ Then in your base jinja template, do:
{{ render_bundle('main') }}
```

Note: `get_files` in Jinja2 is called `webpack_get_files`.

## Migrating from version < 1.0.0

In order to use `django-webpack-loader>=1.0.0`, you must ensure that `webpack-bundle-tracker@1.0.0` is being used on the JavaScript side. It's recommended that you always keep at least minor version parity across both packages for full compatibility.
Expand Down
107 changes: 77 additions & 30 deletions tests/app/tests/test_webpack.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,13 @@
WebpackLoaderBadStatsError,
WebpackLoaderTimeoutError)
from webpack_loader.templatetags.webpack_loader import _WARNING_MESSAGE
from webpack_loader.utils import get_loader
from webpack_loader.utils import get_as_tags, get_loader

BUNDLE_PATH = os.path.join(
settings.BASE_DIR, 'assets/django_webpack_loader_bundles/')
DEFAULT_CONFIG = 'DEFAULT'
_OUR_EXTENSION = 'webpack_loader.contrib.jinja2ext.WebpackExtension'

_warn_mock = Mock()


class LoaderTestCase(TestCase):
def setUp(self):
Expand Down Expand Up @@ -402,10 +400,8 @@ def test_request_blocking(self):
elapsed = time.time() - then
self.assertTrue(elapsed < wait_for)

@patch(
target='webpack_loader.templatetags.webpack_loader.warn',
new=_warn_mock)
def test_emits_warning_on_no_request_in_djangoengine(self):
@patch(target='webpack_loader.templatetags.webpack_loader.warn')
def test_emits_warning_on_no_request_in_djangoengine(self, warn_mock):
"""
Should emit warnings on having no request in context (django
template).
Expand All @@ -427,7 +423,7 @@ def test_emits_warning_on_no_request_in_djangoengine(self):
r'{% render_bundle "app1" %}'
r'{% render_bundle "app2" %}')) # type: Template
output = dups_template.render(context=Context())
_warn_mock.assert_not_called()
warn_mock.assert_not_called()
self.assertEqual(output.count(asset_app1), 1)
self.assertEqual(output.count(asset_app2), 1)
self.assertEqual(output.count(asset_vendor), 2)
Expand All @@ -442,11 +438,11 @@ def test_emits_warning_on_no_request_in_djangoengine(self):
self.assertEqual(output.count(asset_app1), 1)
self.assertEqual(output.count(asset_app2), 1)
self.assertEqual(output.count(asset_vendor), 2)
_warn_mock.assert_called_once_with(
warn_mock.assert_called_once_with(
message=_WARNING_MESSAGE, category=RuntimeWarning)

# Should NOT call `warn()` here
_warn_mock.reset_mock()
warn_mock.reset_mock()
nodups_template = Template(template_string=(
r'{% load render_bundle from webpack_loader %}'
r'{% render_bundle "app1" %}'
Expand All @@ -460,13 +456,11 @@ def test_emits_warning_on_no_request_in_djangoengine(self):
self.assertEqual(output.count(asset_app1), 1)
self.assertEqual(output.count(asset_app2), 1)
self.assertEqual(output.count(asset_vendor), 1)
_warn_mock.assert_not_called()
_warn_mock.reset_mock()
warn_mock.assert_not_called()
warn_mock.reset_mock()

@patch(
target='webpack_loader.templatetags.webpack_loader.warn',
new=_warn_mock)
def test_emits_warning_on_no_request_in_jinja2engine(self):
@patch(target='webpack_loader.templatetags.webpack_loader.warn')
def test_emits_warning_on_no_request_in_jinja2engine(self, warn_mock):
'Should emit warnings on having no request in context (Jinja2).'
self.compile_bundles('webpack.config.skipCommon.js')
settings = {
Expand Down Expand Up @@ -500,7 +494,7 @@ def test_emits_warning_on_no_request_in_jinja2engine(self):
dups_template = jinja2_engine.get_template(
template_name='home-duplicated.jinja') # type: Jinja2Template
output = dups_template.render()
_warn_mock.assert_not_called()
warn_mock.assert_not_called()
self.assertEqual(output.count(asset_app1), 2)
self.assertEqual(output.count(asset_app2), 2)
self.assertEqual(output.count(asset_vendor), 4)
Expand All @@ -515,13 +509,13 @@ def test_emits_warning_on_no_request_in_jinja2engine(self):
self.assertEqual(output.count(asset_app1), 2)
self.assertEqual(output.count(asset_app2), 2)
self.assertEqual(output.count(asset_vendor), 4)
self.assertEqual(_warn_mock.call_count, 3)
self.assertEqual(warn_mock.call_count, 3)
self.assertListEqual(
_warn_mock.call_args_list,
warn_mock.call_args_list,
[warning_call, warning_call, warning_call])

# Should NOT call `warn()` here
_warn_mock.reset_mock()
warn_mock.reset_mock()
request = self.factory.get(path='/')
with self.settings(**settings):
jinja2_engine = engines['jinja2'] # type: Jinja2
Expand All @@ -535,17 +529,15 @@ def test_emits_warning_on_no_request_in_jinja2engine(self):
self.assertEqual(output.count(asset_app1), 1)
self.assertEqual(output.count(asset_app2), 1)
self.assertEqual(output.count(asset_vendor), 1)
_warn_mock.assert_not_called()
_warn_mock.reset_mock()
warn_mock.assert_not_called()
warn_mock.reset_mock()

@patch(
target='webpack_loader.templatetags.webpack_loader.warn',
new=_warn_mock)
def test_get_files_emits_warning_on_no_request(self):
@patch(target='webpack_loader.templatetags.webpack_loader.warn')
def test_get_files_emits_warning_on_no_request_in_djangoengine(self, warn_mock):
self.compile_bundles('webpack.config.skipCommon.js')
asset_vendor = '"/static/django_webpack_loader_bundles/vendors.js"'
asset_app1 = '"/static/django_webpack_loader_bundles/app1.js"'
asset_app2 = '"/static/django_webpack_loader_bundles/app2.js"'
asset_vendor = '/static/django_webpack_loader_bundles/vendors.js'
asset_app1 = '/static/django_webpack_loader_bundles/app1.js'
asset_app2 = '/static/django_webpack_loader_bundles/app2.js'

template = Template(template_string=(
'{% load render_bundle get_files from webpack_loader %}'
Expand All @@ -559,7 +551,43 @@ def test_get_files_emits_warning_on_no_request(self):
self.assertEqual(output.count(asset_app1), 1)
self.assertEqual(output.count(asset_app2), 1)
self.assertEqual(output.count(asset_vendor), 2)
_warn_mock.assert_called_once_with(
warn_mock.assert_called_once_with(
message=_WARNING_MESSAGE, category=RuntimeWarning)

@patch(target='webpack_loader.templatetags.webpack_loader.warn')
def test_get_files_emits_warning_on_no_request_in_jinja2engine(self, warn_mock):
self.compile_bundles('webpack.config.skipCommon.js')
asset_vendor = '/static/django_webpack_loader_bundles/vendors.js'
asset_app1 = '/static/django_webpack_loader_bundles/app1.js'
asset_app2 = '/static/django_webpack_loader_bundles/app2.js'
settings = {
'TEMPLATES': [
{
'NAME': 'jinja2',
'BACKEND': 'django_jinja.backend.Jinja2',
'APP_DIRS': True,
'OPTIONS': {
'match_extension': '.jinja',
'extensions': DEFAULT_EXTENSIONS + [_OUR_EXTENSION],
}
},
]
}

with self.settings(**settings):
jinja2_engine = engines['jinja2'] # type: Jinja2
template = jinja2_engine.from_string(
"{{ render_bundle('app1', 'js') }}"
"{% set app2_files = webpack_get_files('app2', skip_common_chunks=True) %}"
"{% for f in app2_files %}"
" <link rel='prefetch' href='{{ f.url }}' />"
"{% endfor %}"
)
output = template.render(context=Context())
self.assertEqual(output.count(asset_app1), 1)
self.assertEqual(output.count(asset_app2), 1)
self.assertEqual(output.count(asset_vendor), 2)
warn_mock.assert_called_once_with(
message=_WARNING_MESSAGE, category=RuntimeWarning)

def _assert_common_chunks_duplicated_djangoengine(self, template):
Expand Down Expand Up @@ -803,3 +831,22 @@ def test_skip_common_chunks_missing_config(self):

# return removed key
loader.config['SKIP_COMMON_CHUNKS'] = skip_common_chunks

def test_get_as_tags_direct_usage(self):
self.compile_bundles('webpack.config.skipCommon.js')

asset_vendor = (
'<script src="/static/django_webpack_loader_bundles/vendors.js" >'
'</script>')
asset_app1 = (
'<link href="/static/django_webpack_loader_bundles/app1.css" rel="stylesheet" />')
asset_app2 = (
'<script src="/static/django_webpack_loader_bundles/app1.js" >'
'</script>')

tags = get_as_tags('app1')

self.assertEqual(len(tags), 3)
self.assertEqual(tags[0], asset_vendor)
self.assertEqual(tags[1], asset_app1)
self.assertEqual(tags[2], asset_app2)
2 changes: 1 addition & 1 deletion webpack_loader/contrib/jinja2ext.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ def _render_bundle(context: Context, *args, **kwargs):

@pass_context
def _get_files(context: Context, *args, **kwargs):
return get_files(context=context, *args, **kwargs)
return get_files(context, *args, **kwargs)


class WebpackExtension(Extension):
Expand Down
2 changes: 1 addition & 1 deletion webpack_loader/utils.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ def get_as_tags(bundle_name, extension=None, config='DEFAULT', suffix='', attrs=
:param config: (optional) the name of the configuration
:return: a list of formatted tags as strings
'''
return get_as_url_to_tag_dict(bundle_name, extension, config, suffix, attrs, is_preload).values()
return list(get_as_url_to_tag_dict(bundle_name, extension, config, suffix, attrs, is_preload).values())


def get_static(asset_name, config='DEFAULT'):
Expand Down

0 comments on commit f409a2a

Please sign in to comment.