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

[Marcus Tomlinson]

Reverted Debug.Process.Timeout and Debug.Locate.Timeout configuration parameters

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:607
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1484/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-wily-amd64-ci/25
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-wily-armhf-ci/25
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-wily-armhf-ci/25/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-wily-i386-ci/25

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-devel-ci/1484/rebuild

review: Approve (continuous-integration)

[Paweł Stołowski (stolowski)]

+1

review: Approve

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2015-06-29 10:26:01 +0000
+++ CMakeLists.txt	2015-07-01 11:05:00 +0000
@@ -218,7 +218,7 @@
 # API version
 set(UNITY_SCOPES_MAJOR 0)
 set(UNITY_SCOPES_MINOR 6)
-set(UNITY_SCOPES_MICRO 20)
+set(UNITY_SCOPES_MICRO 19)
 set(UNITY_SCOPES_SOVERSION 3)
 
 # Version for testing, with all symbols visible

=== modified file 'CONFIGFILES'
--- CONFIGFILES	2015-06-29 12:58:18 +0000
+++ CONFIGFILES	2015-07-01 11:05:00 +0000
@@ -226,15 +226,6 @@
 
   The default value is 5000 milliseconds.
 
-- Debug.Locate.Timeout
-
-  This parameter overrides the value of Locate.Timeout above when DebugMode is enabled on
-  a target scope. (See DebugMode in <scope_id>.ini for more details)
-
-  Only values in the range 10 to 120000 milliseconds are accepted.
-
-  The default value is 30000 milliseconds.
-
 - Registry.Timeout
 
   The timeout to be used when invoking a twoway operation on the registry other
@@ -315,15 +306,6 @@
   config group, otherwise the middleware can prematurely conclude that
   a locate() request failed to start a scope.
 
-- Debug.Process.Timeout
-
-  This parameter overrides the value of Process.Timeout above when DebugMode is enabled on
-  a target scope. (See DebugMode in <scope_id>.ini for more details)
-
-  Only values in the range 10 to 120000 milliseconds are accepted.
-
-  The default value is 30000 milliseconds.
-
 
 Smartscopes.ini
 --------------

=== modified file 'RELEASE_NOTES.md'
--- RELEASE_NOTES.md	2015-06-29 10:26:01 +0000
+++ RELEASE_NOTES.md	2015-07-01 11:05:00 +0000
@@ -1,11 +1,6 @@
 Release notes
 =============
 
-Changes in version 0.6.20
-=========================
-  - Added Debug.Process.Timeout configuration parameter to Registry.ini
-  - Added Debug.Locate.Timeout configuration parameter to Zmq.ini
-
 Changes in version 0.6.19
 =========================
   - Support UNITY_SCOPES_CONFIG_DIR environment variable.

=== modified file 'debian/changelog'
--- debian/changelog	2015-06-29 10:26:01 +0000
+++ debian/changelog	2015-07-01 11:05:00 +0000
@@ -1,10 +1,3 @@
-unity-scopes-api (0.6.20-0ubuntu1) UNRELEASED; urgency=medium
-
-  * Added Debug.Process.Timeout configuration parameter to Registry.ini
-  * Added Debug.Locate.Timeout configuration parameter to Zmq.ini
-
- -- Marcus Tomlinson <[e-mail]>  Mon, 29 Jun 2015 07:56:37 +0200
-
 unity-scopes-api (0.6.19+15.10.20150617.2-0ubuntu1) wily; urgency=medium
 
   [ Pawel Stolowski ]

=== modified file 'debian/libunity-scopes3.symbols'
--- debian/libunity-scopes3.symbols	2015-06-29 09:04:07 +0000
+++ debian/libunity-scopes3.symbols	2015-07-01 11:05:00 +0000
@@ -395,7 +395,6 @@
  (c++)"unity::scopes::internal::MiddlewareFactory::MiddlewareFactory(unity::scopes::internal::RuntimeImpl*)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::MiddlewareFactory::to_kind(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::RegistryConfig::click_installdir() const@Base" 0.4.3+14.10.20140428
