Merge lp:~abreu-alexandre/unity-webapps-qml/handle-bidirectional-callback-params into lp:unity-webapps-qml

[Alexandre Abreu]

Add bidirectional callback support between js <-> qml,

Add bidirectional callback support between js <-> qml,

The current situation is that javascript can (and has to) handoff js callbacks to qml, so that events are properly propagated and translated. One use case recently came up that highlighted the limitation that basically the "callback translation between js & qml" does not work both ways. The use case is for content hub share handler that might ask js to call a qml callback when an operation is done.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:135
http://jenkins.qa.ubuntu.com/job/unity-webapps-qml-ci/138/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-webapps-qml-utopic-amd64-ci/24/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-webapps-qml-utopic-armhf-ci/24/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-webapps-qml-ci/138/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:135
http://jenkins.qa.ubuntu.com/job/unity-webapps-qml-ci/139/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-webapps-qml-utopic-amd64-ci/25/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-webapps-qml-utopic-armhf-ci/25/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-webapps-qml-ci/139/rebuild

review: Needs Fixing (continuous-integration)

[lp:~abreu-alexandre/unity-webapps-qml/handle-bidirectional-callback-params]

127. By Alexandre Abreu on 2014-07-15

handle bidirectional callback parameters betwee js & qml

[Alberto Mardegan (mardy)]

What is the use case?

I added a couple of inline comments.

[lp:~abreu-alexandre/unity-webapps-qml/handle-bidirectional-callback-params]

128. By Alexandre Abreu on 2014-07-18

fixes

129. By Alexandre Abreu on 2014-07-18

fix nit

=== modified file 'debian/rules'
--- debian/rules	2013-07-11 17:53:01 +0000
+++ debian/rules	2014-07-18 17:03:51 +0000
@@ -9,7 +9,7 @@
 
 override_dh_install:
 	# install autopilot tests
-	cd tests/integration/autopilot; \
+	cd tests/autopilot; \
 	set -ex; for python in $(shell pyversions -r); do \
 		$$python setup.py install --root=$(CURDIR)/debian/tmp --install-layout=deb; \
 	done; \
 
=== modified file 'debian/unity-webapps-qml-autopilot.install'
--- debian/unity-webapps-qml-autopilot.install	2014-07-08 19:30:06 +0000
+++ debian/unity-webapps-qml-autopilot.install	2014-07-18 17:03:51 +0000
@@ -1,4 +1,4 @@
-tests/integration/autopilot/html/* usr/share/unity-webapps-qml/autopilot-tests/html/
-tests/integration/autopilot/data/* usr/share/unity-webapps-qml/autopilot-tests/data/
-tests/integration/autopilot/qml/* usr/share/unity-webapps-qml/autopilot-tests/qml/
+tests/autopilot/html/* usr/share/unity-webapps-qml/autopilot-tests/html/
+tests/autopilot/data/* usr/share/unity-webapps-qml/autopilot-tests/data/
+tests/autopilot/qml/* usr/share/unity-webapps-qml/autopilot-tests/qml/
 usr/lib/python*
 
=== modified file 'src/Ubuntu/UnityWebApps/Settings.qml'
--- src/Ubuntu/UnityWebApps/Settings.qml	2014-06-20 13:32:55 +0000
+++ src/Ubuntu/UnityWebApps/Settings.qml	2014-07-18 17:03:51 +0000
@@ -23,6 +23,6 @@
      *
      */
     property bool injectExtraUbuntuApis: false
-    property bool injectExtraUILaunchCapabilities: false
+    property bool injectExtraContentShareCapabilities: false
     property bool requiresInit: true
 }
 
=== modified file 'src/Ubuntu/UnityWebApps/UnityWebApps.js'
--- src/Ubuntu/UnityWebApps/UnityWebApps.js	2014-06-20 13:32:55 +0000
+++ src/Ubuntu/UnityWebApps/UnityWebApps.js	2014-07-18 17:03:51 +0000
@@ -36,12 +36,13 @@
      * \param backends
      * \param userscriptContent
      */
