fix(vim.ui.input): return empty string when inputs nothing (#20883)

fix(vim.ui.input): return empty string when inputs nothing

The previous behavior of `vim.ui.input()` when typing <CR> with
no text input (with an intention of having the empty string as input)
was to execute `on_confirm(nil)`, conflicting with its documentation.

Inputting an empty string should now correctly execute `on_confirm('')`.
This should be clearly distinguished from cancelling or aborting the
input UI, in which case `on_confirm(nil)` is executed as before.

1 files changed, 46 insertions, 0 deletions

diff --git a/test/functional/lua/ui_spec.lua b/test/functional/lua/ui_spec.lua
index 3fcb2dec8d..8f9d8e0f72 100644
--- a/test/functional/lua/ui_spec.lua
+++ b/test/functional/lua/ui_spec.lua
@@ -83,5 +83,51 @@ describe('vim.ui', function()
       feed('abcdefg<cr>')
       eq('abcdefg', exec_lua('return result'))
     end)
+
+    it('can input empty text #18144', function()
+      feed(':lua vim.ui.input({}, function(input) result = input end)<cr>')
+      feed('<cr>')
+      eq('', exec_lua('return result'))
+    end)
+
+    it('can input empty text with cancelreturn opt #18144', function()
+      feed(':lua vim.ui.input({ cancelreturn = "CANCEL" }, function(input) result = input end)<cr>')
+      feed('<cr>')
+      eq('', exec_lua('return result'))
+    end)
+
+    it('can return nil when aborted with ESC #18144', function()
+      feed(':lua result = "on_confirm not called"<cr>')
+      feed(':lua vim.ui.input({}, function(input) result = input end)<cr>')
+      feed('Inputted Text<esc>')
+      -- Note: When `result == nil`, exec_lua('returns result') returns vim.NIL
+      eq(true, exec_lua('return (nil == result)'))
+    end)
+
+    it('can return opts.cacelreturn when aborted with ESC with cancelreturn opt #18144', function()
+      feed(':lua result = "on_confirm not called"<cr>')
+      feed(':lua vim.ui.input({ cancelreturn = "CANCEL" }, function(input) result = input end)<cr>')
+      feed('Inputted Text<esc>')
+      eq('CANCEL', exec_lua('return result'))
+    end)
+
+    it('does not call on_confirm when interrupted with Ctrl-C #18144', function()
+      feed(':lua result = "on_confirm not called"<cr>')
+      eq('on_confirm not called', exec_lua('return result'))
+      feed(':lua vim.ui.input({}, function(input) result = input end)<cr>')
+      feed('Inputted Text<c-c>')
+      -- Ctrl-C would make vim.ui.input() throw, so `result = input` won't be executed
+      eq('on_confirm not called', exec_lua('return result'))
+    end)
+
+    it('can return the identical object when an arbitrary opts.cancelreturn object is given', function()
+      feed(':lua fn = function() return 42 end<CR>')
+      eq(42, exec_lua('return fn()'))
+      feed(':lua vim.ui.input({ cancelreturn = fn }, function(input) result = input end)<cr>')
+      feed('cancel<esc>')
+      eq(true, exec_lua('return (result == fn)'))
+      eq(42, exec_lua('return result()'))
+    end)
+
   end)
 end)