- (c++)"unity::scopes::internal::RegistryConfig::debug_process_timeout() const@Base" 0replaceme
  (c++)"unity::scopes::internal::RegistryConfig::identity() const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::RegistryConfig::mw_configfile() const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::RegistryConfig::mw_kind() const@Base" 0.4.0+14.04.20140312.1

=== modified file 'include/unity/scopes/internal/DfltConfig.h.in'
--- include/unity/scopes/internal/DfltConfig.h.in	2015-06-29 06:00:21 +0000
+++ include/unity/scopes/internal/DfltConfig.h.in	2015-07-01 11:05:00 +0000
@@ -46,15 +46,13 @@
 
 static constexpr char const* DFLT_SS_SCOPE_IDENTITY = "SmartScope";
 
-static constexpr int DFLT_REAP_EXPIRY = 45;                  // seconds
-static constexpr int DFLT_REAP_INTERVAL = 10;                // seconds
-static constexpr int DFLT_PROCESS_TIMEOUT = 4000;            // milliseconds
-static constexpr int DFLT_DEBUG_PROCESS_TIMEOUT = 30000;     // milliseconds
-static constexpr int DFLT_ZMQ_TWOWAY_TIMEOUT = 500;          // milliseconds
-static constexpr int DFLT_ZMQ_LOCATE_TIMEOUT = 5000;         // milliseconds
-static constexpr int DFLT_ZMQ_DEBUG_LOCATE_TIMEOUT = 30000;  // milliseconds
-static constexpr int DFLT_ZMQ_REGISTRY_TIMEOUT = 5000;       // milliseconds
-static constexpr int DFLT_ZMQ_CHILDSCOPES_TIMEOUT = 2000;    // milliseconds
+static constexpr int DFLT_REAP_EXPIRY = 45;                // seconds
+static constexpr int DFLT_REAP_INTERVAL = 10;              // seconds
+static constexpr int DFLT_PROCESS_TIMEOUT = 4000;          // milliseconds
+static constexpr int DFLT_ZMQ_TWOWAY_TIMEOUT = 500;        // milliseconds
+static constexpr int DFLT_ZMQ_LOCATE_TIMEOUT = 5000;       // milliseconds
+static constexpr int DFLT_ZMQ_REGISTRY_TIMEOUT = 5000;     // milliseconds
+static constexpr int DFLT_ZMQ_CHILDSCOPES_TIMEOUT = 2000;  // milliseconds
 
 static constexpr char const* DFLT_HOME_CACHE_SUBDIR = ".local/share/unity-scopes";
 static constexpr char const* DFLT_HOME_APP_SUBDIR = ".local/share";

=== modified file 'include/unity/scopes/internal/RegistryConfig.h'
--- include/unity/scopes/internal/RegistryConfig.h	2015-06-29 06:02:37 +0000
+++ include/unity/scopes/internal/RegistryConfig.h	2015-07-01 11:05:00 +0000
@@ -43,7 +43,6 @@
     std::string click_installdir() const;       // Directory for Click scope config files
     std::string scoperunner_path() const;       // Path to scoperunner binary
     int process_timeout() const;                // Milliseconds to wait before scope is considereed non-responsive.
-    int debug_process_timeout() const;          // Milliseconds to wait before scope is considereed non-responsive in debug mode.
 
 private:
     std::string identity_;
@@ -54,7 +53,6 @@
     std::string click_installdir_;
     std::string scoperunner_path_;
     int process_timeout_;                       // Milliseconds
-    int debug_process_timeout_;                 // Milliseconds
 };
 
 } // namespace internal

=== modified file 'include/unity/scopes/internal/zmq_middleware/ZmqConfig.h'
--- include/unity/scopes/internal/zmq_middleware/ZmqConfig.h	2015-06-29 06:02:37 +0000
+++ include/unity/scopes/internal/zmq_middleware/ZmqConfig.h	2015-07-01 11:05:00 +0000
@@ -38,7 +38,6 @@
     std::string endpoint_dir() const;
     int twoway_timeout() const;
     int locate_timeout() const;
-    int debug_locate_timeout() const;
     int registry_timeout() const;
     int child_scopes_timeout() const;
     std::string registry_endpoint_dir() const;
@@ -48,7 +47,6 @@
     std::string endpoint_dir_;
     int twoway_timeout_;
     int locate_timeout_;
