Add support to filter out folders and tasks by assignment #622

fabiaserra · 2024-06-10T14:28:28Z

Changelog Description

This adds a toggle in the Launcher, Workfile Manager and a few other widgets that show a folder hierarchy to filter out the folders and tasks shown by whether the user has it assigned or not:

Launcher

With filter

Without filter

Creator

Workfile manager

Scene Inventory

Additional info

~~The next step would be to also filter out the tasks by whether they are assigned or not~~ Done here 6187065

Testing notes:

Open the launcher, workfile manager, creator, scene manager...
Check that a "Show my assignments only" toggle shows up and that when checked, only the folders and tasks that you have assigned show up

client/ayon_core/tools/utils/folders_widget.py

BigRoy · 2024-06-10T15:50:10Z

client/ayon_core/tools/launcher/ui/hierarchy_page.py

@@ -49,12 +49,16 @@ def __init__(self, controller, parent):
        folders_filter_text = PlaceholderLineEdit(folders_wrapper)
        folders_filter_text.setPlaceholderText("Filter folders...")

+        show_only_assignments = QtWidgets.QCheckBox("Show only assignments")


I personally think this wording is a bit weird. It's not showing assignments, it's still showing folder and tasks - but just filters to those assigned to you.

This would already be clearer "Show only assigned folders"
Even more explicit if it refers to assignments to "You" maybe - although that may be just me overthinking this and could be easily added in a tooltip.

I wrote it like this knowing that I was going to use the same filter to filter out tasks, does that now change your thinking about the wording too?

or I could change it to Show only my assignments

Not sure if anyone else's mind trips over this so I'll leave to anyone else to confirm from a UX perspective what they like instead.

I think I do prefer Show only my assignments tbh

client/ayon_core/tools/utils/folders_widget.py

fabiaserra · 2024-06-11T14:55:56Z

~~I'm realizing this needs more work as the FoldersWidget is reused in other tools (i.e. workfile, loader...)~~
EDIT:
Done

…hey don't get applied on all FoldersWidget/TasksWidget uses

…oller

…com/fabiaserra/ayon-core into feature/filter_launcher_assignments

BigRoy · 2024-06-11T17:26:37Z

client/ayon_core/tools/common_models/hierarchy.py

+        If a child folder is assigned (i.e. /season/seq/sh010) this
+        function will also return all the parent entities on the
+        hierarchy (i.e. ["/season", "/season/seq"]) as those are
+        implicitly assigned to the user as well.


I understand reasoning as to why we might want to include parents for filtering for filtering logic where we still want to access the child. But the wording here is a bit weird since I don't understand why "implicitly" it means the parent folder is also assigned to the user - that seems odd and not the case in the frontend?

what do you suggest?

I'd suggest just explaining it as:

If a child folder is assigned (i.e. /season/seq/sh010) this function will also return all the parent entities on the hierarchy (i.e. ["/season", "/season/seq"]) because it contains children folders assigned to the user.

But maybe I'm misinterpreting why it's returning the parent entities?

I understand both the same way but I will change it to your phrasing

BigRoy · 2024-06-11T17:30:31Z

client/ayon_core/tools/launcher/ui/hierarchy_page.py

+        show_only_my_assignments = QtWidgets.QCheckBox(
+            "Show only my assignments"
+        )
+        show_only_my_assignments.setChecked(True)
+


Admittedly now it starts feeling weird there's so much duplicated code for this hierarchy widget that also allows filtering across the codebase - but hey, we likely have good reasons for it :P

yeah... I felt a bit like playing whac-a-mole trying to add it on all the places

MustafaJafar · 2024-06-13T16:20:12Z

This PR made me realize that I never assign myself any tasks. I also have one user AYON Admin 😄.
anyways, I started assigning myself some tasks and I had to restart the launcher to see the updates.
I tried again and said to myself why don't I get back to project and re-select the same project to update the tasks list.
and then I faced this error (endless loop).

Traceback (most recent call last):
  File "E:\Ynput\ayon-launcher\.venv\lib\site-packages\ayon_api\server_api.py", line 199, in raise_for_status
    self._response.raise_for_status()
  File "E:\Ynput\ayon-launcher\.venv\lib\site-packages\requests\models.py", line 1021, in raise_for_status
    raise HTTPError(http_error_msg, response=self)
