Merge lp:~marcustomlinson/unity-scopes-api/scope_debug_mode into lp:unity-scopes-api/devel

[Marcus Tomlinson]

Added "DebugMode" parameter to scope config in order to enable more lenient operation timeouts when debugging that particular scope.

If a scope config file contains the line "DebugMode = true" the following debug timeouts are applied (only) to comms with that particular scope:

* Registry process timeout upped to 15s
* Scope idle timeout disabled
* Runtime reply reaper disabled
* Middleware two-way invocation timeout disabled
* Middleware locate() timeout upped to 15s

*** Summary of changes: ***

* Added "DebugMode" parameter to ScopeConfig (not to ScopeMetadata).

* A new debug_mode() method on ScopeObject (propagated through middleware to MWScope but not expose to the public ScopeProxy).

* An additional "dont_reap" boolean argument for ReplyObject constructor (provided via ScopeImpl from the result of fwd()->debug_mode()).

* An additional "locate_timeout" argument for ZmqObjectProxy::invoke_twoway_() allowing for both two-way and locate timeouts to be overridden from ZmqScope invocations ("locate_timeout" argument also made available on MWRegistry interface).

* Updated RuntimeImpl::run_scope() to use scope_config.debug_mode() to set idle timeout and construct ScopeObject accordingly.

* Updated scoperegistry to use scope_config.debug_mode() to set process timeout accordingly.

* Added tests.

*** Other changes: ***

* Fixed remove_local_scope() to kill scope if currently running before removing it from the list.

* Some cleaning up of API code in general.

* Invocation.shutdown_with_outstanding_async test was missing "run_test_registry();"

[lp:~marcustomlinson/unity-scopes-api/scope_debug_mode]

465. By Marcus Tomlinson on 2014-08-13

Updated symbols

466. By Marcus Tomlinson on 2014-08-13

Make sure scope_processes_ map operations are under mutex protection

467. By Marcus Tomlinson on 2014-08-13

Return false from remove_local_scope() if not found (as before)

468. By Marcus Tomlinson on 2014-08-13

Added interlock in ZmqScope::debug_mode() for accessing debug_mode_ from parallel threads

469. By Marcus Tomlinson on 2014-08-13

Hopefully fixes "terminate called without an active exception"

Unmerged revisions

=== modified file 'include/unity/scopes/internal/ActivationReplyObject.h'
--- include/unity/scopes/internal/ActivationReplyObject.h	2014-03-07 04:19:32 +0000
+++ include/unity/scopes/internal/ActivationReplyObject.h	2014-08-13 04:58:30 +0000
@@ -34,7 +34,8 @@
 class ActivationReplyObject : public ReplyObject
 {
 public:
-    ActivationReplyObject(ActivationListenerBase::SPtr const& receiver, RuntimeImpl const* runtime, std::string const& scope_id);
+    ActivationReplyObject(ActivationListenerBase::SPtr const& receiver, RuntimeImpl const* runtime,
+                          std::string const& scope_id, bool dont_reap = false);
     virtual bool process_data(VariantMap const& data) override;
 
 private:

=== modified file 'include/unity/scopes/internal/DfltConfig.h.in'
--- include/unity/scopes/internal/DfltConfig.h.in	2014-07-25 01:23:02 +0000
+++ include/unity/scopes/internal/DfltConfig.h.in	2014-08-13 04:58:30 +0000
@@ -28,10 +28,10 @@
 namespace internal
 {
 
-static constexpr const char* DFLT_RUNTIME_INI = "@CMAKE_INSTALL_PREFIX@/@LIB_INSTALL_PREFIX@/@UNITY_SCOPES_LIB@/Runtime.ini";
-static constexpr const char* DFLT_REGISTRY_INI = "@CMAKE_INSTALL_PREFIX@/@LIB_INSTALL_PREFIX@/@UNITY_SCOPES_LIB@/Registry.ini";
+static constexpr char const* DFLT_RUNTIME_INI = "@CMAKE_INSTALL_PREFIX@/@LIB_INSTALL_PREFIX@/@UNITY_SCOPES_LIB@/Runtime.ini";
+static constexpr char const* DFLT_REGISTRY_INI = "@CMAKE_INSTALL_PREFIX@/@LIB_INSTALL_PREFIX@/@UNITY_SCOPES_LIB@/Registry.ini";
 static constexpr char const* DFLT_REGISTRY_ID = "Registry";
-static constexpr const char* DFLT_SS_REGISTRY_INI = "@CMAKE_INSTALL_PREFIX@/@LIB_INSTALL_PREFIX@/@UNITY_SCOPES_LIB@/Smartscopes.ini";
+static constexpr char const* DFLT_SS_REGISTRY_INI = "@CMAKE_INSTALL_PREFIX@/@LIB_INSTALL_PREFIX@/@UNITY_SCOPES_LIB@/Smartscopes.ini";
 static constexpr char const* DFLT_SS_REGISTRY_ID = "SSRegistry";
 static constexpr char const* DFLT_SCOPERUNNER_PATH = "@CMAKE_INSTALL_PREFIX@/@LIB_INSTALL_PREFIX@/@UNITY_SCOPES_LIB@/scoperunner";
 static constexpr char const* DFLT_MIDDLEWARE = "Zmq";

=== modified file 'include/unity/scopes/internal/MWRegistry.h'
--- include/unity/scopes/internal/MWRegistry.h	2014-06-04 17:49:34 +0000
+++ include/unity/scopes/internal/MWRegistry.h	2014-08-13 04:58:30 +0000
@@ -39,6 +39,7 @@
     // Remote operations
     virtual ScopeMetadata get_metadata(std::string const& scope_id) = 0;
     virtual MetadataMap list() = 0;
+    virtual ObjectProxy locate(std::string const& identity, int64_t timeout) = 0;
     virtual ObjectProxy locate(std::string const& identity) = 0;
     virtual bool is_scope_running(std::string const& scope_id) = 0;
 

=== modified file 'include/unity/scopes/internal/MWScope.h'
--- include/unity/scopes/internal/MWScope.h	2014-02-27 16:58:50 +0000
+++ include/unity/scopes/internal/MWScope.h	2014-08-13 04:58:30 +0000
@@ -44,6 +44,7 @@
     virtual QueryCtrlProxy activate(VariantMap const& result, VariantMap const& hints, MWReplyProxy const& reply) = 0;
     virtual QueryCtrlProxy perform_action(VariantMap const& result, VariantMap const& hints, std::string const& widget_id, std::string const& action_id, MWReplyProxy const& reply) = 0;
     virtual QueryCtrlProxy preview(VariantMap const& result, VariantMap const& hints, MWReplyProxy const& reply) = 0;
+    virtual bool debug_mode() = 0;
 
 protected:
     MWScope(MiddlewareBase* mw_base);

=== modified file 'include/unity/scopes/internal/PreviewReplyObject.h'
--- include/unity/scopes/internal/PreviewReplyObject.h	2014-03-07 04:19:32 +0000
+++ include/unity/scopes/internal/PreviewReplyObject.h	2014-08-13 04:58:30 +0000
@@ -37,7 +37,8 @@
 class PreviewReplyObject : public ReplyObject
 {
 public:
-    PreviewReplyObject(PreviewListenerBase::SPtr const& receiver, RuntimeImpl const* runtime, std::string const& scope_id);
+    PreviewReplyObject(PreviewListenerBase::SPtr const& receiver, RuntimeImpl const* runtime,
+                       std::string const& scope_id, bool dont_reap = false);
     virtual ~PreviewReplyObject();
 
     virtual bool process_data(VariantMap const& data) override;

=== modified file 'include/unity/scopes/internal/ReplyObject.h'
--- include/unity/scopes/internal/ReplyObject.h	2014-07-28 09:55:08 +0000
+++ include/unity/scopes/internal/ReplyObject.h	2014-08-13 04:58:30 +0000
@@ -47,7 +47,8 @@
 public:
     UNITY_DEFINES_PTRS(ReplyObject);
 
-    ReplyObject(ListenerBase::SPtr const& receiver_base, RuntimeImpl const* runtime, std::string const& scope_proxy);
+    ReplyObject(ListenerBase::SPtr const& receiver_base, RuntimeImpl const* runtime,
+                std::string const& scope_proxy, bool dont_reap);
     virtual ~ReplyObject();
 
     virtual bool process_data(VariantMap const& data) = 0;

=== modified file 'include/unity/scopes/internal/ResultReplyObject.h'
--- include/unity/scopes/internal/ResultReplyObject.h	2014-04-09 09:36:50 +0000
+++ include/unity/scopes/internal/ResultReplyObject.h	2014-08-13 04:58:30 +0000
@@ -37,10 +37,8 @@
 class ResultReplyObject : public ReplyObject
 {
 public:
-    ResultReplyObject(SearchListenerBase::SPtr const& receiver,
-                      RuntimeImpl const* runtime,
-                      std::string const& scope_id,
-                      int cardinality);
+    ResultReplyObject(SearchListenerBase::SPtr const& receiver, RuntimeImpl const* runtime,
+                      std::string const& scope_id, int cardinality, bool dont_reap = false);
     virtual ~ResultReplyObject();
 
     virtual bool process_data(VariantMap const& data) override;

=== modified file 'include/unity/scopes/internal/ScopeConfig.h'
--- include/unity/scopes/internal/ScopeConfig.h	2014-07-22 08:02:32 +0000
+++ include/unity/scopes/internal/ScopeConfig.h	2014-08-13 04:58:30 +0000
@@ -52,6 +52,7 @@
     std::string scope_runner() const;      // Optional, throws NotFoundException if not present
     int idle_timeout() const;              // Optional, returns default value if not present
     ScopeMetadata::ResultsTtlType results_ttl_type() const;  // Optional, returns none if not present
+    bool debug_mode() const;               // Optional, returns false if not present
 
     VariantMap appearance_attributes() const; // Optional, returns empty map if no attributes are present
 
@@ -71,6 +72,7 @@
     std::unique_ptr<std::string> scope_runner_;
     int idle_timeout_;
     ScopeMetadata::ResultsTtlType results_ttl_type_;
+    bool debug_mode_;
 
     VariantMap appearance_attributes_;
 };

=== modified file 'include/unity/scopes/internal/ScopeObject.h'
--- include/unity/scopes/internal/ScopeObject.h	2014-02-27 16:58:50 +0000
+++ include/unity/scopes/internal/ScopeObject.h	2014-08-13 04:58:30 +0000
@@ -52,7 +52,7 @@
 public:
     UNITY_DEFINES_PTRS(ScopeObject);
 
-    ScopeObject(RuntimeImpl* runtime, ScopeBase* scope_base_);
+    ScopeObject(RuntimeImpl* runtime, ScopeBase* scope_base, bool debug_mode = false);
     virtual ~ScopeObject();
 
     // Remote operation implementations
@@ -78,12 +78,15 @@
                                      MWReplyProxy const& reply,
                                      InvokeInfo const& info) override;
 
+    virtual bool debug_mode() const override;
+
 private:
     MWQueryCtrlProxy query(MWReplyProxy const& reply, MiddlewareBase* mw_base,
         std::function<QueryBase::SPtr(void)> const& query_factory_fun,
         std::function<QueryObjectBase::SPtr(QueryBase::SPtr, MWQueryCtrlProxy)> const& query_object_factory_fun);
     RuntimeImpl* const runtime_;
     ScopeBase* const scope_base_;
+    bool const debug_mode_;
 };
 
 } // namespace internal

