Improve get_files support for skip_common_chunks, avoid changing public API for get_as_tags

fjsj · fjsj · commit 043f506b4250 · 2024-01-15T18:20:02.000-03:00
diff --git a/tests/app/settings.py b/tests/app/settings.py
@@ -119,6 +119,11 @@
         'BUNDLE_DIR_NAME': 'django_webpack_loader_bundles/',
         'STATS_FILE': os.path.join(BASE_DIR, 'webpack-stats-app2.json'),
     },
+    'GET_FILES': {
+        'CACHE': False,
+        'BUNDLE_DIR_NAME': 'django_webpack_loader_bundles/',
+        'STATS_FILE': os.path.join(BASE_DIR, 'webpack-stats-getFiles.json'),
+    },
     'NO_IGNORE_APP': {
         'IGNORE': [],
     },
diff --git a/tests/app/templates/home.html b/tests/app/templates/home.html
@@ -1,4 +1,4 @@
-{% load render_bundle webpack_static from webpack_loader %}
+{% load render_bundle webpack_static get_files from webpack_loader %}
 <!DOCTYPE html>
 <html>
   <head>
@@ -11,8 +11,18 @@
   <body>
     <img src="{% webpack_static 'my-image.png' %}"/>
     <img src="{% webpack_static 'my-image.png' 'APP2'%}"/>
+    
     <div id="react-app"></div>
+    
     {% render_bundle 'main' 'js' attrs='async charset="UTF-8"'%}
     {% render_bundle 'app2' 'js' config='APP2' %}
+
+    {% render_bundle 'getFiles' 'css' config='GET_FILES' %}
+    {% get_files 'getFiles' 'css' config='GET_FILES' skip_common_chunks=True as other_files %}
+    {% for css_file in other_files %}
+      <li>{{ css_file.url }}</li>
+    {% empty %}
+      <li>All from getFiles already rendered</li>
+    {% endfor %}
   </body>
 </html>
diff --git a/tests/app/templates/only_files.html b/tests/app/templates/only_files.html
@@ -2,7 +2,7 @@
 <script>
 
   {% get_files 'main' 'css' as main_css_files %}
-  {% get_files 'main' 'js' as main_js_files %}
+  {% get_files 'main' 'js' skip_common_chunks=True as main_js_files %}
 
   var contentCss = '{{ main_css_files.0.url }}';
 
diff --git a/tests/app/tests/test_webpack.py b/tests/app/tests/test_webpack.py
@@ -149,6 +149,7 @@ def test_code_spliting(self):
     def test_templatetags(self):
         self.compile_bundles('webpack.config.simple.js')
         self.compile_bundles('webpack.config.app2.js')
+        self.compile_bundles('webpack.config.getFiles.js')
         view = TemplateView.as_view(template_name='home.html')
         request = self.factory.get('/')
         result = view(request)
@@ -169,6 +170,9 @@ def test_templatetags(self):
         self.assertIn(
             '<img src="/static/my-image.png"/>', result.rendered_content)
 
+        self.assertIn('<li>All from getFiles already rendered</li>', result.rendered_content)
+
+        request = self.factory.get('/')
         view = TemplateView.as_view(template_name='only_files.html')
         result = view(request)
         self.assertIn((
@@ -180,6 +184,7 @@ def test_templatetags(self):
             result.rendered_content)
 
         self.compile_bundles('webpack.config.publicPath.js')
+        request = self.factory.get('/')
         view = TemplateView.as_view(template_name='home.html')
         request = self.factory.get('/')
         result = view(request)
@@ -527,6 +532,30 @@ def test_emits_warning_on_no_request_in_jinja2engine(self):
         _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):
