[SDL-0189] Restructuring OnResetTimeout (#3726)

* Add Reset Timeout Handler, remove deprecated functionality, create Request Controller interface. * fixup! Add Reset Timeout Handler, remove deprecated functionality, create Request Controller interface. * Fix compilation errors after merge of develop branch * Remove deprecated functions from SubtleAlert request and remove redundant UTs * Add changes to HMI API * Increase timeout in case if SIVD need Consent popup * Increase timeout for ButtonPress request * Restrict timeout for Subtle Alert with soft buttons * update timeout for hmi request * careful stopping of the request controller * Fix OnResetTimeout for Alerts with soft buttons (#192) * Do not manage requests with NULL timeout * Revert double timeouts from core * Apply smaller timeout to requests * Address Livio comments * Add timeout compensation parameter Update default timeout logic accordingly for all commands. Added new file to ini file. * Fix affected unit tests * Address Livio comments * Update rpc_spec * Update rpc_spec one more time Co-authored-by: Yevhenii <dem.yevhenii@gmail.com> Co-authored-by: Yevhenii <ydementieiev@luxoft.com> Co-authored-by: Vadym Luchko (gitHub) <vluchko@luxoft.com> Co-authored-by: Vadym Luchko (GitHub) <76956836+VadymLuchko@users.noreply.github.com> Co-authored-by: Dmytro Boltovskyi (GitHub) <dboltovskyi@luxoft.com> Co-authored-by: Andrii Kalinich <AKalinich@luxoft.com>
smartdevicelink · Aug 11, 2021 · 2532805 · 2532805
1 parent 5045791
commit 2532805
Show file tree

Hide file tree

Showing 79 changed files with 1,471 additions and 722 deletions.
diff --git a/src/appMain/smartDeviceLink.ini b/src/appMain/smartDeviceLink.ini
@@ -58,6 +58,8 @@ HMICapabilitiesCacheFile = hmi_capabilities_cache.json
 MaxCmdID = 2000000000
 ; SDL respond timeout (in milliseconds) in case of HMI has not respond on a mobile request
 DefaultTimeout = 10000
+; Extra time to compensate default timeout due to external delays
+DefaultTimeoutCompensation = 1000
 ; Available disk space in bytes for each application file handling
 ; Default value is 100 MiB
 AppDirectoryQuota = 104857600

diff --git a/src/components/application_manager/include/application_manager/application_manager_impl.h b/src/components/application_manager/include/application_manager/application_manager_impl.h
@@ -53,7 +53,6 @@
 #include "application_manager/hmi_interfaces_impl.h"
 #include "application_manager/message.h"
 #include "application_manager/message_helper.h"
-#include "application_manager/request_controller.h"
 #include "application_manager/resumption/resume_ctrl.h"
 #include "application_manager/rpc_handler.h"
 #include "application_manager/rpc_service.h"
@@ -781,14 +780,14 @@ class ApplicationManagerImpl
    *
    * @param ptr Reference to shared pointer that point on hmi notification
    */
-  void addNotification(const CommandSharedPtr ptr);
+  void AddNotification(const CommandSharedPtr ptr);
 
   /**
    * @ Add notification to collection
    *
-   * @param ptr Reference to shared pointer that point on hmi notification
+   * @param notification Pointer that points to hmi notification
    */
-  void removeNotification(const commands::Command* notification);
+  void RemoveNotification(const commands::Command* notification);
 
   /**
    * @ Updates request timeout
@@ -797,7 +796,7 @@ class ApplicationManagerImpl
    * @param mobile_correlation_id Correlation ID of the mobile request
    * @param new_timeout_value New timeout in milliseconds to be set
    */
-  void updateRequestTimeout(uint32_t connection_key,
+  void UpdateRequestTimeout(uint32_t connection_key,
                             uint32_t mobile_correlation_id,
                             uint32_t new_timeout_value) OVERRIDE;
 
@@ -986,6 +985,18 @@ class ApplicationManagerImpl
     return *rpc_handler_;
   }
 
+  request_controller::RequestTimeoutHandler& get_request_timeout_handler()
+      const OVERRIDE {
+    DCHECK(request_timeout_handler_);
+    return *request_timeout_handler_;
+  }
+
+  request_controller::RequestController& get_request_controller()
+      const OVERRIDE {
+    DCHECK(request_ctrl_);
+    return *request_ctrl_;
+  }
+
   void SetRPCService(std::unique_ptr<rpc_service::RPCService>& rpc_service) {
     rpc_service_ = std::move(rpc_service);
   }
@@ -1589,8 +1600,10 @@ class ApplicationManagerImpl
   connection_handler::ConnectionHandler* connection_handler_;
   std::unique_ptr<policy::PolicyHandlerInterface> policy_handler_;
   protocol_handler::ProtocolHandler* protocol_handler_;
+  std::unique_ptr<request_controller::RequestTimeoutHandler>
+      request_timeout_handler_;
+  std::unique_ptr<request_controller::RequestController> request_ctrl_;
   std::unique_ptr<plugin_manager::RPCPluginManager> plugin_manager_;
-  request_controller::RequestController request_ctrl_;
   std::unique_ptr<application_manager::AppServiceManager> app_service_manager_;
 
   /**

diff --git a/...omponents/application_manager/include/application_manager/commands/command_request_impl.h b/...omponents/application_manager/include/application_manager/commands/command_request_impl.h
@@ -419,6 +419,13 @@ class CommandRequestImpl : public CommandImpl,
    */
   void AddTimeOutComponentInfoToMessage(
       smart_objects::SmartObject& response) const;
+  /**
+   * @brief AddRequestToTimeoutHandler checks the request and adds it to
+   * request_timeout_handler map for tracking
+   * @param request_to_hmi request to HMI
+   */
+  void AddRequestToTimeoutHandler(
+      const smart_objects::SmartObject& request_to_hmi) const;
 };
 
 }  // namespace commands