=== modified file 'include/unity/scopes/internal/ScopeObjectBase.h'
--- include/unity/scopes/internal/ScopeObjectBase.h	2014-05-15 00:34:39 +0000
+++ include/unity/scopes/internal/ScopeObjectBase.h	2014-08-13 04:58:30 +0000
@@ -69,6 +69,8 @@
                                      ActionMetadata const& hints,
                                      MWReplyProxy const& reply,
                                      InvokeInfo const& info) = 0;
+
+    virtual bool debug_mode() const = 0;
 };
 
 } // namespace internal

=== modified file 'include/unity/scopes/internal/smartscopes/SSScopeObject.h'
--- include/unity/scopes/internal/smartscopes/SSScopeObject.h	2014-02-27 16:58:50 +0000
+++ include/unity/scopes/internal/smartscopes/SSScopeObject.h	2014-08-13 04:58:30 +0000
@@ -74,6 +74,8 @@
                              MWReplyProxy const& reply,
                              InvokeInfo const& info) override;
 
+    bool debug_mode() const override;
+
 private:
     MWQueryCtrlProxy query(InvokeInfo const& info,
                            MWReplyProxy const& reply,

=== modified file 'include/unity/scopes/internal/zmq_middleware/ScopeI.h'
--- include/unity/scopes/internal/zmq_middleware/ScopeI.h	2014-02-27 15:46:44 +0000
+++ include/unity/scopes/internal/zmq_middleware/ScopeI.h	2014-08-13 04:58:30 +0000
@@ -43,8 +43,8 @@
 
 private:
     virtual void search_(Current const& current,
-                               capnp::AnyPointer::Reader& in_params,
-                               capnproto::Response::Builder& r);
+                         capnp::AnyPointer::Reader& in_params,
+                         capnproto::Response::Builder& r);
     virtual void activate_(Current const& current,
                            capnp::AnyPointer::Reader& in_params,
                            capnproto::Response::Builder& r);
@@ -54,6 +54,9 @@
     virtual void preview_(Current const& current,
                           capnp::AnyPointer::Reader& in_params,
                           capnproto::Response::Builder& r);
+    virtual void debug_mode_(Current const& current,
+                             capnp::AnyPointer::Reader& in_params,
+                             capnproto::Response::Builder& r);
 };
 
 } // namespace zmq_middleware

=== modified file 'include/unity/scopes/internal/zmq_middleware/ZmqObjectProxy.h'
--- include/unity/scopes/internal/zmq_middleware/ZmqObjectProxy.h	2014-05-29 15:41:42 +0000
+++ include/unity/scopes/internal/zmq_middleware/ZmqObjectProxy.h	2014-08-13 04:58:30 +0000
@@ -77,7 +77,7 @@
     void invoke_oneway_(capnp::MessageBuilder& out_params);
 
     ZmqReceiver invoke_twoway_(capnp::MessageBuilder& out_params);
-    ZmqReceiver invoke_twoway_(capnp::MessageBuilder& out_params, int64_t timeout);
+    ZmqReceiver invoke_twoway_(capnp::MessageBuilder& out_params, int64_t twoway_timeout, int64_t locate_timeout = -1);
 
 private:
     ZmqReceiver invoke_twoway__(capnp::MessageBuilder& out_params, int64_t timeout);

=== modified file 'include/unity/scopes/internal/zmq_middleware/ZmqRegistry.h'
--- include/unity/scopes/internal/zmq_middleware/ZmqRegistry.h	2014-06-04 17:49:34 +0000
+++ include/unity/scopes/internal/zmq_middleware/ZmqRegistry.h	2014-08-13 04:58:30 +0000
@@ -51,6 +51,7 @@
     // Remote operations.
     virtual ScopeMetadata get_metadata(std::string const& scope_id) override;
     virtual MetadataMap list() override;
+    virtual ObjectProxy locate(std::string const& identity, int64_t timeout) override;
     virtual ObjectProxy locate(std::string const& identity) override;
     virtual bool is_scope_running(std::string const& scope_id) override;
 };

=== modified file 'include/unity/scopes/internal/zmq_middleware/ZmqScope.h'
--- include/unity/scopes/internal/zmq_middleware/ZmqScope.h	2014-02-27 16:58:50 +0000
+++ include/unity/scopes/internal/zmq_middleware/ZmqScope.h	2014-08-13 04:58:30 +0000
@@ -62,6 +62,12 @@
     virtual QueryCtrlProxy preview(VariantMap const& result,
                                    VariantMap const& hints,
                                    MWReplyProxy const& reply) override;
