Settings: Flag project as deactivated and hide from tools' view #2008

davidlatwe · 2021-09-12T16:00:40Z

Feature

Able to switch project state between active and inactive in Studio Settings.

The project in inactive state will not be shown in tools like :

Launcher
Library Loader
Standalone Publisher
Project Manager
Local Settings
Sync Server

Usage

To mark project as inactive :

Go to Projects tab in Studio Settings and select the project that you want to deactivate.
Go to project_anatomy/attributes/active and toggle it.
Save the settings

Tips

The current selected project will remain in the list view when it just got deactivated, it will be hidden when you switch to another project settings.
You can view all projects by checking the "Show Inactive Project" box. This check-box only exists in Studio Settings.

Notes

This PR depends on Enable AvalonMongoDB.projects() filtering with 'data.active' field avalon-core#368
The Sync Server is not yet tested in my end.

Based on avalon-core bfce450f

So the settings can recognize and won't pop warnings

tokejepsen · 2021-09-12T20:00:36Z

Great stuff! Maybe we could have a confirmation box when using the archive switch rather than a separate line edit @iLLiCiTiT ?

iLLiCiTiT · 2021-09-13T07:53:17Z

openpype/tools/settings/settings/widgets.py

 class ProjectListWidget(QtWidgets.QWidget):
 default = "< Default >"
 project_changed = QtCore.Signal()

- def __init__(self, parent):
+ ProjectSortRole = QtCore.Qt.UserRole + 10


Don't use came case for attributes and don't set these constants used in different code in class. It is better to define roles as constants at header part.

Should be resolved by 0bf84ad

iLLiCiTiT · 2021-09-13T07:55:10Z

openpype/tools/settings/settings/widgets.py

+
+ index = self.sourceModel().index(source_row, 0, source_parent)
+ is_active = bool(index.data(self.filterRole()))
+ is_selected = bool(index.data(ProjectListWidget.ProjectSelectedRole))


I quite don't get why selection is important? All projects should disappear when checkbox change value...

This was for keeping current selected project visible in list when it just got deactivated.

Since the only way for user to know which project is being edited is from the selection of that list view, so I thought it would be better not to hide the project that just got deactivated from list as soon as the "Save" is clicked and processed, until the user changed the selection to another project settings.

iLLiCiTiT · 2021-09-13T08:02:20Z

I would maybe change archived to active. The validation does not make much sense as you are not triggering any callbacks. It's just a flag to show/hide projects for artists plus you may accidentally "unarchive" project when you save project settings on "archived" project because confirmation won't be passed (through API). Settings are not just UI they can be (and are) use headless so validation of entered value on user base is dangerous.

BTW: The validation could be done only in UI with using custom checkbox which would trigger confirmation dialog but I don't think it's necessary.

Ad active: Also you may want to have inactive projects by default which does not make sense with having archived by default or just want pause project but not archive yet.

mkolar · 2021-09-13T10:51:14Z

I'd also stay away from archived considering studios tend to use that as and information when project data is actually archived and not easily accessible. Active is quite nice, with it being on by default. But it also allows as @iLLiCiTiT mentioned for other workflows. For example preparing a project structure and some date before marking it as active and showing to the artists.

davidlatwe · 2021-09-15T03:37:26Z

All good points, I have changed the attrib archive to active.

It's just a flag to show/hide projects for artists plus you may accidentally "unarchive" project when you save project settings on "archived" project because confirmation won't be passed (through API).

That's true. I removed the confirmation for now as it's also outdated after the archive attrib is changed.

But after the confirmation is removed, code like this (e.g. in avalon-core code base AvalonMongoDB.projects) may not work as expect if the default setting active is changed to false :

for doc in project_docs:
    if not doc["data"].get("active", True):
        # the default value here is not following studio default setting
        continue
    ...

Not sure how to solve this properly, as it may also make sense if one like the project's default active state to False ?

For new project, we could make the project manager to always set the data.active in database with studio default when creating new one. But for the existing old projects, how do we handle that ?

Edit

But for the existing old projects, how do we handle that ?

How about scan and update project documents that doesn't have data.active and set it to true on pype tray launch ?

iLLiCiTiT · 2021-09-15T08:12:18Z

But after the confirmation is removed, code like this (e.g. in avalon-core code base AvalonMongoDB.projects) may not work as expect if the default setting active is changed to false

I don't think it's used in a way that it would change behavior or affect anything.

But for the existing old projects, how do we handle that ?

Since there is (in avalon-core) default value of "active" set to True (project_doc["data"].get("active", True)) it should be fine as all projects without the key are proposed as active.

How about scan and update project documents that doesn't have data.active and set it to true on pype tray launch ?

Not in tray like a script before/after launch that's not good idea as it would slow down all tray applications if studio has 30 projects it would query 30 times on each tray launch without doing anything. It could be done by script (out of tray), through settings or could modify AvalonMongoDB.projects to set the key to True if is not set or value is None. The last one is most easiest but is forcing to have that key on project...

