[ENG-8462] Institution setup fixes (#11241)

* create monthly reports when institution is created

* better exception handling; async generate report

* fix test

* handle deactivated institutions; minor fixes

Author: antkryt

admin/institutions/urls.py

@@ -9,6 +9,7 @@
     re_path(r'^import/$', views.ImportInstitution.as_view(), name='import'),
     re_path(r'^(?P<institution_id>[0-9]+)/$', views.InstitutionDetail.as_view(), name='detail'),
     re_path(r'^(?P<institution_id>[0-9]+)/export/$', views.InstitutionExport.as_view(), name='export'),
+    re_path(r'^(?P<institution_id>[0-9]+)/monthly_report/$', views.InstitutionMonthlyReporterDo.as_view(), name='monthly_report'),
     re_path(r'^(?P<institution_id>[0-9]+)/delete/$', views.DeleteInstitution.as_view(), name='delete'),
     re_path(r'^(?P<institution_id>[0-9]+)/deactivate/$', views.DeactivateInstitution.as_view(), name='deactivate'),
     re_path(r'^(?P<institution_id>[0-9]+)/reactivate/$', views.ReactivateInstitution.as_view(), name='reactivate'),

admin/institutions/views.py

@@ -1,4 +1,5 @@
 import json
+from dateutil.parser import isoparse
 
 from django.contrib import messages
 from django.contrib.auth.mixins import PermissionRequiredMixin
@@ -15,6 +16,9 @@
 from admin.base.forms import ImportFileForm
 from admin.institutions.forms import InstitutionForm, InstitutionalMetricsAdminRegisterForm
 from osf.models import Institution, Node, OSFUser
+from osf.metrics.utils import YearMonth
+from osf.metrics.reporters import AllMonthlyReporters
+from osf.management.commands.monthly_reporters_go import monthly_reporter_do
 
 
 class InstitutionList(PermissionRequiredMixin, ListView):
@@ -129,6 +133,38 @@ def get(self, request, *args, **kwargs):
         return response
 
 
+class InstitutionMonthlyReporterDo(PermissionRequiredMixin, View):
+    permission_required = 'osf.view_institution'
+    raise_exception = True
+
+    def post(self, request, *args, **kwargs):
+        institution_id = self.kwargs.get('institution_id')
+        try:
+            institution = Institution.objects.get_all_institutions().get(id=institution_id)
+        except Institution.DoesNotExist:
+            raise Http404(f"Institution with id {institution_id} is not found or deactivated.")
+
+        monthly_report_date = request.POST.get('monthly_report_date', None)
+        if monthly_report_date:
+            try:
+                monthly_report_date = isoparse(monthly_report_date).date()
+            except ValueError as exc:
+                messages.error(request, str(exc))
+                return redirect('institutions:detail', institution_id=institution.id)
+        else:
+            messages.error(request, 'Report date cannot be none.')
+            return redirect('institutions:detail', institution_id=institution.id)
+
+        monthly_reporter_do.apply_async(kwargs={
+            'yearmonth': str(YearMonth.from_date(monthly_report_date)),
+            'reporter_key': request.POST.get('monthly_reporter', None),
+            'report_kwargs': {'institution_pk': institution.id},
+        })
+
+        messages.success(request, 'Monthly reporter successfully went.')
+        return redirect('institutions:detail', institution_id=institution.id)
+
+
 class CreateInstitution(PermissionRequiredMixin, CreateView):
     permission_required = 'osf.change_institution'
     raise_exception = True
@@ -141,6 +177,18 @@ def get_context_data(self, *args, **kwargs):
         kwargs['import_form'] = ImportFileForm()
         return super().get_context_data(*args, **kwargs)
 
+    def form_valid(self, form):
+        response = super().form_valid(form)
+
+        # Make a report after Institution is created
+        monthly_reporter_do.apply_async(kwargs={
+            'yearmonth': str(YearMonth.from_date(self.object.created)),
+            'reporter_key': AllMonthlyReporters.INSTITUTIONAL_SUMMARY.name,
+            'report_kwargs': {'institution_pk': self.object.id},
+        })
+
+        return response
+
 
 class InstitutionNodeList(PermissionRequiredMixin, ListView):
     template_name = 'institutions/node_list.html'

admin/management/views.py

@@ -130,6 +130,7 @@ def post(self, request, *args, **kwargs):
                 if report_date is not None
                 else ''
             ),
+            reporter_key=request.POST.get('monthly_reporter', '')
         )
 
         if errors:

admin/templates/institutions/detail.html

@@ -9,9 +9,17 @@
 {% endblock title %}
 {% block content %}
     <div class="container-fluid">
+        <ul class="messages">
+            {% for message in messages %}
+                <li{% if message.tags %} class="{{ message.tags }}"{% endif %}>{{ message }}</li>
+            {% endfor %}
+        </ul>
         <div class="row">
             <div class="col-md-12">
                 <a class="btn btn-primary" href={% url 'institutions:export' institution.id %}>Export institution metadata</a>
+                <a data-toggle="modal" data-target="#monthlyReportModal" class="btn btn-primary">
+                    Run monthly report
+                </a>
                 {%  if perms.osf.delete_institution %}
                 <a class="btn btn-danger" href={% url 'institutions:delete' institution.id %}>Delete institution</a>
                 {%  endif %}
@@ -100,6 +108,33 @@ <h4>Import from JSON</h4>
             </div>
         </div>
     </div>
+
+    <div class="modal" id="monthlyReportModal">
+        <div class="modal-dialog">
+            <div class="modal-content">
+                <div class="modal-header">
+                    <button type="button" class="close" data-dismiss="modal">x</button>
+                    <h3>Are you sure you want to run monthly report for this institution?</h3>
+                </div>
+                <div style="text-align: center">
+                    <form id="run-monthly-report-form" method="post" action={% url 'institutions:monthly_report' institution.id %}>
+                        {% csrf_token %}
+                        <label for="monthly_report_date">
+                        Report date:
+                        </label>
+                        <input type="date" name="monthly_report_date" id="monthly_report_date"/>
+                        <input type="text" value="INSTITUTIONAL_SUMMARY" name="monthly_reporter" id="monthly_reporter" hidden/>
+                    </form>
+                </div>
+                <div class="modal-footer">
+                    <input class="btn btn-danger" type="submit" form="run-monthly-report-form" value="Confirm" />
+                    <button type="button" class="btn btn-default" data-dismiss="modal">
+                        Cancel
+                    </button>
+                </div>
+            </div>
+        </div>
+    </div>
 {% endblock content %}
 
 {% block bottom_js %}

admin/templates/management/commands.html

@@ -96,7 +96,7 @@ <h4><u>Daily Reporters, Go!</u></h4>
             </section>
             <section>
                 <h4><u>Monthly Reporters, Go!</u></h4>
-                <p>Use this management command to run all daily metrics reports.</p>
+                <p>Use this management command to run all monthly metrics reports.</p>
                 <form method="post"
                       action="{% url 'management:monthly_reporters_go'%}">
                     {% csrf_token %}

admin_tests/institutions/test_views.py

@@ -1,10 +1,12 @@
 import json
 import pytest
+from unittest import mock
 
 from django.test import RequestFactory
 from django.contrib.auth.models import Permission
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import PermissionDenied
+from osf_tests.factories import faker, FakeList
 
 from tests.base import AdminTestCase
 from osf_tests.factories import (
@@ -199,6 +201,32 @@ def test_get_view(self):
         res = self.view.get(self.request)
         assert res.status_code == 200
 
+    @mock.patch('admin.institutions.views.monthly_reporter_do.apply_async')
+    def test_monthly_reporter_called_on_create(self, mock_monthly_reporter_do):
+        data = {
+            '_id': 'wqhx1',
+            'name': 'company',
+            'login_url': faker.url(),
+            'logout_url': faker.url(),
+            'identifier_domain': faker.url(),
+            'ror_uri': faker.url(),
+            'domains': FakeList('url', n=3),
+            'email_domains': FakeList('domain_name', n=1),
+            'orcid_record_verified_source': '',
+            'delegation_protocol': '',
+            'institutional_request_access_enabled': False
+        }
+        form = InstitutionForm(data=data)
+        assert form.is_valid()
+
+        view = setup_form_view(self.base_view(), self.request, form=form)
+        view.object = form.save()
+        view.form_valid(form)
+
+        mock_monthly_reporter_do.assert_called_once()
+        _, kwargs = mock_monthly_reporter_do.call_args
+        assert kwargs['kwargs']['report_kwargs']['institution_pk'] == view.object.id
+
 
 class TestAffiliatedNodeList(AdminTestCase):
     def setUp(self):

api/institutions/views.py

@@ -624,7 +624,11 @@ def get_object(self):
             return object
 
     def get_default_search(self):
-        yearmonth = InstitutionMonthlySummaryReport.most_recent_yearmonth()
+        base_search = InstitutionMonthlySummaryReport.search().filter(
+            'term',
+            institution_id=self.get_institution()._id,
+        )
+        yearmonth = InstitutionMonthlySummaryReport.most_recent_yearmonth(base_search=base_search)
         if report_date_str := self.request.query_params.get('report_yearmonth'):
             try:
                 yearmonth = YearMonth.from_str(report_date_str)
@@ -634,12 +638,9 @@ def get_default_search(self):
         if yearmonth is None:
             return None
 
-        return InstitutionMonthlySummaryReport.search().filter(
+        return base_search.filter(
             'term',
             report_yearmonth=str(yearmonth),
-        ).filter(
-            'term',
-            institution_id=self.get_institution()._id,
         )
 
 

osf/management/commands/monthly_reporters_go.py

@@ -79,7 +79,12 @@ def schedule_monthly_reporter(
     retry_backoff=True,
 )
 def monthly_reporter_do(reporter_key: str, yearmonth: str, report_kwargs: dict):
-    _reporter = _get_reporter(reporter_key, yearmonth)
+    try:
+        _reporter = _get_reporter(reporter_key, yearmonth)
+    except KeyError as exc:
+        framework.sentry.log_exception(exc)
+        return
+
     _report = _reporter.report(**report_kwargs)
     if _report is not None:
         _report.report_yearmonth = _reporter.yearmonth

osf/metrics/reports.py

@@ -90,7 +90,7 @@ class Meta:
     @classmethod
     def most_recent_yearmonth(cls, base_search=None) -> YearMonth | None:
         _search = base_search or cls.search()
-        _search = _search.update_from_dict({'size': 0})  # omit hits
+        _search = _search[0:0]  # omit hits
         _search.aggs.bucket(
             'agg_most_recent_yearmonth',
             'terms',
@@ -101,8 +101,12 @@ def most_recent_yearmonth(cls, base_search=None) -> YearMonth | None:
         _response = _search.execute()
         if not _response.aggregations:
             return None
-        (_bucket,) = _response.aggregations.agg_most_recent_yearmonth.buckets
-        return _bucket.key
+
+        buckets = _response.aggregations.agg_most_recent_yearmonth.buckets
+        if not buckets:
+            return None
+
+        return buckets[0].key
 
     def __init_subclass__(cls, **kwargs):
         super().__init_subclass__(**kwargs)