diff --git a/.../application_manager/request_controller.h → ...ication_manager/request_controller_impl.h b/.../application_manager/request_controller.h → ...ication_manager/request_controller_impl.h
@@ -30,8 +30,8 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_REQUEST_CONTROLLER_H_
-#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_REQUEST_CONTROLLER_H_
+#ifndef SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_REQUEST_CONTROLLER_IMPL_H_
+#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_REQUEST_CONTROLLER_IMPL_H_
 
 #include <climits>
 #include <list>
@@ -47,6 +47,7 @@
 #include "interfaces/HMI_API.h"
 #include "interfaces/MOBILE_API.h"
 
+#include "application_manager/request_controller.h"
 #include "application_manager/request_controller_settings.h"
 #include "application_manager/request_info.h"
 #include "application_manager/request_tracker.h"
@@ -55,165 +56,60 @@ namespace application_manager {
 
 namespace request_controller {
 
-/**
- * @brief RequestController class is used to control currently active mobile
- * requests.
- */
-class RequestController {
+class RequestControllerImpl : public RequestController {
  public:
-  /**
-   * @brief Result code for addRequest
-   */
-  enum TResult {
-    SUCCESS = 0,
-    TOO_MANY_REQUESTS,
-    TOO_MANY_PENDING_REQUESTS,
-    NONE_HMI_LEVEL_MANY_REQUESTS,
-    INVALID_DATA
-  };
-
-  /**
-   * @brief Thread pool state
-   */
-  enum TPoolState {
-    UNDEFINED = 0,
-    STARTED,
-    STOPPED,
-  };
-
-  // Methods
-
   /**
    * @brief Class constructor
    *
    */
-  RequestController(const RequestControlerSettings& settings);
+  RequestControllerImpl(const RequestControlerSettings& settings,
+                        RequestTimeoutHandler& request_timeout_handler);
 
-  /**
-   * @brief Class destructor
-   *
-   */
-  virtual ~RequestController();
+  ~RequestControllerImpl();
 
-  /**
-   * @brief Initialize thread pool
-   *
-   */
-  void InitializeThreadpool();
+  void Stop() OVERRIDE;
 
-  /**
-   * @brief Destroy thread pool
-   *
-   */
-  void DestroyThreadpool();
+  void InitializeThreadpool() OVERRIDE;
 
-  /**
-   * @brief Check if max request amount wasn't exceed and adds request to queue.
-   *
-   * @param request     Active mobile request
-   * @param hmi_level   Current application hmi_level
-   *
-   * @return Result code
-   *
-   */
-  TResult addMobileRequest(const RequestPtr request,
-                           const mobile_apis::HMILevel::eType& hmi_level);
+  void DestroyThreadpool() OVERRIDE;
 
-  /**
-   * @brief Store HMI request until response or timeout won't remove it
-   *
-   * @param request     Active hmi request
-   * @return Result code
-   *
-   */
-  TResult addHMIRequest(const RequestPtr request);
+  TResult AddMobileRequest(
+      const RequestPtr request,
+      const mobile_apis::HMILevel::eType& hmi_level) OVERRIDE;
 
-  /**
-   * @ Add notification to collection
-   *
-   * @param ptr Reference to shared pointer that point on hmi notification
-   */
-  void addNotification(const RequestPtr ptr);
+  TResult AddHMIRequest(const RequestPtr request) OVERRIDE;
+
+  void AddNotification(const RequestPtr ptr) OVERRIDE;
 
-  /**
-   * @brief Removes request from queue
-   *
-   * @param correlation_id Active request correlation ID,
-   * @param connection_key Active request connection key (0 for HMI requersts)
-   * @param function_id Active request  function id
-   * @param force_terminate if true, request controller will terminate
-   * even if not allowed by request
-   */
   void TerminateRequest(const uint32_t correlation_id,
                         const uint32_t connection_key,
                         const int32_t function_id,
-                        bool force_terminate = false);
+                        const bool force_terminate = false) OVERRIDE;
 
-  /**
-   * @brief Removes request from queue
-   *
-   * @param mobile_correlation_id Active mobile request correlation ID
-   *
-   */
   void OnMobileResponse(const uint32_t mobile_correlation_id,
                         const uint32_t connection_key,
-                        const int32_t function_id);
+                        const int32_t function_id) OVERRIDE;
 
-  /**
-   * @brief Removes request from queue
-   *
-   * @param mobile_correlation_id Active mobile request correlation ID
-   *
-   */
-  void OnHMIResponse(const uint32_t correlation_id, const int32_t function_id);
+  void OnHMIResponse(const uint32_t correlation_id,
+                     const int32_t function_id) OVERRIDE;
 
-  /**
-   * @ Add notification to collection
-   *
-   * @param ptr Reference to shared pointer that point on hmi notification
-   */
-  void removeNotification(const commands::Command* notification);
+  void RemoveNotification(const commands::Command* notification) OVERRIDE;
 
-  /**
-   * @brief Removes all requests from queue for specified application
-   *
-   * @param app_id Mobile application ID (app_id)
-   *
-   */
-  void terminateAppRequests(const uint32_t& app_id);
+  void TerminateAppRequests(const uint32_t app_id) OVERRIDE;
 
-  /**
-   * @brief Terminates all requests from HMI
-   */
-  void terminateAllHMIRequests();
+  void TerminateAllHMIRequests() OVERRIDE;
 
-  /**
-   * @brief Terminates all requests from Mobile
-   */
-  void terminateAllMobileRequests();
+  void TerminateAllMobileRequests() OVERRIDE;
 
-  /**
-   * @brief Updates request timeout
-   *
-   * @param app_id Connection key of application
-   * @param mobile_correlation_id Correlation ID of the mobile request
-   * @param new_timeout_value New timeout to be set in milliseconds
-   */
-  void updateRequestTimeout(const uint32_t& app_id,
-                            const uint32_t& mobile_correlation_id,
-                            const uint32_t& new_timeout);
+  void UpdateRequestTimeout(const uint32_t app_id,
+                            const uint32_t mobile_correlation_id,
+                            const uint32_t new_timeout) OVERRIDE;
 
-  /*
-   * @brief Function Should be called when Low Voltage is occured
-   */
-  void OnLowVoltage();
+  void OnLowVoltage() OVERRIDE;
 
-  /*
-   * @brief Function Should be called when Low Voltage is occured
-   */
-  void OnWakeUp();
+  void OnWakeUp() OVERRIDE;
 
-  bool IsLowVoltage();
+  bool IsLowVoltage() OVERRIDE;
 
  protected:
   /**
@@ -226,8 +122,8 @@ class RequestController {
    */
   void NotifyTimer();
 
-  void terminateWaitingForExecutionAppRequests(const uint32_t& app_id);
-  void terminateWaitingForResponseAppRequests(const uint32_t& app_id);
+  void TerminateWaitingForExecutionAppRequests(const uint32_t app_id);
+  void TerminateWaitingForResponseAppRequests(const uint32_t app_id);
 
   /**
    * @brief Checks whether all constraints are met before adding of request into
@@ -246,19 +142,19 @@ class RequestController {
    * allowed for all applications
    * @return True if new request could be added, false otherwise
    */
-  bool CheckPendingRequestsAmount(const uint32_t& pending_requests_amount);
+  bool CheckPendingRequestsAmount(const uint32_t pending_requests_amount);
 
  private:
   class Worker : public threads::ThreadDelegate {
    public:
-    explicit Worker(RequestController* requestController);
+    explicit Worker(RequestControllerImpl* request_controller);
     virtual ~Worker();
     virtual void threadMain();
     virtual void exitThreadMain();
 
    protected:
    private:
-    RequestController* request_controller_;
+    RequestControllerImpl* request_controller_;
     sync_primitives::Lock thread_lock_;
     volatile bool stop_flag_;
   };
@@ -310,11 +206,12 @@ class RequestController {
 
   bool is_low_voltage_;
   const RequestControlerSettings& settings_;
-  DISALLOW_COPY_AND_ASSIGN(RequestController);
+  RequestTimeoutHandler& request_timeout_handler_;
+  DISALLOW_COPY_AND_ASSIGN(RequestControllerImpl);
 };
 
 }  // namespace request_controller
 
 }  // namespace application_manager
 
