Add banner for project managers, give priority to roles within locale #3422

flodolo · 2024-10-21T14:49:05Z

This adds a banner for users defined as "Project Manager" within a project. To reduce the space for confusion, I changed the tooltip of MNGR from "Manager" to "Team Manager".

This also makes the priority of roles consistent between front-end and back-end:

If a user as a role within the locale (translator, manager), we use that for the banner.
If a user is set as PM, we use that even if the user is an Admin.

Finally, this adds CSS variables for users, instead of reusing the ones for translation status.

Fixes #3418

flodolo · 2024-10-21T15:24:15Z

Deleted the previous comment because I realize I was testing the same code 🤦🏼

Follow-up on conversation, I tested with with debug_sql():, if I did it correctly:

1 translation comment: new code 6 db calls, previous 5.
1 source comment: 10 db calls, previous 6.

flodolo · 2024-10-25T07:26:45Z

The second commit fixes #3425

mathjazz

Nice work!

Added a few suggestions for minor improvements, and suggested a couple of ways forward for the PM status.

pontoon/base/models/user.py

pontoon/base/views.py

translate/src/hooks/useUserStatus.ts

mathjazz · 2024-10-25T12:17:23Z

pontoon/base/models/comment.py

+            self.translation.entity.resource.project
+            if self.translation
+            else self.entity.resource.project
+        )


This is not very pretty and not very fast. Similarly, the path to get to project in pontoon/base/views.py, while a bit prettier, is still slow.

There are ways to get to the project object in a more scalable way, e.g. by passing the project from frontend all the way to here or by passing contact = entity.resource.project.contact instead.

My personal preference would be to just use user.groups.filter(name="project_managers").exists() in user_status(), which would show all PMs, regardless of the project, as PMs.

I think that's even better, because when PMs of other projects add translations or comments, they are effectively acting PMs (e.g. because they step in temporarily or because they have managed the project in the past).

My personal preference would be to just use user.groups.filter(name="project_managers").exists() in user_status(), which would show all PMs, regardless of the project, as PMs.

That kind of defies the main point of having the PM banner.

I want the PM banner to show up only within the project for which that user is set as PM, not in all of them.

An admin that is also a PM should show up as an Admin. A person that is not an Admin, but is set as a PM for a specific project, shouldn't be displayed as a PM for any other projects (sure, they're unlikely to do anything outside of their project, but we should still avoid presenting them as something they're not).

Regarding this being slow: can we live with it, considering it's only used when there are actually comments (so, not in the majority of cases)? We have 12k comments for almost 8M translations, and I bet most comments are in group of at least 2 (so, ballpark of 4–5k translations affected? I'm sure actual data can be extracted if we think it's important).

There are ways to get to the project object in a more scalable way, e.g. by passing the project from frontend all the way to here or by passing contact = entity.resource.project.contact instead.

I'd be happy to have someone else pick up this PR and pursue this path, because I'm not sure that's something I can do with my current understanding of the codebase 😉

(investigating the passing contact = entity.resource.project.contact instead in the meantime)

flodolo · 2024-10-25T13:37:59Z

~~My previous version of the code was running without issues, with the last commit (review comments) I see a weird error when I load the first time?~~

EDIT: (solved) The suggest code returns a ProjectQuerySet that can't be serialized as JSON

f'Object of type {o.__class__.__name__} '
[server] TypeError: Object of type ProjectQuerySet is not JSON serializable
[server] [ERROR:django.server] 2024-10-25 13:34:52,066 "GET /user-data/ HTTP/1.1" 500 22414

~~I also tried to move project to the caller code, but that seems to be more complicated than I expected? Does that require a migration?~~

EDIT: removed the diff, because after putting some logging, I realize I was completely off.

flodolo · 2024-10-25T13:47:19Z

pontoon/base/views.py

@@ -886,6 +886,7 @@ def user_data(request):
            "manager_for_locales": list(
                user.managed_locales.values_list("code", flat=True)
            ),
+            "pm_for_projects": user.contact_for.all(),


This returns a ProjectQuerySet. Not sure if there's a better way to get a list of slugs besides list comprehension.

This adds a banner for users defined as "Project Manager" within a project. To reduce the space for confusion, I changed the tooltip of MNGR from "Manager" to "Team Manager". This also makes the priority of roles consistent between front-end and back-end: - If a user as a role within the locale (translator, manager), we use that for the banner. - If a user is set as PM, we use that even if the user is an Admin. Finally, this adds CSS variables for users, instead of reusing the ones for translation status.

flodolo changed the title ~~Add banner for project managers, given priority to role within locale~~ Add banner for project managers, give priority to roles within locale Oct 21, 2024

mathjazz mentioned this pull request Oct 21, 2024

Check if users are managers and translators first, then admins (frontend code) #3421

Closed

flodolo requested a review from mathjazz October 21, 2024 15:19

flodolo force-pushed the test_pm branch from db7112d to 54295c0 Compare October 25, 2024 07:30

mathjazz reviewed Oct 25, 2024

View reviewed changes

flodolo force-pushed the test_pm branch from feacd43 to 9509d06 Compare October 25, 2024 12:46

flodolo commented Oct 25, 2024

View reviewed changes

flodolo added 4 commits October 25, 2024 16:19

Ignore system users for banners

2877a01

Address comments (partial)

a11292e

Fix JSON error

803f941

flodolo force-pushed the test_pm branch from df43474 to 803f941 Compare October 25, 2024 14:19

flodolo mentioned this pull request Oct 26, 2024

Create documentation for banners mozilla-l10n/localizer-documentation#255

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add banner for project managers, give priority to roles within locale #3422

Add banner for project managers, give priority to roles within locale #3422

flodolo commented Oct 21, 2024 •

edited

Loading

flodolo commented Oct 21, 2024

flodolo commented Oct 25, 2024

mathjazz left a comment

mathjazz Oct 25, 2024

flodolo Oct 25, 2024

flodolo Oct 25, 2024 •

edited

Loading

flodolo Oct 25, 2024

flodolo commented Oct 25, 2024 •

edited

Loading

flodolo Oct 25, 2024

Add banner for project managers, give priority to roles within locale #3422

Are you sure you want to change the base?

Add banner for project managers, give priority to roles within locale #3422

Conversation

flodolo commented Oct 21, 2024 • edited Loading

flodolo commented Oct 21, 2024

flodolo commented Oct 25, 2024

mathjazz left a comment

Choose a reason for hiding this comment

mathjazz Oct 25, 2024

Choose a reason for hiding this comment

flodolo Oct 25, 2024

Choose a reason for hiding this comment

flodolo Oct 25, 2024 • edited Loading

Choose a reason for hiding this comment

flodolo Oct 25, 2024

Choose a reason for hiding this comment

flodolo commented Oct 25, 2024 • edited Loading

flodolo Oct 25, 2024

Choose a reason for hiding this comment

flodolo commented Oct 21, 2024 •

edited

Loading

flodolo Oct 25, 2024 •

edited

Loading

flodolo commented Oct 25, 2024 •

edited

Loading