[WIP] Impact Notifications

.docker-compose.gv.env

@@ -1,4 +1,4 @@
-ALLOWED_HOSTS="localhost,192.168.168.167"
+ALLOWED_HOSTS="localhost,192.168.168.167,127.0.0.1"
 CORS_ALLOWED_ORIGINS="http://localhost:5000,http://192.168.168.167:5000"
 OSFDB_HOST=192.168.168.167
 POSTGRES_HOST="$OSFDB_HOST"
@@ -7,5 +7,10 @@ OSF_API_BASE_URL="http://192.168.168.167:8000"
 POSTGRES_USER="postgres"
 POSTGRES_DB="gravyvalet"
 SECRET_KEY="secret"
-PYTHONUNBUFFERED=0 # This when set to 0 will allow print statements to be visible in the Docker logs
+PYTHONUNBUFFERED=1 # This when set to 0 will allow print statements to be visible in the Docker logs
+OSF_AUTH_COOKIE_NAME=osf
+OSF_SENSITIVE_DATA_SECRET="TrainglesAre5Squares"
+OSF_SENSITIVE_DATA_SALT="yusaltydough"
+DEBUG=1
+
 

README-docker-compose.md

@@ -350,12 +350,12 @@ docker compose run --rm --service-ports web
 
 - Test a Specific Class
   ```bash
-  docker compose run --rm web python3 -m pytest tests/test_conferences.py::TestProvisionNode
+  docker compose run --rm web python3 -m pytest tests/test_node.py::TestExample:test_example
   ```
 
 - Test a Specific Method
   ```bash
-  docker compose run --rm web python3 -m pytest tests/test_conferences.py::TestProvisionNode::test_upload
+  docker compose run --rm web python3 -m pytest tests/test_node.py::TestExample:test_example
   ```
 
 ## Managing Container State

addons/base/views.py

@@ -36,7 +36,6 @@
 from framework.sentry import log_exception
 from framework.routing import proxy_url
 from framework.transactions.handlers import no_auto_transaction
-from website import mails
 from website import settings
 from addons.base import signals as file_signals
 from addons.base.utils import format_last_known_metadata, get_mfr_url
@@ -54,7 +53,8 @@
     DraftRegistration,
     Guid,
     FileVersionUserMetadata,
-    FileVersion
+    FileVersion,
+    NotificationType
 )
 from osf.metrics import PreprintView, PreprintDownload
 from osf.utils import permissions
@@ -431,11 +431,7 @@ def _enqueue_metrics(file_version, file_node, action, auth, from_mfr=False):
 def _construct_payload(auth, resource, credentials, waterbutler_settings):
 
     if isinstance(resource, Registration):
-        callback_url = resource.api_url_for(
-            'registration_callbacks',
-            _absolute=True,
-            _internal=True
-        )
+        callback_url = resource.callbacks_url
     else:
         callback_url = resource.api_url_for(
             'create_waterbutler_log',
@@ -583,17 +579,17 @@ def create_waterbutler_log(payload, **kwargs):
                 )
 
             if payload.get('email') is True or payload.get('errors'):