requests.exceptions.HTTPError: 404 Client Error: Not Found for url: http://192.168.1.4:5000/api/projects/None/hierarchy

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "E:\Ynput\ayon-core\client\ayon_core\lib\events.py", line 333, in process_event
    callback(event)
  File "E:\Ynput\ayon-core\client\ayon_core\tools\utils\folders_widget.py", line 577, in _on_folders_refresh_finished
    self.set_project_name(event["project_name"])
  File "E:\Ynput\ayon-core\client\ayon_core\tools\utils\folders_widget.py", line 456, in set_project_name
    self._refresh_folder_assignments(project_name)
  File "E:\Ynput\ayon-core\client\ayon_core\tools\utils\folders_widget.py", line 572, in _refresh_folder_assignments
    assigned_folder_paths = self._controller.get_assigned_folder_paths(project_name)
  File "E:\Ynput\ayon-core\client\ayon_core\tools\launcher\control.py", line 68, in get_assigned_folder_paths
    return self._hierarchy_model.get_assigned_folder_paths(
  File "E:\Ynput\ayon-core\client\ayon_core\tools\common_models\hierarchy.py", line 310, in get_assigned_folder_paths
    folder_items = self.get_folder_items(project_name, sender)
  File "E:\Ynput\ayon-core\client\ayon_core\tools\common_models\hierarchy.py", line 279, in get_folder_items
    self._refresh_folders_cache(project_name, sender)
  File "E:\Ynput\ayon-core\client\ayon_core\tools\common_models\hierarchy.py", line 573, in _refresh_folders_cache
    folder_items = self._query_folders(project_name)
  File "E:\Ynput\ayon-core\client\ayon_core\tools\common_models\hierarchy.py", line 577, in _query_folders
    hierarchy = ayon_api.get_folders_hierarchy(project_name)
  File "E:\Ynput\ayon-launcher\.venv\lib\site-packages\ayon_api\_api.py", line 785, in get_folders_hierarchy
    return con.get_folders_hierarchy(*args, **kwargs)
  File "E:\Ynput\ayon-launcher\.venv\lib\site-packages\ayon_api\server_api.py", line 3553, in get_folders_hierarchy
    response.raise_for_status()
  File "E:\Ynput\ayon-launcher\.venv\lib\site-packages\ayon_api\server_api.py", line 203, in raise_for_status
    raise HTTPRequestError(message, exc.response)
ayon_api.exceptions.HTTPRequestError: 404 Client Error: Not Found for url: http://192.168.1.4:5000/api/projects/None/hierarchy
WARNING:EventCallback:Failed to execute event callback < EventCallback - _on_folders_refresh_finished > E:\Ynput\ayon-core\client\ayon_core\tools\utils\folders_widget.py
Traceback (most recent call last):
  File "E:\Ynput\ayon-launcher\.venv\lib\site-packages\ayon_api\server_api.py", line 199, in raise_for_status
    self._response.raise_for_status()
  File "E:\Ynput\ayon-launcher\.venv\lib\site-packages\requests\models.py", line 1021, in raise_for_status
    raise HTTPError(http_error_msg, response=self)
requests.exceptions.HTTPError: 404 Client Error: Not Found for url: http://192.168.1.4:5000/api/projects/None/hierarchy

MustafaJafar · 2024-06-13T16:31:11Z

Looks good.
Is there any reason it's enabled by default in the launcher and disabled in the rest ?
Is there a way to specify whether or not to enable that check box by default ?

fabiaserra · 2024-06-13T18:50:48Z

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
File "E:\Ynput\ayon-core\client\ayon_core\lib\events.py", line 333, in process_event
callback(event)
File "E:\Ynput\ayon-core\client\ayon_core\tools\utils\folders_widget.py", line 577, in _on_folders_refresh_finished
self.set_project_name(event["project_name"])
File "E:\Ynput\ayon-core\client\ayon_core\tools\utils\folders_widget.py", line 456, in set_project_name
self._refresh_folder_assignments(project_name)
File "E:\Ynput\ayon-core\client\ayon_core\tools\utils\folders_widget.py", line 572, in _refresh_folder_assignments
assigned_folder_paths = self._controller.get_assigned_folder_paths(project_name)
File "E:\Ynput\ayon-core\client\ayon_core\tools\launcher\control.py", line 68, in get_assigned_folder_paths
return self._hierarchy_model.get_assigned_folder_paths(
File "E:\Ynput\ayon-core\client\ayon_core\tools\common_models\hierarchy.py", line 310, in get_assigned_folder_paths
folder_items = self.get_folder_items(project_name, sender)
File "E:\Ynput\ayon-core\client\ayon_core\tools\common_models\hierarchy.py", line 279, in get_folder_items
self._refresh_folders_cache(project_name, sender)
File "E:\Ynput\ayon-core\client\ayon_core\tools\common_models\hierarchy.py", line 573, in _refresh_folders_cache
folder_items = self._query_folders(project_name)
File "E:\Ynput\ayon-core\client\ayon_core\tools\common_models\hierarchy.py", line 577, in _query_folders
hierarchy = ayon_api.get_folders_hierarchy(project_name)
File "E:\Ynput\ayon-launcher.venv\lib\site-packages\ayon_api_api.py", line 785, in get_folders_hierarchy
return con.get_folders_hierarchy(*args, **kwargs)
File "E:\Ynput\ayon-launcher.venv\lib\site-packages\ayon_api\server_api.py", line 3553, in get_folders_hierarchy
response.raise_for_status()
File "E:\Ynput\ayon-launcher.venv\lib\site-packages\ayon_api\server_api.py", line 203, in raise_for_status
raise HTTPRequestError(message, exc.response)
ayon_api.exceptions.HTTPRequestError: 404 Client Error: Not Found for url: http://192.168.1.4:5000/api/projects/None/hierarchy
WARNING:EventCallback:Failed to execute event callback < EventCallback - _on_folders_refresh_finished > E:\Ynput\ayon-core\client\ayon_core\tools\utils\folders_widget.py
Traceback (most recent call last):
File "E:\Ynput\ayon-launcher.venv\lib\site-packages\ayon_api\server_api.py", line 199, in raise_for_status
self._response.raise_for_status()
File "E:\Ynput\ayon-launcher.venv\lib\site-packages\requests\models.py", line 1021, in raise_for_status
raise HTTPError(http_error_msg, response=self)
requests.exceptions.HTTPError: 404 Client Error: Not Found for url: http://192.168.1.4:5000/api/projects/None/hierarchy

Oh yeah, I have fixed that on my fork, let me push it here as well

EDIT: done here 6e0de41

fabiaserra · 2024-06-13T18:51:46Z

Looks good. Is there any reason it's enabled by default in the launcher and disabled in the rest ?

No reason really, we should probably just expose it as addon settings to let each studio choose their defaults

MustafaJafar · 2024-06-13T19:48:25Z

Oh yeah, I have fixed that on my fork, let me push it here as well

EDIT: done here 6e0de41

The error vanished. Thanks.
I wonder why the update doesn't work.. I had to return and reselect my project to make it work.

fabiaserra · 2024-06-13T20:36:50Z

Oh yeah, I have fixed that on my fork, let me push it here as well
EDIT: done here 6e0de41

The error vanished. Thanks. I wonder why the update doesn't work.. I had to return and reselect my project to make it work.

Good catch, but the reason is because I'm only calling the function _refresh_folder_assignments on the set_project_name function, which only happens on first load. I can add it on the refresh function too and that should do it

fabiaserra · 2024-06-13T20:43:37Z

Good catch, but the reason is because I'm only calling the function _refresh_folder_assignments on the set_project_name function, which only happens on first load. I can add it on the refresh function too and that should do it

Fixed here 6dde360

MustafaJafar

The error is no longer occurs however a new bug shows up.
When closing the launcher after selecting a project and re-opening the launcher, the list becomes empty.

Add a checkbox in Launcher to filter out folders by assignment only

4b7eb89

ynbot added type: feature Adding something new and exciting to the product size/S labels Jun 10, 2024

fabiaserra commented Jun 10, 2024

View reviewed changes

client/ayon_core/tools/utils/folders_widget.py Outdated Show resolved Hide resolved

fabiaserra and others added 2 commits June 10, 2024 16:32

Indent setting up proxy as get_assigned_folder_items could return None

d640dd1

Add support to filter out tasks by assignment as well

6187065

fabiaserra changed the title ~~Add a checkbox in Launcher to filter out folders by assignment only~~ Add support in Launcher to filter out folders and tasks by assignment only Jun 10, 2024

fabiaserra changed the title ~~Add support in Launcher to filter out folders and tasks by assignment only~~ Add support in Launcher to filter out folders and tasks by assignment Jun 10, 2024

BigRoy reviewed Jun 10, 2024

View reviewed changes

farrizabalaga and others added 2 commits June 10, 2024 18:13

Make use of folder paths instead of names

898074e

Rephrase checkbox label to be more intuitive

93b9175

farrizabalaga added 3 commits June 11, 2024 18:54

Add assignment filtering in a few other widgets and fix defaults so t…

2b3c4a4

…hey don't get applied on all FoldersWidget/TasksWidget uses

Other fixes to make assignments filtering work across different widgets

ec61120

Clean up some other changes for assignments feature

c70550d

fabiaserra changed the title ~~Add support in Launcher to filter out folders and tasks by assignment~~ Add support to filter out folders and tasks by assignment Jun 11, 2024

fabiaserra and others added 3 commits June 11, 2024 19:04

Merge branch 'develop' into feature/filter_launcher_assignments

8a867d5

Add missing get_assigned_folder_paths function to SceneInventoryContr…

2cb7023

…oller

Merge branch 'feature/filter_launcher_assignments' of https://github.…

082d304

…com/fabiaserra/ayon-core into feature/filter_launcher_assignments

fabiaserra requested a review from BigRoy June 11, 2024 17:04

BigRoy reviewed Jun 11, 2024

View reviewed changes

fabiaserra and others added 3 commits June 11, 2024 20:35

Update docstring

d7a0744

Update docstrings

9d0df9f

Fix preserving selection

bcf11c0

MustafaJafar requested review from MustafaJafar and iLLiCiTiT June 12, 2024 08:10

Catch error when project isn't set

6e0de41

Add a way to force folder assignments on refresh too

6dde360

MustafaJafar reviewed Jun 27, 2024

View reviewed changes

MustafaJafar added the community Issues and PRs coming from the community members label Jul 2, 2024

dee-ynput assigned iLLiCiTiT Aug 14, 2024

BigRoy mentioned this pull request Sep 10, 2024

AY-6316_Launcher: show only assigned tasks #899

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support to filter out folders and tasks by assignment #622

Add support to filter out folders and tasks by assignment #622

fabiaserra commented Jun 10, 2024 •

edited

Loading

BigRoy Jun 10, 2024

fabiaserra Jun 10, 2024

fabiaserra Jun 10, 2024

BigRoy Jun 10, 2024

fabiaserra Jun 10, 2024

fabiaserra commented Jun 11, 2024 •

edited

Loading

BigRoy Jun 11, 2024

fabiaserra Jun 11, 2024

BigRoy Jun 11, 2024 •

edited

Loading

fabiaserra Jun 11, 2024

BigRoy Jun 11, 2024

fabiaserra Jun 11, 2024

MustafaJafar commented Jun 13, 2024 •

edited

Loading

MustafaJafar commented Jun 13, 2024

fabiaserra commented Jun 13, 2024 •

edited

Loading

fabiaserra commented Jun 13, 2024

MustafaJafar commented Jun 13, 2024

fabiaserra commented Jun 13, 2024 •

edited

Loading

fabiaserra commented Jun 13, 2024

MustafaJafar left a comment

Add support to filter out folders and tasks by assignment #622

Are you sure you want to change the base?

Add support to filter out folders and tasks by assignment #622

Conversation

fabiaserra commented Jun 10, 2024 • edited Loading

Changelog Description

Launcher

Creator

Workfile manager

Scene Inventory

Additional info

Testing notes:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabiaserra commented Jun 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BigRoy Jun 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MustafaJafar commented Jun 13, 2024 • edited Loading

MustafaJafar commented Jun 13, 2024

fabiaserra commented Jun 13, 2024 • edited Loading

fabiaserra commented Jun 13, 2024

MustafaJafar commented Jun 13, 2024

fabiaserra commented Jun 13, 2024 • edited Loading

fabiaserra commented Jun 13, 2024

MustafaJafar left a comment

Choose a reason for hiding this comment

fabiaserra commented Jun 10, 2024 •

edited

Loading

fabiaserra commented Jun 11, 2024 •

edited

Loading

BigRoy Jun 11, 2024 •

edited

Loading

MustafaJafar commented Jun 13, 2024 •

edited

Loading

fabiaserra commented Jun 13, 2024 •

edited

Loading

fabiaserra commented Jun 13, 2024 •

edited

Loading