Merge lp:~mandel/location-service/espoo-delayed-provider into lp:location-service/trunk

[Manuel de la Peña]

Ensure that we use a delayed provider when the espoo service is not running.

Ensure that the remote provider creates a delayed provider in the case in which the service is not ready. This allows the location service to be started without having the here blobs running.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:209
http://jenkins.qa.ubuntu.com/job/location-service-ci/392/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/location-service-vivid-amd64-ci/64
    SUCCESS: http://jenkins.qa.ubuntu.com/job/location-service-vivid-armhf-ci/64
        deb: http://jenkins.qa.ubuntu.com/job/location-service-vivid-armhf-ci/64/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/location-service-vivid-i386-ci/64

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/location-service-ci/392/rebuild

review: Approve (continuous-integration)

[lp:~mandel/location-service/espoo-delayed-provider]

210. By Manuel de la Peña on 2015-06-16

Add extra logging to keep track of the remote daemon.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:210
http://jenkins.qa.ubuntu.com/job/location-service-ci/393/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/location-service-vivid-amd64-ci/65
    SUCCESS: http://jenkins.qa.ubuntu.com/job/location-service-vivid-armhf-ci/65
        deb: http://jenkins.qa.ubuntu.com/job/location-service-vivid-armhf-ci/65/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/location-service-vivid-i386-ci/65/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/location-service-ci/393/rebuild

review: Needs Fixing (continuous-integration)

[Alfonso Sanchez-Beato (alfonsosanchezbeato)]

LGTM, just have some minor nits. See comments below.

review: Needs Fixing

[lp:~mandel/location-service/espoo-delayed-provider]

211. By Manuel de la Peña on 2015-06-24

Track ownership change of the service to check if the name changed.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:211
http://jenkins.qa.ubuntu.com/job/location-service-ci/395/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/location-service-vivid-amd64-ci/67
    SUCCESS: http://jenkins.qa.ubuntu.com/job/location-service-vivid-armhf-ci/67
        deb: http://jenkins.qa.ubuntu.com/job/location-service-vivid-armhf-ci/67/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/location-service-vivid-i386-ci/67

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/location-service-ci/395/rebuild

review: Approve (continuous-integration)

[lp:~mandel/location-service/espoo-delayed-provider]

212. By Manuel de la Peña on 2015-06-25

Add some extra logging for debugging purposes.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:212
http://jenkins.qa.ubuntu.com/job/location-service-ci/397/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/location-service-vivid-amd64-ci/69
    SUCCESS: http://jenkins.qa.ubuntu.com/job/location-service-vivid-armhf-ci/69
        deb: http://jenkins.qa.ubuntu.com/job/location-service-vivid-armhf-ci/69/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/location-service-vivid-i386-ci/69

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/location-service-ci/397/rebuild

review: Approve (continuous-integration)

[lp:~mandel/location-service/espoo-delayed-provider]

213. By Manuel de la Peña on 2015-06-26

Increase logging to know what the provider is not started.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:213
http://jenkins.qa.ubuntu.com/job/location-service-ci/398/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/location-service-vivid-amd64-ci/70
    SUCCESS: http://jenkins.qa.ubuntu.com/job/location-service-vivid-armhf-ci/70
        deb: http://jenkins.qa.ubuntu.com/job/location-service-vivid-armhf-ci/70/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/location-service-vivid-i386-ci/70

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/location-service-ci/398/rebuild

review: Approve (continuous-integration)

Unmerged revisions

213. By Manuel de la Peña on 2015-06-26

Increase logging to know what the provider is not started.

212. By Manuel de la Peña on 2015-06-25

Add some extra logging for debugging purposes.

211. By Manuel de la Peña on 2015-06-24

Track ownership change of the service to check if the name changed.

210. By Manuel de la Peña on 2015-06-16

Add extra logging to keep track of the remote daemon.

209. By Manuel de la Peña on 2015-06-16

Use the new method to get the signal.

208. By Manuel de la Peña on 2015-06-16

Merged delayed-providers into espoo-delayed-provider.

207. By Manuel de la Peña on 2015-06-16

Ensure that we connect to the booted signal.

206. By Manuel de la Peña on 2015-06-15

Merged delayed-providers into espoo-delayed-provider.

205. By Manuel de la Peña on 2015-06-15

Make the remote provider work when the daemons have not been launched.

204. By Manuel de la Peña on 2015-06-15

Merged with tvoss work to make the boot more reliable.