+
+    virtual bool debug_mode() override;
+
+private:
+    ZmqReceiver invoke_scope_(capnp::MessageBuilder& out_params);
+    std::unique_ptr<bool> debug_mode_;
 };
 
 } // namespace zmq_middleware

=== modified file 'scoperegistry/scoperegistry.cpp'
--- scoperegistry/scoperegistry.cpp	2014-07-29 10:22:45 +0000
+++ scoperegistry/scoperegistry.cpp	2014-08-13 04:58:30 +0000
@@ -389,7 +389,15 @@
                 scope_dir.filename().native();
     }
 
-    exec_data.timeout_ms = timeout_ms;
+    // Check if this scope has requested debug mode, if so, set the process timeout to 15s
+    if (sc.debug_mode())
+    {
+        exec_data.timeout_ms = 15000;
+    }
+    else
+    {
+        exec_data.timeout_ms = timeout_ms;
+    }
 
     try
     {

=== modified file 'src/scopes/internal/ActivationReplyObject.cpp'
--- src/scopes/internal/ActivationReplyObject.cpp	2014-03-07 04:19:32 +0000
+++ src/scopes/internal/ActivationReplyObject.cpp	2014-08-13 04:58:30 +0000
@@ -30,8 +30,9 @@
 namespace internal
 {
 
-ActivationReplyObject::ActivationReplyObject(ActivationListenerBase::SPtr const& receiver, RuntimeImpl const* runtime, std::string const& scope_id) :
-    ReplyObject(std::static_pointer_cast<ListenerBase>(receiver), runtime, scope_id),
+ActivationReplyObject::ActivationReplyObject(ActivationListenerBase::SPtr const& receiver, RuntimeImpl const* runtime,
+                                             std::string const& scope_id, bool dont_reap) :
+    ReplyObject(std::static_pointer_cast<ListenerBase>(receiver), runtime, scope_id, dont_reap),
     receiver_(receiver)
 {
     assert(receiver_);

=== modified file 'src/scopes/internal/PreviewReplyObject.cpp'
--- src/scopes/internal/PreviewReplyObject.cpp	2014-03-07 04:19:32 +0000
+++ src/scopes/internal/PreviewReplyObject.cpp	2014-08-13 04:58:30 +0000
@@ -40,8 +40,9 @@
 namespace internal
 {
 
-PreviewReplyObject::PreviewReplyObject(PreviewListenerBase::SPtr const& receiver, RuntimeImpl const* runtime, std::string const& scope_id) :
-    ReplyObject(std::static_pointer_cast<ListenerBase>(receiver), runtime, scope_id),
+PreviewReplyObject::PreviewReplyObject(PreviewListenerBase::SPtr const& receiver, RuntimeImpl const* runtime,
+                                       std::string const& scope_id, bool dont_reap) :
+    ReplyObject(std::static_pointer_cast<ListenerBase>(receiver), runtime, scope_id, dont_reap),
     receiver_(receiver)
 {
     assert(receiver_);

=== modified file 'src/scopes/internal/RegistryObject.cpp'
--- src/scopes/internal/RegistryObject.cpp	2014-08-06 04:54:06 +0000
+++ src/scopes/internal/RegistryObject.cpp	2014-08-13 04:58:30 +0000
@@ -261,18 +261,24 @@
                                               "with empty id");
     }
 
-    lock_guard<decltype(mutex_)> lock(mutex_);
-
-    scope_processes_.erase(scope_id);
-
-    if (scopes_.erase(scope_id) == 1)
+    unique_lock<decltype(mutex_)> lock(mutex_);
+    if (scopes_.find(scope_id) != scopes_.end())
     {
-        if (publisher_)
+        // Unlock here so that we can handle on_process_death
+        lock.unlock();
+        scope_processes_.at(scope_id).kill();
+        lock.lock();
+        scope_processes_.erase(scope_id);
+
+        if (scopes_.erase(scope_id) == 1)
         {
-            // Send a blank message to subscribers to inform them that the registry has been updated
-            publisher_->send_message("");
+            if (publisher_)
+            {
+                // Send a blank message to subscribers to inform them that the registry has been updated
+                publisher_->send_message("");
+            }
+            return true;
         }
-        return true;
     }
 
     return false;
@@ -335,8 +341,7 @@
 }
 
 RegistryObject::ScopeProcess::ScopeProcess(ScopeProcess const& other)
-    : exec_data_(other.exec_data_)
-    , reg_publisher_(other.reg_publisher_)
+    : ScopeProcess(other.exec_data_, other.reg_publisher_)
 {
 }
 

=== modified file 'src/scopes/internal/ReplyObject.cpp'
--- src/scopes/internal/ReplyObject.cpp	2014-07-30 21:34:13 +0000
+++ src/scopes/internal/ReplyObject.cpp	2014-08-13 04:58:30 +0000
@@ -41,7 +41,8 @@
 namespace internal
 {
 
-ReplyObject::ReplyObject(ListenerBase::SPtr const& receiver_base, RuntimeImpl const* runtime, std::string const& scope_proxy) :
+ReplyObject::ReplyObject(ListenerBase::SPtr const& receiver_base, RuntimeImpl const* runtime,
+                         std::string const& scope_proxy, bool dont_reap) :
     listener_base_(receiver_base),
     finished_(false),
     origin_proxy_(scope_proxy),
@@ -50,10 +51,14 @@
 {
     assert(receiver_base);
     assert(runtime);
-    reap_item_ = runtime->reply_reaper()->add([this] {
-        string msg = "No activity on ReplyObject for scope " + this->origin_proxy_ + ": ReplyObject destroyed";
-        this->finished(CompletionDetails(CompletionDetails::Error, msg));
-    });
+
+    if (dont_reap == false)
+    {
+        reap_item_ = runtime->reply_reaper()->add([this] {
+            string msg = "No activity on ReplyObject for scope " + this->origin_proxy_ + ": ReplyObject destroyed";
+            this->finished(CompletionDetails(CompletionDetails::Error, msg));
+        });
+    }
 }
 
 ReplyObject::~ReplyObject()
@@ -89,7 +94,10 @@
         return; // Ignore replies that arrive after finished().
     }
 
-    reap_item_->refresh();
+    if (reap_item_)
+    {
+        reap_item_->refresh();
+    }
 
     {
         unique_lock<mutex> lock(mutex_);
@@ -148,7 +156,10 @@
 
     // Only one thread can reach this point, any others were thrown out above.
 
-    reap_item_->destroy();
+    if (reap_item_)
+    {
+        reap_item_->destroy();
+    }
 
     // Wait until all currently executing calls to push() have completed.
     unique_lock<mutex> lock(mutex_);
@@ -189,7 +200,10 @@
         return; // Ignore info messages that arrive after finished().
     }
 
-    reap_item_->refresh();
+    if (reap_item_)
+    {
+        reap_item_->refresh();
+    }
     info_occurred_.exchange(true);
 
     try

=== modified file 'src/scopes/internal/ResultReplyObject.cpp'
--- src/scopes/internal/ResultReplyObject.cpp	2014-05-29 10:03:56 +0000
+++ src/scopes/internal/ResultReplyObject.cpp	2014-08-13 04:58:30 +0000
@@ -43,11 +43,9 @@
 namespace internal
 {
 
-ResultReplyObject::ResultReplyObject(SearchListenerBase::SPtr const& receiver,
-                                     RuntimeImpl const* runtime,
-                                     std::string const& scope_id,
-                                     int cardinality) :
-    ReplyObject(std::static_pointer_cast<ListenerBase>(receiver), runtime, scope_id),
+ResultReplyObject::ResultReplyObject(SearchListenerBase::SPtr const& receiver, RuntimeImpl const* runtime,
+                                     std::string const& scope_id, int cardinality, bool dont_reap) :
+    ReplyObject(std::static_pointer_cast<ListenerBase>(receiver), runtime, scope_id, dont_reap),
     receiver_(receiver),
     cat_registry_(new CategoryRegistry()),
     runtime_(runtime),

=== modified file 'src/scopes/internal/RuntimeImpl.cpp'
--- src/scopes/internal/RuntimeImpl.cpp	2014-08-08 14:06:59 +0000
+++ src/scopes/internal/RuntimeImpl.cpp	2014-08-13 04:58:30 +0000
@@ -357,15 +357,18 @@
     auto run_future = std::async(launch::async, [scope_base] { scope_base->run(); });
 
     // Create a servant for the scope and register the servant.
-    auto scope = unique_ptr<internal::ScopeObject>(new internal::ScopeObject(this, scope_base));
     if (!scope_ini_file.empty())
     {
+        // Check if this scope has requested debug mode, if so, disable the idle timeout
         ScopeConfig scope_config(scope_ini_file);
-        int idle_timeout_ms = scope_config.idle_timeout() * 1000;
+        int idle_timeout_ms = scope_config.debug_mode() ? -1 : scope_config.idle_timeout() * 1000;
+
+        auto scope = unique_ptr<internal::ScopeObject>(new internal::ScopeObject(this, scope_base, scope_config.debug_mode()));
         mw->add_scope_object(scope_id_, move(scope), idle_timeout_ms);
     }
     else
     {
+        auto scope = unique_ptr<internal::ScopeObject>(new internal::ScopeObject(this, scope_base));
         mw->add_scope_object(scope_id_, move(scope));
     }
 

=== modified file 'src/scopes/internal/ScopeConfig.cpp'
--- src/scopes/internal/ScopeConfig.cpp	2014-08-08 12:31:23 +0000
+++ src/scopes/internal/ScopeConfig.cpp	2014-08-13 04:58:30 +0000
@@ -55,6 +55,7 @@
     const string scoperunner_key = "ScopeRunner";
     const string idle_timeout_key = "IdleTimeout";
     const string results_ttl_key = "ResultsTtlType";
+    const string debug_mode_key = "DebugMode";
 
     const string scope_appearance_group = "Appearance";
     const string fg_color_key = "ForegroundColor";
@@ -189,6 +190,15 @@
     {
     }
 
+    try
+    {
+        debug_mode_ = parser()->get_boolean(scope_config_group, debug_mode_key);
+    }
+    catch (LogicException const&)
+    {
+        debug_mode_ = false;
+    }
+
     // read all display attributes from scope_appearance_group
     try
     {
@@ -202,39 +212,40 @@
     }
 
     KnownEntries const known_entries = {
-                                          {  scope_config_group,
-                                             {
-                                                overrideable_key,
-                                                scope_name_key,
-                                                description_key,
-                                                author_key,
-                                                art_key,
-                                                icon_key,
-                                                search_hint_key,
-                                                hot_key_key,
-                                                invisible_key,
-                                                location_data_needed_key,
-                                                scoperunner_key,
-                                                idle_timeout_key,
-                                                results_ttl_key
-                                             }
-                                          },
-                                          {  scope_appearance_group,
-                                             {
-                                                fg_color_key,
-                                                bg_color_key,
-                                                shape_images_key,
-                                                category_header_bg_key,
-                                                preview_button_color_key,
-                                                logo_overlay_color_key,
-                                                pageheader_logo_key,
-                                                pageheader_fg_color_key,
-                                                pageheader_background_key,
-                                                pageheader_div_color_key,
-                                                pageheader_nav_bg_key
-                                             }
-                                          }
-                                       };
+        {  scope_config_group,
+           {
+               overrideable_key,
+               scope_name_key,
+               description_key,
+               author_key,
+               art_key,
+               icon_key,
+               search_hint_key,
+               hot_key_key,
+               invisible_key,
+               location_data_needed_key,
+               scoperunner_key,
+               idle_timeout_key,
+               results_ttl_key,
+               debug_mode_key
+           }
+        },
+        {  scope_appearance_group,
+           {
+               fg_color_key,
+               bg_color_key,
+               shape_images_key,
+               category_header_bg_key,
+               preview_button_color_key,
+               logo_overlay_color_key,
+               pageheader_logo_key,
+               pageheader_fg_color_key,
+               pageheader_background_key,
+               pageheader_div_color_key,
+               pageheader_nav_bg_key
+           }
+        }
+    };
     check_unknown_entries(known_entries);
 }
 
@@ -380,6 +391,11 @@
     return results_ttl_type_;
 }
 
