Draft: Feature: Handling out of date workfiles in Blender #4176

Sharkitty · 2022-12-05T14:59:04Z

Draft: This PR depends on this other PR: #4102

Description

Added warning and validator when workfile is out of file (in Blender).
The warning shows up as a props dialog that user cannot ignore as it will be reinvoked on cancel (So if they click anywhere outside of the dialog, it reappears). This props dialog has an enum to select what action to perform, then they can click "OK" to execute.

There are three actions provided:

Download last workfile
Quit blender
Proceed anyway

There is also a variable set when the workfile has been detected as out of date. The validator checks it, so if user decide to proceed anyway, they won't be able to publish, unless they explicitly untick this box.
A warning sign will appear next to the OpenPype menu as well, and there is also an Update workfile button in the OpenPype menu, which is grayed out if the workfile is up to date.
This system however presents a limitation: As the workfile is determined as up to date, or out of date based on modification time, if it is modified and saved then it will always be considered up to date. This brings a few unwanted behavior. For instance if the users proceeds anyway, then closes blender, as the file is saved when making paths absolute, it will always be considered up to date from now on.

Testing

General

Have a local workfile (blender) with its datetime older than the last published workfile
Open it in blender using OpenPype launcher
Notice the props dialog popping, try to click somewhere else and see that it reappears whatever you do
Select an option in the enum and click ok to test it.

Download last workfile using the props dialog

Select Download last workfile in the enum and click ok
The last workfile should now download and be automatically opened, with the correct version number
Confirm props dialog does not reopen
Confirm OpenPype menu does not have a warning sign
Confirm Update workfile in the OpenPype menu is grayed out
Open pyblish and do a publish test (at least test the validators)

Quit blender using props dialog

Select Quit blender in the enum and click ok
Blender should close

Proceed anyway

Select proceed anyway in the enum and click ok
You should now be able to work
OpenPype menu should have a warning sign
Try to publish, the workfile up to date validator should fail
Reset pyblish, untick the workfile up to date validator, and do a publish test again (at least test validators)
Confirm Update workfile is available in the OpenPype menu and has the same behavior as the Download last workfile option in the props dialog

Workfile is up to date case

Confirm props dialog does not display
Confirm OpenPype menu should does not have a warning sign
Confirm Update workfile in the OpenPype menu is grayed out
Confirm you can publish (at least test validators)

…nted

* Enhancement: copy last published workfile as reusable methods (WiP) * Added get_host_extensions method, added subset_id and las_version_doc access, added optional arguments to get_last_published_workfile * Plugged in the new methods + minor changes * Added docstrings, last workfile optional argument, and removed unused code * Using new implementation to get local workfile path. Warning: It adds an extra dot to the extension which I need to fix * Refactoring and fixed double dots * Added match subset_id and get representation method, plus clan up * Removed unused vars * Fixed some rebasing errors * delinted unchanged code and renamed get_representation into get_representation_with_task * This time it's really delinted, I hope... * Update openpype/modules/sync_server/sync_server.py reprenation isn't the right spelling (: Co-authored-by: Félix David <felixg.david@gmail.com> * Changes based on reviews * Fixed non imperative docstring and missing space * Fixed another non imperative docstring * Update openpype/modules/sync_server/sync_server.py Fixed typo Co-authored-by: Félix David <felixg.david@gmail.com> Co-authored-by: Hayley GUILLOT <hayleyguillot@outlook.com> Co-authored-by: Félix David <felixg.david@gmail.com>

openpype/client/entities.py

iLLiCiTiT · 2022-12-05T16:46:33Z

openpype/modules/sync_server/sync_server.py

 from openpype.lib import Logger
+from openpype.lib.local_settings import get_local_site_id
+from openpype.modules.base import ModulesManager
+from openpype.pipeline import Anatomy


~~This is public definition of sync server which must be at this moment Python 2 compatible and should be clear without pipeline imports if possible.~~ Sorry not true, this is not in public part.

BTW Even I understand the use case I don't think those functions should be called directly from blender as blender workflow is now dependent on sync server in it's core (which is not good). He should find if there is sync server addon, if it's enabled, and then call a method which does all the logic and return or raise result, but blender should not know anything about how it works (whole content of DownloadLastWorkfile). If anything changes how sync server works (and it will soon) Blender will break too so he should know almost nothing.

Okay, I see what you mean. I'll edit my implementation.

iLLiCiTiT · 2022-12-05T16:52:00Z

openpype/hooks/pre_copy_last_published_workfile.py


        Returns:
            None: This is a void method.
        """

-        sync_server = self.modules_manager.get("sync_server")


So if sync server is not available or enabled it will happen anyway?

This part comes from #4102 (which this PR depends on) so I think it's more appropriate to discuss it in #4102
But to answer your question the check still exists it's just been moved to download_last_published_workfile in sync_server.py

I think these kind of checks must remain in hooks to have explicit logging.

Tilix4

Works fine, good job! (even if I'll review it after #4102 is merged and your branch will be rebased)

Doesn't work when local settings are both on studio. It holds forever.

openpype/hosts/blender/utility_scripts/is_workfile_out_of_date.py

+from openpype.hosts.blender.api.workio import current_file
+
+
+def is_work_file_out_of_date() -> bool:


openpype/hosts/blender/api/ops.py

+            ("DL", "Download last workfile", "Download last workfile"),
+            ("QUIT", "Quit blender", "Quit blender"),
+            ("PROC", "Proceed anyway", "Proceed anyway AT YOUR OWN RISK"),


openpype/hosts/blender/api/ops.py

+        return self.execute(context)
+
+
+class DrawWorkFileOutOfDateWarning(bpy.types.Operator):


openpype/hosts/blender/api/ops.py

+            project_name, subset_id, fields=["_id", "name"]
+        )
+        if not last_version_doc:
+            print("Subset does not have any version")


openpype/hooks/pre_copy_last_published_workfile.py

openpype/hosts/blender/api/ops.py

Tilix4 · 2022-12-08T07:32:07Z

openpype/hosts/blender/api/ops.py

+    bl_idname = "wm.workfile_out_of_date"
+    bl_label = "WARNING: Workfile is out of date"
+
+    action_enum: bpy.props.EnumProperty(


I'd rename it simply "action"

openpype/hosts/blender/api/pipeline.py

Tilix4 · 2022-12-08T07:40:16Z

openpype/hosts/blender/api/pipeline.py

+
+    # Getting date and time of the latest locally installed workfile
+    # Time is converted to use the same format as for `last_publishd_time`
+    workfile_time = get_timestamp(


You better keep the value of the last publish time in a bpy.props.StringProperty or maybe in a FloatProperty to have fewer conversions.

LiborBatek · 2022-12-20T07:13:04Z

@Tilix4 is it already ok to test it / review it?

…k implementation. Using blender self.report, changing ops prefixes, changing enum short names, added sync_server availability check.

Co-authored-by: Félix David <felixg.david@gmail.com>

Using context passed as argument Co-authored-by: Félix David <felixg.david@gmail.com>

Renamed `is_work_file_out_of_date` into `check_workfile_up_to_date` Co-authored-by: Félix David <felixg.david@gmail.com>

Fixed typo in comment Co-authored-by: Félix David <felixg.david@gmail.com>

…r StringProperty, applied check_workfile_up_to_date renaming, added no published workfile exception

LiborBatek

Did all testing with following findings...

Pop up win shows up when out of date workfile being present
when selecting Proceed option , OP menu shows out of date workfile warning and Publish validator will fail correctly...
when selecting "Download workfile" blender freezes instantly (I guess its because absence of Sync Server on my machine or?!

When correct up-to-date workfile exists in asset workfile folder the win pop up doesnt show up as expected and also OP menu doesnt have that workfile warning and all behaves normally in Blender.

So my only concern is about that "download workfile" feature and how should I test it so its properly synced/downloaded... other than that all seems working fine.

openpype/hosts/blender/api/ops.py

Tilix4 · 2023-01-04T14:46:38Z

openpype/modules/sync_server/sync_server.py

+        local_workfile_path,
+    )
+
+    return local_workfile_path


In fact, download_last_published_workfile shouldn't return the local path but the last published wf which has been downloaded. The resolving of the local_workfile_path must be put into another function and the copy made my the master process or into a utility function.

Co-authored-by: Félix David <felixg.david@gmail.com>

…ime.

…to 'studio/ft_blender_workfile_out_of_date_handling' Enhancement: workfile out of date check no longer uses modification time. See merge request NORMAAL/openpype-for-normaal!28

calling the check for update operator. Also fixed missing return value in the check for update operator, when user selects "Quit blender".

Feature: Blender update button in OP menu

…being updated in blend file

Tilix4 and others added 12 commits November 17, 2022 16:06

Fix: Locally copied version of last published workfile is not increme…

126967e

…nted

fix subset first match

30895bd

correct anatomy name

c1bf060

Fix typo and linting

8188ab8

keep source filepath for further path conformation

d93ff65

fetch also input dependencies of workfile

87e595f

required changes

23c7a1e

lint

a208a3b

fix case only one subset

069342b

Fix: syntax error

25759af

fix single subset case

6eb2859

mkolar requested review from LiborBatek, antirotor and simonebarbieri December 5, 2022 15:48

iLLiCiTiT reviewed Dec 5, 2022

View reviewed changes

openpype/client/entities.py Outdated Show resolved Hide resolved

iLLiCiTiT reviewed Dec 5, 2022

View reviewed changes

openpype/client/entities.py Outdated Show resolved Hide resolved

iLLiCiTiT reviewed Dec 5, 2022

View reviewed changes

Tilix4 mentioned this pull request Dec 6, 2022

Fix: Locally copied version of last published workfile is not incremented #4102

Closed

Tilix4 added 2 commits December 6, 2022 08:33

Restore sync server enabled test in hook

bff759f

Python2 syntax

cf8560c

Tilix4 suggested changes Dec 6, 2022

View reviewed changes

antirotor assigned Sharkitty Dec 7, 2022

antirotor added host: Blender type: enhancement Enhancements to existing functionality labels Dec 7, 2022

Tilix4 suggested changes Dec 8, 2022

View reviewed changes

renaming and missing key case handling

26cccd7

Hayley GUILLOT and others added 8 commits December 20, 2022 15:29

Moved blender download last workfile, and workfile is up to date chec…

1651ab0

…k implementation. Using blender self.report, changing ops prefixes, changing enum short names, added sync_server availability check.

Update openpype/hooks/pre_copy_last_published_workfile.py

f56bdd9

Co-authored-by: Félix David <felixg.david@gmail.com>

Linting

3b06fd1

Update openpype/hosts/blender/api/ops.py

574b614

Using context passed as argument Co-authored-by: Félix David <felixg.david@gmail.com>

Update openpype/hosts/blender/api/pipeline.py

ac315d9

Renamed `is_work_file_out_of_date` into `check_workfile_up_to_date` Co-authored-by: Félix David <felixg.david@gmail.com>

Update openpype/hosts/blender/api/pipeline.py

1eaa5fb

Fixed typo in comment Co-authored-by: Félix David <felixg.david@gmail.com>

Renamed action_enum into action, stored last publish time in a blende…

55e0563

…r StringProperty, applied check_workfile_up_to_date renaming, added no published workfile exception

Moved where last_publish_time blender property is set

f369486

Sharkitty force-pushed the ft_blender_workfile_out_of_date_handling branch from a72b1f8 to f369486 Compare December 20, 2022 14:29

Hayley GUILLOT and others added 5 commits December 20, 2022 16:09

Enhancement: Using last publish time, Edited workfile up to date check

323c132

Fixed: Blender last publish time variable set to dict instead of string

4bb1028

Feature: Explicit OP menu warning

b13f09e

Fixed merging issue

e0c1c53

Fixed import issues

4ef7e4f

LiborBatek reviewed Dec 27, 2022

View reviewed changes

Tilix4 suggested changes Jan 4, 2023

View reviewed changes

openpype/hosts/blender/api/ops.py Outdated Show resolved Hide resolved

Tilix4 suggested changes Jan 4, 2023

View reviewed changes

Refactor download_last_workfile call

424512b

Co-authored-by: Félix David <felixg.david@gmail.com>

mkolar added the community contribution label Jan 19, 2023

Hayley GUILLOT and others added 9 commits January 25, 2023 13:16

Enhancement: workfile out of date check no longer uses modification t…

a6e07cb

…ime.

Merge branch 'enhancement_wf_out_of_date_check_without_modif_time' in…

dd2ebfd

…to 'studio/ft_blender_workfile_out_of_date_handling' Enhancement: workfile out of date check no longer uses modification time. See merge request NORMAAL/openpype-for-normaal!28

Fixed cherry-pick issues

42b5a82

Fixed other cherry-pick errors

77eb9ea

Linting

6a3c7ab

Turned the workfile out of date label in the openpype menu into a button

ff6ff0f

calling the check for update operator. Also fixed missing return value in the check for update operator, when user selects "Quit blender".

Merge pull request #1 from Sharkitty/ft_bl_update_button

8634ac3

Feature: Blender update button in OP menu

Linting small adjustment

dd56adf

Changed integrator order to reduce risk of workfile publish time not …

a0f8dc2

…being updated in blend file

Sharkitty closed this Jun 6, 2023

ynbot added this to the next-patch milestone Jun 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Draft: Feature: Handling out of date workfiles in Blender #4176

Draft: Feature: Handling out of date workfiles in Blender #4176

Sharkitty commented Dec 5, 2022

iLLiCiTiT Dec 5, 2022 •

edited

Loading

Sharkitty Dec 5, 2022

iLLiCiTiT Dec 5, 2022

Sharkitty Dec 5, 2022

Tilix4 Dec 6, 2022

Tilix4 left a comment

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

Tilix4 Dec 8, 2022

Tilix4 Dec 8, 2022

LiborBatek commented Dec 20, 2022

LiborBatek left a comment

Tilix4 Jan 4, 2023

		from openpype.hosts.blender.api.workio import current_file


		def is_work_file_out_of_date() -> bool:

		return self.execute(context)


		class DrawWorkFileOutOfDateWarning(bpy.types.Operator):

Draft: Feature: Handling out of date workfiles in Blender #4176

Draft: Feature: Handling out of date workfiles in Blender #4176

Conversation

Sharkitty commented Dec 5, 2022

Description

Testing

General

Download last workfile using the props dialog

Quit blender using props dialog

Proceed anyway

Workfile is up to date case

iLLiCiTiT Dec 5, 2022 • edited Loading

Choose a reason for hiding this comment

Sharkitty Dec 5, 2022

Choose a reason for hiding this comment

iLLiCiTiT Dec 5, 2022

Choose a reason for hiding this comment

Sharkitty Dec 5, 2022

Choose a reason for hiding this comment

Tilix4 Dec 6, 2022

Choose a reason for hiding this comment

Tilix4 left a comment

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

Tilix4 Dec 8, 2022

Choose a reason for hiding this comment

Tilix4 Dec 8, 2022

Choose a reason for hiding this comment

LiborBatek commented Dec 20, 2022

LiborBatek left a comment

Choose a reason for hiding this comment

Tilix4 Jan 4, 2023

Choose a reason for hiding this comment

iLLiCiTiT Dec 5, 2022 •

edited

Loading