[B5] Support for migrating report views to Bootstrap 5

corehq/apps/hqwebapp/management/commands/complete_bootstrap5_migration.py

@@ -10,6 +10,7 @@
     get_all_javascript_paths_for_app,
     get_split_paths,
     get_short_path,
+    get_bootstrap5_path,
 )
 from corehq.apps.hqwebapp.utils.management_commands import (
     get_confirmation,
@@ -142,7 +143,7 @@ def sanitize_bootstrap3_from_filename(self, filename):
                 f"You specified '{filename}', which appears to be a Bootstrap 3 path!\n"
                 f"This file cannot be marked as complete with this tool.\n\n"
             ))
-            filename = filename.replace('/bootstrap3/', '/bootstrap5/')
+            filename = get_bootstrap5_path(filename)
             confirm = get_confirmation(f"Did you mean '{filename}'?")
             if not confirm:
                 self.stdout.write("Ok, aborting operation.\n\n")

corehq/apps/hqwebapp/tests/utils/test_bootstrap_paths.py

@@ -1,5 +1,9 @@
 from testil import eq
-from corehq.apps.hqwebapp.utils.bootstrap.paths import is_ignored_path
+from corehq.apps.hqwebapp.utils.bootstrap.paths import (
+    is_ignored_path,
+    get_bootstrap5_path,
+    is_bootstrap3_path,
+)
 
 
 def test_is_ignored_path_true():
@@ -12,3 +16,22 @@ def test_is_ignored_path_false():
     path = "/path/to/corehq/apps/builds/templates/builds/base_builds.html"
     app_name = "builds"
     eq(is_ignored_path(app_name, path), False)
+
+
+def test_get_bootstrap5_path():
+    bootstrap3_path = "reports/bootstrap3/base_template.html"
+    bootstrap5_path = "reports/bootstrap5/base_template.html"
+    eq(get_bootstrap5_path(bootstrap3_path), bootstrap5_path)
+
+
+def test_get_bootstrap5_path_none():
+    eq(get_bootstrap5_path(None), None)
+
+
+def test_is_bootstrap3_path():
+    bootstrap3_path = "reports/bootstrap3/base_template.html"
+    eq(is_bootstrap3_path(bootstrap3_path), True)
+
+
+def test_is_bootstrap3_path_false_with_none():
+    eq(is_bootstrap3_path(None), False)

corehq/apps/hqwebapp/utils/bootstrap/paths.py

@@ -56,6 +56,12 @@ def is_bootstrap5_path(path):
     return '/bootstrap5/' in str(path)
 
 
+def is_bootstrap3_path(path):
+    if path is None:
+        return False
+    return '/bootstrap3/' in path
+
+
 def is_mocha_path(path):
     return str(path).endswith('mocha.html')
 
@@ -124,3 +130,9 @@ def get_split_folders(paths, include_root=False):
             path.replace(str(COREHQ_BASE_DIR), '') for path in split_folders
         }
     return split_folders
+
+
+def get_bootstrap5_path(bootstrap3_path):
+    if bootstrap3_path is None:
+        return None
+    return bootstrap3_path.replace('/bootstrap3/', '/bootstrap5/')

corehq/apps/reports/dispatcher.py

@@ -24,6 +24,7 @@
 from corehq.util.quickcache import quickcache
 
 from .lookup import ReportLookup