+bool ScopeConfig::debug_mode() const
+{
+    return debug_mode_;
+}
+
 VariantMap ScopeConfig::appearance_attributes() const
 {
     return appearance_attributes_;

=== modified file 'src/scopes/internal/ScopeImpl.cpp'
--- src/scopes/internal/ScopeImpl.cpp	2014-07-28 08:30:35 +0000
+++ src/scopes/internal/ScopeImpl.cpp	2014-08-13 04:58:30 +0000
@@ -95,7 +95,7 @@
         throw unity::InvalidArgumentException("Scope::search(): invalid SearchListenerBase (nullptr)");
     }
 
-    ReplyObject::SPtr ro(make_shared<ResultReplyObject>(reply, runtime_, to_string(), metadata.cardinality()));
+    ReplyObject::SPtr ro(make_shared<ResultReplyObject>(reply, runtime_, to_string(), metadata.cardinality(), fwd()->debug_mode()));
     MWReplyProxy rp = fwd()->mw_base()->add_reply_object(ro);
 
     // "Fake" QueryCtrlProxy that doesn't have a real MWQueryCtrlProxy yet.
@@ -149,7 +149,7 @@
         throw unity::InvalidArgumentException("Scope::activate(): invalid ActivationListenerBase (nullptr)");
     }
 
-    ActivationReplyObject::SPtr ro(make_shared<ActivationReplyObject>(reply, runtime_, to_string()));
+    ReplyObject::SPtr ro(make_shared<ActivationReplyObject>(reply, runtime_, to_string(), fwd()->debug_mode()));
     MWReplyProxy rp = fwd()->mw_base()->add_reply_object(ro);
 
     shared_ptr<QueryCtrlImpl> ctrl = make_shared<QueryCtrlImpl>(nullptr, rp);
@@ -197,7 +197,7 @@
         throw unity::InvalidArgumentException("Scope::perform_action(): invalid ActivationListenerBase (nullptr)");
     }
 
-    ActivationReplyObject::SPtr ro(make_shared<ActivationReplyObject>(reply, runtime_, to_string()));
+    ReplyObject::SPtr ro(make_shared<ActivationReplyObject>(reply, runtime_, to_string(), fwd()->debug_mode()));
     MWReplyProxy rp = fwd()->mw_base()->add_reply_object(ro);
 
     shared_ptr<QueryCtrlImpl> ctrl = make_shared<QueryCtrlImpl>(nullptr, rp);
@@ -246,7 +246,7 @@
         throw unity::InvalidArgumentException("Scope::preview(): invalid PreviewListenerBase (nullptr)");
     }
 
-    PreviewReplyObject::SPtr ro(make_shared<PreviewReplyObject>(reply, runtime_, to_string()));
+    ReplyObject::SPtr ro(make_shared<PreviewReplyObject>(reply, runtime_, to_string(), fwd()->debug_mode()));
     MWReplyProxy rp = fwd()->mw_base()->add_reply_object(ro);
 
     shared_ptr<QueryCtrlImpl> ctrl = make_shared<QueryCtrlImpl>(nullptr, rp);

=== modified file 'src/scopes/internal/ScopeObject.cpp'
--- src/scopes/internal/ScopeObject.cpp	2014-08-05 05:29:56 +0000
+++ src/scopes/internal/ScopeObject.cpp	2014-08-13 04:58:30 +0000
@@ -47,9 +47,10 @@
 namespace internal
 {
 
-ScopeObject::ScopeObject(RuntimeImpl* runtime, ScopeBase* scope_base) :
+ScopeObject::ScopeObject(RuntimeImpl* runtime, ScopeBase* scope_base, bool debug_mode) :
     runtime_(runtime),
-    scope_base_(scope_base)
+    scope_base_(scope_base),
+    debug_mode_(debug_mode)
 {
     assert(runtime);
     assert(scope_base);
@@ -217,6 +218,11 @@
     );
 }
 
