fix(buffer): ignore stale extmark range errors

[fei6409]

When asynchronous updates or byte-offset misalignments produce stale ranges, nvim_buf_set_extmark() can raise an out-of-range error.

Ignore only stale col, end_col, and line range errors for both non-virtualtext and virtualtext highlights. Re-raise all other extmark errors.

[catgoose]

Can we do something like

  local function set_extmark_ignore_stale_range(bufnr, ns_id, line, col, opts)
    local ok, err = pcall(vim.api.nvim_buf_set_extmark, bufnr, ns_id, line, col, opts)
    if ok then
      return true
    end

    if type(err) == "string" and err:find("Invalid 'end_col': out of range", 1, true) then
      return false
    end

    error(err, 2)
  end

  -- replace your pcall with:

  set_extmark_ignore_stale_range(bufnr, ns_id, linenr, hl.range[1], {
    end_col = hl.range[2],
    hl_group = hlname,
    priority = priority,
  })

Perhaps using something like

  local stale_extmark_range_errors = {
    "Invalid 'col': out of range",
    "Invalid 'end_col': out of range",
    "Invalid 'line': out of range",
  }

  local function is_stale_extmark_range_error(err)
    if type(err) ~= "string" then
      return false
    end
    for _, msg in ipairs(stale_extmark_range_errors) do
      if err:find(msg, 1, true) then
        return true
      end
    end
    return false
  end

So we don't swallow all errors, only specific extmark ones you are concerned about.

[fei6409]

Addressed, both non-virtualtext and virtualtext extmarks now use the helper.