Add Enterprise CommCare Client Version Compliance Report

corehq/apps/builds/tests/test_utils.py

@@ -0,0 +1,48 @@
+from django.test import SimpleTestCase
+from corehq.apps.builds.utils import _parse_version, is_out_of_date
+
+
+class TestVersionUtils(SimpleTestCase):
+    def test_parse_version(self):
+        test_cases = [
+            ('2.53.0', (2, 53, 0)),
+            ('2.53', (2, 53)),
+            ('1.0.0', (1, 0, 0)),
+            ('7', (7,)),
+            ('', None),
+            (None, None),
+            ('2.53.0.invalid', None),
+            ('not_a_version', None),
+        ]
+
+        for version, expected in test_cases:
+            with self.subTest(version=version, expected=expected):
+                result = _parse_version(version)
+                self.assertEqual(
+                    result,
+                    expected,
+                    f"Failed to parse '{version}'. Expected {expected}, got {result}"
+                )
+
+    def test_is_out_of_date(self):
+        test_cases = [
+            # (version_in_use, latest_version, expected_result)
+            ('2.53.0', '2.53.1', True),     # Normal case - out of date
+            ('2.53.1', '2.53.1', False),    # Same version - not out of date
+            ('2.53.2', '2.53.1', False),    # Higher version - not out of date
+            (None, '2.53.1', False),        # None version_in_use
+            ('2.53.1', None, False),        # None latest_version
+            ('invalid', '2.53.1', False),   # Invalid version string
+            ('2.53.1', 'invalid', False),   # Invalid latest version
+            ('6', '7', True),               # Normal case - app version is integer
+            (None, None, False),            # None version_in_use and latest_version
+        ]
+
+        for version_in_use, latest_version, expected in test_cases:
+            with self.subTest(version_in_use=version_in_use, latest_version=latest_version):
+                result = is_out_of_date(version_in_use, latest_version)
+                self.assertEqual(
+                    result,
+                    expected,
+                    f"Expected is_out_of_date('{version_in_use}', '{latest_version}') to be {expected}"
+                )

corehq/apps/builds/utils.py

@@ -40,3 +40,47 @@ def extract_build_info_from_filename(content_disposition):
     else:
         raise ValueError('Could not find filename like {!r} in {!r}'.format(
             pattern, content_disposition))
+
+
+def get_latest_version_at_time(target_time):
+    """
+    Get the latest CommCare version that was available at a given time.
+    Excludes superuser-only versions.
+    Menu items are already in chronological order (newest last).
+    If no target time is provided, return the latest version at now.
+    """
+    config = CommCareBuildConfig.fetch()
+
+    if not target_time:
+        return config.get_default().version
+
+    # Iterate through menu items in reverse (newest to oldest)
+    for item in reversed(config.menu):
+        if item.superuser_only:
+            continue
+        try:
+            build = CommCareBuild.get_build(item.build.version, latest=True)
+            if build and build.time and build.time <= target_time:
+                return item.build.version
+        except KeyError:
+            continue
+
+    return None
+
+
+def _parse_version(version_str):
+    """Convert version string to comparable tuple"""
+    if version_str:
+        try:
+            return tuple(int(n) for n in version_str.split('.'))
+        except (ValueError, AttributeError):
+            return None
+    return None
+
+
+def is_out_of_date(version_in_use, latest_version):
+    version_in_use_tuple = _parse_version(version_in_use)
+    latest_version_tuple = _parse_version(latest_version)
+    if not version_in_use_tuple or not latest_version_tuple:
+        return False
+    return version_in_use_tuple < latest_version_tuple

corehq/apps/enterprise/api/api.py

@@ -1,6 +1,7 @@
 from tastypie.api import Api
 
 from corehq.apps.enterprise.api.resources import (
+    CommCareVersionComplianceResource,
     DomainResource,
     FormSubmissionResource,
     MobileUserResource,
@@ -14,3 +15,4 @@
 v1_api.register(MobileUserResource())
 v1_api.register(FormSubmissionResource())
 v1_api.register(ODataFeedResource())
+v1_api.register(CommCareVersionComplianceResource())

corehq/apps/enterprise/api/resources.py

@@ -193,7 +193,12 @@ def get_object_list(self, request):
             response=http.HttpTooManyRequests(headers={'Retry-After': self.RETRY_IN_PROGRESS_DELAY}))
 
     def get_report_task(self, request):
-        raise NotImplementedError()
+        account = BillingAccount.get_account_by_domain(request.domain)
+        return generate_enterprise_report.s(
+            self.REPORT_SLUG,
+            account.id,
+            request.couch_user.username,
+        )
 
     def _add_query_id_to_request(self, request, query_id):
         if 'report' not in request.GET:
@@ -213,14 +218,6 @@ class DomainResource(ODataEnterpriseReportResource):
 
     REPORT_SLUG = EnterpriseReport.DOMAINS
 
-    def get_report_task(self, request):
-        account = BillingAccount.get_account_by_domain(request.domain)
-        return generate_enterprise_report.s(
-            self.REPORT_SLUG,
-            account.id,
-            request.couch_user.username,
-        )
-
     def dehydrate(self, bundle):
         bundle.data['domain'] = bundle.obj[6]
         bundle.data['created_on'] = self.convert_datetime(bundle.obj[0])
@@ -247,14 +244,6 @@ class WebUserResource(ODataEnterpriseReportResource):
 
     REPORT_SLUG = EnterpriseReport.WEB_USERS
 
-    def get_report_task(self, request):
-        account = BillingAccount.get_account_by_domain(request.domain)
-        return generate_enterprise_report.s(
-            self.REPORT_SLUG,
-            account.id,
-            request.couch_user.username,
-        )
-
     def dehydrate(self, bundle):
         bundle.data['email'] = bundle.obj[0]
         bundle.data['name'] = self.convert_not_available(bundle.obj[1])
@@ -288,14 +277,6 @@ class MobileUserResource(ODataEnterpriseReportResource):
 
     REPORT_SLUG = EnterpriseReport.MOBILE_USERS
 
-    def get_report_task(self, request):
-        account = BillingAccount.get_account_by_domain(request.domain)
-        return generate_enterprise_report.s(
-            self.REPORT_SLUG,
-            account.id,
-            request.couch_user.username,
-        )
-
     def dehydrate(self, bundle):
         bundle.data['username'] = bundle.obj[0]
         bundle.data['name'] = bundle.obj[1]
@@ -328,14 +309,6 @@ class ODataFeedResource(ODataEnterpriseReportResource):
 
     REPORT_SLUG = EnterpriseReport.ODATA_FEEDS
 
-    def get_report_task(self, request):
-        account = BillingAccount.get_account_by_domain(request.domain)
-        return generate_enterprise_report.s(
-            self.REPORT_SLUG,
-            account.id,
-            request.couch_user.username,
-        )
-
     def dehydrate(self, bundle):
         bundle.data['num_feeds_used'] = bundle.obj[0]
         bundle.data['num_feeds_available'] = bundle.obj[1]
@@ -388,3 +361,22 @@ def dehydrate(self, bundle):
 
     def get_primary_keys(self):
         return ('form_id', 'submitted',)
+
+
+class CommCareVersionComplianceResource(ODataEnterpriseReportResource):
+    mobile_worker = fields.CharField()
+    project_space = fields.CharField()
+    latest_version_available_at_submission = fields.CharField()
+    version_in_use = fields.CharField()
+
+    REPORT_SLUG = EnterpriseReport.COMMCARE_VERSION_COMPLIANCE
+
+    def dehydrate(self, bundle):
+        bundle.data['mobile_worker'] = bundle.obj[0]
+        bundle.data['project_space'] = bundle.obj[1]
+        bundle.data['latest_version_available_at_submission'] = bundle.obj[2]
+        bundle.data['version_in_use'] = bundle.obj[3]
+        return bundle
+
+    def get_primary_keys(self):
+        return ('mobile_worker', 'project_space',)

corehq/apps/enterprise/enterprise.py

@@ -7,9 +7,11 @@
 
 from memoized import memoized
 
+from corehq.apps.reports.standard.deployments import _format_commcare_version
 from couchforms.analytics import get_last_form_submission_received
 from dimagi.utils.dates import DateSpan
 
+from corehq.apps.builds.utils import get_latest_version_at_time, is_out_of_date
 from corehq.apps.enterprise.exceptions import EnterpriseReportError, TooMuchRequestedDataError
 from corehq.apps.enterprise.iterators import raise_after_max_elements
 from corehq.apps.accounting.models import BillingAccount
@@ -34,6 +36,7 @@ class EnterpriseReport:
     MOBILE_USERS = 'mobile_users'
     FORM_SUBMISSIONS = 'form_submissions'
     ODATA_FEEDS = 'odata_feeds'
+    COMMCARE_VERSION_COMPLIANCE = 'commcare_version_compliance'
 
     DATE_ROW_FORMAT = '%Y/%m/%d %H:%M:%S'
 
@@ -67,6 +70,8 @@ def create(cls, slug, account_id, couch_user, **kwargs):
             report = EnterpriseFormReport(account, couch_user, **kwargs)
         elif slug == cls.ODATA_FEEDS:
             report = EnterpriseODataReport(account, couch_user, **kwargs)
+        elif slug == cls.COMMCARE_VERSION_COMPLIANCE:
+            report = EnterpriseCommCareVersionReport(account, couch_user, **kwargs)
 
         if report:
             report.slug = slug
