compat is introduced since version 2.11.0-rc.
The usual way to handle compatibility problems is to introduce an option for a new behavior and leave the old one by default. It is not always the perfect way.
Sometimes developers want to keep the old behavior for existing applications and offer the new behavior by default for the new ones. For example, the old behavior is known to be problematic, or less safe, or it doesn’t correspond to user expectations. In contrast, the user doesn’t always read all the documentation and often assumes good defaults. It was decided to introduce a compatibility module to provide a direct way to deprecate unwanted behavior.
compat module is basically a global table of options with additional verbose interface and helper functions.
There are three stages of changing behavior:
- Old behavior by default.
- New behavior by default.
- New behavior is frozen and the old behavior is removed.
During the first two stages, a user can toggle options via the interface and change the behavior according to one’s needs.
At the last stage, the old behavior is removed from the codebase, and the option is marked as obsolete.
compat is a global instance, options can be hardcoded into it or added in runtime, for example, by external module.
Options are switched to the next stage in major releases. In this way, developers are able to adapt to the new standard behavior and test it before switching to the next release. If something is broken by a new Tarantool version, a developer can still have a way to fix it by a simple config change, that is, explicitly select the old behavior.
Consider example below:
- The option
json_esc_slashis introduced in the 2.11 minor release. Default is set to „old“, but a developer can utilize the new behavior or test the updated behavior by switching it manually to „new“.
- In release 3.0, the next major release,
json_esc_slashdefault is switched to „new“. Now, developers who don’t manage to adapt to the new behavior, are able to switch the option to „old“ and fix their module in the future.
- In release 4.0,
json_esc_slashis marked as obsolete, and the old behavior is no longer accessible. Developers are forced to use the new behavior.
If you want to explicitly secure every behavior in
compat, you can do it manually, and then call
compat.dump() to get a Lua command that sets up the
compat with all the options selected.
You should place this commands at the beginning of code in your
init.lua file. In this way, you are guaranteed to get the same behavior on any other Tarantool version.
See a tutorial on using compat for more examples.