-    int debug_locate_timeout_;
     int registry_timeout_;
     int child_scopes_timeout_;
     std::string registry_endpoint_dir_;

=== modified file 'include/unity/scopes/internal/zmq_middleware/ZmqMiddleware.h'
--- include/unity/scopes/internal/zmq_middleware/ZmqMiddleware.h	2015-06-29 06:08:25 +0000
+++ include/unity/scopes/internal/zmq_middleware/ZmqMiddleware.h	2015-07-01 11:05:00 +0000
@@ -93,7 +93,6 @@
     ThreadPool* oneway_pool();
     ThreadPool* twoway_pool();
     int64_t locate_timeout() const noexcept;
-    int64_t debug_locate_timeout() const noexcept;
     int64_t registry_timeout() const noexcept;
     int64_t child_scopes_timeout() const noexcept;
 
@@ -139,7 +138,6 @@
 
     int64_t twoway_timeout_;                    // Default timeout for twoway invocations
     int64_t locate_timeout_;                    // Timeout for registry locate()
-    int64_t debug_locate_timeout_;              // Timeout for registry locate() in debug mode
     int64_t registry_timeout_;                  // Timeout for registry operations other than locate()
     int64_t child_scopes_timeout_;              // Timeout for child_scopes() and set_child_scopes() methods
 

=== modified file 'scoperegistry/scoperegistry.cpp'
--- scoperegistry/scoperegistry.cpp	2015-06-29 12:51:07 +0000
+++ scoperegistry/scoperegistry.cpp	2015-07-01 11:05:00 +0000
@@ -293,8 +293,7 @@
                      string const& scoperunner_path,
                      string const& config_file,
                      bool click,
-                     int timeout_ms,
-                     int debug_timeout_ms)
+                     int timeout_ms)
 {
     unique_ptr<ScopeMetadataImpl> mi(new ScopeMetadataImpl(mw.get()));
     string scope_config(scope.second);
@@ -424,10 +423,10 @@
                 scope_dir.filename().native();
     }
 
