Merge lp:~unity-team/unity8/cache-network-data into lp:unity8

[Michal Hruby]

Cache network requests to reduce data usage and increase dash icon loading speed.

Cache network requests to reduce data usage and increase dash icon loading speed.

 * Are there any related MPs required for this MP to build/function as expected? Please list.

No

 * Did you perform an exploratory manual test run of your code change and any related functionality?

Yes

 * Did you make sure that your branch does not contain spurious tags?

Yes

 * If you changed the packaging (debian), did you subscribe the ubuntu-unity team to this MP?

N/A

 * If you changed the UI, has there been a design review?

N/A

[lp:~unity-team/unity8/cache-network-data]

998. By Michal Hruby on 2014-06-30

Hook up with QNetworkConfigurationManager

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:997
http://jenkins.qa.ubuntu.com/job/unity8-ci/3267/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-utopic-touch/1362
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-utopic/271
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-utopic-amd64-ci/361
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-utopic-armhf-ci/361
        deb: http://jenkins.qa.ubuntu.com/job/unity8-utopic-armhf-ci/361/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-utopic-i386-ci/361
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/1670
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/2290
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/2290/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/9043

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/3267/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:998
http://jenkins.qa.ubuntu.com/job/unity8-ci/3273/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-utopic-touch/1378
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-utopic/277
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-utopic-amd64-ci/367
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-utopic-armhf-ci/367
        deb: http://jenkins.qa.ubuntu.com/job/unity8-utopic-armhf-ci/367/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-utopic-i386-ci/367
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/1684
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/2320
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/2320/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/9065

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/3273/rebuild

review: Needs Fixing (continuous-integration)

[Michał Sawicz (saviq)]

Just one small comment inline.

review: Approve (code)

[lp:~unity-team/unity8/cache-network-data]

999. By Michal Hruby on 2014-07-02

Remove unneeded include

[Michał Sawicz (saviq)]

 * Did you perform an exploratory manual test run of the code change and any related functionality?
Yeah, everything works fine, feels slightly faster to load known preview images (and should improve after servers send correct cache control headers).

 * Did CI run pass? If not, please explain why.
Not sure, the failed tests pass locally.

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:999
http://jenkins.qa.ubuntu.com/job/unity8-ci/3293/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-utopic-touch/1449
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-utopic/297
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-utopic-amd64-ci/387
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-utopic-armhf-ci/387
        deb: http://jenkins.qa.ubuntu.com/job/unity8-utopic-armhf-ci/387/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-utopic-i386-ci/387
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/1741
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/2415
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/2415/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/9146

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/3293/rebuild

review: Needs Fixing (continuous-integration)

=== modified file 'src/CMakeLists.txt'
--- src/CMakeLists.txt	2014-06-11 15:36:51 +0000
+++ src/CMakeLists.txt	2014-07-02 07:56:49 +0000
@@ -19,6 +19,7 @@
     ApplicationArguments.h
     main.cpp
     MouseTouchAdaptor.cpp
+    CachingNetworkManagerFactory.cpp
     ${QML_FILES} # This is to make qml and image files appear in the IDE's project tree
 )
 

