Merge lp:~stolowski/unity-scopes-shell/prepopulate-scopes-when-locked into lp:unity-scopes-shell

[Paweł Stołowski]

Pre-populate first scope on startup (even if the screen is locked).

Pre-populate first scope on startup (even if the screen is locked).

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:306
http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-ci/452/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-vivid-amd64-ci/146
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-vivid-armhf-ci/146
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-vivid-armhf-ci/146/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-vivid-i386-ci/146
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-wily-amd64-ci/109/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-wily-armhf-ci/109/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-shell-wily-i386-ci/109/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-shell-ci/452/rebuild

review: Needs Fixing (continuous-integration)

[Marcus Tomlinson (marcustomlinson)]

Looks good. Just a question: What was the motivation behind the UNITY_SCOPES_NO_PREPOPULATE_FIRST variable?

review: Needs Information

[Paweł Stołowski (stolowski)]

> Looks good. Just a question: What was the motivation behind the
> UNITY_SCOPES_NO_PREPOPULATE_FIRST variable?

Solely to leave backdoor for disabling this enhancement in tests. All tests which fully utilize scope-harness (such as resultstest) work fine, but all the filters tests (which haven't been migrated to scope harness) which rely TestUtils::performSearch broke because the scope is not in the expected state when tests starts (search is already in progress due to pre-population logic, and TestUtils::performSearch doesn't expect that). After some failed attempts to work around this in the tests I concluded it's probably now worth the effort.

[Marcus Tomlinson (marcustomlinson)]

Awesome. Works well. +Silo 22 is looking good now.

review: Approve

=== modified file 'src/Unity/scopes.cpp'
--- src/Unity/scopes.cpp	2016-02-04 11:43:34 +0000
+++ src/Unity/scopes.cpp	2016-04-18 10:11:05 +0000
@@ -106,6 +106,7 @@
     , m_overviewScope(nullptr)
     , m_listThread(nullptr)
     , m_loaded(false)
+    , m_prepopulateFirstScope(true)
     , m_priv(new Priv())
 {
     QByteArray noFav = qgetenv("UNITY_SCOPES_NO_FAVORITES");
@@ -113,6 +114,11 @@
         m_noFavorites = true;
     }
 
+    QByteArray noPrep = qgetenv("UNITY_SCOPES_NO_PREPOPULATE_FIRST");
+    if (!noPrep.isNull()) {
+        m_prepopulateFirstScope = false;
+    }
+
     connect(m_priv.get(), SIGNAL(safeInvalidateScopeResults(const QString&)), this,
             SLOT(invalidateScopeResults(const QString &)), Qt::QueuedConnection);
 
@@ -345,6 +351,24 @@
     Q_EMIT metadataRefreshed();
 
     m_listThread = nullptr;
+
+    if (m_prepopulateFirstScope) {
+        m_prepopulateFirstScope = false;
+        prepopulateFirstScope();
+    }
+}
+
+void Scopes::prepopulateFirstScope()
+{
+    if (!m_scopes.isEmpty()) {
+        auto& scope = m_scopes.front();
+        if (!scope->initialQueryDone()) {
+            qDebug() << "Pre-populating first scope";
+            scope->setSearchQuery(QLatin1String(""));
+            // must dispatch search explicitly since setSearchQuery will not do that for inactive scope
+            scope->dispatchSearch();
+        }
+    }
 }
 
 void Scopes::prepopulateNextScopes()

=== modified file 'src/Unity/scopes.h'
--- src/Unity/scopes.h	2015-09-24 12:41:23 +0000
+++ src/Unity/scopes.h	2016-04-18 10:11:05 +0000
@@ -95,6 +95,7 @@
     void discoveryFinished();
     void refreshFinished();
     void invalidateScopeResults(QString const&);
+    void prepopulateFirstScope();
     void prepopulateNextScopes();
 
     void initPopulateScopes();
@@ -121,6 +122,7 @@
     QList<QPair<QString, QString>> m_versions;
     QString m_userAgent;
     bool m_loaded;
+    bool m_prepopulateFirstScope;
 
     QSharedPointer<LocationService> m_locationService;
     QTimer m_startupQueryTimeout;

=== modified file 'tests/filtersendtoendtest.cpp'
--- tests/filtersendtoendtest.cpp	2016-03-02 15:14:30 +0000
+++ tests/filtersendtoendtest.cpp	2016-04-18 10:11:05 +0000
@@ -61,6 +61,8 @@
 
     void init()
     {
+        qputenv("UNITY_SCOPES_NO_PREPOPULATE_FIRST", "1");
+        
         const QStringList favs {"scope://mock-scope-filters"};
         TestUtils::setFavouriteScopes(favs);