change/set/select_choice: update current node before modifying choice.

If we don't do this, the content of a choiceNode may not be restored
correctly.
(or, it will be restored correctly, but it won't be what the user saw
before they called change/set/select_choice, which seems suboptimal).

lua/luasnip/extras/select_choice.lua

@@ -1,6 +1,7 @@
 local session = require("luasnip.session")
 local ls = require("luasnip")
 local node_util = require("luasnip.nodes.util")
+local feedkeys = require("luasnip.util.feedkeys")
 
 -- in this procedure, make sure that api_leave is called before
 -- set_choice_callback exits.
@@ -10,9 +11,8 @@ local function set_choice_callback(data)
 			ls._api_leave()
 			return
 		end
-		-- feed+immediately execute i to enter INSERT after vim.ui.input closes.
-		-- vim.api.nvim_feedkeys("i", "x", false)
-		ls._set_choice(indx, {cursor_restore_data = data})
+		-- set_choice restores cursor from before.
+		ls._set_choice(indx, {cursor_restore_data = data, skip_update = true})
 		ls._api_leave()
 	end
 end
@@ -25,12 +25,25 @@ local function select_choice()
 	local active = session.current_nodes[vim.api.nvim_get_current_buf()]
 
 	ls._api_enter()
-	local restore_data = node_util.store_cursor_node_relative(active, {place_cursor_mark = false})
-	vim.ui.select(
-		ls.get_current_choices(),
-		{ kind = "luasnip" },
-		set_choice_callback(restore_data)
-	)
+
+	ls._active_update_dependents()
+
+	if not session.active_choice_nodes[vim.api.nvim_get_current_buf()] then
+		print("Active choice was removed while updating a dynamicNode.")
+		return
+	end
+
+	local restore_data = node_util.store_cursor_node_relative(active, {place_cursor_mark = true})
+
+	-- make sure all movements are done, otherwise the movements may be put into
+	-- the select-dialog.
+	feedkeys.enqueue_action(function()
+		vim.ui.select(
+			ls.get_current_choices(),
+			{ kind = "luasnip" },
+			set_choice_callback(restore_data)
+		)
+	end)
 end
 
 return select_choice

lua/luasnip/init.lua

@@ -201,7 +201,7 @@ end
 
 local function node_update_dependents_preserve_position(node, current, opts)
 	-- set luasnip_changedtick so that static_text is preserved when possible.
-	local restore_data = node_util.store_cursor_node_relative(current, {place_cursor_mark = true})
+	local restore_data = opts.cursor_restore_data or node_util.store_cursor_node_relative(current, {place_cursor_mark = true})
 
 	-- update all nodes that depend on this one.
 	local ok, res =
@@ -318,15 +318,15 @@ local function node_update_dependents_preserve_position(node, current, opts)
 	end
 end
 
-local function update_dependents(node)
+local function update_dependents(node, opts)
 	local active = session.current_nodes[vim.api.nvim_get_current_buf()]
 	-- don't update if a jump/change_choice is in progress, or if we don't have
 	-- an active node.
 	if active ~= nil then
 		local upd_res = node_update_dependents_preserve_position(
 			node,
 			active,
-			{ no_move = false, restore_position = true }
+			{ no_move = false, restore_position = true, cursor_restore_data = opts and opts.cursor_restore_data }
 		)
 		if upd_res.new_current then
 			upd_res.new_current:focus()
@@ -335,8 +335,8 @@ local function update_dependents(node)
 	end
 end
 
-local function _active_update_dependents()
-	update_dependents(session.current_nodes[vim.api.nvim_get_current_buf()])
+local function _active_update_dependents(opts)
+	update_dependents(session.current_nodes[vim.api.nvim_get_current_buf()], opts)
 end
 
 -- return next active node.
@@ -804,39 +804,61 @@ end
 local function _change_choice(val, opts)
 	local active_choice =
 		session.active_choice_nodes[vim.api.nvim_get_current_buf()]
