tarantool / tarantool / 7932379524

88%

push

github

lua: add `message` argument to table constructor of `box.error.new`

Currently, the error message is specified in the `reason` argument to the
table constructor of `box.error.new`. This is confusing, because the
message is accessed and printed by `error:unpack` as `message`.

Let’s allow users to pass the error message in the `message` argument. We
won’t drop the `reason` argument so as not to break potential users. Let's
also allow to omit the message key by treating the first table constructor
entry as an error message if present.

The error message setting has the following priority: first table
constructor entry > `message` > `reason`.

This change is backwards-compatible and does not require a new `compat`
option.

Closes #9102

@TarantoolBot document
Title: Document `message` argument to table constructor of `box.error.new`
Product: Tarantool
Since: 3.1
Root documents: https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_error/new/
and https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_error/error

[Link to the design document](https://www.notion.so/tarantool/Error-subsystem-improvements-90faa0a4714b4143abaf8bed2c10b2fc?pvs=4#c984e766372743c99a4a7be79a5783f6)

66924 of 119428 branches covered (56.04%)

99366 of 114316 relevant lines covered (86.92%)

2694011.36 hits per line