+from ..hqwebapp.utils.bootstrap import set_bootstrap_version5
 
 datespan_default = datespan_in_request(
     from_param="startdate",
@@ -151,6 +152,8 @@ def dispatch(self, request, domain=None, report_slug=None, render_as=None,
                 report.decorator_dispatcher(
                     request, domain=domain, report_slug=report_slug, *args, **kwargs
                 )
+                if report.use_bootstrap5:
+                    set_bootstrap_version5()
                 return getattr(report, '%s_response' % render_as)
             except BadRequestError as e:
                 return HttpResponseBadRequest(e)

corehq/apps/reports/filters/base.py

@@ -6,6 +6,7 @@
 from memoized import memoized
 
 from corehq.apps.hqwebapp.crispy import CSS_FIELD_CLASS, CSS_LABEL_CLASS
+from corehq.apps.hqwebapp.utils.bootstrap.paths import get_bootstrap5_path
 
 
 class BaseReportFilter(object):
@@ -24,8 +25,9 @@ class BaseReportFilter(object):
     is_cacheable = False
     help_style_bubble = False
 
-    def __init__(self, request, domain=None, timezone=pytz.utc, parent_report=None,
-                 css_label=None, css_field=None):
+    def __init__(self, request, domain=None, timezone=pytz.utc,
+                 parent_report=None, css_label=None, css_field=None,
+                 use_bootstrap5=False):
         self.domain = domain
         if self.slug is None:
             raise NotImplementedError("slug is required")
@@ -39,6 +41,8 @@ def __init__(self, request, domain=None, timezone=pytz.utc, parent_report=None,
         self.css_label = css_label or (CSS_LABEL_CLASS + ' control-label')
         self.css_field = css_field or CSS_FIELD_CLASS
         self.context = {}
+        if use_bootstrap5:
+            self.template = get_bootstrap5_path(self.template)
 
     @property
     def is_disabled(self):

corehq/apps/reports/generic.py

@@ -19,6 +19,7 @@
 from celery.utils.log import get_task_logger
 from memoized import memoized
 
+from corehq.apps.hqwebapp.utils.bootstrap.paths import get_bootstrap5_path
 from corehq.util.timezones.utils import get_timezone
 from couchexport.export import export_from_tables, get_writer
 from couchexport.shortcuts import export_response
@@ -64,7 +65,7 @@ def _sanitize_col(col):
     return col
 
 
-def get_filter_classes(fields, request, domain, timezone):
+def get_filter_classes(fields, request, domain, timezone, use_bootstrap5=False):
     filters = []
     fields = fields
     for field in fields or []:
@@ -73,7 +74,7 @@ def get_filter_classes(fields, request, domain, timezone):
         else:
             klass = field
         filters.append(
-            klass(request, domain, timezone)
+            klass(request, domain, timezone, use_bootstrap5=use_bootstrap5)
         )
     return filters
 
@@ -175,6 +176,9 @@ class GenericReportView(object):
     deprecation_email_message = gettext("This report has been deprecated.")
     deprecation_message = gettext("This report has been deprecated.")
 
+    # use for bootstrap5 migration
+    use_bootstrap5 = False
+
     def __init__(self, request, base_context=None, domain=None, **kwargs):
         if not self.name or not self.section_name or self.slug is None or not self.dispatcher:
             raise NotImplementedError(
@@ -294,19 +298,29 @@ def timezone(self):
     @property
     @memoized
     def template_base(self):
+        if self.use_bootstrap5:
+            return get_bootstrap5_path(self.base_template)
         return self.base_template
 
     @property
     @memoized
     def template_async_base(self):
+        if self.use_bootstrap5:
+            default_path = "reports/async/bootstrap5/default.html"
+        else:
+            default_path = "reports/async/bootstrap3/default.html"
         if self.asynchronous:
-            return self.base_template_async or "reports/async/bootstrap3/default.html"
+            return self.base_template_async or default_path
         return self.template_base
 
     @property
     @memoized
     def template_report(self):
-        original_template = self.report_template_path or "reports/async/basic.html"
+        if self.use_bootstrap5:
+            template_path = get_bootstrap5_path(self.report_template_path)
+        else:
+            template_path = self.report_template_path
+        original_template = template_path or "reports/async/basic.html"
         if self.is_rendered_as_email:
             self.context.update(original_template=original_template)
             return self.override_template
@@ -315,12 +329,18 @@ def template_report(self):
     @property
     @memoized
     def template_report_partial(self):
+        if self.use_bootstrap5:
+            return get_bootstrap5_path(self.report_partial_path)
         return self.report_partial_path
 
     @property
     @memoized
     def template_filters(self):
-        return self.base_template_filters or "reports/async/bootstrap3/filters.html"
+        if self.use_bootstrap5:
+            default_path = "reports/async/bootstrap5/filters.html"
+        else:
+            default_path = "reports/async/bootstrap3/filters.html"
+        return self.base_template_filters or default_path
 
     @property
     @memoized
@@ -330,7 +350,7 @@ def rendered_report_title(self):
     @property
     @memoized
     def filter_classes(self):
-        return get_filter_classes(self.fields, self.request, self.domain, self.timezone)
+        return get_filter_classes(self.fields, self.request, self.domain, self.timezone, self.use_bootstrap5)
 
     @property
     @memoized