+bool ScopeObject::debug_mode() const
+{
+    return debug_mode_;
+}
+
 } // namespace internal
 
 } // namespace scopes

=== modified file 'src/scopes/internal/smartscopes/SSScopeObject.cpp'
--- src/scopes/internal/smartscopes/SSScopeObject.cpp	2014-07-28 08:30:35 +0000
+++ src/scopes/internal/smartscopes/SSScopeObject.cpp	2014-08-13 04:58:30 +0000
@@ -192,6 +192,11 @@
     return info.mw->create_query_ctrl_proxy(reply->identity() + ".c", info.mw->get_query_ctrl_endpoint());
 }
 
+bool SSScopeObject::debug_mode() const
+{
+    return false;
+}
+
 }  // namespace smartscopes
 
 }  // namespace internal

=== modified file 'src/scopes/internal/zmq_middleware/ScopeI.cpp'
--- src/scopes/internal/zmq_middleware/ScopeI.cpp	2014-05-29 15:41:42 +0000
+++ src/scopes/internal/zmq_middleware/ScopeI.cpp	2014-08-13 04:58:30 +0000
@@ -60,6 +60,7 @@
     QueryCtrl* preview(ValueDict result, ValueDict hints, Reply* replyProxy);
     QueryCtrl* perform_action(ValueDict result, ValueDict hints, string action_id, Reply* replyProxy);
     QueryCtrl* activate(ValueDict result, ValueDict hints, Reply* replyProxy);
+    bool debug_mode();
 };
 
 */
@@ -71,7 +72,8 @@
         { "search", bind(&ScopeI::search_, this, _1, _2, _3) },
         { "preview", bind(&ScopeI::preview_, this, _1, _2, _3) },
         { "activate", bind(&ScopeI::activate_, this, _1, _2, _3) },
-        { "perform_action", bind(&ScopeI::perform_action_, this, _1, _2, _3) }
+        { "perform_action", bind(&ScopeI::perform_action_, this, _1, _2, _3) },
+        { "debug_mode", bind(&ScopeI::debug_mode_, this, _1, _2, _3) }
     })
 {
 }
@@ -81,8 +83,8 @@
 }
 
 void ScopeI::search_(Current const& current,
-                           capnp::AnyPointer::Reader& in_params,
-                           capnproto::Response::Builder& r)
+                     capnp::AnyPointer::Reader& in_params,
+                     capnproto::Response::Builder& r)
 {
     auto req = in_params.getAs<capnproto::Scope::CreateQueryRequest>();
     auto query = internal::CannedQueryImpl::create(to_variant_map(req.getQuery()));
@@ -135,8 +137,8 @@
 }
 
 void ScopeI::perform_action_(Current const& current,
-                           capnp::AnyPointer::Reader& in_params,
-                           capnproto::Response::Builder& r)
+                             capnp::AnyPointer::Reader& in_params,
+                             capnproto::Response::Builder& r)
 {
     auto req = in_params.getAs<capnproto::Scope::ActionActivationRequest>();
     auto result = ResultImpl::create_result(to_variant_map(req.getResult()));
@@ -192,6 +194,18 @@
     p.setCategory(ctrl_proxy->target_category().c_str());
 }
 
+void ScopeI::debug_mode_(Current const&,
+                         capnp::AnyPointer::Reader&,
+                         capnproto::Response::Builder& r)
+{
+    auto delegate = dynamic_pointer_cast<ScopeObjectBase>(del());
+    assert(delegate);
+    auto debug_mode = delegate->debug_mode();
+    r.setStatus(capnproto::ResponseStatus::SUCCESS);
+    auto debug_mode_response = r.initPayload().getAs<capnproto::Scope::DebugModeResponse>();
+    debug_mode_response.setReturnValue(debug_mode);
+}
+
 } // namespace zmq_middleware
 
 } // namespace internal

=== modified file 'src/scopes/internal/zmq_middleware/ZmqObject.cpp'
--- src/scopes/internal/zmq_middleware/ZmqObject.cpp	2014-08-08 12:22:19 +0000
+++ src/scopes/internal/zmq_middleware/ZmqObject.cpp	2014-08-13 04:58:30 +0000
@@ -206,7 +206,7 @@
     return invoke_twoway_(out_params, timeout_);
 }
 
-ZmqReceiver ZmqObjectProxy::invoke_twoway_(capnp::MessageBuilder& out_params, int64_t timeout)
+ZmqReceiver ZmqObjectProxy::invoke_twoway_(capnp::MessageBuilder& out_params, int64_t twoway_timeout, int64_t locate_timeout)
 {
     auto registry_proxy = mw_base()->registry_proxy();
     auto ss_registry_proxy = mw_base()->ss_registry_proxy();
@@ -221,7 +221,15 @@
     {
         try
         {
-            ObjectProxy new_proxy = registry_proxy->locate(identity());
+            ObjectProxy new_proxy;
+            if (locate_timeout != -1)
+            {
+                new_proxy = registry_proxy->locate(identity(), locate_timeout);
+            }
+            else
+            {
+                new_proxy = registry_proxy->locate(identity());
+            }
             // update our proxy with the newly received data
             // (we need to first store values in local variables outside of the mutex,
             // otherwise we will deadlock on the following ZmqObjectProxy methods)
@@ -244,7 +252,7 @@
     }
 
     // Try the invocation
-    return invoke_twoway__(out_params, timeout);
+    return invoke_twoway__(out_params, twoway_timeout);
 }
 
 // Get a socket to the endpoint for this proxy and write the request on the wire.

=== modified file 'src/scopes/internal/zmq_middleware/ZmqRegistry.cpp'
--- src/scopes/internal/zmq_middleware/ZmqRegistry.cpp	2014-07-14 06:54:43 +0000
+++ src/scopes/internal/zmq_middleware/ZmqRegistry.cpp	2014-08-13 04:58:30 +0000
@@ -144,7 +144,7 @@
     return sm;
 }
 
-ObjectProxy ZmqRegistry::locate(std::string const& identity)
+ObjectProxy ZmqRegistry::locate(std::string const& identity, int64_t timeout)
 {
     capnp::MallocMessageBuilder request_builder;
     auto request = make_request_(request_builder, "locate");
@@ -152,7 +152,6 @@
     in_params.setIdentity(identity.c_str());
 
     // locate uses a custom timeout because it needs to potentially fork/exec a scope.
-    int64_t timeout = mw_base()->locate_timeout();
     auto future = mw_base()->twoway_pool()->submit([&] { return this->invoke_twoway_(request_builder, timeout); });
     auto receiver = future.get();
     auto segments = receiver.receive();
@@ -192,6 +191,11 @@
     }
 }
 
+ObjectProxy ZmqRegistry::locate(std::string const& identity)
+{
+    return locate(identity, mw_base()->locate_timeout());
+}
+
 bool ZmqRegistry::is_scope_running(std::string const& scope_id)
 {
     capnp::MallocMessageBuilder request_builder;

=== modified file 'src/scopes/internal/zmq_middleware/ZmqScope.cpp'
--- src/scopes/internal/zmq_middleware/ZmqScope.cpp	2014-06-30 07:30:25 +0000
+++ src/scopes/internal/zmq_middleware/ZmqScope.cpp	2014-08-13 04:58:30 +0000
@@ -54,6 +54,7 @@
     QueryCtrl* activate(string query, ValueDict hints, Reply* replyProxy);
     QueryCtrl* perform_action(string query, ValueDict hints, string action_id, Reply* replyProxy);
     QueryCtrl* preview(string query, ValueDict hints, Reply* replyProxy);
+    bool debug_mode();
 };
 
 */
@@ -90,7 +91,7 @@
         p.setCategory(reply_proxy->target_category().c_str());
     }
 