-    // Check if this scope has requested debug mode, if so, set the process timeout to debug_process_timeout
+    // Check if this scope has requested debug mode, if so, set the process timeout to 30s
     if (sc.debug_mode())
     {
-        exec_data.timeout_ms = debug_timeout_ms;
+        exec_data.timeout_ms = 30000;
     }
     else
     {
@@ -480,14 +479,13 @@
                       string const& scoperunner_path,
                       string const& config_file,
                       bool click,
-                      int timeout_ms,
-                      int debug_timeout_ms)
+                      int timeout_ms)
 {
     for (auto&& pair : all_scopes)
     {
         try
         {
-            add_local_scope(registry, pair, mw, scoperunner_path, config_file, click, timeout_ms, debug_timeout_ms);
+            add_local_scope(registry, pair, mw, scoperunner_path, config_file, click, timeout_ms);
         }
         catch (unity::Exception const& e)
         {
@@ -557,7 +555,6 @@
         string click_installdir;
         string scoperunner_path;
         int process_timeout;
-        int debug_process_timeout;
         {
             RegistryConfig c(identity, runtime->registry_configfile());
             mw_kind = c.mw_kind();
@@ -566,7 +563,6 @@
             click_installdir = c.click_installdir();
             scoperunner_path = c.scoperunner_path();
             process_timeout = c.process_timeout();
-            debug_process_timeout = c.debug_process_timeout();
         } // Release memory for config parser
 
         // Inform the signal thread that it should shutdown the runtime
@@ -607,8 +603,8 @@
             local_scopes[scope_id] = argv[i];                   // operator[] overwrites pre-existing entries
         }
 
-        add_local_scopes(registry, local_scopes, middleware, scoperunner_path, config_file, false, process_timeout, debug_process_timeout);
-        add_local_scopes(registry, click_scopes, middleware, scoperunner_path, config_file, true, process_timeout, debug_process_timeout);
+        add_local_scopes(registry, local_scopes, middleware, scoperunner_path, config_file, false, process_timeout);
+        add_local_scopes(registry, click_scopes, middleware, scoperunner_path, config_file, true, process_timeout);
         if (ss_reg_id.empty())
         {
             error("no remote registry configured, only local scopes will be available");
@@ -619,12 +615,12 @@
         }
 
         // Configure watches for scope install directories
-        auto local_watch_lambda = [registry, &middleware, &scoperunner_path, &config_file, process_timeout, debug_process_timeout]
+        auto local_watch_lambda = [registry, &middleware, &scoperunner_path, &config_file, process_timeout]
                                   (pair<string, string> const& scope)
         {
             try
             {
-                add_local_scope(registry, scope, middleware, scoperunner_path, config_file, false, process_timeout, debug_process_timeout);
+                add_local_scope(registry, scope, middleware, scoperunner_path, config_file, false, process_timeout);
             }
             catch (unity::Exception const& e)
             {
@@ -635,12 +631,12 @@
         local_scopes_watcher.add_install_dir(scope_installdir);
         local_scopes_watcher.add_install_dir(oem_installdir);
 
-        auto click_watch_lambda = [registry, &middleware, &scoperunner_path, &config_file, process_timeout, debug_process_timeout]
+        auto click_watch_lambda = [registry, &middleware, &scoperunner_path, &config_file, process_timeout]
                                   (pair<string, string> const& scope)
         {
             try
             {
-                add_local_scope(registry, scope, middleware, scoperunner_path, config_file, true, process_timeout, debug_process_timeout);
+                add_local_scope(registry, scope, middleware, scoperunner_path, config_file, true, process_timeout);
             }
             catch (unity::Exception const& e)
             {

=== modified file 'src/scopes/internal/RegistryConfig.cpp'
--- src/scopes/internal/RegistryConfig.cpp	2015-06-29 15:07:42 +0000
+++ src/scopes/internal/RegistryConfig.cpp	2015-07-01 11:05:00 +0000
@@ -45,7 +45,6 @@
     const string click_installdir_key = "Click.InstallDir";
     const string scoperunner_path_key = "Scoperunner.Path";
     const string process_timeout_key = "Process.Timeout";
-    const string debug_process_timeout_key = "Debug.Process.Timeout";
 }
 
 RegistryConfig::RegistryConfig(string const& identity, string const& configfile) :
@@ -80,11 +79,6 @@
     {
         throw_ex("Illegal value (" + to_string(process_timeout_) + ") for " + process_timeout_key + ": value must be 10-15000 ms");
     }
-    debug_process_timeout_ = get_optional_int(registry_config_group, debug_process_timeout_key, DFLT_DEBUG_PROCESS_TIMEOUT);
-    if (debug_process_timeout_ < 10 || debug_process_timeout_ > 120000)
-    {
-        throw_ex("Illegal value (" + to_string(debug_process_timeout_) + ") for " + debug_process_timeout_key + ": value must be 10-120000 ms");
-    }
 
     KnownEntries const known_entries = {
                                           {  registry_config_group,
@@ -95,8 +89,7 @@
                                                 oem_installdir_key,
                                                 click_installdir_key,
                                                 scoperunner_path_key,
-                                                process_timeout_key,
-                                                debug_process_timeout_key
+                                                process_timeout_key
                                              }
                                           }
                                        };
@@ -147,11 +140,6 @@
     return process_timeout_;
 }
 
-int RegistryConfig::debug_process_timeout() const
-{
-    return debug_process_timeout_;
-}
-
 } // namespace internal
 
 } // namespace scopes

=== modified file 'src/scopes/internal/zmq_middleware/ZmqConfig.cpp'
--- src/scopes/internal/zmq_middleware/ZmqConfig.cpp	2015-06-29 15:09:24 +0000
+++ src/scopes/internal/zmq_middleware/ZmqConfig.cpp	2015-07-01 11:05:00 +0000
@@ -41,7 +41,6 @@
     const string endpoint_dir_key = "EndpointDir";
     const string twoway_timeout_key = "Default.Twoway.Timeout";
     const string locate_timeout_key = "Locate.Timeout";
-    const string debug_locate_timeout_key = "Debug.Locate.Timeout";
     const string registry_timeout_key = "Registry.Timeout";
     const string child_scopes_timeout_key = "ChildScopes.Timeout";
     const string registry_endpoint_dir_key = "Registry.EndpointDir";
@@ -92,12 +91,6 @@
         throw_ex("Illegal value (" + to_string(locate_timeout_) + ") for " + locate_timeout_key + ": value must be 10-15000");
     }
 
