Merge lp:~mardy/location-service/last-known-position into lp:location-service/trunk

[Alberto Mardegan]

Send last known position to the client as soon as the session starts

Send last known position to the client as soon as the session starts

[Thomas Voß (thomas-voss)]

LGTM.

review: Approve (code)

[lp:~mardy/location-service/last-known-position]

217. By Launchpad Translations on behalf of phablet-team on 2015-12-04

Launchpad automatic translations update.

218. By Launchpad Translations on behalf of phablet-team on 2015-12-23

Launchpad automatic translations update.

219. By Launchpad Translations on behalf of phablet-team on 2016-02-17

Launchpad automatic translations update.

220. By Launchpad Translations on behalf of phablet-team on 2016-03-06

Launchpad automatic translations update.

221. By Launchpad Translations on behalf of phablet-team on 2016-03-07

Launchpad automatic translations update.

222. By Launchpad Translations on behalf of phablet-team on 2016-03-13

Launchpad automatic translations update.

223. By Launchpad Translations on behalf of phablet-team on 2016-03-20

Launchpad automatic translations update.

224. By Launchpad Translations on behalf of phablet-team on 2016-03-27

Launchpad automatic translations update.

225. By Thomas Voß on 2016-04-04

[ Alberto Mardegan ]
* Make sure that injected time is given in milliseconds
[ Thomas Voß ]
* Cherry-pick rev. 196 and 199 from lp:location-service. The changes
  got accidentally removed by merging the outstanding documentation
  branch.