=== added file 'src/CachingNetworkManagerFactory.cpp'
--- src/CachingNetworkManagerFactory.cpp	1970-01-01 00:00:00 +0000
+++ src/CachingNetworkManagerFactory.cpp	2014-07-02 07:56:49 +0000
@@ -0,0 +1,62 @@
+/*
+ * Copyright (C) 2014 Canonical, Ltd.
+ *
+ * This program 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.
+ *
+ * This program 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/>.
+ *
+ */
+
+#include "CachingNetworkManagerFactory.h"
+
+#include <QNetworkDiskCache>
+#include <QNetworkAccessManager>
+#include <QStandardPaths>
+#include <QNetworkConfigurationManager>
+
+CachingNetworkAccessManager::CachingNetworkAccessManager(QObject *parent)
+    : QNetworkAccessManager(parent)
+{
+    m_networkManager = new QNetworkConfigurationManager(this);
+
+    QObject::connect(m_networkManager, &QNetworkConfigurationManager::onlineStateChanged, this, &CachingNetworkAccessManager::onlineStateChanged);
+    m_isOnline = m_networkManager->isOnline();
+}
+
+void CachingNetworkAccessManager::onlineStateChanged(bool isOnline)
+{
+    m_isOnline = isOnline;
+}
+
+QNetworkReply* CachingNetworkAccessManager::createRequest(Operation op, const QNetworkRequest &request, QIODevice *outgoingData)
+{
+    if (!m_isOnline) {
+        QNetworkRequest req(request);
+        req.setAttribute(QNetworkRequest::CacheLoadControlAttribute, QNetworkRequest::AlwaysCache);
+        return QNetworkAccessManager::createRequest(op, req, outgoingData);
+    }
+
+    return QNetworkAccessManager::createRequest(op, request, outgoingData);
+}
+
+CachingNetworkManagerFactory::CachingNetworkManagerFactory()
+{
+}
+
+QNetworkAccessManager *CachingNetworkManagerFactory::create(QObject *parent) {
+    QNetworkAccessManager *manager = new CachingNetworkAccessManager(parent);
+
+    QNetworkDiskCache* cache = new QNetworkDiskCache(manager);
+    cache->setCacheDirectory(QString("%1/network").arg(QStandardPaths::writableLocation(QStandardPaths::CacheLocation)));
+
+    manager->setCache(cache);
+    return manager;
+}

=== added file 'src/CachingNetworkManagerFactory.h'
--- src/CachingNetworkManagerFactory.h	1970-01-01 00:00:00 +0000
+++ src/CachingNetworkManagerFactory.h	2014-07-02 07:56:49 +0000
@@ -0,0 +1,50 @@
+/*
+ * Copyright (C) 2014 Canonical, Ltd.
+ *
+ * This program 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.
+ *
+ * This program 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/>.
+ *
+ */
+
+#ifndef CACHINGNETWORKMANAGERFACTORY_H
+#define CACHINGNETWORKMANAGERFACTORY_H
+
+#include <QQmlNetworkAccessManagerFactory>
+#include <QNetworkAccessManager>
+
+class QNetworkConfigurationManager;
+
+class CachingNetworkAccessManager : public QNetworkAccessManager
+{
+public:
+    CachingNetworkAccessManager(QObject *parent = 0);
+
+protected:
+    QNetworkReply* createRequest(Operation op, const QNetworkRequest &req, QIODevice *outgoingData = 0) override;
+
+private Q_SLOTS:
+    void onlineStateChanged(bool isOnline);
+
+private:
+    QNetworkConfigurationManager* m_networkManager;
+    bool m_isOnline;
+};
+
+class CachingNetworkManagerFactory : public QQmlNetworkAccessManagerFactory
+{
+public:
+    CachingNetworkManagerFactory();
+
+    QNetworkAccessManager *create(QObject *parent) override;
+};
+
+#endif // CACHINGNETWORKMANAGERFACTORY_H

=== modified file 'src/main.cpp'
--- src/main.cpp	2014-06-20 17:04:02 +0000
+++ src/main.cpp	2014-07-02 07:56:49 +0000
@@ -34,15 +34,15 @@
 #include <paths.h>
 #include "MouseTouchAdaptor.h"
 #include "ApplicationArguments.h"
+#include "CachingNetworkManagerFactory.h"
 
 #include <unity-mir/qmirserver.h>
 
-
 int startShell(int argc, const char** argv, void* server)
 {
     const bool isUbuntuMirServer = qgetenv("QT_QPA_PLATFORM") == "ubuntumirserver";
 
-    QGuiApplication::setApplicationName("Unity 8");
+    QGuiApplication::setApplicationName("unity8");
     QGuiApplication *application;
 
     QCommandLineParser parser;
@@ -159,6 +159,9 @@
     }
     appendImportPaths(view->engine(), ::fallbackImportPaths());
 
+    CachingNetworkManagerFactory *managerFactory = new CachingNetworkManagerFactory();
+    view->engine()->setNetworkAccessManagerFactory(managerFactory);
+
     view->setSource(source);
     view->setColor("transparent");
     QObject::connect(view->engine(), SIGNAL(quit()), application, SLOT(quit()));