openpype/tools/settings/settings/widgets.py

davidlatwe · 2021-09-15T08:29:43Z

Since there is (in avalon-core) default value of "active" set to True (project_doc["data"].get("active", True)) it should be fine as all projects without the key are proposed as active.

Yeah, but if the default value in Studio Settings gets change to false, the code won't be align with the settings (for existing projects that without the key). Or this behavior should be considered as edge case ?

…ema_anatomy_attributes.json Co-authored-by: Milan Kolar <mkolar@users.noreply.github.com>

mkolar

Actually I spoke too soon. Sync queue is showing no projects at all with this PR. @davidlatwe get in touch with @kalisp he should be able to point to to a simple site sync setup with local storage so you can sort it out.

iLLiCiTiT · 2021-09-16T09:06:12Z

openpype/tools/settings/settings/widgets.py

+ if only_active:
+ inactive_chk = None
+ else:
+ inactive_chk = QtWidgets.QCheckBox(" Show Inactive Projects ")


Use parenting on widgets for proper style propagation.

Suggested change

inactive_chk = QtWidgets.QCheckBox(" Show Inactive Projects ")

inactive_chk = QtWidgets.QCheckBox(" Show Inactive Projects ", self)

Hmmm, I tried this but doesn't have any difference.

I know but it may differ if we had different styles for checkbox than default.

Sync server projects widget

davidlatwe · 2021-09-16T17:30:35Z

Thanks @iLLiCiTiT for taking a stab on fixing SyncServer ❤️

However I found an issue :

I deactivate a project
open up SyncServer and find that inactive project still showing in the list
select that inactive project in SyncServer
entire Pype tray crashed

As for Launcher, LibraryLoader, StandalonePublisher, LocalSettings and ProjectManager, they all seems fine in a few quick tests.

mkolar · 2021-09-16T17:31:25Z

However I found an issue :

Oh good testing. I literally just tested too and didn't notice that

mkolar · 2021-09-16T17:32:40Z

But I can confirm that it indeed crashes in the scenario that @davidlatwe described

iLLiCiTiT · 2021-09-16T17:36:18Z

So in the end @kalisp will have to look into that :)

davidlatwe · 2021-09-16T17:36:35Z

Here's the full log and GIF that shows the bug
davidlatwe#1 (comment)

mkolar · 2021-09-20T08:48:15Z

Task linked: PYPE-1427 Pype Projects - Deleting & Archiving

kalisp · 2021-09-22T14:22:09Z

Fixed Site Sync issue in davidlatwe#2

mkolar · 2021-09-23T10:41:17Z

@kalisp @davidlatwe apologies. I've prematurely merged this thinking the fix was already part of it here.

Petr could you please make the same PR to this main repo and we'll make a hotfix asap with it. Thanks.

davidlatwe added 11 commits September 11, 2021 17:33

add project archive confirm setting attribute

181c1fa

Launcher ignore archived project

394b714

Based on avalon-core bfce450f

ProjectManager ignore archived project

902334d

Based on avalon-core bfce450f

StandalonePublisher ignore archived project

07e248d

Based on avalon-core bfce450f

Settings ignore archived project

1ec69c3

Based on avalon-core bfce450f

evaluate archive flag on saving anatomy

04d4afa

add archived sorting/filtering in Studio Settings

f817740

SyncServer ignore archived project

02937e3

register 'archived' to project anatomy schema

c234cb9

So the settings can recognize and won't pop warnings

reset 'archived' to False if no confirmation string

662e748

keep selected project in view when being archived

921fc00

davidlatwe added the type: feature Larger, user affecting changes and completely new things label Sep 12, 2021

davidlatwe requested review from mkolar and iLLiCiTiT September 12, 2021 16:00

fix linter

453a813

iLLiCiTiT reviewed Sep 13, 2021

View reviewed changes

mkolar assigned davidlatwe Sep 13, 2021

davidlatwe added 3 commits September 15, 2021 10:03

reverse project 'archive' to 'active'

b0d166f

refactor data role attrib to model

0bf84ad

remove project archive confirmation

7ac2c04

davidlatwe changed the title ~~Settings: Flag project as archived and hide from tools' view~~ Settings: Flag project as deactivated and hide from tools' view Sep 15, 2021

iLLiCiTiT reviewed Sep 15, 2021

View reviewed changes

openpype/tools/settings/settings/widgets.py Show resolved Hide resolved

iLLiCiTiT reviewed Sep 15, 2021

View reviewed changes

openpype/tools/settings/settings/widgets.py Outdated Show resolved Hide resolved

mkolar approved these changes Sep 16, 2021

View reviewed changes

Update openpype/settings/entities/schemas/projects_schema/schemas/sch…

d0e0bcb