* Handle responses of clients to updates asynchronously. Rely on
  dummy::ConnectivityManager as harvesting is disabled anyway. (LP:
  #1462664, #1387643)
[ Thomas Voß ]
* Add documentation for debugging, hacking and debugging the location
  service. Pull manual testing instructions over from the wiki. Add
  tools for formatting the source.
[ thomas-voss ]
* Add documentation for debugging, hacking and debugging the location
  service. Pull manual testing instructions over from the wiki. Add
  tools for formatting the source.
Approved by: Alberto Mardegan

226. By Thomas Voß on 2016-04-04

* Enable dual landings according to https://wiki.ubuntu.com/citrain/LandingProcess#Dual-landing_for_stable_and_devel:
  * Both vivid+overlay and xenial packages are built from the same source.
  * To account for differences in major revisions (necessary to handle the g++ 5 ABI break),
    we generate install files on the fly.
Approved by: Łukasz Zemczak

227. By Thomas Voß on 2016-04-04

Lower number of concurrent clients to stabilize acceptance test on loaded builders.
Approved by: Scott Sweeny

228. By CI Train Bot Account on 2016-04-04

Releasing 3.0.0+16.04.20160404-0ubuntu1

229. By Scott Sweeny on 2016-04-05

Use a fusion engine provider to generate higher quality position updates

230. By Scott Sweeny on 2016-04-05

Small fixes around provider loading

231. By CI Train Bot Account on 2016-04-05

Releasing 3.0.0+16.04.20160405-0ubuntu1

232. By CI Train Bot Account on 2016-04-07

Resync trunk.

233. By Launchpad Translations on behalf of phablet-team on 2016-04-08

Launchpad automatic translations update.

234. By Launchpad Translations on behalf of phablet-team on 2016-04-09

Launchpad automatic translations update.

235. By Launchpad Translations on behalf of phablet-team on 2016-04-10

Launchpad automatic translations update.

236. By Launchpad Translations on behalf of phablet-team on 2016-04-14

Launchpad automatic translations update.

237. By Launchpad Translations on behalf of phablet-team on 2016-04-17

Launchpad automatic translations update.

238. By Launchpad Translations on behalf of phablet-team on 2016-04-18

Launchpad automatic translations update.

239. By Launchpad Translations on behalf of phablet-team on 2016-04-19

Launchpad automatic translations update.

240. By Launchpad Translations on behalf of phablet-team on 2016-04-20

Launchpad automatic translations update.

241. By Launchpad Translations on behalf of phablet-team on 2016-04-21

Launchpad automatic translations update.

242. By Launchpad Translations on behalf of phablet-team on 2016-04-23

Launchpad automatic translations update.

243. By Launchpad Translations on behalf of phablet-team on 2016-04-26

Launchpad automatic translations update.

244. By Launchpad Translations on behalf of phablet-team on 2016-05-04

Launchpad automatic translations update.

245. By Launchpad Translations on behalf of phablet-team on 2016-05-05

Launchpad automatic translations update.

246. By Launchpad Translations on behalf of phablet-team on 2016-05-08

Launchpad automatic translations update.

247. By Launchpad Translations on behalf of phablet-team on 2016-05-23

Launchpad automatic translations update.

248. By Thomas Voß on 2016-05-24

Fix #1584860. The NM update altered the type of LastSeen to int32. Fixes: #1584860
Approved by: Scott Sweeny

249. By CI Train Bot Account on 2016-05-24

Releasing 3.0.0+16.10.20160524.3-0ubuntu1

250. By Launchpad Translations on behalf of phablet-team on 2016-05-31

Launchpad automatic translations update.

251. By Launchpad Translations on behalf of phablet-team on 2016-06-02

Launchpad automatic translations update.

252. By Thomas Voß on 2016-06-13

Expose service::State to the bus. (LP: #1536774)

253. By CI Train Bot Account on 2016-06-13

Releasing 3.0.0+16.10.20160613.1-0ubuntu1

254. By CI Train Bot Account on 2016-06-15

Resync trunk.

255. By Launchpad Translations on behalf of phablet-team on 2016-06-16

Launchpad automatic translations update.

256. By Scott Sweeny on 2016-06-16

Fusion provider: Always use an update that came from the same source as the previous used update (fixes LP: #1570878) (LP: #1570878)

257. By CI Train Bot Account on 2016-06-16

Releasing 3.0.0+16.10.20160616-0ubuntu1

258. By Launchpad Translations on behalf of phablet-team on 2016-06-26

Launchpad automatic translations update.

259. By Launchpad Translations on behalf of phablet-team on 2016-07-03

Launchpad automatic translations update.

260. By Launchpad Translations on behalf of phablet-team on 2016-07-04

Launchpad automatic translations update.

261. By Launchpad Translations on behalf of phablet-team on 2016-07-18

Launchpad automatic translations update.

262. By Launchpad Translations on behalf of phablet-team on 2016-07-19

Launchpad automatic translations update.

263. By Alberto Mardegan on 2016-07-25

Don't sent last known position to new sessions

264. By Alberto Mardegan on 2016-07-26

WIP

265. By Alberto Mardegan on 2016-07-26

codec fixes

266. By Alberto Mardegan on 2016-07-27

Wrap update into a struct

Unmerged revisions

266. By Alberto Mardegan on 2016-07-27

Wrap update into a struct

265. By Alberto Mardegan on 2016-07-26

codec fixes

264. By Alberto Mardegan on 2016-07-26

WIP

262. By Launchpad Translations on behalf of phablet-team on 2016-07-19

Launchpad automatic translations update.

261. By Launchpad Translations on behalf of phablet-team on 2016-07-18

Launchpad automatic translations update.

=== modified file 'include/location_service/com/ubuntu/location/codec.h'
--- include/location_service/com/ubuntu/location/codec.h	2016-05-20 15:24:39 +0000
+++ include/location_service/com/ubuntu/location/codec.h	2016-07-27 06:58:25 +0000
@@ -108,6 +108,35 @@
 };
 }
 
+namespace helper
+{
+template<typename T>
+struct TypeMapper<com::ubuntu::location::Optional<T>>
+{
+    constexpr static ArgumentType type_value()
+    {
+        return ArgumentType::structure;
+    }
+
+    constexpr static bool is_basic_type()
+    {
+        return false;
+    }
+    constexpr static bool requires_signature()
+    {
+        return true;
+    }
+
+    static std::string signature()
+    {
+        static const std::string s =
+                helper::TypeMapper<bool>::signature() +
+                helper::TypeMapper<T>::signature();
+        return s;
+    }
+};
+}
+
 template<typename T>
 struct Codec<com::ubuntu::location::Optional<T>>
 {
@@ -115,18 +144,22 @@
     {
         bool has_value{in};
         Codec<bool>::encode_argument(writer, has_value);
+        typename com::ubuntu::location::Optional<T>::value_type value;
         if (has_value)
-            Codec<typename com::ubuntu::location::Optional<T>::value_type>::encode_argument(writer, *in);
+        {
+            value = *in;
+        }
+        Codec<typename com::ubuntu::location::Optional<T>::value_type>::encode_argument(writer, value);
     }
 
     static void decode_argument(Message::Reader& reader, com::ubuntu::location::Optional<T>& in)
     {
         bool has_value{false};
         Codec<bool>::decode_argument(reader, has_value);
+        typename com::ubuntu::location::Optional<T>::value_type value;
+        Codec<typename com::ubuntu::location::Optional<T>::value_type>::decode_argument(reader, value);
         if (has_value)
         {
-            typename com::ubuntu::location::Optional<T>::value_type value;
-            Codec<typename com::ubuntu::location::Optional<T>::value_type>::decode_argument(reader, value);
             in = value;
         } else
         {
@@ -165,6 +198,43 @@
     }
 };
 
+namespace helper
+{
+template<>
+struct TypeMapper<com::ubuntu::location::Position>
+{
+    constexpr static ArgumentType type_value()
+    {
+        return ArgumentType::structure;
+    }
+    constexpr static bool is_basic_type()
+    {
+        return false;
+    }
+    constexpr static bool requires_signature()
+    {
+        return true;
+    }
+
+    inline static std::string signature()
+    {
+        std::string s =
+            //DBUS_STRUCT_BEGIN_CHAR_AS_STRING +
+                // latitude
+                TypeMapper<com::ubuntu::location::units::Quantity<com::ubuntu::location::units::PlaneAngle>>::signature() +
+                // longitude
+                TypeMapper<com::ubuntu::location::units::Quantity<com::ubuntu::location::units::PlaneAngle>>::signature() +
+                // optional altitude
+                TypeMapper<com::ubuntu::location::Optional<com::ubuntu::location::units::Quantity<com::ubuntu::location::units::Length>>>::signature() +
+                // accuracy
+                TypeMapper<com::ubuntu::location::Optional<com::ubuntu::location::units::Quantity<com::ubuntu::location::units::Length>>>::signature() +
+                TypeMapper<com::ubuntu::location::Optional<com::ubuntu::location::units::Quantity<com::ubuntu::location::units::Length>>>::signature();// +
+            //DBUS_STRUCT_END_CHAR_AS_STRING;
+        return s;
+    }
+};
+}
+
 template<>
 struct Codec<com::ubuntu::location::Position>
 {
@@ -451,8 +521,10 @@
     static std::string signature()
     {
         static const std::string s =
+            DBUS_STRUCT_BEGIN_CHAR_AS_STRING +
                 helper::TypeMapper<T>::signature() +
-                helper::TypeMapper<uint64_t>::signature();
+                helper::TypeMapper<uint64_t>::signature() +
+            DBUS_STRUCT_END_CHAR_AS_STRING;
         return s;
     }
 };
@@ -463,14 +535,20 @@
 {
     static void encode_argument(Message::Writer& writer, const com::ubuntu::location::Update<T>& in)
     {
-        Codec<T>::encode_argument(writer, in.value);
-        Codec<int64_t>::encode_argument(writer, in.when.time_since_epoch().count());
+        auto sub = writer.open_structure();
+
+        Codec<T>::encode_argument(sub, in.value);
+        Codec<uint64_t>::encode_argument(sub, in.when.time_since_epoch().count());
+
+        writer.close_structure(std::move(sub));
     }
 
     static void decode_argument(Message::Reader& reader, com::ubuntu::location::Update<T>& in)
     {
-        Codec<T>::decode_argument(reader, in.value);
-        in.when = com::ubuntu::location::Clock::Timestamp(com::ubuntu::location::Clock::Duration(reader.pop_int64()));
+        auto sub = reader.pop_structure();
+
+        Codec<T>::decode_argument(sub, in.value);
+        in.when = com::ubuntu::location::Clock::Timestamp(com::ubuntu::location::Clock::Duration(sub.pop_uint64()));
     }    
 };
 }

=== modified file 'include/location_service/com/ubuntu/location/service/interface.h'
--- include/location_service/com/ubuntu/location/service/interface.h	2016-05-20 15:24:39 +0000
+++ include/location_service/com/ubuntu/location/service/interface.h	2016-07-27 06:58:25 +0000
@@ -173,6 +173,24 @@
             static const bool readable = true;
             static const bool writable = false;
         };