-                mails.send_mail(
-                    user.username,
-                    mails.FILE_OPERATION_FAILED if payload.get('errors')
-                    else mails.FILE_OPERATION_SUCCESS,
-                    action=payload['action'],
-                    source_node=source_node,
-                    destination_node=destination_node,
-                    source_path=payload['source']['materialized'],
-                    source_addon=payload['source']['addon'],
-                    destination_addon=payload['destination']['addon'],
-                    osf_support_email=settings.OSF_SUPPORT_EMAIL
+                if payload.get('errors'):
+                    notification_type = NotificationType.Type.FILE_OPERATION_FAILED
+                else:
+                    notification_type = NotificationType.Type.FILE_OPERATION_SUCCESS
+
+                NotificationType.objects.get(
+                    name=notification_type.value,
+                ).emit(
+                    user=user,
+                    subscribed_object=destination_node or node,
+                    event_context=payload,
                 )
 
             if payload.get('errors'):
@@ -613,6 +609,14 @@ def create_waterbutler_log(payload, **kwargs):
     with transaction.atomic():
         file_signals.file_updated.send(target=node, user=user, event_type=action, payload=payload)
 
+    NotificationType.objects.get(
+        name=action,
+    ).emit(
+        user=user,
+        subscribed_object=target_node or node,
+        event_context=metadata,
+    )
+
     return {'status': 'success'}
 
 

addons/wiki/tests/test_views.py

@@ -111,66 +111,6 @@ def test_update_name_invalid(self):
         with pytest.raises(NameInvalidError):
             WikiPage.objects.create_for_node(self.project, invalid_name, 'more valid content', self.auth)
 
-    def test_update_wiki_updates_comments_and_user_comments_viewed_timestamp(self):
-        project = ProjectFactory(creator=self.user, is_public=True)
-        wiki_page = WikiFactory(node=project, page_name='test')
-        wiki = WikiVersionFactory(wiki_page=wiki_page)
-        comment = CommentFactory(node=project, target=Guid.load(wiki_page._id), user=UserFactory())
-
-        # user views comments -- sets user.comments_viewed_timestamp
-        url = project.api_url_for('update_comments_timestamp')
-        res = self.app.put(url, json={
-            'page': 'wiki',
-            'rootId': wiki_page._id
-        }, auth=self.user.auth)
-        assert res.status_code == 200
-        self.user.reload()
-        assert wiki_page._id in self.user.comments_viewed_timestamp
-
-        # user updates the wiki
-        wiki_page.update(self.user, 'Updating wiki')
-        comment.reload()
-        self.user.reload()
-        assert wiki_page._id in self.user.comments_viewed_timestamp
-        assert comment.target.referent._id == wiki_page._id
-
-    # Regression test for https://openscience.atlassian.net/browse/OSF-6138
-    def test_update_wiki_updates_contributor_comments_viewed_timestamp(self):
-        contributor = AuthUserFactory()
-        project = ProjectFactory(creator=self.user, is_public=True)
-        project.add_contributor(contributor)
-        project.save()
-        wiki_page = WikiFactory(node=project, page_name='test')
-        wiki = WikiVersionFactory(wiki_page=wiki_page)
-        comment = CommentFactory(node=project, target=Guid.load(wiki_page._id), user=self.user)
-
-        # user views comments -- sets user.comments_viewed_timestamp
-        url = project.api_url_for('update_comments_timestamp')
-        res = self.app.put(url, json={
-            'page': 'wiki',
-            'rootId': wiki_page._id
-        }, auth=self.user.auth)
-        assert res.status_code == 200
-        self.user.reload()
-        assert wiki_page._id in self.user.comments_viewed_timestamp
-
-        # contributor views comments -- sets contributor.comments_viewed_timestamp
-        res = self.app.put(url, json={
-            'page': 'wiki',
-            'rootId': wiki_page._id
-        }, auth=contributor.auth)
-        contributor.reload()
-        assert wiki_page._id in contributor.comments_viewed_timestamp
-
-        # user updates the wiki
-        wiki_page.update(self.user, 'Updating wiki')
-        comment.reload()
-        contributor.reload()
-
-        new_version_id = WikiVersion.objects.get_for_node(project, 'test')._id
-        assert wiki_page._id in contributor.comments_viewed_timestamp
-        assert comment.target.referent._id == wiki_page._id
-
     # Regression test for https://openscience.atlassian.net/browse/OSF-8584
     def test_no_read_more_when_less_than_400_character(self):
         wiki_content = '1234567'

admin/nodes/urls.py

@@ -27,10 +27,12 @@
     re_path(r'^(?P<guid>[a-z0-9]+)/reindex_share_node/$', views.NodeReindexShare.as_view(), name='reindex-share-node'),
     re_path(r'^(?P<guid>[a-z0-9]+)/reindex_elastic_node/$', views.NodeReindexElastic.as_view(),
         name='reindex-elastic-node'),
-    re_path(r'^(?P<guid>[a-z0-9]+)/restart_stuck_registrations/$', views.RestartStuckRegistrationsView.as_view(),
-        name='restart-stuck-registrations'),
     re_path(r'^(?P<guid>[a-z0-9]+)/remove_stuck_registrations/$', views.RemoveStuckRegistrationsView.as_view(),
         name='remove-stuck-registrations'),
+    re_path(r'^(?P<guid>[a-z0-9]+)/check_archive_status/$', views.CheckArchiveStatusRegistrationsView.as_view(),
+        name='check-archive-status'),
+    re_path(r'^(?P<guid>[a-z0-9]+)/force_archive_registration/$', views.ForceArchiveRegistrationsView.as_view(),
+        name='force-archive-registration'),
     re_path(r'^(?P<guid>[a-z0-9]+)/remove_user/(?P<user_id>[a-z0-9]+)/$', views.NodeRemoveContributorView.as_view(),
         name='remove-user'),
     re_path(r'^(?P<guid>[a-z0-9]+)/modify_storage_usage/$', views.NodeModifyStorageUsage.as_view(),

admin/nodes/views.py

@@ -1,4 +1,5 @@
 import pytz
+from enum import Enum
 from datetime import datetime
 from framework import status
 
@@ -26,7 +27,7 @@
 from api.share.utils import update_share
 from api.caching.tasks import update_storage_usage_cache
 
-from osf.exceptions import NodeStateError
+from osf.exceptions import NodeStateError, RegistrationStuckError
 from osf.models import (
     OSFUser,
     NodeLog,
@@ -672,44 +673,97 @@ def post(self, request, *args, **kwargs):
         return redirect(self.get_success_url())
 
 
-class RestartStuckRegistrationsView(NodeMixin, TemplateView):
-    """ Allows an authorized user to restart a registrations archive process.
+class RemoveStuckRegistrationsView(NodeMixin, View):
+    """ Allows an authorized user to remove a registrations if it's stuck in the archiving process.
     """
-    template_name = 'nodes/restart_registrations_modal.html'
     permission_required = ('osf.view_node', 'osf.change_node')
 
     def post(self, request, *args, **kwargs):
-        # Prevents circular imports that cause admin app to hang at startup
-        from osf.management.commands.force_archive import archive, verify
         stuck_reg = self.get_object()
-        if verify(stuck_reg):
-            try:
-                archive(stuck_reg)
-                messages.success(request, 'Registration archive processes has restarted')
-            except Exception as exc:
-                messages.error(request, f'This registration cannot be unstuck due to {exc.__class__.__name__} '
-                                        f'if the problem persists get a developer to fix it.')
+        if Registration.find_failed_registrations().filter(id=stuck_reg.id).exists():
+            stuck_reg.delete_registration_tree(save=True)
+            messages.success(request, 'The registration has been deleted')
         else:
             messages.error(request, 'This registration may not technically be stuck,'
                                     ' if the problem persists get a developer to fix it.')
 
         return redirect(self.get_success_url())
 
 
-class RemoveStuckRegistrationsView(NodeMixin, TemplateView):
-    """ Allows an authorized user to remove a registrations if it's stuck in the archiving process.
+class CheckArchiveStatusRegistrationsView(NodeMixin, View):
+    """Allows an authorized user to check a registration archive status.
+    """
+    permission_required = ('osf.view_node', 'osf.change_node')
+
+    def get(self, request, *args, **kwargs):
+        # Prevents circular imports that cause admin app to hang at startup
+        from osf.management.commands.force_archive import check
+
+        registration = self.get_object()
+
+        if registration.archived:
+            messages.success(request, f"Registration {registration._id} is archived.")
+            return redirect(self.get_success_url())
+
+        try:
+            archive_status = check(registration)
+            messages.success(request, archive_status)
+        except RegistrationStuckError as exc:
+            messages.error(request, str(exc))
+
+        return redirect(self.get_success_url())
+
+
+class CollisionMode(Enum):
+    NONE: str = 'none'
+    SKIP: str = 'skip'
+    DELETE: str = 'delete'
+
+
+class ForceArchiveRegistrationsView(NodeMixin, View):
+    """Allows an authorized user to force archive registration.
     """
-    template_name = 'nodes/remove_registrations_modal.html'
     permission_required = ('osf.view_node', 'osf.change_node')
 
     def post(self, request, *args, **kwargs):
-        stuck_reg = self.get_object()
-        if Registration.find_failed_registrations().filter(id=stuck_reg.id).exists():
-            stuck_reg.delete_registration_tree(save=True)
-            messages.success(request, 'The registration has been deleted')
+        # Prevents circular imports that cause admin app to hang at startup
+        from osf.management.commands.force_archive import verify, archive, DEFAULT_PERMISSIBLE_ADDONS
+
+        registration = self.get_object()
+        force_archive_params = request.POST
+
+        collision_mode = force_archive_params.get('collision_mode', CollisionMode.NONE.value)
+        delete_collision = CollisionMode.DELETE.value == collision_mode
+        skip_collision = CollisionMode.SKIP.value == collision_mode
+
+        allow_unconfigured = force_archive_params.get('allow_unconfigured', False)
+
+        addons = set(force_archive_params.getlist('addons', []))
+        addons.update(DEFAULT_PERMISSIBLE_ADDONS)
+
+        try:
+            verify(registration, permissible_addons=addons, raise_error=True)
+        except ValidationError as exc:
+            messages.error(request, str(exc))
+            return redirect(self.get_success_url())
+
+        dry_mode = force_archive_params.get('dry_mode', False)
+
+        if dry_mode:
+            messages.success(request, f"Registration {registration._id} can be archived.")
         else:
-            messages.error(request, 'This registration may not technically be stuck,'
-                                    ' if the problem persists get a developer to fix it.')
+            try:
+                archive(
+                    registration,
+                    permissible_addons=addons,
+                    allow_unconfigured=allow_unconfigured,
+                    skip_collision=skip_collision,
+                    delete_collision=delete_collision,
+                )
+                messages.success(request, 'Registration archive process has finished.')
+            except Exception as exc:
+                messages.error(request, f'This registration cannot be archived due to {exc.__class__.__name__}: {str(exc)}. '
+                                        f'If the problem persists get a developer to fix it.')
 
         return redirect(self.get_success_url())
 

admin/notifications/views.py

@@ -1,11 +1,11 @@
-from osf.models.notifications import NotificationSubscription
+from osf.models.notification import NotificationSubscription
 from django.db.models import Count
 
 def delete_selected_notifications(selected_ids):
     NotificationSubscription.objects.filter(id__in=selected_ids).delete()
 
 def detect_duplicate_notifications(node_id=None):
-    query = NotificationSubscription.objects.values('_id').annotate(count=Count('_id')).filter(count__gt=1)
+    query = NotificationSubscription.objects.annotate(count=Count('id')).filter(count__gt=1)
     if node_id:
         query = query.filter(node_id=node_id)
 

admin/preprints/urls.py

@@ -13,8 +13,10 @@
     re_path(r'^(?P<guid>\w+)/change_provider/$', views.PreprintProviderChangeView.as_view(), name='preprint-provider'),
     re_path(r'^(?P<guid>\w+)/machine_state/$', views.PreprintMachineStateView.as_view(), name='preprint-machine-state'),
     re_path(r'^(?P<guid>\w+)/reindex_share_preprint/$', views.PreprintReindexShare.as_view(), name='reindex-share-preprint'),
+    re_path(r'^(?P<guid>\w+)/reversion_preprint/$', views.PreprintReVersion.as_view(), name='re-version-preprint'),
     re_path(r'^(?P<guid>\w+)/remove_user/(?P<user_id>[a-z0-9]+)/$', views.PreprintRemoveContributorView.as_view(), name='remove-user'),
     re_path(r'^(?P<guid>\w+)/make_private/$', views.PreprintMakePrivate.as_view(), name='make-private'),
+    re_path(r'^(?P<guid>\w+)/fix_editing/$', views.PreprintFixEditing.as_view(), name='fix-editing'),
     re_path(r'^(?P<guid>\w+)/make_public/$', views.PreprintMakePublic.as_view(), name='make-public'),
     re_path(r'^(?P<guid>\w+)/remove/$', views.PreprintDeleteView.as_view(), name='remove'),
     re_path(r'^(?P<guid>\w+)/restore/$', views.PreprintDeleteView.as_view(), name='restore'),