…ema_anatomy_attributes.json Co-authored-by: Milan Kolar <mkolar@users.noreply.github.com>

mkolar self-requested a review September 16, 2021 08:09

mkolar suggested changes Sep 16, 2021

View reviewed changes

iLLiCiTiT reviewed Sep 16, 2021

View reviewed changes

iLLiCiTiT and others added 5 commits September 16, 2021 17:01

removed unused ProjectModel

4fbf5dd

delegate signal handler to method

a67cfcd

Transfer logic from settings project list widget to sync server

c5cc3fc

modified how projects are queried for sync server

cca2017

Merge pull request #1 from pypeclub/feature/sync_server_fix

44c7b88

Sync server projects widget

mkolar self-requested a review September 16, 2021 17:30

mkolar approved these changes Sep 16, 2021

View reviewed changes

mkolar assigned kalisp Sep 20, 2021

mkolar added type: enhancement Enhancements to existing functionality type: feature Larger, user affecting changes and completely new things and removed type: feature Larger, user affecting changes and completely new things labels Sep 23, 2021

mkolar merged commit bf02118 into ynput:develop Sep 23, 2021

mkolar removed the type: feature Larger, user affecting changes and completely new things label Sep 23, 2021

davidlatwe mentioned this pull request Sep 23, 2021

Fix - project lists refresh each show up event davidlatwe/OpenPype#2

Closed

davidlatwe deleted the feature/project-archive-state branch September 23, 2021 18:15

mkolar added type: feature Larger, user affecting changes and completely new things and removed type: enhancement Enhancements to existing functionality labels Sep 24, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Settings: Flag project as deactivated and hide from tools' view #2008

Settings: Flag project as deactivated and hide from tools' view #2008

davidlatwe commented Sep 12, 2021 •

edited

Loading

tokejepsen commented Sep 12, 2021

iLLiCiTiT Sep 13, 2021

davidlatwe Sep 15, 2021

iLLiCiTiT Sep 13, 2021

davidlatwe Sep 15, 2021

iLLiCiTiT commented Sep 13, 2021 •

edited

Loading

mkolar commented Sep 13, 2021

davidlatwe commented Sep 15, 2021 •

edited

Loading

iLLiCiTiT commented Sep 15, 2021

davidlatwe commented Sep 15, 2021 •

edited

Loading

mkolar left a comment

iLLiCiTiT Sep 16, 2021

davidlatwe Sep 16, 2021

iLLiCiTiT Sep 16, 2021

davidlatwe commented Sep 16, 2021 •

edited

Loading

mkolar commented Sep 16, 2021

mkolar commented Sep 16, 2021

iLLiCiTiT commented Sep 16, 2021

davidlatwe commented Sep 16, 2021

mkolar commented Sep 20, 2021

kalisp commented Sep 22, 2021

mkolar commented Sep 23, 2021

	inactive_chk = QtWidgets.QCheckBox(" Show Inactive Projects ")
	inactive_chk = QtWidgets.QCheckBox(" Show Inactive Projects ", self)

Settings: Flag project as deactivated and hide from tools' view #2008

Settings: Flag project as deactivated and hide from tools' view #2008

Conversation

davidlatwe commented Sep 12, 2021 • edited Loading

Feature

Usage

Tips

Notes

tokejepsen commented Sep 12, 2021

iLLiCiTiT Sep 13, 2021

Choose a reason for hiding this comment

davidlatwe Sep 15, 2021

Choose a reason for hiding this comment

iLLiCiTiT Sep 13, 2021

Choose a reason for hiding this comment

davidlatwe Sep 15, 2021

Choose a reason for hiding this comment

iLLiCiTiT commented Sep 13, 2021 • edited Loading

mkolar commented Sep 13, 2021

davidlatwe commented Sep 15, 2021 • edited Loading

iLLiCiTiT commented Sep 15, 2021

davidlatwe commented Sep 15, 2021 • edited Loading

mkolar left a comment

Choose a reason for hiding this comment

iLLiCiTiT Sep 16, 2021

Choose a reason for hiding this comment

davidlatwe Sep 16, 2021

Choose a reason for hiding this comment

iLLiCiTiT Sep 16, 2021

Choose a reason for hiding this comment

davidlatwe commented Sep 16, 2021 • edited Loading

mkolar commented Sep 16, 2021

mkolar commented Sep 16, 2021

iLLiCiTiT commented Sep 16, 2021

davidlatwe commented Sep 16, 2021

mkolar commented Sep 20, 2021

kalisp commented Sep 22, 2021

mkolar commented Sep 23, 2021

davidlatwe commented Sep 12, 2021 •

edited

Loading

iLLiCiTiT commented Sep 13, 2021 •

edited

Loading

davidlatwe commented Sep 15, 2021 •

edited

Loading

davidlatwe commented Sep 15, 2021 •

edited

Loading

davidlatwe commented Sep 16, 2021 •

edited

Loading