-    debug_locate_timeout_ = get_optional_int(zmq_config_group, debug_locate_timeout_key, DFLT_ZMQ_DEBUG_LOCATE_TIMEOUT);
-    if (debug_locate_timeout_ < 10 || debug_locate_timeout_ > 120000)
-    {
-        throw_ex("Illegal value (" + to_string(debug_locate_timeout_) + ") for " + debug_locate_timeout_key + ": value must be 10-120000");
-    }
-
     child_scopes_timeout_ = get_optional_int(zmq_config_group, child_scopes_timeout_key, DFLT_ZMQ_CHILDSCOPES_TIMEOUT);
     if (child_scopes_timeout_ < 10 || child_scopes_timeout_ > 15000)
     {
@@ -113,7 +106,6 @@
                                                 endpoint_dir_key,
                                                 twoway_timeout_key,
                                                 locate_timeout_key,
-                                                debug_locate_timeout_key,
                                                 registry_timeout_key,
                                                 child_scopes_timeout_key,
                                                 registry_endpoint_dir_key,
@@ -143,11 +135,6 @@
     return locate_timeout_;
 }
 
-int ZmqConfig::debug_locate_timeout() const
-{
-    return debug_locate_timeout_;
-}
-
 int ZmqConfig::registry_timeout() const
 {
     return registry_timeout_;

=== modified file 'src/scopes/internal/zmq_middleware/ZmqMiddleware.cpp'
--- src/scopes/internal/zmq_middleware/ZmqMiddleware.cpp	2015-06-29 06:11:47 +0000
+++ src/scopes/internal/zmq_middleware/ZmqMiddleware.cpp	2015-07-01 11:05:00 +0000
@@ -106,7 +106,6 @@
 
         twoway_timeout_ = config.twoway_timeout();
         locate_timeout_ = config.locate_timeout();
-        debug_locate_timeout_ = config.debug_locate_timeout();
         registry_timeout_ = config.registry_timeout();
         child_scopes_timeout_ = config.child_scopes_timeout();
         public_endpoint_dir_ = config.endpoint_dir();
@@ -811,11 +810,6 @@
     return locate_timeout_;
 }
 
-int64_t ZmqMiddleware::debug_locate_timeout() const noexcept
-{
-    return debug_locate_timeout_;
-}
-
 int64_t ZmqMiddleware::registry_timeout() const noexcept
 {
     return registry_timeout_;

=== modified file 'src/scopes/internal/zmq_middleware/ZmqScope.cpp'
--- src/scopes/internal/zmq_middleware/ZmqScope.cpp	2015-06-29 06:13:53 +0000
+++ src/scopes/internal/zmq_middleware/ZmqScope.cpp	2015-07-01 11:05:00 +0000
@@ -325,8 +325,7 @@
         capnp::MallocMessageBuilder request_builder;
         make_request_(request_builder, "debug_mode");
 
-        int64_t timeout = mw_base()->debug_locate_timeout();
-        auto future = mw_base()->twoway_pool()->submit([&] { return this->invoke_twoway_(request_builder, -1, timeout); });
+        auto future = mw_base()->twoway_pool()->submit([&] { return this->invoke_twoway_(request_builder, -1, 30000); });
         auto out_params = future.get();
         auto response = out_params.reader->getRoot<capnproto::Response>();
         throw_if_runtime_exception(response);
@@ -346,11 +345,10 @@
 ZmqObjectProxy::TwowayOutParams ZmqScope::invoke_scope_(capnp::MessageBuilder& in_params, int64_t timeout)
 {
     // Check if this scope has requested debug mode, if so, disable two-way timeout and set
-    // locate timeout to debug_locate_timeout.
+    // locate timeout to 30s.
     if (debug_mode())
     {
-        int64_t timeout = mw_base()->debug_locate_timeout();
-        return this->invoke_twoway_(in_params, -1, timeout);
+        return this->invoke_twoway_(in_params, -1, 30000);
     }
     return this->invoke_twoway_(in_params, timeout);
 }