-    auto future = mw_base()->twoway_pool()->submit([&] { return this->invoke_twoway_(request_builder); });
+    auto future = mw_base()->twoway_pool()->submit([&] { return this->invoke_scope_(request_builder); });
 
     auto receiver = future.get();
     auto segments = receiver.receive();
@@ -122,7 +123,7 @@
         p.setIdentity(reply_proxy->identity().c_str());
     }
 
-    auto future = mw_base()->twoway_pool()->submit([&] { return this->invoke_twoway_(request_builder); });
+    auto future = mw_base()->twoway_pool()->submit([&] { return this->invoke_scope_(request_builder); });
 
     auto receiver = future.get();
     auto segments = receiver.receive();
@@ -157,7 +158,7 @@
         p.setIdentity(reply_proxy->identity().c_str());
     }
 
-    auto future = mw_base()->twoway_pool()->submit([&] { return this->invoke_twoway_(request_builder); });
+    auto future = mw_base()->twoway_pool()->submit([&] { return this->invoke_scope_(request_builder); });
     future.wait();
 
     auto receiver = future.get();
@@ -190,7 +191,7 @@
         p.setIdentity(reply_proxy->identity().c_str());
     }
 
-    auto future = mw_base()->twoway_pool()->submit([&] { return this->invoke_twoway_(request_builder); });
+    auto future = mw_base()->twoway_pool()->submit([&] { return this->invoke_scope_(request_builder); });
 
     auto receiver = future.get();
     auto segments = receiver.receive();
@@ -206,6 +207,39 @@
     return make_shared<QueryCtrlImpl>(p, reply_proxy);
 }
 
+bool ZmqScope::debug_mode()
+{
+    // We only need to retrieve the debug mode state once, so we cache it in debug_mode_
+    if (!debug_mode_)
+    {
+        capnp::MallocMessageBuilder request_builder;
+        make_request_(request_builder, "debug_mode");
+
+        auto future = mw_base()->twoway_pool()->submit([&] { return this->invoke_twoway_(request_builder); });
+        auto receiver = future.get();
+        auto segments = receiver.receive();
+        capnp::SegmentArrayMessageReader reader(segments);
+        auto response = reader.getRoot<capnproto::Response>();
+        throw_if_runtime_exception(response);
+
+        auto debug_mode_response = response.getPayload().getAs<capnproto::Scope::DebugModeResponse>();
+        debug_mode_.reset(new bool(debug_mode_response.getReturnValue()));
+    }
+
+    return *debug_mode_;
+}
+
+ZmqReceiver ZmqScope::invoke_scope_(capnp::MessageBuilder& out_params)
+{
+    // Check if this scope has requested debug mode, if so, disable two-way timeout and set
+    // locate timeout to 15s.
+    if (debug_mode())
+    {
+        return this->invoke_twoway_(out_params, -1, 15000);
+    }
+    return this->invoke_twoway_(out_params);
+}
+
 } // namespace zmq_middleware
 
 } // namespace internal

=== modified file 'src/scopes/internal/zmq_middleware/capnproto/Scope.capnp'
--- src/scopes/internal/zmq_middleware/capnproto/Scope.capnp	2014-02-04 15:15:25 +0000
+++ src/scopes/internal/zmq_middleware/capnproto/Scope.capnp	2014-08-13 04:58:30 +0000
@@ -75,3 +75,8 @@
     hints @1      : ValueDict.ValueDict;
     replyProxy @2 : Proxy.Proxy;
 }
+
+struct DebugModeResponse
+{
+    returnValue @0 : Bool;
+}

=== modified file 'test/gtest/scopes/Invocation/CMakeLists.txt'
--- test/gtest/scopes/Invocation/CMakeLists.txt	2014-05-13 01:40:09 +0000
+++ test/gtest/scopes/Invocation/CMakeLists.txt	2014-08-13 04:58:30 +0000
@@ -1,8 +1,9 @@
 configure_file(Registry.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Registry.ini)
 configure_file(Runtime.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Runtime.ini)
 configure_file(Zmq.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Zmq.ini)
+configure_file(DebugTestScope.ini.in ${CMAKE_CURRENT_BINARY_DIR}/DebugTestScope.ini)
 
-add_executable(Invocation_test Invocation_test.cpp TestScope.cpp EmptyScope.cpp)
+add_executable(Invocation_test Invocation_test.cpp TestScope.cpp EmptyScope.cpp DebugTestScope.cpp)
 target_link_libraries(Invocation_test ${TESTLIBS})
 
 add_test(Invocation Invocation_test)

=== added file 'test/gtest/scopes/Invocation/DebugTestScope.cpp'
--- test/gtest/scopes/Invocation/DebugTestScope.cpp	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/Invocation/DebugTestScope.cpp	2014-08-13 04:58:30 +0000
@@ -0,0 +1,59 @@
+/*
+ * Copyright (C) 2014 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Marcus Tomlinson <[e-mail]>
+ */
+
+#include "DebugTestScope.h"
+
+#include <unity/scopes/ScopeBase.h>
+
+#include <thread>
+
+using namespace std;
+using namespace unity::scopes;
+
+namespace
+{
+
+class TestQuery : public SearchQueryBase
+{
+public:
+    TestQuery(CannedQuery const& query, SearchMetadata const& metadata)
+        : SearchQueryBase(query, metadata)
+    {
+    }
+
+    virtual void cancelled() override
+    {
+    }
+
+    virtual void run(SearchReplyProxy const&) override
+    {
+    }
+};
+
+}  // namespace
+
+SearchQueryBase::UPtr DebugTestScope::search(CannedQuery const& query, SearchMetadata const& metadata)
+{
+    this_thread::sleep_for(chrono::milliseconds(2000));  // Attempt to timeout the two-way invocation
+    return SearchQueryBase::UPtr(new TestQuery(query, metadata));
+}
+
+PreviewQueryBase::UPtr DebugTestScope::preview(Result const&, ActionMetadata const&)
+{
+    return nullptr;  // unused
+}

=== added file 'test/gtest/scopes/Invocation/DebugTestScope.h'
--- test/gtest/scopes/Invocation/DebugTestScope.h	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/Invocation/DebugTestScope.h	2014-08-13 04:58:30 +0000
@@ -0,0 +1,33 @@
+/*
+ * Copyright (C) 2014 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Marcus Tomlinson <[e-mail]>
+ */
+
+#ifndef TEST_DEBUGTESTSCOPE_H
+#define TEST_DEBUGTESTSCOPE_H
+
+#include <unity/scopes/ScopeBase.h>
+
+class DebugTestScope : public unity::scopes::ScopeBase
+{
+public:
+    virtual unity::scopes::SearchQueryBase::UPtr search(unity::scopes::CannedQuery const&,
+                                                        unity::scopes::SearchMetadata const&) override;
+    virtual unity::scopes::PreviewQueryBase::UPtr preview(unity::scopes::Result const&,
+                                                          unity::scopes::ActionMetadata const&) override;
+};
+
+#endif

=== added file 'test/gtest/scopes/Invocation/DebugTestScope.ini.in'
--- test/gtest/scopes/Invocation/DebugTestScope.ini.in	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/Invocation/DebugTestScope.ini.in	2014-08-13 04:58:30 +0000
@@ -0,0 +1,5 @@
+[ScopeConfig]
+DisplayName = Debug Test Scope
+Description = Debug Test Scope description
+Author = Canonical
+DebugMode = true

=== modified file 'test/gtest/scopes/Invocation/Invocation_test.cpp'
--- test/gtest/scopes/Invocation/Invocation_test.cpp	2014-07-28 08:30:35 +0000
+++ test/gtest/scopes/Invocation/Invocation_test.cpp	2014-08-13 04:58:30 +0000
@@ -38,6 +38,7 @@
 
 #include "EmptyScope.h"
 #include "TestScope.h"
+#include "DebugTestScope.h"
 
 using namespace std;
 using namespace unity::scopes;
@@ -136,6 +137,26 @@
     EXPECT_EQ("", receiver->error_message());
 }
 
