Add progress_count and progress_total to Project model, compute on POST

when using the API and add progress to the project overview (#488)

.eslintrc.js

@@ -22,6 +22,7 @@ module.exports = {
   "plugins": [
     "react"
   ],
+  "ignorePatterns": ["**/static/**/*.js"],
   "rules": {
     "indent": "off",
     "no-empty-pattern": "off",
@@ -42,5 +43,5 @@ module.exports = {
     "react": {
       "version": "detect"
     }
-  }
+  },
 }

rdmo/core/static/core/js/core.js

@@ -16,6 +16,13 @@ angular.module('core', ['ngResource'])
         method: 'PUT',
         params: {}
     };
+    $resourceProvider.defaults.actions.postAction = {
+        method: 'POST',
+        params: {
+            id: '@id',
+            detail_action: '@detail_action'
+        }
+    };
 }])
 
 .filter('capitalize', function() {

rdmo/projects/migrations/0059_project_progress.py

@@ -0,0 +1,23 @@
+# Generated by Django 3.2.19 on 2023-08-24 09:38
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('projects', '0058_meta'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='project',
+            name='progress_count',
+            field=models.IntegerField(help_text='The number of values for the progress bar.', null=True, verbose_name='Progress count'),
+        ),
+        migrations.AddField(
+            model_name='project',
+            name='progress_total',
+            field=models.IntegerField(help_text='The total number of expected values for the progress bar.', null=True, verbose_name='Progress total'),
+        ),
+    ]

rdmo/projects/models/project.py

@@ -14,7 +14,6 @@
 from rdmo.views.models import View
 
 from ..managers import ProjectManager
-from ..progress import get_progress
 
 
 class Project(MPTTModel, Model):
@@ -62,6 +61,16 @@ class Project(MPTTModel, Model):
         verbose_name=_('Views'),
         help_text=_('The views that will be used for this project.')
     )
+    progress_total = models.IntegerField(
+        null=True,
+        verbose_name=_('Progress total'),
+        help_text=_('The total number of expected values for the progress bar.')
+    )
+    progress_count = models.IntegerField(
+        null=True,
+        verbose_name=_('Progress count'),
+        help_text=_('The number of values for the progress bar.')
+    )
 
     class Meta:
         ordering = ('tree_id', 'level', 'title')
@@ -83,21 +92,6 @@ def clean(self):
                 'parent': [_('A project may not be moved to be a child of itself or one of its descendants.')]
             })
 
-    @property
-    def progress(self):
-        values, total = get_progress(self)
-
-        try:
-            ratio = values / total
-        except ZeroDivisionError:
-            ratio = 0
-
-        return {
-            'total': total,
-            'values': values,
-            'ratio': ratio
-        }
-
     @property
     def catalog_uri(self):
         if self.catalog is not None:

rdmo/projects/progress.py

@@ -6,7 +6,7 @@
 from rdmo.questions.models import Catalog, Section, Page, QuestionSet, Question
 
 
-def get_progress(project, snapshot=None):
+def compute_progress(project, snapshot=None):
     # get all values for this project and snapshot
     project_values = project.values.filter(snapshot=snapshot).select_related('attribute', 'option')
 

rdmo/projects/static/projects/js/project_questions/services.js