-    function _UnityWebApps(parentItem, bindeeProxies, accessPolicy) {
-        this._injected_unity_api_path = Qt.resolvedUrl('unity-webapps-api.js');
+    function _UnityWebApps(parentItem, bindeeProxies, accessPolicy, injected_api_path) {
+        this._injected_unity_api_path = injected_api_path;
         this._bindeeProxies = bindeeProxies;
         this._backends = null;
         this._userscripts = [];
         this._accessPolicy = accessPolicy;
+        this._callbackManager = UnityWebAppsUtils.makeCallbackManager();
 
         this._bind();
     };
@@ -110,7 +111,7 @@
          *
          */
         _onMessage: function(msg) {
-            if ( ! this._isValidWebAppsMessage(msg)) {
+            if ( ! this._isValidWebAppsMessage(msg) && ! this._isValidCallbackMessage(msg)) {
                 this._log ('Invalid message received: ' + json.stringify(msg));
 
                 return;
@@ -129,6 +130,7 @@
             return true;
         },
 
+
         /**
          * \internal
          *
@@ -175,6 +177,23 @@
                                           objectid: objectid,
                                           class_name: class_name,
                                           method_name: method_name}]);
+
+            } else if (target === UnityWebAppsUtils.UBUNTU_WEBAPPS_BINDING_API_CALLBACK_MESSAGE) {
+
+                var id = message.id;
+
+                if (! id || ! params)
+                    return;
+
+                var cbfunc = this._callbackManager.get(id);
+                if (!cbfunc || !(cbfunc instanceof Function)) {
+                    try {
+                        console.log('Invalid callback id: ' + id);
+                    }
+                    catch (e) {}
+                    return;
+                }
+                cbfunc.apply(null, params);
             }
         },
 
@@ -215,6 +234,10 @@
                     return;
 
                 var callback_args = Array.prototype.slice.call(arguments);
+                callback_args = callback_args.map (function (arg) {
+                    return UnityWebAppsUtils.transformCallbacksToIds(arg, self._callbackManager);
+                });
+
                 var message = UnityWebAppsUtils.formatUnityWebappsCallbackCall(callbackid, callback_args);
 
                 self._bindeeProxies.sendToPage(JSON.stringify(message));
@@ -258,7 +281,7 @@
                 }
             }
             return ret;
-          },
+        },
 
         /**
          * \internal
@@ -281,6 +304,17 @@
                     message.target.indexOf('ubuntu-webapps-binding-call') === 0 &&
                     message.name &&
                     message.args;
+        },
+
+        /**
+         * \internal
+         *
+         */
+        _isValidCallbackMessage: function(message) {
+            return message != null &&
+                    message.target &&
+                    message.target.indexOf('ubuntu-webapps-binding-callback-call') === 0 &&
+                    message.args;
         }
     };
 
 
=== modified file 'src/Ubuntu/UnityWebApps/UnityWebApps.pro'
--- src/Ubuntu/UnityWebApps/UnityWebApps.pro	2014-05-16 16:29:35 +0000
+++ src/Ubuntu/UnityWebApps/UnityWebApps.pro	2014-07-18 17:03:51 +0000
@@ -4,9 +4,6 @@
 TEMPLATE = subdirs
 SUBDIRS += plugin
 
-#
-#
-#
 UNITY_API_JS_FILE = $$system($$PWD/../../../tools/inject-js-utils.py unity-webapps-api.js.in unity-webapps-api.js)
 
 inject_dependancies.target = unity-webapps-api.js
 
=== modified file 'src/Ubuntu/UnityWebApps/UnityWebApps.qml'
--- src/Ubuntu/UnityWebApps/UnityWebApps.qml	2014-07-08 19:27:21 +0000
+++ src/Ubuntu/UnityWebApps/UnityWebApps.qml	2014-07-18 17:03:51 +0000
@@ -28,7 +28,6 @@
 import "./bindings/online-accounts/backend/online-accounts.js" as OnlineAccountsApiBackend
 import "./bindings/download-manager/backend/download-api.js" as DownloadApiBackend
 
-
 /*!
     \qmltype UnityWebApps
     \inqmlmodule Ubuntu.UnityWebApps 0.1
@@ -121,10 +120,10 @@
     property alias injectExtraUbuntuApis: settings.injectExtraUbuntuApis
 
     /*!
-      \qmlproperty bool UnityWebApps::injectExtraUILaunchCapabilities
+      \qmlproperty bool UnityWebApps::injectExtraContentShareCapabilities
 
      */
-    property alias injectExtraUILaunchCapabilities: settings.injectExtraUILaunchCapabilities
+    property alias injectExtraContentShareCapabilities: settings.injectExtraContentShareCapabilities
 
     /*!
       \qmlproperty bool UnityWebApps::requiresInit
@@ -142,13 +141,22 @@
     property var actionsContext: null
 
     /*!
-      \qmlproperty string UnityWebApps::_opt_backendProxies
+      \qmlproperty string UnityWebApps::customBackendProxies
 
       Used only for testing.
       Allows optional (not the default ones) mocked backends to be used.
 
      */
-    property var _opt_backendProxies: null
+    property var customBackendProxies: null
+
+    /*!
+      \qmlproperty string UnityWebApps::_opt_clientApiFileUrl
+
+      Used only for testing.
+      Allows optional (not the default ones) client api to be used instead of the default one.
+
+     */
+    property string customClientApiFileUrl: ""
 
     /*!
       \qmlproperty string UnityWebApps::_opt_homepage
@@ -162,7 +170,7 @@
 
     Settings {
         id: settings
-        injectExtraUILaunchCapabilities: name && name.length && name.length !== 0
+        injectExtraContentShareCapabilities: name && name.length && name.length !== 0
     }
 
 /*
@@ -216,10 +224,15 @@
             console.debug('__bind: ERROR bindee proxies not valid')
             return;
         }
+        var instance =
+            new UnityWebAppsJs.UnityWebApps(
+                    webapps,
+                    bindeeProxies,
+                    __getPolicyForContent(settings),
+                    customClientApiFileUrl && customClientApiFileUrl.length !== 0
+                      ? customClientApiFileUrl
+                      : Qt.resolvedUrl('unity-webapps-api.js'));
 
-        var instance = new UnityWebAppsJs.UnityWebApps(webapps,
-                                                       bindeeProxies,
-                                                       __getPolicyForContent(settings));
         internal.instance = instance;
 
         if (internal.backends)
@@ -232,8 +245,8 @@
      */
     function __createBackendsIfNeeded() {
         var backends;
-        if (_opt_backendProxies != null)
-            backends = _opt_backendProxies;
+        if (customBackendProxies != null)
+            backends = customBackendProxies;
         else {
             backends = __makeBackendProxies();
         }
@@ -245,7 +258,7 @@
 
      */
     function __initBackends() {
-        if (__isValidWebAppName(webapps.name) || injectExtraUbuntuApis) {
+        if (customBackendProxies || __isValidWebAppName(webapps.name) || injectExtraUbuntuApis) {
             internal.backends = __createBackendsIfNeeded();
             if (internal.backends && internal.instance)
                 internal.instance.setBackends(internal.backends);
@@ -368,6 +381,8 @@
         }
     }
 
+    onCustomBackendProxiesChanged: __initBackends()
+
     /*!
       \internal
 
@@ -448,17 +463,32 @@
             this.restrictions = restrictions || BASIC_WEBAPPS_ALLOWED_APIS;
         };
         RestrictedPolicy.prototype.allowed = function(signature) {
-            return this.restrictions.some(function(e) { return e === signature; });
+            return this.restrictions.some(function(e) { return signature.match(e); });
+        };
+        RestrictedPolicy.prototype.add = function(signature) {
+            if (! this.restrictions.some(function(e) { return e === signature; })) {
+                this.restrictions.push(signature);
+            }
         };
 
         if (settings.injectExtraUbuntuApis)
             return new PassthroughPolicy();
 
-//        if (settings.injectExtraUILaunchCapabilities)
-//            return new RestrictedPolicy(["launchEmbeddedUI", "ContentHub.onShareRequested"]);
-
-        // Inject only the basic init + api
-        return new PassthroughPolicy()
+        var policy = new RestrictedPolicy(['init',
+                                           'addAction',
+                                           'clearAction',
+                                           'clearActions',
+                                           'acceptData',
+                                           'Launcher.*',
+                                           'Notification.*',
+                                           'Launcher.*',
+                                           'MediaPlayer.*',
+                                           'MessagingIndicator.*']);
+        if (settings.injectExtraContentShareCapabilities) {
+            policy.add("launchEmbeddedUI");
+            policy.add("ContentHub.onShareRequested");
+        }
+        return policy;
     }
 
     /*!
@@ -602,11 +632,10 @@
                         uiobject.destroy();
                         return;
                     }
-                    function _onCompleted(data) {
+                    function _onCompleted(data, onResourceUploadedCallback) {
                         p.visible = true;
                         uiobject.onCompleted.disconnect(_onCompleted);
-                        uiobject.destroy();
-                        callback(data);
+                        callback(data, onResourceUploadedCallback);
                     }
                     uiobject.onCompleted.connect(_onCompleted);
                 };
 
=== modified file 'src/Ubuntu/UnityWebApps/UnityWebAppsUtils.js'
--- src/Ubuntu/UnityWebApps/UnityWebAppsUtils.js	2014-07-08 19:27:21 +0000
+++ src/Ubuntu/UnityWebApps/UnityWebAppsUtils.js	2014-07-18 17:03:51 +0000
@@ -19,6 +19,7 @@
 .pragma library
 
 var UBUNTU_WEBAPPS_BINDING_API_CALL_MESSAGE = "ubuntu-webapps-binding-call";
+var UBUNTU_WEBAPPS_BINDING_API_CALLBACK_MESSAGE = "ubuntu-webapps-binding-callback-call";
 var UBUNTU_WEBAPPS_BINDING_OBJECT_METHOD_CALL_MESSAGE = "ubuntu-webapps-binding-call-object-method";
 
 
@@ -331,4 +332,71 @@
         + pad(d.getUTCSeconds()) + 'Z';
 };
 
+function transformFunctionToCallbackIdIfNecessary(obj, callbackManager) {
+    var ret = obj;
+    if (obj instanceof Function && callbackManager && callbackManager.store) {
+        var id = callbackManager.store(obj);
+        ret = {callbackid: id};
+    }
+    return ret;
+}
+
+function transformCallbacksToIds(obj, callbackManager) {
+    if ( ! isIterableObject(obj)) {
+        return transformFunctionToCallbackIdIfNecessary(obj, callbackManager);
+    }
+    var ret = (obj instanceof Array) ? [] : {};
+    for (var key in obj) {
+        if (obj.hasOwnProperty(key)) {
+            if (obj[key] instanceof Function) {
+                ret[key] = transformFunctionToCallbackIdIfNecessary(obj[key], callbackManager);
+            }
+            else if (isIterableObject (obj[key])) {
+                ret[key] = transformCallbacksToIds(obj[key]);
+            }
+            else {
+                ret[key] = obj[key];
+            }
+        }
+    }
+    return ret;
+}
+
+/**
+ * Wraps callback ids in proper callback that dispatch to the
+ * webpage thru a proper event
+ *
+ */
+function wrapCallbackIds(obj) {
+    if ( ! obj)
+        return obj;
+
+    if (!UnityWebAppsUtils.isIterableObject(obj)) {
+        return obj;
+    }
+
+    if (obj
+        && obj.hasOwnProperty('callbackid')
+        && obj.callbackid !== null) {
+      return this._makeWebpageCallback (obj.callbackid);
+    }
+
+    var ret = (obj instanceof Array) ? [] : {};
+    for (var key in obj) {
+        if (obj.hasOwnProperty(key)) {
+            if (UnityWebAppsUtils.isIterableObject (obj[key])) {
+                if (obj[key].callbackid !== null) {
+                    ret[key] = this._makeWebpageCallback (obj[key].callbackid);
+                }
+                else {
+                    ret[key] = this._wrapCallbackIds (obj[key]);
+                }
+            }
+            else {
+                ret[key] = obj[key];
+            }
+        }
+    }
+    return ret;
+}
 
 
=== modified file 'src/Ubuntu/UnityWebApps/common/js/unity-binding-bridge.js'
--- src/Ubuntu/UnityWebApps/common/js/unity-binding-bridge.js	2014-03-18 18:52:11 +0000
+++ src/Ubuntu/UnityWebApps/common/js/unity-binding-bridge.js	2014-07-18 17:03:51 +0000
@@ -137,6 +137,64 @@
     },
 
     /**
+     * \internal
+     *
+     */
+    _makeWebpageCallback: function (callbackid) {
+        var self = this;
+        return function () {
+            var callback_args = Array.prototype.slice.call(arguments);
+
+            callback_args = callback_args.map (function (arg) {
+                return self._transformCallbacksToIds(arg);
+            });
+
+            var message = formatUnityWebappsCallbackCall(callbackid, JSON.stringify(callback_args));
+
+            self._sendToBackend(JSON.stringify(message));
+        };
+    },
+
+    /**
+     * \internal
+     *
+     * Wraps callback ids in proper callback that dispatch to the
+     * webpage thru a proper event
+     *
+     */
+    _wrapCallbackIds: function (obj) {
+        if ( ! obj)
+            return obj;
+        if ( ! isIterableObject(obj)) {
+            return obj;
+        }
+
+        if (obj
+            && obj.hasOwnProperty('callbackid')
+            && obj.callbackid !== null) {
+          return this._makeWebpageCallback (obj.callbackid);
+        }
+
+        var ret = (obj instanceof Array) ? [] : {};
+        for (var key in obj) {
+            if (obj.hasOwnProperty(key)) {
+                if (UnityWebAppsUtils.isIterableObject (obj[key])) {
+                    if (obj[key].callbackid != null) {
+                        ret[key] = this._makeWebpageCallback (obj[key].callbackid);
+                    }
+                    else {
+                        ret[key] = this._wrapCallbackIds (obj[key]);
+                    }
+                }
+                else {
+                    ret[key] = obj[key];
+                }
+            }
+        }
+        return ret;
+    },
+
+    /**
      * @internal
      */
     _dispatchCallbackCall: function(id, args) {
@@ -174,6 +232,11 @@
             else if (arg instanceof Array) {
                 return self._translateArgs(arg);
             }
+            else if (arg
+                && arg.hasOwnProperty('callbackid')
+                && arg.callbackid !== null) {
+              return self._makeWebpageCallback (arg.callbackid);
+            }
 
             return arg;
         });
 
=== renamed directory 'tests/integration/autopilot' => 'tests/autopilot'
=== modified file 'tests/autopilot/autopilot.pro'
--- tests/integration/autopilot/autopilot.pro	2014-07-08 19:27:21 +0000
+++ tests/autopilot/autopilot.pro	2014-07-18 17:03:51 +0000
@@ -1,5 +1,16 @@
 TEMPLATE=aux
 
+UNITY_API_JS_FILE = $$system($$PWD/../../tools/inject-js-utils.py ./html/test_webapps_callback_dispatch_api.js.in ./html/test_webapps_callback_dispatch_api.js)
+
+inject_dependancies.target = ./html/test_webapps_callback_dispatch_api.js
+inject_dependancies.depends = ./html/test_webapps_callback_dispatch_api.js.in
+inject_dependancies.commands = $$PWD/../../tools/inject-js-utils.py $< $@
+
+QMAKE_EXTRA_TARGETS += inject_dependancies
+
+PRE_TARGETDEPS += \
+    ./html/test_webapps_callback_dispatch_api.js
+
 OTHER_FILES += \
     $$system(ls ./qml/*) \
     $$system(ls ./html/*) \
@@ -11,4 +22,11 @@
     unity_webapps_qml/tests/fake_servers.py \
     qml/WebviewBackendWebkit.qml \
     qml/WebviewBackendOxide.qml \
-    qml/message-server.js
+    qml/message-server.js \
+    $$system(ls ./data/installed-webapps/*) \
+    unity_webapps_qml/tests/test_callbackDispatch.py \
+    html/test_webapps_callback_dispatch.html \
+    html/test_webapps_callback_dispatch_api.js \
+    html/test_webapps_callback_dispatch_api.js.in \
+    qml/test_webapps_callback_dispatch_api.qml
+
 
=== added file 'tests/autopilot/html/test_webapps_callback_dispatch.html'
--- tests/autopilot/html/test_webapps_callback_dispatch.html	1970-01-01 00:00:00 +0000
+++ tests/autopilot/html/test_webapps_callback_dispatch.html	2014-07-18 17:03:51 +0000
@@ -0,0 +1,57 @@
+<html>
+
+<head>
+<title>Unity Webapps QML test: callback</title>
+
+<script>
+
+window.onload = function () {
+    var unity;
+    function init() {
+        unity = window.external.getUnityObject('1.0');
+        doCallbackLoop();
+    }
+
+    var CALLBACK_COUNT_MAX_COUNT = 10;
+    var callbackLoopCount = 0;
+    function doCallbackLoop(callback) {
+        if (callbackLoopCount >= CALLBACK_COUNT_MAX_COUNT) {
+            document.getElementById('content').innerHTML = 'callback-loop-count-reached';
+            return;
+        }
+        ++callbackLoopCount;
+
+        if (callback && typeof callback === 'Function') {
+            callback(doCallbackLoop);
+        }
+        else {
+            unity.withCallback(doCallbackLoop);
+        }
+    }
+
+        init();
+
+    if (window.external.getUnityObject) {
+        init();
+    }
+    else {
+        document.addEventListener('ubuntu-webapps-api-ready', function () {
+            init();
+        }, false);
+    }
+}
+
+</script>
+
+</head>
+
+<body>
+
+HELLO WORLD
+
+<div id="content">
+</div>
+
+</body>
+
+</html>
 
=== added file 'tests/autopilot/html/test_webapps_callback_dispatch_api.js.in'
--- tests/autopilot/html/test_webapps_callback_dispatch_api.js.in	1970-01-01 00:00:00 +0000
+++ tests/autopilot/html/test_webapps_callback_dispatch_api.js.in	2014-07-18 17:03:51 +0000
@@ -0,0 +1,58 @@
+/*
+ * Copyright 2014 Canonical Ltd.
+ *
+ * This file is part of unity-webapps-qml.
+ *
+ * unity-webapps-qml is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * unity-webapps-qml is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+(function () {
+
+    // Acknowledge that the API has been fully injected
+    var sendApiCreatedAcknowledgeEvent = function () {
+        var e = document.createEvent ("Events");
+        e.initEvent ("ubuntu-webapps-api-ready", false, false);
+        document.dispatchEvent (e);
+    };
+
+    //@include ../../src/Ubuntu/UnityWebApps/UnityWebAppsUtils.js
+    //@include ../../src/Ubuntu/UnityWebApps/common/js/unity-backend-messaging-proxy.js
+    //@include ../../src/Ubuntu/UnityWebApps/common/js/unity-binding-proxy.js
+    //@include ../../src/Ubuntu/UnityWebApps/common/js/unity-binding-bridge.js
+
+    var apiBuilder = function(backend) {
+        return {
+            withCallback: function(callback) {
+                backend.call('withCallback', [callback]);
+            }
+        };
+    };
+
+    var apiBridge = new UnityBindingBridge(
+        makeCallbackManager(),
+        createMessagingProxyForCurrentWebRuntime());
+
+    var api = apiBuilder (apiBridge);
+
+    apiBridge.setBindingApi(api);
+
+    if (!window.external)
+        window.external = {};
+
+    window.external.getUnityObject = function (version) {
+        return api;
+    };
+
+    sendApiCreatedAcknowledgeEvent();
+}) ();
+
 
=== modified file 'tests/autopilot/qml/FullWebViewApp.qml'
--- tests/integration/autopilot/qml/FullWebViewApp.qml	2014-07-08 19:27:21 +0000
+++ tests/autopilot/qml/FullWebViewApp.qml	2014-07-18 17:03:51 +0000
@@ -51,6 +51,10 @@
 
     property bool useOxide: false
     property string url: ""
+
+    property string apiBackendQmlFileUrl: ""
+    property string clientApiFileUrl: ""
+
     property string webappName: ""
     property string webappSearchPath: ""
     property string webappHomepage: ""
@@ -82,9 +86,18 @@
     }
 
     Loader {
+        id: apiBackendQmlFileLoader
+        source: apiBackendQmlFileUrl.length !== 0 ? apiBackendQmlFileUrl : ""
+    }
+
+    Loader {
         id: unityWebappsComponentLoader
         anchors.fill: parent
-        sourceComponent: webView !== null && webappName.length !== 0 ? unityWebappsComponent : null
+        sourceComponent: (webView !== null && webappName.length !== 0) ?
+                    (apiBackendQmlFileUrl.length !== 0 ?
+                      (apiBackendQmlFileLoader.item ? unityWebappsComponent : undefined)
+                      : unityWebappsComponent)
+                    : null
     }
 
     UnityWebappsAppModel {
@@ -100,9 +113,15 @@
             objectName: "webappsContainer"
             actionsContext: webappsActionsContext
             name: root.webappName
+            injectExtraUbuntuApis: true
+            customBackendProxies: apiBackendQmlFileLoader.item
+                                 ? apiBackendQmlFileLoader.item.buildapi()
+                                 : undefined
+            customClientApiFileUrl: root.clientApiFileUrl
             bindee: webView
             _opt_homepage: root.webappHomepage
             model: webappModel
         }
     }
 }
+
 
=== added file 'tests/autopilot/qml/test_webapps_callback_dispatch_api.qml'
--- tests/autopilot/qml/test_webapps_callback_dispatch_api.qml	1970-01-01 00:00:00 +0000
+++ tests/autopilot/qml/test_webapps_callback_dispatch_api.qml	2014-07-18 17:03:51 +0000
@@ -0,0 +1,14 @@
+import QtQuick 2.0
+
+Item {
+    function buildapi() {
+        return {
+            withCallback: function(clientCallback) {
+                function callbackLoop(callback) {
+                    callback(callbackLoop);
+                }
+                clientCallback(callbackLoop);
+            }
+        };
+    }
+}
 
=== modified file 'tests/autopilot/unity_webapps_qml/tests/__init__.py'
--- tests/integration/autopilot/unity_webapps_qml/tests/__init__.py	2014-07-08 19:27:21 +0000
+++ tests/autopilot/unity_webapps_qml/tests/__init__.py	2014-07-18 17:03:51 +0000
@@ -21,7 +21,7 @@
 
 from unity.tests import UnityTestCase
 
-LOCAL_QML_LAUNCHER_APP_PATH = "%s/%s" % (os.path.dirname(os.path.realpath(__file__)), '../../../../../tools/qml-launcher/unity-webapps-qml-launcher')
+LOCAL_QML_LAUNCHER_APP_PATH = "%s/%s" % (os.path.dirname(os.path.realpath(__file__)), '../../../../tools/qml-launcher/unity-webapps-qml-launcher')
 INSTALLED_QML_LAUNCHER_APP_PATH = 'unity-webapps-qml-launcher'
 
 # TODO create __init__.py.in
@@ -31,6 +31,7 @@
 BASE_URL = ''
 
 class UnityWebappsTestCaseBase(UnityTestCase):
+
     def setUp(self):
         super(UnityWebappsTestCaseBase, self).setUp()
         self.use_oxide = False
@@ -56,7 +57,8 @@
                           webapp_name='unitywebappsqmllauncher',
                           webapp_search_path="",
                           webapp_homepage="",
-                          use_oxide=False):
+                          use_oxide=False,
+                          extra_params=[]):
         base_params = ['--qml=' + self.get_qml_browser_container_path(),
             '--app-id=' + webapp_name,
             '--webappName=' + webapp_name,
@@ -74,15 +76,17 @@
         if os.path.exists(LOCAL_QML_LAUNCHER_APP_PATH):
             # we are local
             base_params.append('--import=' + os.path.join (os.path.dirname(os.path.realpath(__file__)),
-                               '../../../../../src'))
+                               '../../../../src'))
+
+        base_params += extra_params
 
         return base_params
 
-    def launch_with_html_filepath(self, html_filepath):
+    def launch_with_html_filepath(self, html_filepath, extra_params=[]):
         self.assertThat(os.path.exists(html_filepath), Equals(True))
         url = self.create_file_url(html_filepath)
 
-        self.launch_application(self.get_launch_params(url))
+        self.launch_application(self.get_launch_params(url, 'unitywebappsqmllauncher', '', '', False, extra_params))
         self.assert_url_eventually_loaded(url)
 
     def launch_application(self, args):
 
=== added file 'tests/autopilot/unity_webapps_qml/tests/test_callbackDispatch.py'
--- tests/autopilot/unity_webapps_qml/tests/test_callbackDispatch.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/unity_webapps_qml/tests/test_callbackDispatch.py	2014-07-18 17:03:51 +0000
@@ -0,0 +1,60 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+# Copyright 2014 Canonical
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+
+from __future__ import absolute_import
+
+import time
+import os
+
+from testtools.matchers import Equals, GreaterThan, NotEquals
+from autopilot.matchers import Eventually
+
+from unity_webapps_qml.tests import UnityWebappsTestCaseBase
+
+LOCAL_HTML_TEST_FILE = "%s/%s" % (os.path.dirname(os.path.realpath(__file__)), '../../html/test_webapps_callback_dispatch.html')
+INSTALLED_HTML_TEST_FILE = '/usr/share/unity-webapps-qml/autopilot-tests/html/test_webapps_callback_dispatch.html'
+
+LOCAL_JS_TEST_FILE = "%s/%s" % (os.path.dirname(os.path.realpath(__file__)), '../../html/test_webapps_callback_dispatch_api.js')
+INSTALLED_JS_TEST_FILE = '/usr/share/unity-webapps-qml/autopilot-tests/html/test_webapps_callback_dispatch_api.js'
+
+LOCAL_QML_BACKEND_TEST_FILE = "%s/%s" % (os.path.dirname(os.path.realpath(__file__)), '../../qml/test_webapps_callback_dispatch_api.qml')
+INSTALLED_QML_BACKEND_TEST_FILE = '/usr/share/unity-webapps-qml/autopilot-tests/qml/test_webapps_callback_dispatch_api.qml'
+
+class WebappsCallbackDispatchTestCaseBase(UnityWebappsTestCaseBase):
+    def setUp(self):
+        super(WebappsCallbackDispatchTestCaseBase, self).setUp()
+        self.launch_with_html_filepath(
+            self.get_html_test_file(),
+            ['--clientApiFileUrl=file://' + self.get_js_test_file(),
+             '--apiBackendQmlFileUrl=file://' + self.get_qml_test_file()])
+
+    def get_html_test_file(self):
+        if os.path.exists(LOCAL_HTML_TEST_FILE):
+            return os.path.abspath(LOCAL_HTML_TEST_FILE)
+        return INSTALLED_HTML_TEST_FILE
+
+    def get_js_test_file(self):
+        if os.path.exists(LOCAL_JS_TEST_FILE):
+            return os.path.abspath(LOCAL_JS_TEST_FILE)
+        return INSTALLED_JS_TEST_FILE
+
+    def get_qml_test_file(self):
+        print LOCAL_QML_BACKEND_TEST_FILE
+        if os.path.exists(LOCAL_QML_BACKEND_TEST_FILE):
+            return os.path.abspath(LOCAL_QML_BACKEND_TEST_FILE)
+        return INSTALLED_QML_BACKEND_TEST_FILE
+
+    def test_bidirectionalCallback(self):
+        self.assertThat(
+            lambda: self.eval_expression_in_page_unsafe(
+                'return window.external.getUnityObject("1.0") != null;'),
+            Eventually(Equals(True)))
+
+        self.assertThat(
+            lambda: self.eval_expression_in_page_unsafe("return document.getElementById('content').innerHTML;"),
+            Eventually(Equals('callback-loop-count-reached')))
+
 
=== removed directory 'tests/integration'
=== removed file 'tests/integration/integration.pro'
--- tests/integration/integration.pro	2013-07-09 19:02:23 +0000
+++ tests/integration/integration.pro	1970-01-01 00:00:00 +0000
@@ -1,3 +0,0 @@
-TEMPLATE = subdirs
-
-SUBDIRS = autopilot
 
=== modified file 'tests/tests.pro'
--- tests/tests.pro	2013-07-24 20:31:38 +0000
+++ tests/tests.pro	2014-07-18 17:03:51 +0000
@@ -1,4 +1,4 @@
 TEMPLATE=subdirs
 
-SUBDIRS = unit integration
+SUBDIRS = unit autopilot
 
 
=== modified file 'tests/unit/test_qml/tst_dispatch.qml'
--- tests/unit/test_qml/tst_dispatch.qml	2014-04-14 20:57:17 +0000
+++ tests/unit/test_qml/tst_dispatch.qml	2014-07-18 17:03:51 +0000
@@ -19,7 +19,7 @@
 
         var simple_backend = {This: { Is: { A: {Backend: function (args) { mockedWebView.called(args) } } } } };
 
-        webapps._opt_backendProxies = simple_backend;
+        webapps.customBackendProxies = simple_backend;
         webapps.name = "test_properBackendDispatched";
         webapps.bindee = mockedWebView;
 
@@ -47,7 +47,7 @@
 
         var simple_backend = {This: { Is: { A: {Backend: action } } } };
 
-        webapps._opt_backendProxies = simple_backend;
+        webapps.customBackendProxies = simple_backend;
         webapps.name = "test_backendDispatchedWithProperArguments";
         webapps.bindee = mockedWebView;
 
@@ -65,7 +65,7 @@
 
         var invalid_backend = {This: { Is: { Not: { A: {Backend: function (args) { mockedWebView.called(args) } } } } } };
 
-        webapps._opt_backendProxies = invalid_backend;
+        webapps.customBackendProxies = invalid_backend;
         webapps.name = "test_invalidBackendNotDispatched";
         webapps.bindee = mockedWebView;
 
@@ -94,7 +94,7 @@
 
         var backend = {This: { Is: { A: {Backend: action } } } };
 
-        webapps._opt_backendProxies = backend;
+        webapps.customBackendProxies = backend;
         webapps.name = "test_callbacksAreWrapped";
         webapps.bindee = mockedWebView;
 
 
=== modified file 'tools/qml-launcher/qml-launcher.cpp'
--- tools/qml-launcher/qml-launcher.cpp	2014-07-08 19:27:21 +0000
+++ tools/qml-launcher/qml-launcher.cpp	2014-07-18 17:03:51 +0000
@@ -119,17 +119,17 @@
 
             QString value = argument.right(argument.count() - argument.indexOf(VALUE_HEADER) - 1);
 
-            qDebug() << "Adding property: "
+            qDebug() << "Adding property:"
                      << property
-                     << ", "
-                     << "value: "
+                     << ","
+                     << "value:"
                      << value;
 
             properties.insert(property, value);
         }
         else
         {
-            qDebug() << "Ignoring argument: " << argument;
+            qDebug() << "Ignoring argument:" << argument;
         }
     }
 
@@ -147,13 +147,13 @@
     QFileInfo f(qmlfile);
     if (!f.exists() || !f.isFile())
     {
-        qDebug() << "QML file not found or not a file: " << qmlfile;
+        qDebug() << "QML file not found or not a file:" << qmlfile;
         return EXIT_FAILURE;
     }
 
     if ( ! importPath.isEmpty())
     {
-        qDebug() << "Setting import path to: " << importPath;
+        qDebug() << "Setting import path to:" << importPath;
         qputenv("QML2_IMPORT_PATH", importPath.toLatin1());
     }
 
@@ -167,7 +167,7 @@
 
     if ( ! inspector.isEmpty())
     {
-        qDebug() << "Inspector server being set to: " << inspector;
+        qDebug() << "Inspector server being set to:" << inspector;
 
         qputenv("QTWEBKIT_INSPECTOR_SERVER", inspector.toLatin1());
     }
@@ -202,7 +202,6 @@
     if (useOxide) {
         object->setProperty("useOxide", true);
     }
-
     component.completeCreate();
 
     if (window)