+TEST(Invocation, no_timeout_in_debug_mode)
+{
+    auto reg_rt = run_test_registry();
+    auto rt = internal::RuntimeImpl::create("", "Runtime.ini");
+    auto mw = rt->factory()->create("DebugTestScope", "Zmq", "Zmq.ini");
+    mw->start();
+    auto proxy = mw->create_scope_proxy("DebugTestScope");
+    auto scope = internal::ScopeImpl::create(proxy, rt.get(), "TestScope");
+
+    auto receiver = make_shared<TestReceiver>();
+
+    // This call sleeps for 2s then returns
+    scope->search("test", SearchMetadata("unused", "unused"), receiver);
+    receiver->wait_until_finished();
+
+    // Check that the two-way invocation timeout did not kick in due to "DebugMode = true"
+    EXPECT_EQ(CompletionDetails::OK, receiver->status());
+    EXPECT_EQ("", receiver->error_message());
+}
+
 class NullReceiver : public SearchListenerBase
 {
 public:
@@ -154,6 +175,7 @@
 
 TEST(Invocation, shutdown_with_outstanding_async)
 {
+    auto reg_rt = run_test_registry();
     auto rt = internal::RuntimeImpl::create("", "Runtime.ini");
     auto mw = rt->factory()->create("EmptyScope", "Zmq", "Zmq.ini");
     mw->start();
@@ -183,6 +205,12 @@
     rt->run_scope(&scope, runtime_ini_file, "");
 }
 
+void debugtestscope_thread(Runtime::SPtr const& rt, string const& runtime_ini_file)
+{
+    DebugTestScope scope;
+    rt->run_scope(&scope, runtime_ini_file, "DebugTestScope.ini");
+}
+
 int main(int argc, char **argv)
 {
     ::testing::InitGoogleTest(&argc, argv);
@@ -193,6 +221,9 @@
     Runtime::SPtr esrt = move(Runtime::create_scope_runtime("EmptyScope", "Runtime.ini"));
     std::thread emptyscope_t(nullscope_thread, esrt, "Runtime.ini");
 
+    Runtime::SPtr dsrt = move(Runtime::create_scope_runtime("DebugTestScope", "Runtime.ini"));
+    std::thread debugtestscope_t(debugtestscope_thread, dsrt, "Runtime.ini");
+
     // Give threads some time to bind to endpoints, to avoid getting ObjectNotExistException
     // from a synchronous remote call.
     this_thread::sleep_for(chrono::milliseconds(500));
@@ -205,5 +236,8 @@
     esrt->destroy();
     emptyscope_t.join();
 
+    dsrt->destroy();
+    debugtestscope_t.join();
+
     return rc;
 }

=== modified file 'test/gtest/scopes/Registry/Registry_test.cpp'
--- test/gtest/scopes/Registry/Registry_test.cpp	2014-08-01 03:19:32 +0000
+++ test/gtest/scopes/Registry/Registry_test.cpp	2014-08-13 04:58:30 +0000
@@ -240,6 +240,64 @@
     EXPECT_FALSE(r->is_scope_running("testscopeB"));
 }
 
+TEST(Registry, no_idle_timeout_in_debug_mode)
+{
+    bool update_received = false;
+    std::mutex mutex;
+    std::condition_variable cond;
+
+    Runtime::UPtr rt = Runtime::create(TEST_RUNTIME_FILE);
+    RegistryProxy r = rt->registry();
+
+    // Configure testscopeC scope_state_callback
+    auto conn = r->set_scope_state_callback("testscopeC", [&update_received, &mutex, &cond](bool)
+    {
+        std::lock_guard<std::mutex> lock(mutex);
+        update_received = true;
+        cond.notify_one();
+    });
+
+    auto wait_for_state_update = [&update_received, &mutex, &cond]
+    {
+        // Wait for an update notification
+        std::unique_lock<std::mutex> lock(mutex);
+        bool success = cond.wait_for(lock, std::chrono::milliseconds(500), [&update_received] { return update_received; });
+        update_received = false;
+        return success;
+    };
+
+    // Move testscopeC into the scopes folder
+    filesystem::rename(TEST_RUNTIME_PATH "/other_scopes/testscopeC", TEST_RUNTIME_PATH "/scopes/testscopeC");
+    std::this_thread::sleep_for(std::chrono::milliseconds(500));
+
+    auto meta = r->get_metadata("testscopeC");
+    auto sp = meta.proxy();
+
+    // testscopeC should not be running at this point
+    EXPECT_FALSE(r->is_scope_running("testscopeC"));
+    EXPECT_FALSE(wait_for_state_update());
+
+    // search would fail if testscopeC can't be executed
+    auto receiver = std::make_shared<Receiver>();
+    SearchListenerBase::SPtr reply(receiver);
+    auto ctrl = sp->search("foo", SearchMetadata("C", "desktop"), reply);
+    EXPECT_TRUE(receiver->wait_until_finished());
+
+    // testscopeC should now be running
+    EXPECT_TRUE(wait_for_state_update());
+    EXPECT_TRUE(r->is_scope_running("testscopeC"));
+
+    // check that the scope is still running after 4s
+    // (due to "DebugMode = true" and despite "IdleTimeout = 2")
+    std::this_thread::sleep_for(std::chrono::seconds{4});
+    EXPECT_FALSE(wait_for_state_update());
+    EXPECT_TRUE(r->is_scope_running("testscopeC"));
+
+    // Move testscopeC back into the other_scopes folder
+    filesystem::rename(TEST_RUNTIME_PATH "/scopes/testscopeC", TEST_RUNTIME_PATH "/other_scopes/testscopeC");
+    std::this_thread::sleep_for(std::chrono::milliseconds(500));
+}
+
 TEST(Registry, list_update_notify_before_click_folder_exists)
 {
     bool update_received = false;

=== modified file 'test/gtest/scopes/Registry/other_scopes/testscopeC/CMakeLists.txt'
--- test/gtest/scopes/Registry/other_scopes/testscopeC/CMakeLists.txt	2014-06-04 17:49:34 +0000
+++ test/gtest/scopes/Registry/other_scopes/testscopeC/CMakeLists.txt	2014-08-13 04:58:30 +0000
@@ -1,1 +1,3 @@
+add_library(testscopeC MODULE testscopeC.cpp)
+target_link_libraries(testscopeC ${LIBGTEST})
 configure_file(testscopeC.ini.in testscopeC.ini)

=== added file 'test/gtest/scopes/Registry/other_scopes/testscopeC/testscopeC.cpp'
--- test/gtest/scopes/Registry/other_scopes/testscopeC/testscopeC.cpp	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/Registry/other_scopes/testscopeC/testscopeC.cpp	2014-08-13 04:58:30 +0000
@@ -0,0 +1,99 @@
+/*
+ * Copyright (C) 2014 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Marcus Tomlinson <[e-mail]>
+ */
+
+#include <unity/scopes/ScopeBase.h>
+
+#define EXPORT __attribute__ ((visibility ("default")))
+
+using namespace unity::scopes;
+
+class MyQuery : public SearchQueryBase
+{
+public:
+    MyQuery(CannedQuery const& query, SearchMetadata const& metadata) :
+        SearchQueryBase(query, metadata)
+    {
+    }
+
+    virtual void cancelled() override
+    {
+    }
+
+    virtual void run(SearchReplyProxy const&) override
+    {
+    }
+};
+
+class MyPreview : public PreviewQueryBase
+{
+public:
+    MyPreview(Result const& result, ActionMetadata const& metadata)
+        : PreviewQueryBase(result, metadata)
+    {
+    }
+
+    virtual void cancelled() override
+    {
+    }
+
+    virtual void run(PreviewReplyProxy const&) override
+    {
+    }
+};
+
+class MyScope : public ScopeBase
+{
+public:
+    virtual void start(std::string const&) override
+    {
+    }
+
+    virtual void stop() override {}
+
+    virtual SearchQueryBase::UPtr search(CannedQuery const& q, SearchMetadata const& metadata) override
+    {
+        SearchQueryBase::UPtr query(new MyQuery(q, metadata));
+        return query;
+    }
+
+    virtual PreviewQueryBase::UPtr preview(Result const& result, ActionMetadata const& metadata) override
+    {
+        PreviewQueryBase::UPtr preview(new MyPreview(result, metadata));
+        return preview;
+    }
+};
+
+extern "C"
+{
+
+    EXPORT
+    unity::scopes::ScopeBase*
+    // cppcheck-suppress unusedFunction
+    UNITY_SCOPE_CREATE_FUNCTION()
+    {
+        return new MyScope;
+    }
+
+    EXPORT
+    void
+    // cppcheck-suppress unusedFunction
+    UNITY_SCOPE_DESTROY_FUNCTION(unity::scopes::ScopeBase* scope_base)
+    {
+        delete scope_base;
+    }
+}

=== modified file 'test/gtest/scopes/Registry/other_scopes/testscopeC/testscopeC.ini.in'
--- test/gtest/scopes/Registry/other_scopes/testscopeC/testscopeC.ini.in	2014-06-04 17:49:34 +0000
+++ test/gtest/scopes/Registry/other_scopes/testscopeC/testscopeC.ini.in	2014-08-13 04:58:30 +0000
@@ -6,3 +6,5 @@
 Icon = /foo/scope-C.Icon
 SearchHint = scope-C.SearchHint
 HotKey = scope-C.HotKey
+IdleTimeout = 2
+DebugMode = true

=== modified file 'test/gtest/scopes/ReplyReaper/CMakeLists.txt'
--- test/gtest/scopes/ReplyReaper/CMakeLists.txt	2014-07-30 21:34:13 +0000
+++ test/gtest/scopes/ReplyReaper/CMakeLists.txt	2014-08-13 04:58:30 +0000
@@ -1,6 +1,7 @@
 configure_file(Registry.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Registry.ini)
 configure_file(Runtime.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Runtime.ini)
 configure_file(Zmq.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Zmq.ini)
+configure_file(DebugScope.ini.in ${CMAKE_CURRENT_BINARY_DIR}/DebugScope.ini)
 
 add_definitions(-DTEST_DIR="${CMAKE_CURRENT_BINARY_DIR}")
 

=== added file 'test/gtest/scopes/ReplyReaper/DebugScope.ini.in'
--- test/gtest/scopes/ReplyReaper/DebugScope.ini.in	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/ReplyReaper/DebugScope.ini.in	2014-08-13 04:58:30 +0000
@@ -0,0 +1,5 @@
+[ScopeConfig]
+DisplayName = DebugScope
+Description = Debug Scope
+Author = Canonical
+DebugMode = true

=== modified file 'test/gtest/scopes/ReplyReaper/ReplyReaper_test.cpp'
--- test/gtest/scopes/ReplyReaper/ReplyReaper_test.cpp	2014-08-06 04:54:06 +0000
+++ test/gtest/scopes/ReplyReaper/ReplyReaper_test.cpp	2014-08-13 04:58:30 +0000
@@ -106,3 +106,66 @@
     no_reply_rt->destroy();
     scope_t.join();
 }
