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

Migrate SettingsViewModel.requestData to using promises

Browse source 
Fallback implementation for old callback parameter is still present,
logs warning about deprecation.
This commit is contained in:
Gina Häußge 2015-09-28 18:17:43 +02:00
parent 7a06f496de
commit 73c235d67f
3 changed files with 75 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/octoprint/static/js/app/main.js
View file

@ -501,7 +501,8 @@ $(function() {
if (!_.has(viewModelMap, "settingsViewModel")) {
throw new Error("settingsViewModel is missing, can't run UI")
}
viewModelMap["settingsViewModel"].requestData(bindViewModels);
viewModelMap["settingsViewModel"].requestData()
.done(bindViewModels);
}
);

25
src/octoprint/static/js/app/viewmodels/gcode.js
View file

@ -231,19 +231,20 @@ $(function() {
self._configureLayerSlider(layerSliderElement);
self._configureLayerCommandSlider(commandSliderElement);
self.settings.requestData(function() {
GCODE.ui.init({
container: "#gcode_canvas",
onProgress: self._onProgress,
onModelLoaded: self._onModelLoaded,
onLayerSelected: self._onLayerSelected,
bed: self._retrieveBedDimensions(),
toolOffsets: self._retrieveToolOffsets(),
invertAxes: self._retrieveAxesConfiguration()
self.settings.requestData()
.done(function() {
GCODE.ui.init({
container: "#gcode_canvas",
onProgress: self._onProgress,
onModelLoaded: self._onModelLoaded,
onLayerSelected: self._onLayerSelected,
bed: self._retrieveBedDimensions(),
toolOffsets: self._retrieveToolOffsets(),
invertAxes: self._retrieveAxesConfiguration()
});
self.synchronizeOptions();
self.enabled = true;
});
self.synchronizeOptions();
self.enabled = true;
});
};
self.reset = function() {

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

@ -10,7 +10,7 @@ $(function() {
self.receiving = ko.observable(false);
self.sending = ko.observable(false);
self.callbacks = [];
self.outstanding = [];
self.settingsDialog = undefined;
self.settings_dialog_update_detected = undefined;
@ -386,44 +386,78 @@ $(function() {
return false;
};
self.requestData = function(callback, local) {
if (self.receiving()) {
if (callback) {
self.callbacks.push(callback);
}
return;
self.requestData = function(local) {
// handle old parameter format
var callback = undefined;
if (_.isFunction(local)) {
log.warn("The callback parameter of SettingsViewModel.requestData is deprecated, the method now returns a promise, please use that instead.");
callback = local;
local = false;
} else if (arguments.length == 2) {
log.warn("The callback parameter of SettingsViewModel.requestData is deprecated, the method now returns a promise, please use that instead.");
callback = arguments[0];
local = arguments[1];
}
// handler for any explicitely provided callbacks
var callbackHandler = function() {
if (!callback) return;
try {
callback();
} catch (exc) {
log.error("Error calling settings callback", callback, ":", (exc.stack || exc));
}
};
// if a request is already active, create a new deferred and return
// its promise, it will be resolved in the response handler of the
// current request
if (self.receiving()) {
var deferred = $.Deferred();
self.outstanding.push(deferred);
if (callback) {
// if we have a callback, we need to make sure it will
// get called when the deferred is resolved
deferred.done(callbackHandler);
}
return deferred.promise();
}
// perform the request
self.receiving(true);
OctoPrint.settings.get()
return OctoPrint.settings.get()
.done(function(response) {
self.fromResponse(response, local);
if (callback) {
self.callbacks.push(callback);
var deferred = $.Deferred();
deferred.done(callbackHandler);
self.outstanding.push(deferred);
}
try {
self.fromResponse(response, local);
var cb;
while (self.callbacks.length) {
cb = self.callbacks.shift();
try {
cb();
} catch(exc) {
log.error("Error calling settings callback", cb, ":", (exc.stack || exc));
}
}
} finally {
self.receiving(false);
self.callbacks = [];
}
// resolve all promises
var args = arguments;
_.each(self.outstanding, function(deferred) {
deferred.resolve(args);
});
self.outstanding = [];
})
.fail(function() {
// reject all promises
var args = arguments;
_.each(self.outstanding, function(deferred) {
deferred.reject(args);
});
self.outstanding = [];
})
.always(function() {
self.receiving(false);
});
};
self.requestTranslationData = function(callback) {
self.requestTranslationData = function() {
return OctoPrint.languages.list()
.done(self.fromTranslationResponse);
};