Add progress bar to derived data update (SEED-platform#4825)

perryr16 · Ross Perry · haneslinger · web-flow · commit 5866247c4a9f · 2024-11-05T13:36:12.000-07:00
* progress bar and auto reload refactor notification conditional check progess precommit Fix (SEED-platform#4824) conditional create progress_data more reliable unique_id cleanup Fix (SEED-platform#4824) cleanup * modal dismissed logic * update translations --------- Co-authored-by: Ross Perry <ross.perry@Rosss-MBP-2.home> Co-authored-by: Hannah Eslinger <heslinge@nrel.gov> Co-authored-by: Katherine Fleming <2205659+kflemin@users.noreply.github.com>
diff --git a/locale/en_US/LC_MESSAGES/django.mo b/locale/en_US/LC_MESSAGES/django.mo
diff --git a/locale/en_US/LC_MESSAGES/django.po b/locale/en_US/LC_MESSAGES/django.po
@@ -390,6 +390,9 @@ msgstr "Are you sure you want to unmerge these properties and then merge with th
 msgid "Are you sure you want to unmerge these tax lots and then merge with the selected tax lots?"
 msgstr "Are you sure you want to unmerge these tax lots and then merge with the selected tax lots?"
 
+msgid "Are you sure you want to unmerge these tax lots?"
+msgstr "Are you sure you want to unmerge these tax lots?"
+
 msgid "Area"
 msgstr "Area"
 
@@ -2962,6 +2965,9 @@ msgstr "Properties updated:"
 msgid "Properties with Data"
 msgstr "Properties with Data"
 
+msgid "Properties with elements cannot be unmerged."
+msgstr "Properties with elements cannot be unmerged."
+
 msgid "Property"
 msgstr "Property"
 
@@ -4095,6 +4101,9 @@ msgstr "UBID comparison result:"
 msgid "UBID thresholds are between 0.0 and 1.0"
 msgstr "UBID thresholds are between 0.0 and 1.0"
 
+msgid "UNMERGE_PROPERTIES_MODAL"
+msgstr "Are you sure you want to unmerge these properties? The unmerge action will keep meter data on both properties. Review meter data on both properties once they are unmerged."
+
 msgid "UPDATE_DERIVED_DATA_TEXT_1"
 msgstr "Press the 'Begin Update' button below to begin the process of recalculating the data stored in derived columns for the selected properties and tax lots. The derived columns will appear yellow to indicate that the update is in progress."
 
diff --git a/locale/es/LC_MESSAGES/django.mo b/locale/es/LC_MESSAGES/django.mo
diff --git a/locale/es/LC_MESSAGES/django.po b/locale/es/LC_MESSAGES/django.po
@@ -5,7 +5,7 @@ msgstr ""
 "Content-Transfer-Encoding: 8bit\n"
 "X-Generator: lokalise.com\n"
 "Project-Id-Version: SEED Platform\n"
-"PO-Revision-Date: 2024-11-05 06:02\n"
+"PO-Revision-Date: 2024-11-05 20:24\n"
 "Last-Translator: lokalise.com\n"
 "Language-Team: lokalise.com\n\n"
 "Language: es\n"
@@ -509,6 +509,9 @@ msgstr "¿Está seguro de que desea deshacer la fusión de estas propiedades y,
 msgid "Are you sure you want to unmerge these tax lots and then merge with the selected tax lots?"
 msgstr "¿Está seguro de que desea deshacer la fusión de estos lotes fiscales y, a continuación, fusionarlos con los lotes fiscales seleccionados?"
 
+msgid "Are you sure you want to unmerge these tax lots?"
+msgstr "¿Está seguro de que desea separar estos lotes de impuestos?"
+
 #, fuzzy
 msgid "Area"
 msgstr "Zona"
@@ -3879,6 +3882,9 @@ msgstr "Propiedades actualizadas:"
 msgid "Properties with Data"
 msgstr "Propiedades con datos"
 
+msgid "Properties with elements cannot be unmerged."
+msgstr "Las propiedades con elementos no se pueden separar."
+
 #, fuzzy
 msgid "Property"
 msgstr "Propiedad"
@@ -5362,6 +5368,9 @@ msgstr "Resultado de la comparación de UBID:"
 msgid "UBID thresholds are between 0.0 and 1.0"
 msgstr "Los umbrales UBID se sitúan entre 0,0 y 1,0"
 
+msgid "UNMERGE_PROPERTIES_MODAL"
+msgstr "¿Está seguro de que desea desvincular estas propiedades? La acción de desvincular conservará los datos del medidor en ambas propiedades. Revise los datos del medidor en ambas propiedades una vez que se hayan desvinculado."
+
 #, fuzzy
 msgid "UPDATE_DERIVED_DATA_TEXT_1"
 msgstr "Pulse el botón \"Iniciar actualización\" para iniciar el proceso de recálculo de los datos almacenados en las columnas derivadas para las propiedades y lotes fiscales seleccionados. Las columnas derivadas aparecerán en amarillo para indicar que la actualización está en curso."
diff --git a/locale/fr_CA/LC_MESSAGES/django.mo b/locale/fr_CA/LC_MESSAGES/django.mo
diff --git a/locale/fr_CA/LC_MESSAGES/django.po b/locale/fr_CA/LC_MESSAGES/django.po
@@ -395,6 +395,9 @@ msgstr "Êtes-vous sûr de vouloir annuler la fusion de ces propriétés et fusi
 msgid "Are you sure you want to unmerge these tax lots and then merge with the selected tax lots?"
 msgstr "Êtes-vous sûr de vouloir annuler la fusion de ces lots fiscaux pour ensuite fusionner avec les lots d'impôt sélectionnés?"
 
+msgid "Are you sure you want to unmerge these tax lots?"
+msgstr "Êtes-vous sûr de vouloir dissocier ces lots fiscaux ?"
+
 msgid "Area"
 msgstr "Superficie"
 
@@ -2982,6 +2985,9 @@ msgstr "Propriétés mises à jour :"
 msgid "Properties with Data"
 msgstr "Propriétés avec données"
 
+msgid "Properties with elements cannot be unmerged."
+msgstr "Les propriétés avec des éléments ne peuvent pas être dissociées."
+
 msgid "Property"
 msgstr "Propriété"
 
@@ -4128,6 +4134,9 @@ msgstr "Résultat de la comparaison UBID :"
 msgid "UBID thresholds are between 0.0 and 1.0"
 msgstr "Les seuils UBID sont compris entre 0,0 et 1,0"
 
+msgid "UNMERGE_PROPERTIES_MODAL"
+msgstr "Êtes-vous sûr de vouloir dissocier ces propriétés? L'action de dissociation conservera les données de compteur sur les deux propriétés. Vérifiez les données de compteur sur les deux propriétés une fois qu'elles sont dissociées."
+
 msgid "UPDATE_DERIVED_DATA_TEXT_1"
 msgstr "Appuyez sur le bouton « Démarrer la mise à jour » ci-dessous pour commencer le processus de recalcul des données stockées dans les colonnes dérivées pour les propriétés et les lots fiscaux sélectionnés. Les colonnes dérivées apparaîtront en jaune pour indiquer que la mise à jour est en cours."
 
diff --git a/seed/static/seed/js/controllers/inventory_list_controller.js b/seed/static/seed/js/controllers/inventory_list_controller.js
@@ -1327,15 +1327,18 @@ angular.module('SEED.controller.inventory_list', []).controller('inventory_list_
           taxlot_view_ids: () => ($scope.inventory_type === 'taxlots' ? selectedViewIds : [])
         }
       });
