Update promise.wait to throw an error when timeout reached or interrupted (#723)

* Update promise.wait to throw an error when timeout reached or interrupted

* Revert some formatting changes

* Fix lint error

* Add test to demonstrate functionality

* Update lua/orgmode/utils/promise.lua

Co-authored-by: Kristijan Husak <[email protected]>

---------

Co-authored-by: Kristijan Husak <[email protected]>

Author: chipsenkbeil

lua/orgmode/utils/promise.lua

@@ -263,6 +263,7 @@ end
 --- @param timeout? number
 --- @return any
 function Promise.wait(self, timeout)
+  timeout = timeout or 5000
   local is_done = false
   local has_error = false
   local result = nil
@@ -278,7 +279,7 @@ function Promise.wait(self, timeout)
       is_done = true
     end)
 
-  vim.wait(timeout or 5000, function()
+  local success, code = vim.wait(timeout, function()
     return is_done
   end, 1)
 
@@ -288,7 +289,17 @@ function Promise.wait(self, timeout)
     return error(value)
   end
 
-  return value
+  if success then
+    return value
+  end
+
+  if code == -1 then
+    return error('promise timeout of ' .. tostring(timeout) .. 'ms reached')
+  elseif code == -2 then
+    return error('promise interrupted')
+  end
+
+  return error('promise failed with unknown reason')
 end
 
 --- Equivalents to JavaScript's Promise.all.

tests/plenary/utils/promise_spec.lua

@@ -0,0 +1,14 @@
+local Promise = require('orgmode.utils.promise')
+
+describe('Promise', function()
+  it('should throw an error when wait exceeds its timeout', function()
+    -- Create a promise that will never resolve or reject
+    local promise = Promise.new(function() end)
+
+    -- We expect an error to occur here when the timeout is exceeded
+    assert.is.error(function()
+      -- Provide a smaller timeout so our test doesn't wait 5 seconds
+      promise:wait(50)
+    end)
+  end)
+end)