pingu_98/MrDraw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fixed a rare race condition causing a "settings changed" popup in case of local changes

Browse source 
If the SettingsUpdated event for whatever reason got slightly delayed and arrived AFTER
the save request was already processed, in rare situations it could happen that the
"Settings Changed" popup was triggered even though the settings had already been
successfully saved.

Modified such that we now keep track of if we already saw the SettingsUpdated event
associated with our save request and if not we ignore the next one.

To ensure that we don't get out of sync due to that when a settings update request is
sent, but no settings are actually change, we also now always trigger the SettingsUpdated
event, even in such cases. Clients can use the hashs in the payload to test if something
 actually changed - if necessary.
This commit is contained in:
Gina Häußge 2016-11-23 11:34:58 +01:00
parent 4a0d91315c
commit 5b910b557e
2 changed files with 24 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
src/octoprint/server/api/settings.py
View file

@ -359,9 +359,10 @@ def _saveSettings(data):
except:
logger.exception("Could not save settings for plugin {name} ({version})".format(version=plugin._plugin_version, name=plugin._plugin_name))
if s.save():
payload = dict(
config_hash=s.config_hash,
effective_hash=s.effective_hash
)
eventManager().fire(Events.SETTINGS_UPDATED, payload=payload)
s.save()
payload = dict(
config_hash=s.config_hash,
effective_hash=s.effective_hash
)
eventManager().fire(Events.SETTINGS_UPDATED, payload=payload)

18
src/octoprint/static/js/app/viewmodels/settings.js
View file

@ -16,6 +16,10 @@ $(function() {
});
self.outstanding = [];
self.active = false;
self.sawUpdateEventWhileActive = false;
self.ignoreNextUpdateEvent = false;
self.settingsDialog = undefined;
self.settings_dialog_update_detected = undefined;
self.translationManagerDialog = undefined;
@ -728,6 +732,7 @@ $(function() {
self.settingsDialog.trigger("beforeSave");
self.sawUpdateEventWhileSending = false;
self.sending(data == undefined || options.sending || false);
if (data == undefined) {
@ -735,10 +740,15 @@ $(function() {
data = getOnlyChangedData(self.getLocalData(), self.lastReceivedSettings);
}
self.active = true;
return OctoPrint.settings.save(data)
.done(function(data, status, xhr) {
self.ignoreNextUpdateEvent = !self.sawUpdateEventWhileSending;
self.active = false;
self.receiving(true);
self.sending(false);
try {
self.fromResponse(data);
if (options.success) options.success(data, status, xhr);
@ -748,6 +758,7 @@ $(function() {
})
.fail(function(xhr, status, error) {
self.sending(false);
self.active = false;
if (options.error) options.error(xhr, status, error);
})
.always(function(xhr, status) {
@ -756,6 +767,10 @@ $(function() {
};
self.onEventSettingsUpdated = function() {
if (self.active) {
self.sawUpdateEventWhileActive = true;
}
var preventSettingsRefresh = _.any(self.allViewModels, function(viewModel) {
if (viewModel.hasOwnProperty("onSettingsPreventRefresh")) {
try {
@ -776,7 +791,8 @@ $(function() {
if (self.isDialogActive()) {
// dialog is open and not currently busy...
if (self.sending() || self.receiving()) {
if (self.sending() || self.receiving() || self.active || self.ignoreNextUpdateEvent) {
self.ignoreNextUpdateEvent = false;
return;
}