Merge lp:~justinmcp/unity-webapps-gmail/heuristics-update into lp:unity-webapps-gmail

[Justin McPherson]

Change to use the WebApp class.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:89
http://jenkins.qa.ubuntu.com/job/unity-webapps-gmail-ci/18/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-webapps-gmail-trusty-amd64-ci/11/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-webapps-gmail-trusty-armhf-ci/11/console

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

review: Needs Fixing (continuous-integration)

[lp:~justinmcp/unity-webapps-gmail/heuristics-update]

90. By Justin McPherson on 2013-12-20

Fix loaded support, add missing name.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:90
http://jenkins.qa.ubuntu.com/job/unity-webapps-gmail-ci/19/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-webapps-gmail-trusty-amd64-ci/12/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-webapps-gmail-trusty-armhf-ci/12/console

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

review: Needs Fixing (continuous-integration)

[Robert Bruce Park (robru)]

Your diff introduces '@require validate.js', which causes the jslint checker to fail because it cannot find validate.js in the userscripts directory. What is this file and where did you get it from? The jenkins failure can most easily be resolved by not requiring validate.js, assuming that it can be easily removed from the code...

[Justin McPherson (justinmcp)]

My fault, I mistakenly believed there was some dependency tracking between
projects. This should work when some changes to webapps-application go
through (webapp-support).

On Tue, Jan 7, 2014 at 11:06 AM, Robert Bruce Park <
<email address hidden>> wrote:

> Your diff introduces '@require validate.js', which causes the jslint
> checker to fail because it cannot find validate.js in the userscripts
> directory. What is this file and where did you get it from? The jenkins
> failure can most easily be resolved by not requiring validate.js, assuming
> that it can be easily removed from the code...
> --
>
> https://code.launchpad.net/~justinmcp/unity-webapps-gmail/heuristics-update/+merge/199409
> You are the owner of lp:~justinmcp/unity-webapps-gmail/heuristics-update.
>

[Justin McPherson (justinmcp)]

(for completeness)

webapp-support requires changes in node-validation (which is where
validate.js lives).

On Tue, Jan 7, 2014 at 11:22 AM, Justin McPherson <
<email address hidden>> wrote:

> My fault, I mistakenly believed there was some dependency tracking between
> projects. This should work when some changes to webapps-application go
> through (webapp-support).
>
>
>
>
> On Tue, Jan 7, 2014 at 11:06 AM, Robert Bruce Park <
> <email address hidden>> wrote:
>
>> Your diff introduces '@require validate.js', which causes the jslint
>> checker to fail because it cannot find validate.js in the userscripts
>> directory. What is this file and where did you get it from? The jenkins
>> failure can most easily be resolved by not requiring validate.js, assuming
>> that it can be easily removed from the code...
>> --
>>
>> https://code.launchpad.net/~justinmcp/unity-webapps-gmail/heuristics-update/+merge/199409
>> You are the owner of lp:~justinmcp/unity-webapps-gmail/heuristics-update.
>>
>
>

[Robert Bruce Park (robru)]

There is dependency tracking. When the necessary changes to webapps-applications lands, you can specify the necessary version number in debian/control.

[Robert Bruce Park (robru)]

Ok, so I built and installed webapps-applications/webapp-support, then tried to build and install this one, and then got this jslint error during build:

style_checker.js: checking GMail.user.js
GMail.user.js:107->Unexpected '(space)'.