@@ -933,13 +933,11 @@ angular.module('project_questions')
                 }
             } else {
                 // update progress
-                resources.projects.get({
+                resources.projects.postAction({
                     id: service.project.id,
                     detail_action: 'progress'
                 }, function(response) {
-                    if (service.progress.values != response.values) {
-                        service.progress = response
-                    }
+                    service.progress = response
                 });
 
                 // check if we need to refresh the site

rdmo/projects/templates/projects/project_questions_progress.html

@@ -3,8 +3,8 @@
 <div class="progress project-progress">
     <div class="progress-bar" role="progressbar" style="width: {$ service.progress.ratio * 100 $}%;">
         <span ng-show="service.progress.ratio > 0.25">
-            {% blocktrans trimmed with values='{$ service.progress.values $}' total='{$ service.progress.total $}' %}
-                {{ values }} of {{ total }}
+            {% blocktrans trimmed with count='{$ service.progress.count $}' total='{$ service.progress.total $}' %}
+                {{ count }} of {{ total }}
             {% endblocktrans %}
         </span>
     </div>

rdmo/projects/templates/projects/projects.html

@@ -124,6 +124,7 @@ <h1>{% trans 'My Projects' %}</h1>
         <thead>
             <tr>
                 <th style="width: 60%;">{% trans 'Name' %}</th>
+                <th style="width: 20%;">{% trans 'Progress' %}</th>
                 <th style="width: 10%;">{% trans 'Role' %}</th>
                 <th style="width: 23%;">{% trans 'Last changed' %}</th>
                 <th style="width: 7%;"></th>
@@ -138,6 +139,9 @@ <h1>{% trans 'My Projects' %}</h1>
                     <strong>{{ project.title }}</strong>
                     </a>
                 </td>
+                <td>
+                    {% project_progress project %}
+                </td>
                 <td>
                     {{ project.role|projects_role }}
                 </td>

rdmo/projects/templates/projects/site_projects.html

@@ -61,7 +61,8 @@ <h1>{% blocktrans trimmed with site=request.site %}All projects on {{ site }}{%
     <table class="table projects-table">
         <thead>
             <tr>
-                <th style="width: 50%;">{% trans 'Name' %}</th>
+                <th style="width: 40%;">{% trans 'Name' %}</th>
+                <th style="width: 10%;">{% trans 'Progress' %}</th>
                 <th style="width: 20%;">{% trans 'Created' %}</th>
                 <th style="width: 20%;">{% trans 'Last changed' %}</th>
                 <th style="width: 10%;"></th>
@@ -76,6 +77,9 @@ <h1>{% blocktrans trimmed with site=request.site %}All projects on {{ site }}{%
                     <strong>{{ project.title }}</strong>
                     </a>
                 </td>
+                <td>
+                    {% project_progress project %}
+                </td>
                 <td>
                     {{ project.created }}
                 </td>

rdmo/projects/templatetags/projects_tags.py

@@ -18,6 +18,19 @@ def projects_indent(level):
     return mark_safe('<span class="projects-indent">' + string + '</span>')
 
 
+@register.simple_tag()
+def project_progress(project):
+    if project.progress_count is None or project.progress_total is None:
+        return ''
+
+    try:
+        ratio = project.progress_count / project.progress_total
+    except ZeroDivisionError:
+        ratio = 0
+
+    return f'{ratio:.0%}'
+
+
 @register.filter()
 @stringfilter
 def projects_role(role):

rdmo/projects/views/project.py

@@ -10,7 +10,6 @@
 from django.shortcuts import get_object_or_404, redirect
 from django.urls import reverse_lazy
 from django.utils.decorators import method_decorator
-from django.utils.http import urlencode
 from django.utils.translation import gettext_lazy as _
 from django.views.decorators.csrf import ensure_csrf_cookie
 from django.views.generic import DeleteView, DetailView, TemplateView
@@ -106,8 +105,8 @@ def get_context_data(self, **kwargs):
         context['number_of_filtered_projects'] = context["filter"].qs.count()
         context = set_context_querystring_with_filter_and_page(context)
         context['catalogs'] = Catalog.objects.filter_current_site() \
-                                .filter_group(self.request.user) \
-                                .filter_availability(self.request.user)
+                                             .filter_group(self.request.user) \
+                                             .filter_availability(self.request.user)
         return context
 
 

rdmo/projects/viewsets.py

@@ -29,6 +29,7 @@
                      Project, Snapshot, Value)
 from .permissions import (HasProjectPagePermission, HasProjectPermission,
                           HasProjectsPermission)
+from .progress import compute_progress
 from .serializers.v1 import (IntegrationSerializer, InviteSerializer,
                              IssueSerializer, MembershipSerializer,
                              ProjectIntegrationSerializer,
@@ -154,11 +155,26 @@ def options(self, request, pk=None):
         # if it didn't work return 404
         raise NotFound()
 
-    @action(detail=True, permission_classes=(IsAuthenticated, ))
+    @action(detail=True, methods=['get', 'post'], permission_classes=(HasModelPermission | HasProjectPermission, ))
     def progress(self, request, pk=None):
         project = self.get_object()
-        project.catalog.prefetch_elements()
-        return Response(project.progress)
+
+        if request.method == 'POST' or project.progress_count is None or project.progress_total is None:
+            # compute the progress and store
+            project.catalog.prefetch_elements()
+            project.progress_count, project.progress_total = compute_progress(project)
+            project.save()
+
+        try:
+            ratio = project.progress_count / project.progress_total
+        except ZeroDivisionError:
+            ratio = 0
+
+        return Response({
+            'count': project.progress_count,
+            'total': project.progress_total,
+            'ratio': ratio
+        })
 
     def perform_create(self, serializer):
         project = serializer.save(site=get_current_site(self.request))