Summary

These changes aim to surface ack_timeout at the function handler level. This allows developers to set their own custom timeout for the acknowledgement, this comes in handler when dealing with dynamic options or new function types that may allow for a timeout greater then 3 seconds

Testing

Set up an app with the following function handler

@app.function("search", auto_acknowledge=False, ack_timeout=5)
def handle_search_step_event(
    ack: Ack, inputs: dict, fail: Fail, complete: Complete, logger: logging.Logger
):
    logger.info("Function inputs received:")
    logger.info(f"inputs: {json.dumps(inputs, indent=2)}")
    sleep(4)
    complete(outputs={...})

Bolt will allow your handler to take up to 5 seconds before returning an error response to Slack

Configuring the handler with auto_acknowledge=true (default behavior)

@app.function("search", ack_timeout=5)
def handle_search_step_event(
    ack: Ack, inputs: dict, fail: Fail, complete: Complete, logger: logging.Logger
):
    logger.info("Function inputs received:")
    logger.info(f"inputs: {json.dumps(inputs, indent=2)}")
    ...

Will print a warning indicating that ack_timeout has no effect

WARNING:slack_bolt.App:As you gave `client` as well, `token` will be unused.
WARNING:slack_bolt.App:On @app.function("search"), as `auto_acknowledge` is `True`, the `acknowledgement_timeout=5` you gave will be unused
INFO:slack_bolt.App:A new session has been established (session id: a7bd6667-e9db-45dc-8419-468afbf5e5ea)

Feedback

Instead of naming this acknowledgement_timeout should e name it ack_timeout? 🟢

Category

• slack_bolt.App and/or its core components
• slack_bolt.async_app.AsyncApp and/or its core components
• Adapters in slack_bolt.adapter
• Document pages under /docs
• Others

Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

• I've read and understood the Contributing Guidelines and have done my best effort to follow them.
• I've read and agree to the Code of Conduct.
• I've run ./scripts/install_all_and_run_tests.sh after making the changes.