Moves description of the on_event callback to a separate subsection #5245
Conversation
github-actions
bot
temporarily deployed
to
branch-gh-5244-fix-description-of-app-roles
Adds links from role creation steps to all subsections mentioned in the steps (configuration schema, validation function, apply function, etc.); Fixes #5244
AArdeev
force-pushed
the
AArdeev/gh-5244-fix-description-of-app-roles
branch
from
84e3446 to
46b8f47
Compare
| #. Define a function that :ref:`applies a validated configuration <roles_create_custom_role_apply>`. | ||
| #. Define a function that :ref:`stops a role <roles_create_custom_role_stop>`. | ||
| #. (Optional) Define roles from which this custom role :ref:`depends on <roles_create_custom_role_dependencies>`. | ||
| #. (Optional) Define the ``on_event`` :ref:`callback function <roles_create_custom_role_on_event_callback>. |
There was a problem hiding this comment.
| If multiple custom roles have the ``on_event`` callback defined, these callbacks are called one after another in the order | ||
| defined by roles dependencies. | ||
|
|
||
| The ``on_event`` callback returns 3 arguments, when it is called: |
There was a problem hiding this comment.
I guess, it accepts three arguments.
| @@ -238,7 +215,60 @@ This means that all the dependencies of a role should be defined in the ``roles` | |||
| You can find the full example here: `application_role_cfg <https://github.com/tarantool/doc/tree/latest/doc/code_snippets/snippets/config/instances.enabled/application_role_cfg>`_. | |||
|
|
|||
| .. _roles_create_custom_role_on_event_callback: | |||
|
|
|||
| On_event callback | |||
There was a problem hiding this comment.
BTW, there is the 'Specifics of creating spaces' below and it is written before the on_event callback was implemented. We possibly should recommend to use the on_event callback for this scenario, because it should be simpler. Reach me or @grafin for examples if needed.
|
|
||
| - ``config``, which contains the configuration of the role; | ||
|
|
||
| - ``key``, which reflects the trigger event and is set to: |
There was a problem hiding this comment.
key and value are too general, they don't give much information for a reader. How about event_name and event_data?
|
|
||
| - ``box.status`` if it was triggered by the ``box.status`` system event. | ||
| - ``value``, which shows and logs the information about the instance status as in the trigger ``box.status`` system event. |
There was a problem hiding this comment.
I don't get how it logs anything.
| return { | ||
| validate = function() end, | ||
| apply = function() | ||
| _G.foo = 0 | ||
| end, | ||
| stop = function() | ||
| _G.foo = -1 | ||
| _G.bar = nil | ||
| end, | ||
| on_event = function(config, key, value) | ||
| assert(_G.foo >= 0) | ||
| assert(config == 12345) | ||
| if(_G.foo == 0) then | ||
| assert(key == 'config.apply') | ||
| else | ||
| assert(key == 'box.status') | ||
| end | ||
| _G.is_ro = value.is_ro | ||
| _G.foo = _G.foo + 1 | ||
| _G.bar = config | ||
| end, | ||
| } |
There was a problem hiding this comment.
What is the idea behind all this arithmetic?
Here we demonstrate how on_event works, right? So, maybe, an example with creating a space schema or writing something into a space would suit better (we need to react to transition from RO to RW)?
Adds links from role creation steps to all subsections mentioned in the steps (configuration schema, validation function, apply function, etc.);
Fixes Fix description of Application Roles article #5244