Merge pull request #23288 from MunifTanjim/issue-22263

fix(normal): fix repeated trigger modechanged for scheduled callback

1 files changed, 36 insertions, 3 deletions

diff --git a/test/functional/autocmd/modechanged_spec.lua b/test/functional/autocmd/modechanged_spec.lua
index be5a291ac9..69a722a0e9 100644
--- a/test/functional/autocmd/modechanged_spec.lua
+++ b/test/functional/autocmd/modechanged_spec.lua
@@ -1,17 +1,19 @@
 local helpers = require('test.functional.helpers')(after_each)
 local clear, eval, eq = helpers.clear, helpers.eval, helpers.eq
 local feed, command = helpers.feed, helpers.command
+local exec_lua = helpers.exec_lua
 
 describe('ModeChanged', function()
   before_each(function()
     clear()
+  end)
+
+  it('picks up terminal mode changes', function()
     command('let g:count = 0')
     command('au ModeChanged * let g:event = copy(v:event)')
     command('au ModeChanged * let g:count += 1')
-  end)
 
-  it('picks up terminal mode changes', function()
-    command("term")
+    command('term')
     feed('i')
     eq({
       old_mode = 'nt',
@@ -28,4 +30,35 @@ describe('ModeChanged', function()
     -- v:event is cleared after the autocommand is done
     eq({}, eval('v:event'))
   end)
+
+  it('does not repeatedly trigger for scheduled callback', function()
+    exec_lua([[
+      vim.g.s_count = 0
+      vim.g.s_mode = ""
+      vim.g.t_count = 0
+      vim.g.t_mode = ""
+      vim.api.nvim_create_autocmd("ModeChanged", {
+        callback = function()
+          vim.g.s_count = vim.g.s_count + 1
+          vim.g.s_mode = vim.api.nvim_get_mode().mode
+          vim.schedule(function()
+            vim.g.t_count = vim.g.t_count + 1
+            vim.g.t_mode = vim.api.nvim_get_mode().mode
+          end)
+        end,
+      })
+    ]])
+
+    feed('d')
+    eq(1, eval('g:s_count'))
+    eq('no', eval('g:s_mode'))
+    eq(1, eval('g:t_count'))
+    eq('no', eval('g:t_mode'))
+
+    feed('<Esc>')
+    eq(2, eval('g:s_count'))
+    eq('n', eval('g:s_mode'))
+    eq(2, eval('g:t_count'))
+    eq('n', eval('g:t_mode'))
+  end)
 end)