Application Version Compliance Report

corehq/apps/enterprise/enterprise.py

@@ -16,6 +16,7 @@
 from corehq.apps.accounting.models import BillingAccount
 from corehq.apps.accounting.utils import get_default_domain_url
 from corehq.apps.app_manager.dbaccessors import get_brief_apps_in_domain
+from corehq.apps.app_manager.models import Application, SavedAppBuild
 from corehq.apps.builds.utils import get_latest_version_at_time, is_out_of_date
 from corehq.apps.builds.models import CommCareBuildConfig
 from corehq.apps.domain.calculations import sms_in_last
@@ -25,7 +26,7 @@
     TooMuchRequestedDataError,
 )
 from corehq.apps.enterprise.iterators import raise_after_max_elements
-from corehq.apps.es import forms as form_es
+from corehq.apps.es import AppES, forms as form_es
 from corehq.apps.es.users import UserES
 from corehq.apps.export.dbaccessors import ODataExportFetcher
 from corehq.apps.reports.util import (
@@ -37,7 +38,7 @@
     get_mobile_user_count,
     get_web_user_count,
 )
-from corehq.apps.users.models import CouchUser, HQApiKey, Invitation, WebUser
+from corehq.apps.users.models import CouchUser, HQApiKey, Invitation, LastBuild, WebUser
 
 
 class EnterpriseReport(ABC):
@@ -50,6 +51,7 @@ class EnterpriseReport(ABC):
     SMS = 'sms'
     API_USAGE = 'api_usage'
     TWO_FACTOR_AUTH = '2fa'
+    APP_VERSION_COMPLIANCE = 'app_version_compliance'
 
     DATE_ROW_FORMAT = '%Y/%m/%d %H:%M:%S'
 
@@ -101,6 +103,8 @@ def create(cls, slug, account_id, couch_user, **kwargs):
             report = EnterpriseAPIReport(account, couch_user, **kwargs)
         elif slug == cls.TWO_FACTOR_AUTH:
             report = Enterprise2FAReport(account, couch_user, **kwargs)
+        elif slug == cls.APP_VERSION_COMPLIANCE:
+            report = EnterpriseAppVersionComplianceReport(account, couch_user, **kwargs)
 
         if report:
             report.slug = slug
@@ -635,3 +639,87 @@ def rows_for_domain(self, domain_obj):
         if domain_obj.two_factor_auth:
             return []
         return [(domain_obj.name,)]
+
+
+class EnterpriseAppVersionComplianceReport(EnterpriseReport):
+    title = gettext_lazy('Application Version Compliance')
+    total_description = gettext_lazy('% of Applications Up-to-Date Across All Mobile Workers')
+
+    def __init__(self, account, couch_user):
+        super().__init__(account, couch_user)
+        self.builds_by_app_id = {}
+        self.wrapped_builds_cache = {}
+
+    def get_app_builds(self, domain, app_id):
+        if app_id not in self.builds_by_app_id:
+            app_es = (
+                AppES()
+                .domain(domain)
+                .is_build()
+                .app_id(app_id)
+                .sort('version', desc=True)
+                .is_released()
+            )
+            self.builds_by_app_id[app_id] = app_es.run().hits
+
+        return self.builds_by_app_id[app_id]
+
+    @property
+    def headers(self):
+        return [_('Mobile Worker'), _('Project Space'), _('Application'),
+                _('Latest Version Available at Submission'),
+                _('Version in Use'), _('Last Used [UTC]')]
+
+    def rows_for_domain(self, domain_obj):
+        rows = []
+
+        user_query = (UserES()
+            .domain(domain_obj.name)
+            .mobile_users()
+            .source([
+                'username',
+                'reporting_metadata.last_builds',
+            ]))
+        for user in user_query.run().hits:
+            last_builds = user.get('reporting_metadata', {}).get('last_builds', [])
+            for build in last_builds:
+                build = LastBuild.wrap(build)
+                if build.build_version:
+                    all_builds = self.get_app_builds(domain_obj.name, build.app_id)
+                    latest_version = self.get_latest_build_version_at_time(all_builds,
+                                                                           build.build_version_date)
+                    if is_out_of_date(build.build_version, latest_version):
+                        rows.append([
+                            user['username'],
+                            domain_obj.name,
+                            Application.get(build.app_id).name,
+                            latest_version,
+                            build.build_version,
+                            self.format_date(build.build_version_date),
+                        ])
+
+        return rows
+
+    def total_for_domain(self, domain_obj):
+        return 0
+
+    def get_latest_build_version_at_time(self, all_builds, time):
+        """
+        Get the latest build version at the time
+
+        :param all_builds: List of raw build documents sorted by version in descending order
+        :param time: The date of the build version to compare against
+        :return: The latest build version available at the given date
+        """
+
+        for build_doc in all_builds:
+            build_id = build_doc['_id']
+            if build_id in self.wrapped_builds_cache:
+                build = self.wrapped_builds_cache[build_id]
+            else:
+                build = SavedAppBuild.wrap(build_doc)
+                self.wrapped_builds_cache[build_id] = build
+
+            if build.last_released <= time:
+                return build.version
+        return None

corehq/apps/enterprise/views.py

@@ -92,6 +92,7 @@ def platform_overview(request, domain):
             EnterpriseReport.ODATA_FEEDS,
             EnterpriseReport.COMMCARE_VERSION_COMPLIANCE,
             EnterpriseReport.SMS,
+            EnterpriseReport.APP_VERSION_COMPLIANCE,
         )],
         'uses_date_range': [EnterpriseReport.FORM_SUBMISSIONS, EnterpriseReport.SMS],
         'metric_type': 'Platform Overview',