0026894: Stabilization: Improve the synchronization management

Openbravo Issue Tracking System - Retail Modules

View Issue Details

Project

Category

View Status

Date Submitted

Last Update

0026894

Retail Modules

Web POS

public

2014-06-18 11:08

2014-09-30 18:05

Reporter

Orekaria

Assigned To

Orekaria

Priority

normal

Severity

major

Reproducibility

always

Status

closed

Resolution

fixed

Platform

OS Version

Product Version

Target Version

RR14Q4

Fixed in Version

RR14Q4

Merge Request Status

Review Assigned To

marvintm

OBNetwork customer

Support ticket

Regression level

Regression date

Regression introduced in release

Regression introduced by commit

Triggers an Emergency Pack

Summary

0026894: Stabilization: Improve the synchronization management

Description

Improve the synchronization management

Steps To Reproduce

See the list below of related and blocked issues

Proposed Solution

utils/ob-syncrhonization.js

*
  The SynchornizationHelper class is intended to watch asynchronous calls in the application

  This class does only 2 things:
    - fire a 'synchronizing' event when registered (see below) asynchronous calls in the application starts
    - fire a 'synchronized' event when all the registered asynchronous calls have finished

  These events can and should be received by:
    - ui elements that have to be disabled because the underlying asynchronous calls are blocking its correct behavior (e.g.: the login button or the total to pay button)
    - model elements that have to wait until underlying asynchronous calls have finished (e.g.: update the local database)

  Required:
    - The asynchronous calls to be tracked have to be registered by one of the available SynchronizationHelper methods

  Howto implement the SynchronizationHelper:
    - find the asynchronous calls that are vital for the application
    - add a SynchronizationHelper.busyUntilFinishes and get the returning id
    - add a SynchronizationHelper.finished(<busyUntilFinishes_id>) when the asynchronous call have finished, success or fail
    - subscribe to the events 'synchronizing' and 'synchronized', the elements that you want to depend on the SynchronizationHelper status

  Notes:
    - to see the SynchronizationHelper log, set verbose = true
    - console.error is used because it attaches the stacktrace to the message

  Example of registering/unregistering asynchronous calls (ob-datasource.js):
    function serviceGET(source, dataparams, callback, callbackError, async) {
      var synchId = SynchronizationHelper.busyUntilFinishes('serviceGET ' + source);
      ...
      var ajaxRequest = new enyo.Ajax({
        ...
        success: function (inSender, inResponse) {
          SynchronizationHelper.finished(synchId, 'serviceGET');
          ...
        },
        fail: function (status, inResponse) {
          SynchronizationHelper.finished(synchId, 'serviceGET');
          ...
        }
      });
      ajaxRequest.go().response('success').error('fail');
    }

  Example of event subscriptions (ob-login.js):
    enyo.kind({
      name: 'OB.OBPOSLogin.UI.LoginButton',
      ...
      handlers: {
        synchronizing: 'disableButton',
        synchronized: 'enableButton'
      },
        disableButton: function () {
        this.setDisabled(true);
      },
      enableButton: function () {
        this.setDisabled(false);
      },
      initComponents: function () {
        this.inherited(arguments);
        ...
        this.setDisabled(true);
      }
    });
*/

Additional Information

Tags

No tags attached.

Relationships

related to	defect	0026880		closed	Orekaria	In very slow computers the WebPOS can be cheated
related to	defect	0026740	RR14Q3	closed	malsasua	Disable the pay button until the discounts have been applied
related to	defect	0026866	RR14Q3	closed	malsasua	Total should not be available until all the amounts has been recalculated
related to	defect	0027173		closed	Orekaria	The "Synchronizing data..." message is showing along with the "Data synchronization was..."
blocks	defect	0027059	RR14Q4	closed	marvintm	Discounts processing will be delayed for a bit of time to improve performance
blocks	defect	0027192	RR14Q4	closed	Orekaria	The cash button on cashup step 3 of 5 shows up when it shouldn't
blocks	design defect	0027228		new	marvintm	Stabilization: Web POS should validate that models have been imported properly to Web POS
blocks	defect	0027212	RR14Q4	closed	Orekaria	Stabilization: The buttons in the cashup can be tapped faster than the time its async processes need to finish
blocks	defect	0027268	RR14Q4	closed	Orekaria	Stabilization: Improve the enabling/disabling of the pay button
blocks	defect	0027287	RR14Q4	closed	Orekaria	Stabilization: The 'pay' button should not be enabled by default on WebPOS load
blocks	defect	0027291	RR14Q4	closed	Orekaria	Performance: the new SynchronizationHelper can be used to load delayed models at the right time
blocks	defect	0027300	RR14Q4	closed	Orekaria	Stabilization: The 'log in' button should be disabled until the synchronization has finished
blocks	defect	0027302	RR14Q4	closed	Orekaria	Stabilization: the Cash Management 'done' button should not be enabled while synchronizing
blocks	defect	0027348	RR14Q4	closed	Orekaria	Stabilization: Refactor the MobileCoreComponentProvider for better readability and more atomic commits
blocks	feature request	0027267	RR14Q4	closed	Orekaria	Stabilization: Core async calls should be watched by the SynchronizationHelper
blocks	feature request	0027329		new	Retail	Stabilization: Overhaul the loading process (since the url is entered until the webpos has loaded)
blocks	backport	0027431		closed	Retail	Sometimes the business partner is empty when the WebPOS loads
blocks	defect	0027506	RR14Q4	closed	Orekaria	Stabilization: The 'pay' button should not be enabled if the order can't be payed
blocks	design defect	0027672	RR14Q4	closed	Orekaria	Stabilization: The SynchronizationHelper should be inside the OB.UTIL namespace
blocks	defect	0027908		closed	Orekaria	Disable the timeout of the SynchronizationHelper
blocks	feature request	0028217		new	Retail	Stabilization: Create a basic API for the asynchronous calls