feat(async): add timeout param to will_block (#285)

* feat(async): add timeout param to will_block

* increase hardcoded timeout

* fix(async): use vim.env.PLENARY_TEST_TIMEOUT for async test timeouts

Better than hardcoding a random timeout. If we were to not provide a
timeout here, it'd default to the async lib's internal default (2000).

Author: williamboman

lua/plenary/async/tests.lua

@@ -7,7 +7,7 @@ M.describe = function(s, async_func)
 end
 
 M.it = function(s, async_func)
-  it(s, util.will_block(async_func))
+  it(s, util.will_block(async_func, tonumber(vim.env.PLENARY_TEST_TIMEOUT)))
 end
 
 M.before_each = function(async_func)

lua/plenary/async/util.lua

@@ -40,9 +40,12 @@ M.block_on = function(async_function, timeout)
   return unpack(ret)
 end
 
-M.will_block = function(async_func)
+---@see M.block_on
+---@param async_function Future
+---@param timeout number
+M.will_block = function(async_function, timeout)
   return function()
-    M.block_on(async_func)
+    M.block_on(async_function, timeout)
   end
 end
 

lua/plenary/test_harness.lua

@@ -47,6 +47,8 @@ function harness.test_directory(directory, opts)
     timeout = 50000,
   }, opts or {})
 
+  vim.env.PLENARY_TEST_TIMEOUT = opts.timeout
+
   local res = {}
   if not headless then
     res = win_float.percentage_range_window(0.95, 0.70, opts.winopts)