+
+class NoReapReceiver : public SearchListenerBase
+{
+public:
+    NoReapReceiver()
+        : query_complete_(false)
+    {
+    }
+
+    virtual void push(CategorisedResult /* result */) override
+    {
+    }
+
+    virtual void finished(CompletionDetails const& details) override
+    {
+        // Check that finished() was called by the reaper.
+        EXPECT_EQ(CompletionDetails::OK, details.status());
+        EXPECT_EQ("", details.message());
+        lock_guard<mutex> lock(mutex_);
+        query_complete_ = true;
+        cond_.notify_all();
+    }
+
+    void wait_until_finished()
+    {
+        unique_lock<mutex> lock(mutex_);
+        cond_.wait(lock, [this] { return this->query_complete_; });
+    }
+
+private:
+    bool query_complete_;
+    mutex mutex_;
+    condition_variable cond_;
+};
+
+void scope_thread_debug_mode(Runtime::SPtr const& rt, string const& runtime_ini_file)
+{
+    NoReplyScope scope;
+    rt->run_scope(&scope, runtime_ini_file, TEST_DIR "/DebugScope.ini");
+}
+
+TEST(ReplyReaper, no_reap_in_debug_mode)
+{
+    auto reg_rt = run_test_registry();
+
+    Runtime::SPtr no_reply_rt = move(Runtime::create_scope_runtime("NoReplyScope", TEST_DIR "/Runtime.ini"));
+    std::thread scope_t(scope_thread_debug_mode, no_reply_rt, TEST_DIR "/Runtime.ini");
+
+    // Run a query in the scope. The query will do nothing for 3 seconds,
+    // but the reaper will reap after at most 2 seconds.
+    auto rt = internal::RuntimeImpl::create("", TEST_DIR "/Runtime.ini");
+    auto mw = rt->factory()->create("NoReplyScope", "Zmq", TEST_DIR "/Zmq.ini");
+    mw->start();
+    auto proxy = mw->create_scope_proxy("NoReplyScope");
+    auto scope = internal::ScopeImpl::create(proxy, rt.get(), "NoReplyScope");
+
+    auto receiver = make_shared<NoReapReceiver>();
+    scope->search("test", SearchMetadata("en", "phone"), receiver);
+    receiver->wait_until_finished();
+
+    no_reply_rt->destroy();
+    scope_t.join();
+}

=== modified file 'test/gtest/scopes/internal/ScopeConfig/ScopeConfig_test.cpp'
--- test/gtest/scopes/internal/ScopeConfig/ScopeConfig_test.cpp	2014-08-08 14:06:59 +0000
+++ test/gtest/scopes/internal/ScopeConfig/ScopeConfig_test.cpp	2014-08-13 04:58:30 +0000
@@ -49,6 +49,7 @@
         EXPECT_EQ(300, cfg.idle_timeout());
         EXPECT_EQ(ScopeMetadata::ResultsTtlType::Large, cfg.results_ttl_type());
         EXPECT_TRUE(cfg.location_data_needed());
+        EXPECT_TRUE(cfg.debug_mode());
 
         auto attrs = cfg.appearance_attributes();
         EXPECT_EQ(5, attrs.size());
@@ -78,6 +79,7 @@
         EXPECT_EQ(DFLT_SCOPE_IDLE_TIMEOUT, cfg.idle_timeout());
         EXPECT_EQ(ScopeMetadata::ResultsTtlType::None, cfg.results_ttl_type());
         EXPECT_FALSE(cfg.location_data_needed());
+        EXPECT_FALSE(cfg.debug_mode());
 
         EXPECT_EQ(0, cfg.appearance_attributes().size());
 

=== modified file 'test/gtest/scopes/internal/ScopeConfig/complete_config.ini.in'
--- test/gtest/scopes/internal/ScopeConfig/complete_config.ini.in	2014-07-18 04:02:58 +0000
+++ test/gtest/scopes/internal/ScopeConfig/complete_config.ini.in	2014-08-13 04:58:30 +0000
@@ -16,6 +16,7 @@
 ResultsTtlType = large
 LocationDataNeeded = true
 ConfinementType = unconfined
+DebugMode = true
 
 [Appearance]
 arbitrary_key = true

=== modified file 'test/gtest/scopes/internal/zmq_middleware/ZmqMiddleware/ZmqMiddleware_test.cpp'
--- test/gtest/scopes/internal/zmq_middleware/ZmqMiddleware/ZmqMiddleware_test.cpp	2014-07-24 10:43:37 +0000
+++ test/gtest/scopes/internal/zmq_middleware/ZmqMiddleware/ZmqMiddleware_test.cpp	2014-08-13 04:58:30 +0000
@@ -452,6 +452,11 @@
     {
         return nullptr;
     }
+
+    virtual bool debug_mode() const override
+    {
+        return false;
+    }
 };
 
 // Make sure that multiple threads calling wait_for_shutdown() complete