@@ -383,3 +388,70 @@ def _get_individual_export_rows(self, exports, export_line_counts):
             )
 
         return rows
+
+
+class EnterpriseCommCareVersionReport(EnterpriseReport):
+    title = _('CommCare Client Version Compliance')
+    metric = _('%% of mobile workers on the latest commcare client version ')
+
+    def __init__(self, account, couch_user, **kwargs):
+        super().__init__(account, couch_user, **kwargs)
+
+    @property
+    def headers(self):
+        return [
+            _('Mobile Worker'),
+            _('Project Space'),
+            _('Latest Version Available at Submission'),
+            _('Version in Use'),
+
+        ]
+
+    def rows_for_domain(self, domain_obj):
+        rows = []
+
+        for user in get_all_user_rows(domain_obj.name,
+                                    include_web_users=False,
+                                    include_mobile_users=True,
+                                    include_inactive=False,
+                                    include_docs=True):
+            user = CouchUser.wrap_correctly(user['doc'])
+            last_submission = user.reporting_metadata.last_submission_for_user
+            last_used_device = user.last_device
+
+            version_in_use = _('Unknown')
+            date_of_use = None
+
+            # If the user hasn't submitted a form, we use the last used device
+            if last_submission and last_submission.commcare_version:
+                version_in_use = _format_commcare_version(last_submission.commcare_version)
+                date_of_use = last_submission.submission_date
+            elif last_used_device and last_used_device.commcare_version:
+                version_in_use = _format_commcare_version(last_used_device['commcare_version'])
+                date_of_use = last_used_device.last_used
+
+            latest_version_at_time_of_use = get_latest_version_at_time(date_of_use)
+
+            if is_out_of_date(version_in_use, latest_version_at_time_of_use):
+                rows.append([
+                    user.username,
+                    domain_obj.name,
+                    latest_version_at_time_of_use,
+                    version_in_use,
+                ])
+
+        return rows
+
+    @property
+    def total(self):
+        total_mobile_workers = 0
+        total_up_to_date = 0
+        for domain_obj in self.domains():
+            domain_mobile_workers = get_mobile_user_count(domain_obj.name, include_inactive=False)
+            if domain_mobile_workers:
+                total_mobile_workers += domain_mobile_workers
+                total_up_to_date += domain_mobile_workers - len(self.rows_for_domain(domain_obj))
+        if not total_mobile_workers:
+            return '--'
+        percentage = (total_up_to_date / total_mobile_workers)
+        return f"{percentage * 100:.0f}%"

corehq/apps/enterprise/static/enterprise/js/project_dashboard.js

@@ -175,7 +175,11 @@ hqDefine("enterprise/js/project_dashboard", [
         const requestParams = {
             url: initialPageData.reverse("enterprise_dashboard_total", slug),
             success: function (data) {
-                $display.html(Number(data.total).toLocaleString());
+                if (typeof data.total === 'number') {
+                    $display.html(Number(data.total).toLocaleString());
+                } else {
+                    $display.html(data.total);
+                }
             },
             error: function (request) {
                 if (request.responseJSON) {

corehq/apps/enterprise/views.py

@@ -91,6 +91,7 @@ def platform_overview(request, domain):
             EnterpriseReport.MOBILE_USERS,
             EnterpriseReport.FORM_SUBMISSIONS,
             EnterpriseReport.ODATA_FEEDS,
+            EnterpriseReport.COMMCARE_VERSION_COMPLIANCE,
         )],
         'metric_type': 'Platform Overview',
     })

corehq/apps/reports/standard/deployments.py

@@ -353,10 +353,10 @@ def process_rows(self, users, fmt_for_export=False):
                     device_app_meta = self.get_data_for_app(device.get('app_meta'), last_build.get('app_id'))
 
             if last_sub and last_sub.get('commcare_version'):
-                commcare_version = _get_commcare_version(last_sub.get('commcare_version'))
+                commcare_version = _format_commcare_version(last_sub.get('commcare_version'))
             else:
                 if device and device.get('commcare_version', None):
-                    commcare_version = _get_commcare_version(device['commcare_version'])
+                    commcare_version = _format_commcare_version(device['commcare_version'])
             if last_sub and last_sub.get('submission_date'):
                 last_seen = string_to_utc_datetime(last_sub['submission_date'])
             if last_sync and last_sync.get('sync_date'):
@@ -547,7 +547,7 @@ def _get_formatted_assigned_location_names(self, user, user_loc_dict):
         return format_html(f'<div>{"".join(html_nodes)}</div>')
 
 
-def _get_commcare_version(app_version_info):
+def _format_commcare_version(app_version_info):
     commcare_version = (
         'CommCare {}'.format(app_version_info)
         if app_version_info