(gjs:6492): Gjs-WARNING **: JS ERROR:
JS_EvaluateScript() failed
make[1]: *** [override_dh_auto_test] Error 123
make[1]: Leaving directory `/home/robru/src/unity-webapps-gmail/build-area/unity-webapps-gmail-2.4.16+14.04.20131108.2'
make: *** [build] Error 2

So there's an unexpected space on line 107 of the userscript, please take care of that and then I can continue reviewing this.

review: Needs Fixing

[lp:~justinmcp/unity-webapps-gmail/heuristics-update]

91. By Justin McPherson on 2014-01-23

Fix whitespace inline with style guide (jslint).

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:91
http://jenkins.qa.ubuntu.com/job/unity-webapps-gmail-ci/20/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-webapps-gmail-trusty-amd64-ci/13
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-webapps-gmail-trusty-armhf-ci/13

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

review: Approve (continuous-integration)

[Robert Bruce Park (robru)]

Ok, so like I said on the other branch, I got my VMs back up and running, so I was able to test this much more thoroughly on a pristine system ;-)

What I found for was that with the latest webapps-applications installed, this branch actually breaks the gmail icon in the launcher. Eg, when gmail is open in firefox, the gmail launcher does not appear and does not indicate that gmail is running. So I think this needs a bit of work.

review: Needs Fixing

Unmerged revisions

91. By Justin McPherson on 2014-01-23

Fix whitespace inline with style guide (jslint).

90. By Justin McPherson on 2013-12-20

Fix loaded support, add missing name.

89. By Justin McPherson on 2013-12-13

Change to use the WebApp class.

=== modified file 'GMail.test.js'
--- GMail.test.js	2013-11-06 01:42:59 +0000
+++ GMail.test.js	2014-01-23 01:58:32 +0000
@@ -29,26 +29,7 @@
         assertEquals('Gmail', log[0].args[0].name, 'Gmail');
         assertEquals('Unity.Launcher.addAction', log[2].func, 'Unity.Launcher.addAction');
         assertEquals('Unity.MessagingIndicator.addAction', log[1].func, 'Unity.MessagingIndicator.addAction');
-        assertEquals('Unity.MessagingIndicator.clearIndicators', log[3].func, 'Unity.MessagingIndicator.clearIndicators');
-        assertFalse('log.length', log.length < 20);
-
-        var found = false, i;
-        for (i = 0; i < out.length; i++) {
-            if (out[i] === 'PASS SELF TEST') {
-                found = true;
-            }
-        }
-        assertTrue('PASS SELF TEST', found);
-
-        // Process output to look for reporting information
-        for (i = 0; i < out.length; i++) {
-            var logEntry = out[i];
-
-            found = logEntry.match(/^REPORT: ((\w+): .*)/);
-            if (found !== null) {
-                assertFalse(found[1], found[2] === 'ERROR');
-            }
-        }
+        assertEquals('Unity.MessagingIndicator.clearIndicators', log[4].func, 'Unity.MessagingIndicator.clearIndicators');
     },
 
     scriptName: 'GMail.user.js'

=== modified file 'GMail.user.js'
--- GMail.user.js	2013-11-06 00:52:12 +0000
+++ GMail.user.js	2014-01-23 01:58:32 +0000
@@ -1,6 +1,8 @@
 // ==UserScript==
 // @include        https://mail.google.com/*
 // @require        utils.js
+// @require        validate.js
+// @require        webapp.js
 // @require        google-common.js
 // ==/UserScript==
 
@@ -10,11 +12,7 @@
 ));
 
 window.Unity = external.getUnityObject(1);
-var pane = null;
 
-function getComposeMessageNode() {
-    return document.evaluate('//div[@role="navigation"]/div[1]/div[1]/div[1][@role="button"]', document, null, XPathResult.ANY_UNORDERED_NODE_TYPE, null).singleNodeValue;
-}
 
 function getNumber(str) {
     try {
@@ -26,160 +24,107 @@
     }
 }
 
-function getLabels() {
-    var i, res = [];
-
-    var snapshot = document.evaluate('//div[@role="navigation"]/div[2]//a[contains(@href, "#label")]',
-                                     document, null, XPathResult.UNORDERED_NODE_SNAPSHOT_TYPE, null);
-
-    for (i = 0; i < snapshot.snapshotLength; i++) {
-        var node = snapshot.snapshotItem(i);
-
-        res.push({ name: unescape(node.href.match(/#label\/(.+)$/)[1]),
-                   count: getNumber(node.textContent),
-                   link: node.href });
-    }
-
-    return res;
-}
-
-function checkMessagesCount() {
-
-    var indicators = [];
-
-    var inboxLink = document.evaluate('//div[@role="navigation"]/div[2]//a[contains(@href, "#inbox")]', document, null, XPathResult.ANY_UNORDERED_NODE_TYPE, null).singleNodeValue;
-
-    if (!inboxLink || !inboxLink.href || !inboxLink.text) {
-        return indicators;
-    }
-    var numMessages = getNumber(inboxLink.text);
-
-    indicators.push({ name: _("Inbox"),
-                      count: numMessages,
-                      callback: makeRedirector(inboxLink.href) });
-    var i, labels = getLabels();
-    for (i = 0; i < labels.length; i++) {
-        indicators.push({ name: trim(labels[i].name), count: labels[i].count, callback: makeRedirector(labels[i].link) });
-    }
-
-    return indicators;
-}
-
-/**
- * Validates the page for functional tests.
- *
- */
-function selfTest() {
-    if (!getComposeMessageNode()) {
-        return;
-    }
-    if (!checkMessagesCount().length) {
-        return;
-    }
-
-    reportTestState('PASS SELF TEST');
-}
-
-function validatedNode(nodeInfo) {
-    var resultSet = document.evaluate(nodeInfo.query,
-                                      document,
-                                      null,
-                                      XPathResult.ORDERED_NODE_SNAPSHOT_TYPE,
-                                      null);
-    if (!nodeInfo.validator(resultSet.snapshotItem(0))) {
-        var testNode = document.createElement("div");
-        testNode.innerHTML = nodeInfo.fragment;
-        resultSet = document.evaluate(nodeInfo.query, testNode, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null);
-        var fragmentOk = resultSet.snapshotLength > 0 && nodeInfo.validator(resultSet.snapshotItem(0));
-        reportTestState("REPORT: ERROR: Failed to validate node " + nodeInfo.name + " fragment check " + (fragmentOk ? "OK" : "failed"));
-        return null;
-    }
-    return resultSet.snapshotItem(0);
-}
-
-function isCorrectPage() {
-    var i, ids = ['hist_frame', 'js_frame'];
-
-    for (i = 0; i < ids.length; i++) {
-        if (!document.getElementById(ids[i])) {
-            return false;
-        }
-    }
-
-    return true;
-}
-
-function doMatrixIntegration() {
-    doMainMenuIntegration(document);
-
-    var i, labels = getLabels();
-    for (i = 0; i < labels.length; i++) {
-        Unity.addAction('/' + labels[i].name, makeRedirector(labels[i].link));
-    }
-}
-
-function unityLoaded() {
-    var composeNewMessage = wrapCallback(function () {
-        var compose = getComposeMessageNode();
-        click(compose);
-    });
-
-    Unity.MessagingIndicator.addAction(_("Compose New Message"),
-                                       composeNewMessage);
-    Unity.Launcher.addAction(_("Compose New Message"),
-                             composeNewMessage);
-
-    var indicatorsController = new Indicators(checkMessagesCount);
-
-    window.onpopstate = function () {
-        var hash = window.location.hash;
-        var label = null;
-        if (hash.match(/#label\/(.+)/)) {
-            label = unescape(hash.match(/#label\/(.+)/)[1]);
-        } else if (hash === '#inbox') {
-            label = _("Inbox");
-        } else {
-            return;
-        }
-        indicatorsController.visited(label);
-    };
-
-    doMatrixIntegration();
-
-    selfTest();
-}
-
-if (isCorrectPage()) {
-    setTimeout(wrapCallback(function wait() {
-        pane = document.evaluate('//div[@role="navigation"]',
-                                 document, null, XPathResult.ANY_UNORDERED_NODE_TYPE, null).singleNodeValue;
-
-        if (!pane || !document.getElementsByClassName("nU")) {
-            setTimeout(wait, 1000);
-            return;
-        }
-        var login = null;
-        try {
-            var loginNode = validatedNode({
-                    name: 'login query',
-                    query: '//div[@role="navigation"]//*[contains(text(), "@")]',
-                    validator: function (node) {
-                        return node.textContent.match(/^.*@.*\.{1}.*$/) !== null;
-                    },
-                    fragment: '<div role="navigation"><span>[e-mail]</span></div>'
+
+var gmailApp = new WebApp({
+    name: 'Gmail',
+    iconUrl: "icon://unity-webapps-gmail",
+    homepage: 'https://mail.google.com',
+    domain: 'mail.google.com',
+    maxRetries: 5,
+    validator: function (weight) {
+        return weight >= 0.5;
+    },
+    login: {
+        name: "login",
+        nodes: ['//div[@role="navigation"]//*[contains(text(), "@")]',
+                '//div[@role="navigation"]/div/div[1]/div[3]/div/ol/li[4]/div/div/div/div[2]/span[2]',
+                '//div[@role="navigation"]/div/div[1]/div[3]/div/ol/li[4]/div/div/div/div[3]/span[2]'],
+        validator: function (node) {
+            return node.textContent.match(/^.*@.*\.{1}.*$/) !== null;
+        },
+        value: function (node) {
+            return node.textContent;
+        },
+        fragment: '<div role="navigation"><span>[e-mail]</span></div>'
+    },
+    items: [{
+        name: 'Compose Message',
+        nodes: ['//div[@role="navigation"]/div[1]/div[1]/div[1][@role="button"]'],
+        match: WebApp.match.FIRST,
+        validator: function (node) {
+            return node.textContent !== '';
+        },
+        install: function (nodeFunction) {
+            var composeNewMessage = wrapCallback(function () {
+                    var node = nodeFunction();
+                    click(node);
                 });
 
-            if (loginNode !== null) {
-                login = loginNode.textContent;
+            Unity.MessagingIndicator.addAction(_("Compose New Message"),
+                                               composeNewMessage);
+            Unity.Launcher.addAction(_("Compose New Message"),
+                                     composeNewMessage);
+        },
+        weight: 0.5
+    }, {
+        name: 'inbox',
+        nodes: [ '//div[@role="navigation"]/div[2]//a[contains(@href, "#inbox")]',
+                 '//div[@role="navigation"]/div/div/div/div/div/div/div/div/div/span/a' ],
+        match: WebApp.match.FIRST,
+        validator: function (node) {
+            return !isNaN(getNumber(node.textContent));
+        },
+        value: function (node) {
+            return {
+                name: _('Inbox'),
+                value: getNumber(node.textContent),
+                link: makeRedirector(node.href)
+            };
+        },
+        install: function (nodeFunction) {
+            Unity.addAction('/' + this.name, makeRedirector(nodeFunction()));
+        },
+        weight: 0.5
+    }, {
+        name: 'labels',
+        nodes: [ '//div[@role="navigation"]/div[2]//a[contains(@href, "#label")]',
+                 '//div[@role="navigation"]/div[2]/div/div/div[7]/div/*/div/div/div[2]/span/a'],
+        match: WebApp.match.ALL,
+        validator: function (node) {
+            return node.href || (node.text && isNaN(getNumber(node.textContent)));
+        },
+        value: function (node) {
+            return {
+                name: unescape(node.href.match(/#label\/(.+)$/)[1]),
+                value: getNumber(node.textContent),
+                link: makeRedirector(node.href)
+            };
+        },
+        weight: 0.0
+    }]
+}, {
+    success: function (page) { Unity.init(page); },
+    loaded: function (indicatorsController) {
+        window.onpopstate = function () {
+            var hash = window.location.hash;
+            var label = null;
+            if (hash.match(/#label\/(.+)/)) {
+                label = unescape(hash.match(/#label\/(.+)/)[1]);
+            } else if (hash === '#inbox') {
+                return;
             }
-        } catch (gmail_err) {
-        }
-
-        Unity.init({ name: "Gmail",
-                     login: login,
-                     iconUrl: "icon://unity-webapps-gmail",
-                     homepage: 'https://mail.google.com',
-                     domain: 'mail.google.com',
-                     onInit: wrapCallback(unityLoaded) });
-    }), 2000);
-}
+            indicatorsController.visited(label);
+        };
+
+        doMainMenuIntegration(document);
+    },
+    report: window.reportTestState
+});
+
+
+setTimeout(wrapCallback(function setupPage() {
+    if (!gmailApp.setupPage()) {
+        setTimeout(setupPage, 2000);
+    }
+}),
+    2000);