+
+        struct LastKnownPosition
+        {
+            inline static const std::string& name()
+            {
+                static const std::string s
+                {
+                    "LastKnownPosition"
+                };
+                return s;
+            }
+
+            typedef com::ubuntu::location::service::Interface Interface;
+            typedef com::ubuntu::location::Update<com::ubuntu::location::Position> ValueType;
+
+            static const bool readable = true;
+            static const bool writable = false;
+        };
     };
 
     Interface() = default;
@@ -228,6 +246,11 @@
     virtual core::Property<std::map<SpaceVehicle::Key, SpaceVehicle>>& visible_space_vehicles() = 0;
 
     /**
+      * @brief The last known position.
+      */
+    virtual core::Property<Update<Position>>& last_known_position() = 0;
+
+    /**
      * @brief Starts a new session for the given criteria
      * @throw std::runtime_error in case of errors.
      * @param criteria The client's requirements in terms of accuraccy and functionality

=== modified file 'include/location_service/com/ubuntu/location/service/skeleton.h'
--- include/location_service/com/ubuntu/location/service/skeleton.h	2016-05-20 15:24:39 +0000
+++ include/location_service/com/ubuntu/location/service/skeleton.h	2016-07-27 06:58:25 +0000
@@ -116,6 +116,7 @@
     core::Property<bool>& does_report_cell_and_wifi_ids();
     core::Property<bool>& is_online();
     core::Property<std::map<SpaceVehicle::Key, SpaceVehicle>>& visible_space_vehicles();
+    core::Property<Update<Position>>& last_known_position();
 
 protected:
     // Enable subclasses to alter the state.
@@ -165,6 +166,7 @@
         std::shared_ptr< core::dbus::Property<Interface::Properties::DoesReportCellAndWifiIds> > does_report_cell_and_wifi_ids;
         std::shared_ptr< core::dbus::Property<Interface::Properties::IsOnline> > is_online;
         std::shared_ptr< core::dbus::Property<Interface::Properties::VisibleSpaceVehicles> > visible_space_vehicles;
+        std::shared_ptr< core::Property<Update<Position>> > last_known_position;
     } properties;
     // We sign up to property changes here, to be able to report them to the bus
     struct

=== modified file 'include/location_service/com/ubuntu/location/service/stub.h'
--- include/location_service/com/ubuntu/location/service/stub.h	2016-05-20 15:24:39 +0000
+++ include/location_service/com/ubuntu/location/service/stub.h	2016-07-27 06:58:25 +0000
@@ -46,6 +46,7 @@
     core::Property<bool>& does_report_cell_and_wifi_ids();
     core::Property<bool>& is_online();    
     core::Property<std::map<SpaceVehicle::Key, SpaceVehicle>>& visible_space_vehicles();
+    core::Property<Update<Position>>& last_known_position();
 
   private:
     struct Private;

=== modified file 'src/location_service/com/ubuntu/location/service/implementation.cpp'
--- src/location_service/com/ubuntu/location/service/implementation.cpp	2016-05-20 15:24:39 +0000
+++ src/location_service/com/ubuntu/location/service/implementation.cpp	2016-07-27 06:58:25 +0000
@@ -177,23 +177,5 @@
         new ProxyProvider{provider_selection}
     };
 
-    session::Interface::Ptr session_iface{new session::Implementation(proxy_provider)};
-    std::weak_ptr<session::Interface> session_weak{session_iface};
-    session_iface->updates().position_status.changed().connect([this, session_weak](const session::Interface::Updates::Status& status)
-    {
-        cul::Optional<cul::Update<cul::Position>> last_known_position = configuration.engine->updates.last_known_location.get();
-        bool has_last_known_position = last_known_position ? true : false;
-        bool is_session_enabled = status == culs::session::Interface::Updates::Status::enabled;
-        bool is_session_on_or_active = configuration.engine->configuration.engine_state != Engine::Status::off;
-
-        if (has_last_known_position && is_session_enabled && is_session_on_or_active)
-        {
-            // Immediately send the last known position to the client
-            if (auto session_iface = session_weak.lock())
-            {
-                session_iface->updates().position = last_known_position.get();
-            }
-        }
-    });
-    return session_iface;
+    return session::Interface::Ptr{new culs::session::Implementation(proxy_provider)};
 }

=== modified file 'src/location_service/com/ubuntu/location/service/skeleton.cpp'
--- src/location_service/com/ubuntu/location/service/skeleton.cpp	2016-05-20 15:24:39 +0000
+++ src/location_service/com/ubuntu/location/service/skeleton.cpp	2016-07-27 06:58:25 +0000
@@ -77,7 +77,8 @@
           object->get_property<culs::Interface::Properties::DoesSatelliteBasedPositioning>(),
           object->get_property<culs::Interface::Properties::DoesReportCellAndWifiIds>(),
           object->get_property<culs::Interface::Properties::IsOnline>(),
-          object->get_property<culs::Interface::Properties::VisibleSpaceVehicles>()
+          object->get_property<culs::Interface::Properties::VisibleSpaceVehicles>(),
+          object->get_property<culs::Interface::Properties::LastKnownPosition>(),
       },
       connections
       {
@@ -291,6 +292,11 @@
     return *properties.state;
 }
 
+core::Property<cul::Update<cul::Position>>& culs::Skeleton::last_known_position()
+{
+    return *properties.last_known_position;
+}
+
 core::Property<bool>& culs::Skeleton::does_satellite_based_positioning()
 {
     return *properties.does_satellite_based_positioning;

=== modified file 'src/location_service/com/ubuntu/location/service/stub.cpp'
--- src/location_service/com/ubuntu/location/service/stub.cpp	2016-05-20 15:24:39 +0000
+++ src/location_service/com/ubuntu/location/service/stub.cpp	2016-07-27 06:58:25 +0000
@@ -38,7 +38,8 @@
           does_satellite_based_positioning(object->get_property<culs::Interface::Properties::DoesSatelliteBasedPositioning>()),
           does_report_cell_and_wifi_ids(object->get_property<culs::Interface::Properties::DoesReportCellAndWifiIds>()),
           is_online(object->get_property<culs::Interface::Properties::IsOnline>()),
-          visible_space_vehicles(object->get_property<culs::Interface::Properties::VisibleSpaceVehicles>())
+          visible_space_vehicles(object->get_property<culs::Interface::Properties::VisibleSpaceVehicles>()),
+          last_known_position(object->get_property<culs::Interface::Properties::LastKnownPosition>())
     {
     }
 
@@ -49,6 +50,7 @@
     std::shared_ptr<dbus::Property<culs::Interface::Properties::DoesReportCellAndWifiIds>> does_report_cell_and_wifi_ids;
     std::shared_ptr<dbus::Property<culs::Interface::Properties::IsOnline>> is_online;
     std::shared_ptr<dbus::Property<culs::Interface::Properties::VisibleSpaceVehicles>> visible_space_vehicles;
+    std::shared_ptr<dbus::Property<culs::Interface::Properties::LastKnownPosition>> last_known_position;
 };
 
 culs::Stub::Stub(const dbus::Bus::Ptr& connection) : dbus::Stub<culs::Interface>(connection),
@@ -100,3 +102,8 @@
 {
     return *d->visible_space_vehicles;
 }
+
+core::Property<cul::Update<cul::Position>>& culs::Stub::last_known_position()
+{
+    return *d->last_known_position;
+}

=== modified file 'tests/acceptance_tests.cpp'
--- tests/acceptance_tests.cpp	2016-05-24 07:34:26 +0000
+++ tests/acceptance_tests.cpp	2016-07-27 06:58:25 +0000
@@ -666,7 +666,7 @@
     EXPECT_EQ(core::testing::ForkAndRunResult::empty, core::testing::fork_and_run(server, client));
 }
 
-TEST_F(LocationServiceStandalone, NewSessionsGetLastKnownPosition)
+TEST_F(LocationServiceStandalone, LastKnownPositionCanBeQueried)
 {
     core::testing::CrossProcessSync sync_start;
 
@@ -731,38 +731,13 @@
         EXPECT_EQ(1, sync_start.wait_for_signal_ready_for(std::chrono::milliseconds{500}));
 
         auto bus = session_bus();
-        bus->install_executor(dbus::asio::make_executor(bus));
-        std::thread t{[bus](){bus->run();}};
-
         auto location_service = dbus::resolve_service_on_bus<
             cul::service::Interface,
             cul::service::Stub>(bus);
 
-        auto s1 = location_service->create_session_for_criteria(cul::Criteria{});
-
-        std::cout << "Successfully created session" << std::endl;
-
-        cul::Update<cul::Position> position;
-        auto c1 = s1->updates().position.changed().connect(
-            [&](const cul::Update<cul::Position>& new_position) {
-                std::cout << "On position updated: " << new_position << std::endl;
-                position = new_position;
-            });
-
-        std::cout << "Created event connections, starting updates..." << std::endl;
-
-        s1->updates().position_status = culss::Interface::Updates::Status::enabled;
-
-        std::cout << "done" << std::endl;
-
-        std::this_thread::sleep_for(std::chrono::milliseconds{1000});
-
-        bus->stop();
-
-        if (t.joinable())
-            t.join();
-
-        EXPECT_EQ(reference_position_update, position);
+        auto lkp = location_service->last_known_position().get();
+
+        EXPECT_EQ(reference_position_update, lkp);
 
         return ::testing::Test::HasFailure() ? core::posix::exit::Status::failure : core::posix::exit::Status::success;
     };