-      modalInstance.result.then(() => {
-        $scope.gridOptions.columnDefs.forEach((col) => {
-          if (col.derived_column) {
-            col.is_updating = true;
-            col.headerCellClass = 'updating-derived-column-display-name';
-          }
-        });
-        $scope.gridApi.core.notifyDataChange(uiGridConstants.dataChange.COLUMN);
-      });
+      modalInstance.result.then(
+        () => {}, // on close
+        () => { // on dismiss
+          $scope.gridOptions.columnDefs.forEach((col) => {
+            if (col.derived_column) {
+              col.is_updating = true;
+              col.headerCellClass = 'updating-derived-column-display-name';
+            }
+          });
+          $scope.gridApi.core.notifyDataChange(uiGridConstants.dataChange.COLUMN);
+        }
+      );
     };
 
     $scope.open_delete_modal = (selectedViewIds) => {
diff --git a/seed/static/seed/js/controllers/update_derived_data_modal_controller.js b/seed/static/seed/js/controllers/update_derived_data_modal_controller.js
@@ -4,18 +4,52 @@
  */
 angular.module('SEED.controller.update_derived_data_modal', []).controller('update_derived_data_modal_controller', [
   '$scope',
+  '$state',
   '$q',
   '$uibModalInstance',
   'inventory_service',
+  'Notification',
+  'uploader_service',
   'property_view_ids',
   'taxlot_view_ids',
   // eslint-disable-next-line func-names
-  function ($scope, $q, $uibModalInstance, inventory_service, property_view_ids, taxlot_view_ids) {
+  function (
+    $scope,
+    $state,
+    $q,
+    $uibModalInstance,
+    inventory_service,
+    Notification,
+    uploader_service,
+    property_view_ids,
+    taxlot_view_ids
+  ) {
     $scope.property_view_ids = _.uniq(property_view_ids);
     $scope.taxlot_view_ids = _.uniq(taxlot_view_ids);
 
+    $scope.status = 'ready';
+    $scope.uploader = { progress: 0 };
+
     $scope.begin_update = () => {
-      inventory_service.update_derived_data($scope.property_view_ids, $scope.taxlot_view_ids).then($uibModalInstance.close);
+      inventory_service.update_derived_data($scope.property_view_ids, $scope.taxlot_view_ids).then((data) => {
+        Notification.primary('Updating derived columns. This may take a few minutes...');
+        $scope.status = 'in progress';
+
+        const resultHandler = (notification_type, message) => {
+          $uibModalInstance.close();
+          Notification[notification_type](message);
+          $state.reload();
+        };
+
+        uploader_service.check_progress_loop(
+          data.progress_key,
+          0,
+          1,
+          () => resultHandler('success', 'Derived columns updated'),
+          () => resultHandler('error', 'Unexpected Error'),
+          $scope.uploader
+        );
+      });
     };
 
     /**
diff --git a/seed/static/seed/locales/en_US.json b/seed/static/seed/locales/en_US.json
@@ -124,6 +124,7 @@
     "Are you sure you want to delete the filter group": "Are you sure you want to delete the filter group",
     "Are you sure you want to unmerge these properties and then merge with the selected properties?": "Are you sure you want to unmerge these properties and then merge with the selected properties?",
     "Are you sure you want to unmerge these tax lots and then merge with the selected tax lots?": "Are you sure you want to unmerge these tax lots and then merge with the selected tax lots?",
+    "Are you sure you want to unmerge these tax lots?": "Are you sure you want to unmerge these tax lots?",
     "Area": "Area",
     "Area Column": "Area Column",
     "Area Target Column": "Area Target Column",
@@ -966,6 +967,7 @@
     "Properties failed to update:": "Properties failed to update:",
     "Properties updated:": "Properties updated:",
     "Properties with Data": "Properties with Data",
+    "Properties with elements cannot be unmerged.": "Properties with elements cannot be unmerged.",
     "Property": "Property",
     "Property Classification": "Property Classification",
     "Property Column List Profiles": "Property Column List Profiles",
@@ -1335,6 +1337,7 @@
     "UBID already exists": "UBID already exists",
     "UBID comparison result:": "UBID comparison result:",
     "UBID thresholds are between 0.0 and 1.0": "UBID thresholds are between 0.0 and 1.0",
+    "UNMERGE_PROPERTIES_MODAL": "Are you sure you want to unmerge these properties? The unmerge action will keep meter data on both properties. Review meter data on both properties once they are unmerged.",
     "UPDATE_DERIVED_DATA_TEXT_1": "Press the 'Begin Update' button below to begin the process of recalculating the data stored in derived columns for the selected properties and tax lots. The derived columns will appear yellow to indicate that the update is in progress.",
     "UPDATE_DERIVED_DATA_TEXT_2": "Note that while the columns are yellow, the data may not be up to date. Refresh the page to refresh the columns status.",
     "UPDATE_MANUALLY_GEOCODED_INSTRUCTIONS": "If the properties have been manually geocoded, then they will not be updated. To update geocoding, remove the lat\/long.",
diff --git a/seed/static/seed/locales/es.json b/seed/static/seed/locales/es.json
@@ -124,6 +124,7 @@
     "Are you sure you want to delete the filter group": "¿Está seguro de que desea eliminar el grupo de filtros?",
     "Are you sure you want to unmerge these properties and then merge with the selected properties?": "¿Está seguro de que desea deshacer la fusión de estas propiedades y, a continuación, fusionarlas con las propiedades seleccionadas?",
     "Are you sure you want to unmerge these tax lots and then merge with the selected tax lots?": "¿Está seguro de que desea deshacer la fusión de estos lotes fiscales y, a continuación, fusionarlos con los lotes fiscales seleccionados?",
+    "Are you sure you want to unmerge these tax lots?": "¿Está seguro de que desea separar estos lotes de impuestos?",
     "Area": "Zona",
     "Area Column": "Columna de área",
     "Area Target Column": "Área Columna objetivo",
@@ -966,6 +967,7 @@
     "Properties failed to update:": "No se han podido actualizar las propiedades:",
     "Properties updated:": "Propiedades actualizadas:",
     "Properties with Data": "Propiedades con datos",
+    "Properties with elements cannot be unmerged.": "Las propiedades con elementos no se pueden separar.",
     "Property": "Propiedad",
     "Property Classification": "Clasificación de la propiedad",
     "Property Column List Profiles": "Perfiles de la lista de columnas de propiedades",
@@ -1335,6 +1337,7 @@
     "UBID already exists": "El UBID ya existe",
     "UBID comparison result:": "Resultado de la comparación de UBID:",
     "UBID thresholds are between 0.0 and 1.0": "Los umbrales UBID se sitúan entre 0,0 y 1,0",
+    "UNMERGE_PROPERTIES_MODAL": "¿Está seguro de que desea desvincular estas propiedades? La acción de desvincular conservará los datos del medidor en ambas propiedades. Revise los datos del medidor en ambas propiedades una vez que se hayan desvinculado.",
     "UPDATE_DERIVED_DATA_TEXT_1": "Pulse el botón \"Iniciar actualización\" para iniciar el proceso de recálculo de los datos almacenados en las columnas derivadas para las propiedades y lotes fiscales seleccionados. Las columnas derivadas aparecerán en amarillo para indicar que la actualización está en curso.",
     "UPDATE_DERIVED_DATA_TEXT_2": "Tenga en cuenta que mientras las columnas estén en amarillo, los datos pueden no estar actualizados. Actualice la página para actualizar el estado de las columnas.",
     "UPDATE_MANUALLY_GEOCODED_INSTRUCTIONS": "Si las propiedades se han geocodificado manualmente, no se actualizarán. Para actualizar la geocodificación, elimine la lat\/long.",
diff --git a/seed/static/seed/locales/fr_CA.json b/seed/static/seed/locales/fr_CA.json
@@ -124,6 +124,7 @@
     "Are you sure you want to delete the filter group": "Êtes-vous sûr de vouloir supprimer le groupe de filtres",
     "Are you sure you want to unmerge these properties and then merge with the selected properties?": "Êtes-vous sûr de vouloir annuler la fusion de ces propriétés et fusionner avec les propriétés sélectionnées?",
     "Are you sure you want to unmerge these tax lots and then merge with the selected tax lots?": "Êtes-vous sûr de vouloir annuler la fusion de ces lots fiscaux pour ensuite fusionner avec les lots d'impôt sélectionnés?",
+    "Are you sure you want to unmerge these tax lots?": "Êtes-vous sûr de vouloir dissocier ces lots fiscaux ?",
     "Area": "Superficie",
     "Area Column": "Colonne de Superficie",
     "Area Target Column": "Colonne Cible de Superficie",
@@ -966,6 +967,7 @@
     "Properties failed to update:": "Les propriétés n'ont pas pu être mises à jour :",
     "Properties updated:": "Propriétés mises à jour :",
     "Properties with Data": "Propriétés avec données",
+    "Properties with elements cannot be unmerged.": "Les propriétés avec des éléments ne peuvent pas être dissociées.",
     "Property": "Propriété",
     "Property Classification": "Classification de la propriété",
     "Property Column List Profiles": "Paramètres de la liste de propriétés",
@@ -1335,6 +1337,7 @@
     "UBID already exists": "UBID existe déjà",
     "UBID comparison result:": "Résultat de la comparaison UBID :",
     "UBID thresholds are between 0.0 and 1.0": "Les seuils UBID sont compris entre 0,0 et 1,0",
+    "UNMERGE_PROPERTIES_MODAL": "Êtes-vous sûr de vouloir dissocier ces propriétés? L'action de dissociation conservera les données de compteur sur les deux propriétés. Vérifiez les données de compteur sur les deux propriétés une fois qu'elles sont dissociées.",
     "UPDATE_DERIVED_DATA_TEXT_1": "Appuyez sur le bouton « Démarrer la mise à jour » ci-dessous pour commencer le processus de recalcul des données stockées dans les colonnes dérivées pour les propriétés et les lots fiscaux sélectionnés. Les colonnes dérivées apparaîtront en jaune pour indiquer que la mise à jour est en cours.",
     "UPDATE_DERIVED_DATA_TEXT_2": "Notez que pendant que les colonnes sont jaunes, les données peuvent ne pas être à jour. Actualisez la page pour actualiser l'état des colonnes.",
     "UPDATE_MANUALLY_GEOCODED_INSTRUCTIONS": "Si les propriétés ont été géocodées manuellement, elles ne seront pas mises à jour. Pour mettre à jour le géocodage, supprimez le lat \/ long.",
diff --git a/seed/static/seed/partials/unmerge_modal.html b/seed/static/seed/partials/unmerge_modal.html
@@ -3,7 +3,7 @@ <h4 ng-if="::inventory_type === 'properties'" class="modal-title" translate>Unme
   <h4 ng-if="::inventory_type === 'taxlots'" class="modal-title" translate>Unmerge Tax Lots</h4>
 </div>
 <div class="modal-body row">
-  <div ng-if="::inventory_type === 'properties' && !has_elements" class="col-sm-12" translate>Are you sure you want to unmerge these properties?</div>
+  <div ng-if="::inventory_type === 'properties' && !has_elements" class="col-sm-12" translate>UNMERGE_PROPERTIES_MODAL</div>
   <div ng-if="::inventory_type === 'properties' && has_elements" class="col-sm-12" translate>Properties with elements cannot be unmerged.</div>
   <div ng-if="::inventory_type === 'taxlots'" class="col-sm-12" translate>Are you sure you want to unmerge these tax lots?</div>
 </div>
diff --git a/seed/static/seed/partials/update_derived_data_modal.html b/seed/static/seed/partials/update_derived_data_modal.html
@@ -2,11 +2,26 @@
   <h4 class="modal-title" id="ModalLabel" translate>Update Derived Data</h4>
 </div>
 <div class="modal-body" style="padding-bottom: 0">
-  <p translate>UPDATE_DERIVED_DATA_TEXT_1</p>
+  <div ng-show="status === 'ready'">
+    <p translate>UPDATE_DERIVED_DATA_TEXT_1</p>
 
-  <p translate>UPDATE_DERIVED_DATA_TEXT_2</p>
+    <p translate>UPDATE_DERIVED_DATA_TEXT_2</p>
+  </div>
+
+  <div ng-show="status === 'in progress'" class="container-fluid">
+    <div class="row">
+      <div class="col-sm-12">
+        Updating derived data...
+        <div class="progress_bar_container">
+          <uib-progressbar class="progress-striped active" value="uploader.progress" type="success"></uib-progressbar>
+          <div class="progress_bar_copy_bottom">{$ uploader.progress | number:0 $}% {$:: 'Complete' | translate $} {$ uploader.status_message ? ': ' + uploader.status_message : '' $}</div>
+        </div>
+      </div>
+    </div>
+  </div>
 </div>
+
 <div class="modal-footer">
-  <button type="button" class="btn btn-default" ng-click="cancel()" translate>Cancel</button>
-  <button type="button" class="btn btn-danger" ng-click="begin_update()" translate>Begin Update</button>
+  <button type="button" class="btn btn-default" ng-click="cancel()" ng-disabled="status !== 'ready'" translate>Cancel</button>
+  <button type="button" class="btn btn-danger" ng-click="begin_update()" ng-show="status === 'ready'" translate>Begin Update</button>
 </div>
diff --git a/seed/tasks.py b/seed/tasks.py
diff --git a/seed/views/v3/tax_lot_properties.py b/seed/views/v3/tax_lot_properties.py