=== modified file 'include/location_service/com/ubuntu/location/provider.h'
--- include/location_service/com/ubuntu/location/provider.h	2015-06-26 08:28:45 +0000
+++ include/location_service/com/ubuntu/location/provider.h	2015-06-26 08:28:45 +0000
@@ -241,7 +241,7 @@
      * @brief States the booting state of the provider.
      * @return The boot state of the provider.
      */
-    virtual BootState boot_state() const;
+    virtual BootState boot_state();
 
     /**
      * @brief Indicates to the provider that it should start the boot process in order to be able to
 
=== modified file 'src/location_service/com/ubuntu/location/provider.cpp'
--- src/location_service/com/ubuntu/location/provider.cpp	2015-06-26 08:28:45 +0000
+++ src/location_service/com/ubuntu/location/provider.cpp	2015-06-26 08:28:45 +0000
@@ -142,17 +142,24 @@
 
 void cul::Provider::Controller::on_provider_booted(bool was_booted)
 {
+    LOG(INFO) << "Provider was booted " << was_booted;
     if (!was_booted)
         return;
 
     // we need to propagate the state of the provider using the internal counters as references
-    if (position_updates_counter > 0) {
+    if (position_updates_counter > 0)
+    {
+        LOG(INFO) << "Starting position updates";
         instance.start_position_updates();
     }
-    if (heading_updates_counter > 0) {
+    if (heading_updates_counter > 0)
+    {
+        LOG(INFO) << "Starting heading updates";
         instance.start_heading_updates();
     }
-    if (velocity_updates_counter > 0) {
+    if (velocity_updates_counter > 0)
+    {
+        LOG(INFO) << "Starting velocity updates";
         instance.start_velocity_updates();
     }
 }
@@ -194,7 +201,7 @@
     return false;
 }
 
-cul::Provider::BootState cul::Provider::boot_state() const
+cul::Provider::BootState cul::Provider::boot_state()
 {
     return cul::Provider::BootState::BOOTED;
 }
 
=== modified file 'src/location_service/com/ubuntu/location/providers/remote/provider.cpp'
--- src/location_service/com/ubuntu/location/providers/remote/provider.cpp	2015-04-14 18:54:00 +0000
+++ src/location_service/com/ubuntu/location/providers/remote/provider.cpp	2015-06-26 08:28:45 +0000
@@ -22,7 +22,9 @@
 
 #include <com/ubuntu/location/logging.h>
 
+#include <core/dbus/dbus.h>
 #include <core/dbus/object.h>
+#include <core/dbus/service_watcher.h>
 #include <core/dbus/signal.h>
 #include <core/dbus/asio/executor.h>
 
@@ -30,6 +32,8 @@
 
 #include <boost/asio.hpp>
 
+#include <functional>
+#include <mutex>
 #include <thread>
 
 namespace cul = com::ubuntu::location;
@@ -39,6 +43,124 @@
 
 namespace
 {
+// NotYet is a provider decoration that waits for a remote service to come up, before instantiating
+// the actual stub instance.
+class NotYet : public cul::Provider
+{
+public:
+    // Creates a new instance, watching fo the given service_name on the given bus, invoking the
+    // when_ready functor for constructing the provider instance whenever the service becomes ready.
+    NotYet(const core::dbus::Bus::Ptr& bus, const std::string& service_name, const std::function<cul::Provider::Ptr()>& when_ready)
+        : dbus{bus}, service_watcher{dbus.make_service_watcher(service_name)},
+          service_registered
+          {
+              service_watcher->service_registered().connect(std::bind(&NotYet::on_service_registered, this, when_ready))
+          }
+    {
+    }
+
+    void on_service_registered(const std::function<cul::Provider::Ptr()>& when_ready)
+    {
+        LOG(INFO) << "Remote location service appeared.";
+        impl = when_ready();
+        set_boot_state(cul::Provider::BootState::BOOTED);
+        // notify the system we are booted so that we get the current state (started etc..)
+        LOG(INFO) << "Emitting booted signal.";
+        booted_signal()(true);
+    }
+
+    bool matches_criteria(const cul::Criteria& criteria) override
+    {
+        if (impl) return impl->matches_criteria(criteria);
+
+        return false;
+    }
+
+    bool supports(const cul::Provider::Features& f) const override
+    {
+        if (impl) return impl->supports(f);
+        return false;
+    }
+
+    bool requires(const cul::Provider::Requirements& r) const override
+    {
+        if (impl) return impl->requires(r);
+        return true;
+    }
+
+    void on_wifi_and_cell_reporting_state_changed(cul::WifiAndCellIdReportingState state) override
+    {
+        if (impl) impl->on_wifi_and_cell_reporting_state_changed(state);
+    }
+
+    void on_reference_location_updated(const cul::Update<cul::Position>& position) override
+    {
+        if (impl) impl->on_reference_location_updated(position);
+    }
+
+    void on_reference_velocity_updated(const cul::Update<cul::Velocity>& velocity) override
+    {
+        if (impl) impl->on_reference_velocity_updated(velocity);
+    }
+
+    void on_reference_heading_updated(const cul::Update<cul::Heading>& heading) override
+    {
+        if (impl) impl->on_reference_heading_updated(heading);
+    }
+
+    void start_position_updates() override
+    {
+        if (impl) impl->state_controller()->start_position_updates();
+    }
+
+    void stop_position_updates() override
+    {
+        if (impl) impl->state_controller()->stop_position_updates();
+    }
+
+    void start_heading_updates() override
+    {
+        if (impl) impl->state_controller()->start_heading_updates();
+    }
+
+    void stop_heading_updates() override
+    {
+        if (impl) impl->state_controller()->stop_heading_updates();
+    }
+
+    void start_velocity_updates() override
+    {
+        if (impl) impl->state_controller()->start_velocity_updates();
+    }
+
+    void stop_velocity_updates() override
+    {
+        if (impl) impl->state_controller()->stop_velocity_updates();
+    }
+
+    BootState boot_state()
+    {
+        std::lock_guard<std::mutex> guard(state_mutex);
+        return state;
+    }
+
+    void set_boot_state(BootState new_state)
+    {
+        LOG(INFO) << "Setting boot state.";
+        std::lock_guard<std::mutex> guard(state_mutex);
+        state = new_state;
+        LOG(INFO) << "State was set.";
+    }
+
+private:
+    core::dbus::DBus dbus;
+    std::unique_ptr<core::dbus::ServiceWatcher> service_watcher;
+    core::ScopedConnection service_registered;
+    cul::Provider::Ptr impl;
+    cul::Provider::BootState state = cul::Provider::BootState::BOOTING;
+    std::mutex state_mutex;
+};
+
 struct Runtime
 {
     static Runtime& instance()
@@ -191,7 +313,20 @@
     auto service = dbus::Service::use_service(bus, name);
     auto object = service->object_for_path(path);
 
-    return create_instance_with_config(remote::stub::Configuration{object});
+    try
+    {
+        auto result = create_instance_with_config(remote::stub::Configuration{object});
+    } catch (const std::runtime_error& e)
+    {
+        std::cerr << "Error creating remote provider, creating facade for watching the service and delayed initialization" << std::endl;
+        std::cerr << e.what() << std::endl;
+    }
+
+    return std::make_shared<NotYet>(bus, name, [bus, name, path]()
+    {
+         auto object = dbus::Service::use_service(bus, name)->object_for_path(path);
+         return create_instance_with_config(remote::stub::Configuration{object});
+    });
 }
 
 cul::Provider::Ptr remote::Provider::Stub::create_instance_with_config(const remote::stub::Configuration& config)
 
=== modified file 'src/location_service/com/ubuntu/location/providers/remote/provider.h'
--- src/location_service/com/ubuntu/location/providers/remote/provider.h	2015-01-26 19:11:46 +0000
+++ src/location_service/com/ubuntu/location/providers/remote/provider.h	2015-06-26 08:28:45 +0000
@@ -40,7 +40,8 @@
 {
     class Stub : public com::ubuntu::location::Provider, public std::enable_shared_from_this<Stub>
     {
-    public:
+    public:        
+
         // For integration with the Provider factory.
         static std::string class_name();
 
 
=== modified file 'tests/mock_delayed_provider.h'
--- tests/mock_delayed_provider.h	2015-06-26 08:28:45 +0000
+++ tests/mock_delayed_provider.h	2015-06-26 08:28:45 +0000
@@ -63,7 +63,7 @@
     MOCK_METHOD0(stop_velocity_updates, void());
 
     MOCK_CONST_METHOD0(has_delayed_boot, bool());
-    MOCK_CONST_METHOD0(boot_state, BootState());
+    MOCK_METHOD0(boot_state, BootState());
     MOCK_CONST_METHOD0(boot, void());