Merge pull request #3943 from ZyX-I/better-fref-error

 eval: Use better error messages when failing to dump values

3 files changed, 28 insertions, 14 deletions

diff --git a/test/functional/eval/msgpack_functions_spec.lua b/test/functional/eval/msgpack_functions_spec.lua
index da42fc9d26..41b0faf76c 100644
--- a/test/functional/eval/msgpack_functions_spec.lua
+++ b/test/functional/eval/msgpack_functions_spec.lua
@@ -541,27 +541,27 @@ describe('msgpackdump() function', function()
 
   it('fails to dump a function reference', function()
     execute('let Todump = function("tr")')
-    eq('Vim(call):E475: Invalid argument: attempt to dump function reference',
+    eq('Vim(call):E951: Error while dumping msgpackdump() argument, index 0, itself: attempt to dump function reference',
        exc_exec('call msgpackdump([Todump])'))
   end)
 
   it('fails to dump a function reference in a list', function()
     execute('let todump = [function("tr")]')
-    eq('Vim(call):E475: Invalid argument: attempt to dump function reference',
+    eq('Vim(call):E951: Error while dumping msgpackdump() argument, index 0, index 0: attempt to dump function reference',
        exc_exec('call msgpackdump([todump])'))
   end)
 
   it('fails to dump a recursive list', function()
     execute('let todump = [[[]]]')
     execute('call add(todump[0][0], todump)')
-    eq('Vim(call):E475: Invalid argument: container references itself',
+    eq('Vim(call):E952: Unable to dump msgpackdump() argument, index 0: container references itself in index 0, index 0, index 0',
        exc_exec('call msgpackdump([todump])'))
   end)
 
   it('fails to dump a recursive dict', function()
     execute('let todump = {"d": {"d": {}}}')
     execute('call extend(todump.d.d, {"d": todump})')
-    eq('Vim(call):E475: Invalid argument: container references itself',
+    eq('Vim(call):E952: Unable to dump msgpackdump() argument, index 0: container references itself in key \'d\', key \'d\', key \'d\'',
        exc_exec('call msgpackdump([todump])'))
   end)
 
@@ -580,21 +580,35 @@ describe('msgpackdump() function', function()
   it('fails to dump a recursive list in a special dict', function()
     execute('let todump = {"_TYPE": v:msgpack_types.array, "_VAL": []}')
     execute('call add(todump._VAL, todump)')
-    eq('Vim(call):E475: Invalid argument: container references itself',
+    eq('Vim(call):E952: Unable to dump msgpackdump() argument, index 0: container references itself in index 0',
        exc_exec('call msgpackdump([todump])'))
   end)
 
   it('fails to dump a recursive (key) map in a special dict', function()
-    execute('let todump = {"_TYPE": v:msgpack_types.array, "_VAL": []}')
+    execute('let todump = {"_TYPE": v:msgpack_types.map, "_VAL": []}')
     execute('call add(todump._VAL, [todump, 0])')
-    eq('Vim(call):E475: Invalid argument: container references itself',
+    eq('Vim(call):E952: Unable to dump msgpackdump() argument, index 0: container references itself in index 1',
        exc_exec('call msgpackdump([todump])'))
   end)
 
   it('fails to dump a recursive (val) map in a special dict', function()
-    execute('let todump = {"_TYPE": v:msgpack_types.array, "_VAL": []}')
+    execute('let todump = {"_TYPE": v:msgpack_types.map, "_VAL": []}')
     execute('call add(todump._VAL, [0, todump])')
-    eq('Vim(call):E475: Invalid argument: container references itself',
+    eq('Vim(call):E952: Unable to dump msgpackdump() argument, index 0: container references itself in key 0 at index 0 from special map',
+       exc_exec('call msgpackdump([todump])'))
+  end)
+
+  it('fails to dump a recursive (key) map in a special dict, _VAL reference', function()
+    execute('let todump = {"_TYPE": v:msgpack_types.map, "_VAL": [[[], []]]}')
+    execute('call add(todump._VAL[0][0], todump._VAL)')
+    eq('Vim(call):E952: Unable to dump msgpackdump() argument, index 0: container references itself in key [[[[...@0], []]]] at index 0 from special map, index 0',
+       exc_exec('call msgpackdump([todump])'))
+  end)
+
+  it('fails to dump a recursive (val) map in a special dict, _VAL reference', function()
+    execute('let todump = {"_TYPE": v:msgpack_types.map, "_VAL": [[[], []]]}')
+    execute('call add(todump._VAL[0][1], todump._VAL)')
+    eq('Vim(call):E952: Unable to dump msgpackdump() argument, index 0: container references itself in key [] at index 0 from special map, index 0',
        exc_exec('call msgpackdump([todump])'))
   end)
 
@@ -602,7 +616,7 @@ describe('msgpackdump() function', function()
   function()
     execute('let todump = {"_TYPE": v:msgpack_types.array, "_VAL": []}')
     execute('call add(todump._VAL, [0, todump._VAL])')
-    eq('Vim(call):E475: Invalid argument: container references itself',
+    eq('Vim(call):E952: Unable to dump msgpackdump() argument, index 0: container references itself in index 0, index 1',
        exc_exec('call msgpackdump([todump])'))
   end)
 
diff --git a/test/functional/shada/errors_spec.lua b/test/functional/shada/errors_spec.lua
index f6265bf24b..e7951ee74c 100644
--- a/test/functional/shada/errors_spec.lua
+++ b/test/functional/shada/errors_spec.lua
@@ -497,7 +497,7 @@ $
   it('errors when a funcref is stored in a variable', function()
     nvim_command('let F = function("tr")')
     nvim_command('set shada+=!')
-    eq('\nE475: Invalid argument: attempt to dump function reference'
+    eq('\nE951: Error while dumping variable g:F, itself: attempt to dump function reference'
        .. '\nE574: Failed to write variable F',
        redir_exec('wshada'))
   end)
@@ -506,7 +506,7 @@ $
     nvim_command('let L = []')
     nvim_command('call add(L, L)')
     nvim_command('set shada+=!')
-    eq('\nE475: Invalid argument: container references itself'
+    eq('\nE952: Unable to dump variable g:L: container references itself in index 0'
        .. '\nE574: Failed to write variable L',
        redir_exec('wshada'))
   end)
diff --git a/test/functional/shada/variables_spec.lua b/test/functional/shada/variables_spec.lua
index 22054db353..3becf1bc32 100644
--- a/test/functional/shada/variables_spec.lua
+++ b/test/functional/shada/variables_spec.lua
@@ -143,7 +143,7 @@ describe('ShaDa support code', function()
     meths.set_var('U', '10')
     nvim_command('set shada+=!')
     set_additional_cmd('set shada+=!')
-    eq('Vim(wshada):E475: Invalid argument: attempt to dump function reference',
+    eq('Vim(wshada):E951: Error while dumping variable g:F, itself: attempt to dump function reference',
        exc_exec('wshada'))
     meths.set_option('shada', '')
     reset()
@@ -156,7 +156,7 @@ describe('ShaDa support code', function()
     nvim_command('call add(L, L)')
     meths.set_var('U', '10')
     nvim_command('set shada+=!')
-    eq('Vim(wshada):E475: Invalid argument: container references itself',
+    eq('Vim(wshada):E952: Unable to dump variable g:L: container references itself in index 0',
        exc_exec('wshada'))
     meths.set_option('shada', '')
     set_additional_cmd('set shada+=!')