The "`text` missing" warning is technically not always accurate

The _warn_text_if_missing() code is technically not always a valid warning.

Category (place an x in each of the [ ])

• slack_sdk.web.WebClient (sync/async) (Web API client)
• slack_sdk.webhook.WebhookClient (sync/async) (Incoming Webhook, response_url sender)
• slack_sdk.models (UI component builders)
• slack_sdk.oauth (OAuth Flow Utilities)
• slack_sdk.socket_mode (Socket Mode client)
• slack_sdk.audit_logs (Audit Logs API client)
• slack_sdk.scim (SCIM API client)
• slack_sdk.rtm (RTM client)
• slack_sdk.signature (Request Signature Verifier)

Although this warning is easy to suppress by setting SKIP_SLACK_SDK_WARNING in the env, the code is technically incorrect. 😄 Attachments are still supported (and used, since they have some advantages over Blocks). The issue is that attachments have a separate fallback property, and thus setting a top-level text property is technically not required, and the deprecation warning shouldn’t be logged.

From the docs:

This can be fixed pretty easily with code like this:

def _warn_if_text_is_missing(endpoint: str, kwargs: Dict[str, Any]) -> None:
    attachments = kwargs.get("attachments")
    if attachments:
        if all([attachment.get("fallback") for attachment in attachments]):
            return
        missing = "fallback"
    else: 
        text = kwargs.get("text")
        if text and len(text.strip()) != 0:
            return
        missing = "text"
    message = (
        f"The `{missing}` argument is missing in the request payload for a {endpoint} call - "
        f"It's a best practice to always provide a `{missing}` argument when posting a message. "
        f"The `{missing}` argument is used in places where content cannot be rendered such as: "
        "system push notifications, assistive technology such as screen readers, etc."
    )
    # for unit tests etc.
    skip_deprecation = os.environ.get("SKIP_SLACK_SDK_WARNING")
    if skip_deprecation:
        return
    warnings.warn(message, UserWarning)

I realize this is minor since it’s just a cosmetic warning, but figured I’d mention it anyway.

[eddyg]

@agrawaltarun When using blocks, you should provide a top-level summary text item. (This is used for notifications, for example.) The warning you’re seeing is alerting you that it is missing.

e.g.:

json_body: {
   'user': 'toto',
   'text': "CRITICAL: Issue encountered during snapshot creation",
   'blocks': [
       {'type': 'section',
         'text': {'type': 'mrkdwn', 'text': 'CRITICAL: Issue encountered during snapshot creation on Host:'}
       },
       {'type': 'section',
         'text': ...

[agrawaltarun]

Thanks @seratch & @eddyg , this is helpful. The warning no longer appears post updating the request payload .