Public API documentation for v1/executions documents a callback that users shouldn't really see or use

[lakshmi-kannan]

[stale]

Thanks for contributing to this issue. As it has been 90 days since the last activity, we are automatically marking is as stale. If this issue is not relevant or applicable anymore (problem has been fixed in a new version or similar), please close the issue or let us know so we can close it. On the contrary, if the issue is still relevant, there is nothing you need to do, but if you have any additional details or context which would help us when working on this issue, please include it as a comment to this issue.

[cognifloyd]

This is not a breaking issue any more, or at least, removing the callback from executions will not remove any useful functionality.

callback was only present to support mistral_v2 callbacks. The logic that actually used the callback was in post_run and was removed when the mistral-specific st2resultstracker was ripped out in #5108 here:
https://github.com/StackStorm/st2/pull/5108/files#diff-d7613a0fbf36747a29378082cec19dcaab464b67582aaa72ced86a778b65cb18L231-L234

If a runner needs a callback param, it will need to implement that itself as the logic was removed in #5108. So, these are the remaining callback bits that should be removed:

• delete st2common.callback module (containing the AsyncActionExecutionCallbackHandler which was only ever used with mistral; its abstract callback method is no longer called anywhere).
• remove " such as callback" from this comment in st2common/st2common/services/executions.py:
  

  st2/st2common/st2common/services/executions.py

  Line 268 in 8ac4c6f

  # Invoke post run on the action to execute post run operations such as callback.

• references to the callback attribute on runner/liveaction/execution:
  • In LiveActionDB:

    st2/st2common/st2common/models/db/liveaction.py

    Lines 71 to 74 in 2005126

    	callback = me.DictField(
    	default={},
    	help_text="Callback information for the on completion of action execution.",
    	)

  • In LiveActionAPI:
    

    st2/st2common/st2common/models/api/action.py

    Line 421 in 0604a16

    "callback": {"type": "object"},

    st2/st2common/st2common/models/api/action.py

    Line 477 in 0604a16

    callback = getattr(live_action, "callback", dict())

    st2/st2common/st2common/models/api/action.py

    Line 493 in 0604a16

    callback=callback,

  • In LIVEACTION_ATTRIBUTES:

    st2/st2common/st2common/services/executions.py

    Line 72 in 8ac4c6f

    "callback",

  • In st2common.runners.utils.invoke_post_run func:

    st2/st2common/st2common/runners/utils.py

    Line 241 in 8496bb2

    runner.callback = getattr(liveaction_db, "callback", dict())

  • In st2actions.container.base.RunnerContainer._get_runner:

    st2/st2actions/st2actions/container/base.py

    Line 463 in 2005126

    runner.callback = getattr(liveaction_db, "callback", dict())

  • In openapi.yaml.j2:

    st2/st2common/st2common/openapi.yaml.j2

    Lines 5351 to 5352 in 710137f

    	callback:
    	type: object

  • In openapi.yaml:

    st2/st2common/st2common/openapi.yaml

    Lines 5355 to 5356 in 710137f

    	callback:
    	type: object

  • in various yaml files under st2tests/st2tests/fixtures
  • in various json files under contrib/chatops/tests/fixtures and st2client/tests/fixtures
  • in these tests:
    • st2actions/tests/unit/test_executions.py
    • contrib/runners/local_runner/tests/integration/test_localrunner.py
    • contrib/runners/noop_runner/tests/unit/test_nooprunner.py
    • contrib/core/tests/test_action_sendmail.py
    • st2client/tests/unit/test_formatters.py

When grepping through the code, the callback param that needs to be removed is not related to the callbacks in the transport (rabbitmq) or coordination (redis) related code.

The only question is if we need to do any migrations when we drop the field from the DB. I believe the answer is no.

[arm4b]

+1 for the cleanup!