+        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"'
+
+        template = Template(template_string=(
+            '{% load render_bundle get_files from webpack_loader %}'
+            '{% render_bundle "app1" %}'
+            '{% get_files "app2" skip_common_chunks=True as app2_files %}'
+            '{% for f in app2_files %}'
+            '    <link rel="prefetch" href="{{ f.url }}" />'
+            '{% endfor %}'),
+        )  # type: Template
+        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):
         """
         Verify that any common chunks between two bundles are duplicated in
diff --git a/tests/assets/js/get_files1.css b/tests/assets/js/get_files1.css
@@ -0,0 +1,3 @@
+h1 {
+  font-size: 20px;
+}
diff --git a/tests/assets/js/get_files2.css b/tests/assets/js/get_files2.css
@@ -0,0 +1,3 @@
+h2 {
+  font-size: 18px;
+}
diff --git a/tests/webpack-stats-getFiles.json b/tests/webpack-stats-getFiles.json
@@ -0,0 +1,19 @@
+{
+  "status": "done",
+  "assets": {
+    "getFiles.css": {
+      "name": "getFiles.css",
+      "path": "/home/fjsj/workspace/django-webpack-loader/tests/assets/django_webpack_loader_bundles/getFiles.css"
+    },
+    "getFiles.js": {
+      "name": "getFiles.js",
+      "path": "/home/fjsj/workspace/django-webpack-loader/tests/assets/django_webpack_loader_bundles/getFiles.js"
+    }
+  },
+  "chunks": {
+    "getFiles": [
+      "getFiles.css",
+      "getFiles.js"
+    ]
+  }
+}
diff --git a/tests/webpack.config.getFiles.js b/tests/webpack.config.getFiles.js
@@ -0,0 +1,14 @@
+var config = require("./webpack.config.simple.js");
+var BundleTracker = require('webpack-bundle-tracker');
+var MiniCssExtractPlugin = require('mini-css-extract-plugin');
+
+config.entry = {
+  getFiles: './assets/js/index'
+};
+
+config.plugins = [
+  new MiniCssExtractPlugin(),
+  new BundleTracker({ path: __dirname, filename: 'webpack-stats-getFiles.json' })
+];
+
+module.exports = config;
diff --git a/webpack_loader/templatetags/webpack_loader.py b/webpack_loader/templatetags/webpack_loader.py
@@ -19,21 +19,24 @@ def render_bundle(
         attrs='', is_preload=False, skip_common_chunks=None):
     if skip_common_chunks is None:
         skip_common_chunks = utils.get_skip_common_chunks(config)
-    tags = utils.get_as_tags(
+
+    url_to_tag_dict = utils.get_as_url_to_tag_dict(
         bundle_name, extension=extension, config=config, suffix=suffix,
         attrs=attrs, is_preload=is_preload)
+
     request = context.get('request')
     if request is None:
         if skip_common_chunks:
             warn(message=_WARNING_MESSAGE, category=RuntimeWarning)
-        return mark_safe('\n'.join(tags.values()))
+        return mark_safe('\n'.join(url_to_tag_dict.values()))
+
     used_urls = getattr(request, '_webpack_loader_used_urls', None)
     if not used_urls:
         used_urls = request._webpack_loader_used_urls = set()
     if skip_common_chunks:
-        tags = {url: tag for url, tag in tags.items() if url not in used_urls}
-    used_urls.update(tags)
-    return mark_safe('\n'.join(tags.values()))
+        url_to_tag_dict = {url: tag for url, tag in url_to_tag_dict.items() if url not in used_urls}
+    used_urls.update(url_to_tag_dict.keys())
+    return mark_safe('\n'.join(url_to_tag_dict.values()))
 
 
 @register.simple_tag
@@ -61,16 +64,18 @@ def get_files(
     """
     if skip_common_chunks is None:
         skip_common_chunks = utils.get_skip_common_chunks(config)
-    if not skip_common_chunks:
-        return utils.get_files(bundle_name, extension=extension, config=config)
-    request = context.get('request')
+
     result = utils.get_files(bundle_name, extension=extension, config=config)
-    if not skip_common_chunks:
-        return result
+
+    request = context.get('request')
     if request is None:
-        warn(message=_WARNING_MESSAGE, category=RuntimeWarning)
+        if skip_common_chunks:
+            warn(message=_WARNING_MESSAGE, category=RuntimeWarning)
         return result
+
     used_urls = getattr(request, '_webpack_loader_used_urls', None)
     if not used_urls:
-        used_urls = request._webpack_loader_used_urls = set()
-    return [x for x in result if x['url'] not in used_urls]
+        used_urls = set()
+    if skip_common_chunks:
+        result = [chunk for chunk in result if chunk['url'] not in used_urls]
+    return result
diff --git a/webpack_loader/utils.py b/webpack_loader/utils.py
@@ -57,15 +57,15 @@ def get_files(bundle_name, extension=None, config='DEFAULT'):
     return list(_get_bundle(loader, bundle_name, extension))
 
 
-def get_as_tags(bundle_name, extension=None, config='DEFAULT', suffix='', attrs='', is_preload=False):
+def get_as_url_to_tag_dict(bundle_name, extension=None, config='DEFAULT', suffix='', attrs='', is_preload=False):
     '''
-    Get a list of formatted <script> & <link> tags for the assets in the
+    Get a dict of URLs to formatted <script> & <link> tags for the assets in the
     named bundle.
 
     :param bundle_name: The name of the bundle
     :param extension: (optional) filter by extension, eg. 'js' or 'css'
     :param config: (optional) the name of the configuration
-    :return: a list of formatted tags as strings
+    :return: a dict of URLs to formatted tags as strings
     '''
 
     loader = get_loader(config)
@@ -98,6 +98,19 @@ def get_as_tags(bundle_name, extension=None, config='DEFAULT', suffix='', attrs=
     return result
 
 
+def get_as_tags(bundle_name, extension=None, config='DEFAULT', suffix='', attrs='', is_preload=False):
+    '''
+    Get a list of formatted <script> & <link> tags for the assets in the
+    named bundle.
+
+    :param bundle_name: The name of the bundle
+    :param extension: (optional) filter by extension, eg. 'js' or 'css'
+    :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()
+
+
 def get_static(asset_name, config='DEFAULT'):
     '''
     Equivalent to Django's 'static' look up but for webpack assets.
