Ensure we always wait with a timeout

Author: Xanewok

tests/client.rs

@@ -222,7 +222,7 @@ fn client_changing_workspace_lib_retains_diagnostics() {
 
     let lib = rls.future_diagnostics("library/src/lib.rs");
     let bin = rls.future_diagnostics("binary/src/main.rs");
-    let (lib, bin) = rls.runtime().block_on(lib.join(bin)).unwrap();
+    let (lib, bin) = rls.block_on(lib.join(bin)).unwrap();
 
     assert!(lib.diagnostics.iter().any(|m| m.message.contains("unused variable: `test_val`")));
     assert!(lib.diagnostics.iter().any(|m| m.message.contains("unused variable: `unused`")));
@@ -251,7 +251,7 @@ fn client_changing_workspace_lib_retains_diagnostics() {
 
     let lib = rls.future_diagnostics("library/src/lib.rs");
     let bin = rls.future_diagnostics("binary/src/main.rs");
-    let (lib, bin) = rls.runtime().block_on(lib.join(bin)).unwrap();
+    let (lib, bin) = rls.block_on(lib.join(bin)).unwrap();
 
     // lib unit tests have compile errors
     assert!(lib.diagnostics.iter().any(|m| m.message.contains("unused variable: `unused`")));
@@ -282,7 +282,7 @@ fn client_changing_workspace_lib_retains_diagnostics() {
 
     let lib = rls.future_diagnostics("library/src/lib.rs");
     let bin = rls.future_diagnostics("binary/src/main.rs");
-    let (lib, bin) = rls.runtime().block_on(lib.join(bin)).unwrap();
+    let (lib, bin) = rls.block_on(lib.join(bin)).unwrap();
 
     assert!(lib.diagnostics.iter().any(|m| m.message.contains("unused variable: `test_val`")));
     assert!(lib.diagnostics.iter().any(|m| m.message.contains("unused variable: `unused`")));
@@ -339,7 +339,7 @@ fn client_implicit_workspace_pick_up_lib_changes() {
     rls.request::<Initialize>(0, initialize_params(root_path));
 
     let bin = rls.future_diagnostics("src/main.rs");
-    let bin = rls.runtime().block_on(bin).unwrap();
+    let bin = rls.block_on(bin).unwrap();
     assert!(bin.diagnostics[0].message.contains("unused variable: `val`"));
 
     rls.notify::<DidChangeTextDocument>(DidChangeTextDocumentParams {
@@ -365,7 +365,7 @@ fn client_implicit_workspace_pick_up_lib_changes() {
 
     // bin depending on lib picks up type mismatch
     let bin = rls.future_diagnostics("src/main.rs");
-    let bin = rls.runtime().block_on(bin).unwrap();
+    let bin = rls.block_on(bin).unwrap();
     assert!(bin.diagnostics[0].message.contains("cannot find function `foo`"));
 
     rls.notify::<DidChangeTextDocument>(DidChangeTextDocumentParams {
@@ -390,7 +390,7 @@ fn client_implicit_workspace_pick_up_lib_changes() {
     });
 
     let bin = rls.future_diagnostics("src/main.rs");
-    let bin = rls.runtime().block_on(bin).unwrap();
+    let bin = rls.block_on(bin).unwrap();
     assert!(bin.diagnostics[0].message.contains("unused variable: `val`"));
 
     rls.shutdown();

tests/support/client.rs

@@ -135,8 +135,11 @@ impl RlsHandle {
         self.messages.borrow()
     }
 
-    pub fn runtime(&mut self) -> &mut Runtime {
-        &mut self.runtime
+    /// Block on returned, associated future with a timeout.
+    pub fn block_on<F: Future>(&mut self, f: F) -> Result<F::Item, tokio_timer::timeout::Error<F::Error>> {
+        let future_with_timeout = f.timeout(rls_timeout());
+
+        self.runtime.block_on(future_with_timeout)
     }
 
     /// Send a request to the RLS and block until we receive the message.
@@ -182,7 +185,7 @@ impl RlsHandle {
 
         let fut = writer.send(msg);
 
-        self.writer = Some(self.runtime.block_on(fut).unwrap());
+        self.writer = Some(self.block_on(fut).unwrap());
     }
 
     /// Enqueues a channel that is notified and consumed when a given predicate
@@ -214,7 +217,8 @@ impl RlsHandle {
     /// Blocks until a message, for which predicate `f` returns true, is received.
     pub fn wait_for_message(&mut self, f: impl Fn(&Value) -> bool + 'static) -> Value {
         let fut = self.future_msg(f);
-        self.runtime.block_on(fut).unwrap()
+
+        self.block_on(fut).unwrap()
     }
 
     /// Blocks until the processing (building + indexing) is done by the RLS.