-#endif  // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_REQUEST_CONTROLLER_H_
+#endif  // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_REQUEST_CONTROLLER_IMPL_H_
diff --git a/src/components/application_manager/include/application_manager/request_info.h b/src/components/application_manager/include/application_manager/request_info.h
@@ -127,7 +127,7 @@ struct RequestInfo {
   }
   uint64_t hash();
   static uint64_t GenerateHash(uint32_t var1, uint32_t var2);
-  static uint32_t HmiConnectionKey;
+  static constexpr uint32_t kHmiConnectionKey = 0;
 
  protected:
   RequestPtr request_;
@@ -199,7 +199,7 @@ class RequestInfoSet {
    * @return founded request or shared_ptr with NULL
    */
   RequestInfoPtr Find(const uint32_t connection_key,
-                      const uint32_t correlation_id);
+                      const uint32_t correlation_id) const;
 
   /*
    * @brief Get request with smalest end_time_
@@ -269,7 +269,7 @@ class RequestInfoSet {
   TimeSortedRequestInfoSet time_sorted_pending_requests_;
   HashSortedRequestInfoSet hash_sorted_pending_requests_;
 
-  sync_primitives::Lock pending_requests_lock_;
+  mutable sync_primitives::Lock pending_requests_lock_;
 };
 
 /**