Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

signal handlers for syncing of project views and tasks #1218

Open
wants to merge 8 commits into
base: 2.3.0
Choose a base branch
from

Conversation

MyPyDavid
Copy link
Member

@MyPyDavid MyPyDavid commented Dec 19, 2024

Description

For the settings this PR removes:
PROJECT_REMOVE_VIEWS = True
and adds:

PROJECT_VIEWS_SYNC = True
PROJECT_TASKS_SYNC = True

The projects/handlers.py are refactored into a project/handlers package with a project/handlers/generic_handlers.py module that contains the logic for signal receivers.
It handles the signals for changes in View.catalogs, View.sites, View.groups as well as Task.catalogs, Task.sites, Task.groups and updates the project.views or projects.tasks.

Tests, that only use db view.catalog.add(...) methods and not the client, are included.

Related issues: #966, #1198, #345, #431
Related PRs: #1200

Motivation and Context

ToBeDone:

  • Add tests
  • Decide on automatically adding views to projects (maybe also enabled by setting?)
  • Change to custom signal/include filtering of views based on user permissions
  • Implement adding of views to other signals.
  • ...

How has this been tested?

Screenshots (if appropriate)

@MyPyDavid MyPyDavid self-assigned this Dec 19, 2024
@MyPyDavid MyPyDavid changed the base branch from main to 2.3.0 December 19, 2024 18:34
@MyPyDavid MyPyDavid force-pushed the feat-sync-project-views-and-tasks branch from 15fd305 to d708437 Compare January 7, 2025 17:05
@MyPyDavid MyPyDavid force-pushed the feat-sync-project-views-and-tasks branch from d708437 to 9065876 Compare January 8, 2025 09:54
@MyPyDavid MyPyDavid added this to the RDMO 2.3.0 milestone Jan 8, 2025
from rdmo.projects.models import Project
from rdmo.tasks.models import Task

from .helpers import assert_other_projects_unchanged
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this. We should stick to helpers for tests (and use sparingly) and utils for regular code.

@@ -0,0 +1,10 @@

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think those methods should exist, this should be inline in the handlers (and without the getattr).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could make it more explicit but it would require a lot more boilerplate code.
The signal handlers for View and Task are basically duplicates, so there would be 18 branches instead of the 9 if action == ... in total in the different functions for .catalogs, .sites and .groups .
But we already agreed about this in the meeting right?

Or would there be an extra use case that would require an update on the Issues as well, when project.tasks are handled?

Example for an explicit function

    # Identify the catalogs affected by this change
    catalogs = model.objects.filter(pk__in=pk_set)

    # Determine the projects to be modified
    if action == 'post_add':
        projects = Project.objects.filter_catalogs(catalogs).exclude(views=instance)
        for project in projects:
            project.views.add(instance)

    elif action == 'post_remove':
        projects = Project.objects.filter_catalogs(catalogs).filter(views=instance)
        for project in projects:
            project.views.remove(instance)

    elif action == 'post_clear':
        projects = Project.objects.filter(views=instance)
        for project in projects:
            project.views.remove(instance)

rdmo/projects/handlers/generic_handlers.py Outdated Show resolved Hide resolved
# Conflicts:
#	rdmo/projects/handlers.py
MyPyDavid and others added 2 commits January 20, 2025 17:04
…ange

Fix: remove views from projects if catalog is changed
@@ -15,6 +15,16 @@ class TaskQuestionSet(CurrentSiteQuerySetMixin, GroupsQuerySetMixin, Availabilit
def filter_catalog(self, catalog):
return self.filter(models.Q(catalogs=None) | models.Q(catalogs=catalog))

def filter_available_views_for_project(self, project):
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that a Project should be able to find the views that are available for itself. Do you agree and would this query be correct for that?
I've changed the filter_group a little bit to handle a list of users as well as a single user.

if 'cancel' in self.data:
return self.instance

# if the catalog is the same, do nothing
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to prevent calling the save method if nothing was changed

@@ -160,6 +160,16 @@ class Meta:
'catalog': forms.RadioSelect()
}

def save(self, commit=True, *args, **kwargs):
if 'cancel' in self.data:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this was just still missing right? ;)

return

# Defer synchronization of views
setattr(instance, DEFERRED_SYNC_TASKS_KEY, True)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I needed a pre_save to check if the catalog was changed or not. And afterwards it passes this boolean (with deferred name) to the post_save.
It seems complicated for just a project.save() but could not find another way.

for catalog in view.catalogs.all():
catalog_views_mapping[catalog.id].append({
'id': view.id,
'sites': list(view.sites.values_list('id', flat=True)),
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted to explicitly test this filter filter_available_views_for_project with this mapping but have not implemented that test yet.

@MyPyDavid MyPyDavid requested a review from jochenklar January 22, 2025 09:58
@MyPyDavid MyPyDavid marked this pull request as ready for review January 22, 2025 09:58
@MyPyDavid MyPyDavid changed the title Draft: signal handlers sync project views and tasks signal handlers for syncing of project views and tasks Jan 22, 2025
@MyPyDavid MyPyDavid force-pushed the feat-sync-project-views-and-tasks branch from 55905ba to e19be64 Compare January 24, 2025 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants