General: Validate if current process OpenPype version is requested version #2529

iLLiCiTiT · 2022-01-13T17:37:08Z

Brief description

Added periodical checks of OpenPype version.

Description

Main change is affecting OpenPype tray application. A dialog with information about outdated OpenPype version is shown. If dialog is closed or ignore button is clicked a tray message will popup.

Ftrack event server statuser will show information if is up to date.

Changes

moved few functions in lib and added new for checking if version of currently running process is up to date
tray will check each 5 minutes if is up to date with expected version
- will show a dialog with ability to restart tray
restart of tray will unset OPENPYPE_VERSION environment for new process
- this is to trigger update if needed
ftrack event server statuser has new category OpenPype version with info about current OpenPype version

Testing notes:

Build OpenPype
Create a zip with higher version
Optional: Remove versions from appdata...
Set path to openpype versions to some empty directory
Run tray from the build
Move the created zip with higher version to openpype versions dir
Wait for 5 minutes
Popup should be shown
- you can press Ignore window will close and tray message will show
- press "Restart and Change" should trigger restart of tray and also update

Alternative to not wait 5 minutes (code modification needed)

In build go to ~/openpype/tools/tray/pype_tray.py on line 375 is method _on_version_action modify it to

def _on_version_action(self):
    self._version_check_timer.timeout.emit()
    ...

Now when you click on version action in tray menu it should trigger version validation.

Notes

any changes of messages are welcomed
we could maybe change color of tray icon or add icon to version action (e.g. exclamation mark) or just change color of action text
color of "Restart and Change" could be maybe changed to better color?
It can happen that it is not possible to validate if current version is that which should be used. Should we tell user on start?

Screenshot of dialog showed from Tray

mkolar · 2022-01-13T17:37:10Z

Task linked: OP-2360 Validate if current OpenPype version is production version

tokejepsen · 2022-01-13T20:12:09Z

Is the wait time (5 minutes) configurable in the settings?

BigRoy · 2022-01-13T21:32:23Z

openpype/tools/project_manager/project_manager/widgets.py

@@ -369,7 +369,7 @@ def __init__(self, project_name, parent):
 cancel_btn = QtWidgets.QPushButton("Cancel", self)
 cancel_btn.setToolTip("Cancel deletion of the project")
 confirm_btn = QtWidgets.QPushButton("Permanently Delete Project", self)
- confirm_btn.setObjectName("DeleteButton")
+ confirm_btn.setObjectName("WarningButton")


Is it correct that GitHub is showing these style changes for Project Manager in this PR? Or has there been a merge conflict?

I've changed the object name because it's using same colors and has same purpose.

iLLiCiTiT · 2022-01-14T10:10:53Z

Is the wait time (5 minutes) configurable in the settings?

It wasn't, added.

Does make sense to use decimal points for this validation like each 0.5 minutes?

tokejepsen · 2022-01-14T10:14:19Z

Does make sense to use decimal points for this validation like each 0.5 minutes?

Unless its a bother to implement later, I would stick with whole minutes. Dont think anyone cant wait 1 minute for an update.

BigRoy · 2022-01-14T10:47:02Z

Unless its a bother to implement later, I would stick with whole minutes. Dont think anyone cant wait 1 minute for an update.

I mean, if there's an Update Now button in the Version pop-up window users could always go down that route. Haven't checked myself but is that there? If not, should it be there? I guess just shutting down OP + starting it manually isn't that much effort either.

But yes, integer minutes sounds fine.

Ignore, what then?

If a user clicks Ignore. What happens? Do they get the callback again after 5 minutes?

Pop-up too aggressive message?

Also, I feel Wrong OpenPype version in the dialog bar feels wrong. It should feel more "hey, there's a new update!" than "you did something wrong / are using the wrong software"

How about changing the pop-up to something like this:

TITLE

A new version of OpenPype is available or OpenPype update available

MESSAGE

You're using OpenPype version 3.8.0-nightly.3. New studio version 3.8.0-nightly.4 is available now.

Similarly Restart & Change I think should be either just Update or Restart & Update
Ignore could also be Later? Not sure if better.

Slack reference

I also liked that e.g. Slack would have update messages come with a little wrapped present icon. As if you're about to receive something nice!" See below:

iLLiCiTiT · 2022-01-14T11:27:46Z

I mean, if there's an Update Now button in the Version pop-up window users could always go down that route. Haven't checked myself but is that there? If not, should it be there? I guess just shutting down OP + starting it manually isn't that much effort either.

It's not there, should be there, not goal of this PR. This is more for artists that start OpenPype only when PC is restarted (once in month) so they do not catch new updates at all.

Do they get the callback again after 5 minutes?

Yes.

Also, I feel Wrong OpenPype version in the dialog bar feels wrong. It should feel more "hey, there's a new update!" than "you did something wrong / are using the wrong software"

I agree it's aggresive. I wanted to avoid using "update" because you can downgrade e.g. when latest version breaks production you can in settings set older version that should be used in studio. So it's not like "Hey there is new update" but more like "You should use different version then you're using now".

Ignore could also be Later? Not sure if better.

I like "Later". Much better than "Ignore".

EDITED: Maybe Later could trigger the message in next interval and Ignore would stop the validation so there would be 3 buttons?

iLLiCiTiT · 2022-01-14T15:18:52Z

I expect this notification should be modified too. This is what is shown when you hit Ignore/Later.

mkolar · 2022-01-14T15:36:14Z

@BigRoy I agree with all points with a few minor tweaks.

TITLE

OpenPype update is needed

I'd use needed or required because it really shouldn't be the artist choice here, apart from possibly postponing it.

MESSAGE

Running OpenPype version is 3.8.0-nightly.3. Your production has been updated to version 3.8.0-nightly.4.

Similarly Restart & Change I think should be either just Update or Restart & Update

Restart & Update is the best I think

Ignore could also be Later? Not sure if better.

Later is great. In later PRs we can add a little dropdown with an option to postpone, so users could bypass the 5 minutes for a certain period.

I do like the idea with a little present icon. Even though you can't really choose not to unwrap it :D

Regarding the notification
Title: OpenPype version is outdated
Message: Please update your OpenPype as soon as possible. To update, restart OpenPype Tray application.

mkolar · 2022-01-14T15:40:22Z

EDITED: Maybe Later could trigger the message in next interval and Ignore would stop the validation so there would be 3 buttons?

I'd leave this for another PR, but ideally it should postpone until next interval by (say 5 minutes by default), but give dropdown option with local override, same as with many notifications.
Something like this (without the forever option)

iLLiCiTiT · 2022-01-14T16:59:15Z

Current state

Dialog

Notification

Tray menu

added action Restart & Update to tray menu which is visible when the validation do not pass

BigRoy

Haven't done a full code review nor tested locally but just going based on the screenshots. Looking good to me!

64qam · 2022-01-17T15:37:12Z

The action Restart & Update doesn't show up in the tray menu. Everything else is ok

iLLiCiTiT · 2022-01-17T15:45:14Z

The action Restart & Update doesn't show up in the tray menu. Everything else is ok

What a shame. I didn't push last commit.

64qam · 2022-01-17T16:19:15Z

All good now

iLLiCiTiT added 6 commits January 13, 2022 13:02

implemented callback warpper for execution in main thread

2944531

added check if current running openpype has expected version

d7fb171

moved code from pype_info to openpype_version and fixed few bugs

7d283f5

tray will show info that is outdated and user should restart

12156b6

status action gives information about openpype version

644711c

show tray message when update dialog is ignored

4ee86a6

iLLiCiTiT self-assigned this Jan 13, 2022

iLLiCiTiT requested review from kalisp, 64qam and mkolar January 13, 2022 17:39

iLLiCiTiT added the type: enhancement Enhancements to existing functionality label Jan 13, 2022

iLLiCiTiT changed the title ~~Feature/op 2360 validate if current open pype version is production version~~ General: Validate if current process OpenPype version is requested version Jan 13, 2022

BigRoy reviewed Jan 13, 2022

View reviewed changes

interval of validation can be modified

687181e

fixed reseting from staging

0ebd788

64qam approved these changes Jan 14, 2022

View reviewed changes

fix import if 'is_running_staging'

17578c5

iLLiCiTiT added 2 commits January 14, 2022 17:47

change back project manager styles

ce5c70e

changed dialog and added restart and update action to tray

a18bdbc

BigRoy approved these changes Jan 14, 2022

View reviewed changes

iLLiCiTiT merged commit 44505cc into develop Jan 17, 2022

iLLiCiTiT deleted the feature/OP-2360_Validate-if-current-OpenPype-version-is-production-version branch January 19, 2022 10:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

General: Validate if current process OpenPype version is requested version #2529

General: Validate if current process OpenPype version is requested version #2529

iLLiCiTiT commented Jan 13, 2022 •

edited

Loading

mkolar commented Jan 13, 2022

tokejepsen commented Jan 13, 2022

BigRoy Jan 13, 2022

iLLiCiTiT Jan 13, 2022

iLLiCiTiT commented Jan 14, 2022

tokejepsen commented Jan 14, 2022

BigRoy commented Jan 14, 2022 •

edited

Loading

iLLiCiTiT commented Jan 14, 2022 •

edited

Loading

iLLiCiTiT commented Jan 14, 2022

mkolar commented Jan 14, 2022

mkolar commented Jan 14, 2022

iLLiCiTiT commented Jan 14, 2022

BigRoy left a comment

64qam commented Jan 17, 2022

iLLiCiTiT commented Jan 17, 2022

64qam commented Jan 17, 2022

General: Validate if current process OpenPype version is requested version #2529

General: Validate if current process OpenPype version is requested version #2529

Conversation

iLLiCiTiT commented Jan 13, 2022 • edited Loading

Brief description

Description

Changes

Testing notes:

Alternative to not wait 5 minutes (code modification needed)

Notes

Screenshot of dialog showed from Tray

mkolar commented Jan 13, 2022

tokejepsen commented Jan 13, 2022

BigRoy Jan 13, 2022

Choose a reason for hiding this comment

iLLiCiTiT Jan 13, 2022

Choose a reason for hiding this comment

iLLiCiTiT commented Jan 14, 2022

tokejepsen commented Jan 14, 2022

BigRoy commented Jan 14, 2022 • edited Loading

Ignore, what then?

Pop-up too aggressive message?

Slack reference

iLLiCiTiT commented Jan 14, 2022 • edited Loading

iLLiCiTiT commented Jan 14, 2022

mkolar commented Jan 14, 2022

mkolar commented Jan 14, 2022

iLLiCiTiT commented Jan 14, 2022

Current state

Dialog

Notification

Tray menu

BigRoy left a comment

Choose a reason for hiding this comment

64qam commented Jan 17, 2022

iLLiCiTiT commented Jan 17, 2022

64qam commented Jan 17, 2022

iLLiCiTiT commented Jan 13, 2022 •

edited

Loading

BigRoy commented Jan 14, 2022 •

edited

Loading

iLLiCiTiT commented Jan 14, 2022 •

edited

Loading