-	assert(active_choice, "No active choiceNode")
+
+	-- make sure we update completely, there may have been changes to the
+	-- buffer since the last update.
+	if not opts.skip_update then
+		assert(active_choice, "No active choiceNode")
+
+		_active_update_dependents({ cursor_restore_data = opts.cursor_restore_data })
+
+		active_choice =
+			session.active_choice_nodes[vim.api.nvim_get_current_buf()]
+		if not active_choice then
+			print("Active choice was removed while updating a dynamicNode.")
+			return
+		end
+	end
 
 	-- if the active choice exists current_node still does.
 	local current_node = session.current_nodes[vim.api.nvim_get_current_buf()]
 
-	local restore_data = opts and opts.cursor_restore_data or node_util.store_cursor_node_relative(current_node, {place_cursor_mark = false})
-
 	local new_active = safe_choice_action(
 		active_choice.parent.snippet,
 		active_choice.change_choice,
 		active_choice,
 		val,
 		session.current_nodes[vim.api.nvim_get_current_buf()],
-		restore_data
+		opts.skip_update and opts.cursor_restore_data or node_util.store_cursor_node_relative(current_node, {place_cursor_mark = false})
 	)
 	session.current_nodes[vim.api.nvim_get_current_buf()] = new_active
 	_active_update_dependents()
 end
 
 --- Change the currently active choice.
 ---@param val 1|-1 Move one choice forward or backward.
-function API.change_choice(val, opts)
-	api_do(_change_choice, val, opts)
+function API.change_choice(val)
+	api_do(_change_choice, val, {})
 end
 
 local function _set_choice(choice_indx, opts)
 	local active_choice =
 		session.active_choice_nodes[vim.api.nvim_get_current_buf()]
-	assert(active_choice, "No active choiceNode")
 
-	local current_node = session.current_nodes[vim.api.nvim_get_current_buf()]
+	if not opts.skip_update then
+		assert(active_choice, "No active choiceNode")
+
+		_active_update_dependents({ cursor_restore_data = opts.cursor_restore_data })
+
+		active_choice =
+			session.active_choice_nodes[vim.api.nvim_get_current_buf()]
+		if not active_choice then
+			print("Active choice was removed while updating a dynamicNode.")
+			return
+		end
+	end
 
-	local restore_data = opts and opts.cursor_restore_data or node_util.store_cursor_node_relative(current_node, {place_cursor_mark = false})
+	local current_node = session.current_nodes[vim.api.nvim_get_current_buf()]
 
 	local choice = active_choice.choices[choice_indx]
 	assert(choice, "Invalid Choice")
@@ -847,16 +869,18 @@ local function _set_choice(choice_indx, opts)
 		active_choice,
 		choice,
 		current_node,
-		restore_data
+		-- if the update was skipped, we have to use the cursor_restore_data
+		-- here.
+		opts.skip_update and opts.cursor_restore_data or node_util.store_cursor_node_relative(current_node, {place_cursor_mark = false})
 	)
 	session.current_nodes[vim.api.nvim_get_current_buf()] = new_active
 	_active_update_dependents()
 end
 
 --- Set the currently active choice.
 ---@param choice_indx integer Index of the choice to switch to.
-function API.set_choice(choice_indx, opts)
-	api_do(_set_choice, choice_indx, opts)
+function API.set_choice(choice_indx)
+	api_do(_set_choice, choice_indx, {})
 end
 
 --- Get a string-representation of all the current choiceNode's choices.
@@ -1378,6 +1402,7 @@ API.log = require("luasnip.util.log")
 ls = lazy_table(API, ls_lazy)
 
 -- undocumented, internally-used, exported functions.
+ls._active_update_dependents = _active_update_dependents
 ls._api_do = api_do
 ls._api_enter = api_enter
 ls._api_leave = api_leave