tarantool / tarantool / 8387828794

88%

Build Type

push

github

Committed by locker

Commit Message

error: allow to specify where to get error location

Currently, the error location (file, line) is always retrieved from
the current stack frame. The new argument `level` allows to change
this. It has the same semantics as the `level` argument of the built-in
Lua function `error`.

Closes #9792

@TarantoolBot document
Title: Document `level` argument of `box.error` and `box.error.new`

Now, when used with a table argument, `box.error` and `box.error.new`
also accept an optional second argument called `level`. It has the same
meaning as the `level` argument of the built-in Lua function `error`:
it specifies how to get the error location. With level 1 (the default),
the error location is where `box.error` / `box.error.new` was called.
Level 2 points the error to where the function that called `box.error` /
`box.error.new` was called; and so on. Passing level 0 avoids addition
of location information to the error.

Example of using `level` with `box.error`:

```lua
local json = require('json')

local function inner(level)
    box.error({message = 'test'}, level)    -- line:4
end

local function outer(level)
    inner(level)                            -- line:8
end

local ok, err
ok, err = pcall(outer)
print(json.encode(err.trace))               -- prints line:4
ok, err = pcall(outer, 1)
print(json.encode(err.trace))               -- prints line:4
ok, err = pcall(outer, 2)
print(json.encode(err.trace))               -- prints line:8
ok, err = pcall(outer, 0)
print(json.encode(err.trace))               -- prints empty table
```

Example of using `level` with `box.error.new`:

```lua
local json = require('json')

local function inner(level)
    local err = box.error.new({message = 'test'}, level)    -- line:4
    return err
end

local function outer(level)
    local err = inner(level)                                -- line:9
    return err
end

local err
err = outer()
print(json.encode(err.trace))               -- prints line:4
err = outer(1)
print(json.enc... (continued)

Run Details

67061 of 119449 branches covered (56.14%)

41 of 44 new or added lines in 1 file covered. (93.18%)

24 existing lines in 7 files now uncovered.

99632 of 114521 relevant lines covered (87.0%)

2465334.81 hits per line