Operation Timeout error in actions even after using ack()

[mohan-raheja]

I have implemented the slash command and also actions for handling the interaction, my app sometimes displays an "Operation Timed Out" error when triggering the actions. I have used the ack() call inside my handler, but still sometimes I am getting the Time out error. Not sure if it because of network latency, can you guide me on this.

@app.action("my_statements")
def handle_my_statements(ack):
    ack()
    .....
    ......

The slack_bolt version

slack-bolt==1.9.1
slack-sdk==3.11.1

[seratch]

Hi @mohan-raheja, thanks for writing in!

To help you out, we need a bit more detailed information about your app. Can you share your app code with us?

If your app runs on a FaaS environment and your App initialization has process_before_response=True, this is a possible situation. If so, consider using lazy listeners: https://slack.dev/bolt-python/concepts#lazy-listeners

[mohan-raheja]

Hi @seratch,
I think you meant App ID A02GBRJ4REU
App is not running on FaaS and process_before_response=True this not set in app initialization.

Kindly let me know if you need any other details.

[seratch]

@mohan-raheja Thanks for sharing the info.

Do you use Socket Mode? If so, checking slackapi/bolt-js#1151 (comment) may be helpful.

If you don't use Socket Mode plus the cause of your issue is still unclear, could you share the code that reproduces your situation with us?

[mohan-raheja]

Hi @seratch , I'm not using Socket Mode. I have added my code here. I am facing issue when selecting the options from the select dropdown. And in handling that action, the code logic is heavy so the execution may take some time, may I know after giving the ack(), is there any time limit to send the actual message.

App Settings

app = App(
    signing_secret=signing_secret,
    oauth_settings=OAuthSettings(
        client_id=SLACK_CLIENT_ID,
        client_secret=SLACK_CLIENT_SECRET,
        install_page_rendering_enabled=False,
        scopes=["commands", "chat:write"],
        user_scopes=["users:read", "users:read.email"],
        installation_store=DjangoInstallationStore(
            client_id=SLACK_CLIENT_ID,
            logger=logger,
        ),
        state_store=DjangoOAuthStateStore(
            expiration_seconds=120,
            logger=logger,
        ),
    ),
)

handler = SlackRequestHandler(app=app)

The action below where I am getting timeout error after selecting the options and I am handling the actions as "post_commission_for_a_period"

@app.action("change_time_period")
def handle_change_time_period(
        ack, respond, context, body, client, logger, message, say
):
    ack()
    message_ts = body.get("message", {}).get("ts")
    channel_id = body.get("channel", {}).get("id")
    """
        ..
        ...
    """
  period_options = []
  period_options.append(
              {
                  "label": f"{period_label} {str(fiscal_year)} ",
                  "value": json.dumps(
                      {
                          "selected_period": str(date),
                      }
                  ),
              }
          )
   blocks = [
        {
            "type": "section",
            "text": {
                "type": "plain_text",
                "text": "Hi! Please select a time period ",
                "emoji": True,
            },
        },
        {
            "block_id": "period_select",
            "type": "section",
            "text": {"type": "mrkdwn", "text": "Pick a time period"},
            "accessory": {
                "type": "static_select",
                "placeholder": {
                    "type": "plain_text",
                    "text": "Select period",
                    "emoji": True,
                },
                "options": build_select_options(period_options),
                "action_id": "post_commission_for_a_period",
            },
        },
    ]
    result = client.chat_update(
        channel=channel_id,
        text="Commissions",
        blocks=blocks,
        ts=message_ts,
        # as_user=True,
    )

@app.action("post_commission_for_a_period")
def post_commission_period(client, body, ack, say, context, respond):
    """

    """
    ack()

def build_select_options(options):
    option_block = []
    for option in options:
        option_object = {
            "text": {"type": "plain_text", "text": option.get("label"), "emoji": True},
            "value": option.get("value"),
        }
        option_block.append(option_object)

    return option_block

[seratch]

@mohan-raheja Can you share other parts as well (ideally, compete working example)? Especially, I'm curious about the block element with action_id: change_time_period.

[mohan-raheja]

Hi @seratch, Excuse me for the delayed response, I have given the complete code here, please check.

@app.command("/cms")
def cms(client, context, body, ack, respond):
    ack()
    user_id = context.get("user_id")
    team_id = context.get("team_id")
    try:
        employee = get_employee_in_slack(slack_user_id=user_id, slack_team_id=team_id)
        client_id = employee.client_id
        email_id = employee.employee_email_id
        if body.get("text") == "help":
            client.chat_postEphemeral(
                text="cms",
                user=context.get("user_id"),
                channel=context.get("user_id"),
                blocks=slash_help_block(),
            )
        else:
            post_cms(
                client_id=client_id,
                email_id=email_id,
                body=body,
                cms_date=None,
                update=False,
                context=context,
            )
    except ObjectDoesNotExist as o:
        client.chat_postEphemeral(
            text="cms",
            user=context.get("user_id"),
            channel=context.get("user_id"),
            blocks=connect_prompt_block(),

        )

Below is the code which contains change_time_period block

def post_cms(
        client_id,
        email_id,
        body,
        cms_date=None,
        update=False,
        context=None,
):
    logger.info(f"Posting cms for the payee {email_id}")
    employee = EmployeeAccessor(client_id).get_employee(email_id)
    emp_name = f"{employee.first_name} {employee.last_name}"

    # create slack api client
    user_id = context.get("user_id")
    tokens = get_valid_token(user_id)
    client = WebClient(token=tokens.get("bot_token"))
    try:
        if cms_date is None:
            cms_date = timezone.now()

        payroll = EmployeePayrollAccessor(client_id).get_employee_payroll(
            cms_date, email_id, as_dicts=False
        )
        if payroll is None or len(payroll) == 0:
            raise Exception(f"Payroll data not found for {email_id}")
        else:
            payroll = payroll[0]
        pay_currency = payroll.pay_currency
        payout_frequency = payroll.payout_frequency.lower()
        countries = CountriesAccessor().get_currency_symbol(pay_currency)
        currency_symbol = countries.currency_symbol
        client_data = get_client(client_id)
        start_month = client_data.fiscal_start_month
        fiscal_year = get_fiscal_year(start_month)
        period = get_period_start_and_end_date(
            cms_date,
            client_data.fiscal_start_month,
            payout_frequency,
        )
        psd = period.get("start_date").strftime("%Y-%m-%d")
        ped = period.get("end_date").strftime("%Y-%m-%d")

        statements_url = get_statements_url_for_payee(email_id, ped, psd)

        # get cms data for the period
        cms_data = comm_service.get_cms(
            client_id, email_id, cms_date, payroll
        )
        plan_data = cms_data.get("plan_data")
        payouts = []
        total_payout_in_period = 0
        for plan_id, plan_object in plan_data.items():
            total_payout_in_plan = {plan_id: 0}
            criterias = plan_object.get("criteria_datas") if plan_object else {}
            for criteria_id, criteria_object in criterias.items():
                cms_data = criteria_object.get("cms_data")
                for _ in cms_data:
                    total_payout_in_plan[plan_id] += _.get("amount")
                    total_payout_in_period += _.get("amount")
            payouts.append(total_payout_in_plan)

        plan_details = PlanDetailsAllAccessor(client_id).get_employee_plans(
            cms_date, email_id, as_dicts=False
        )
        plan_id_name = {str(_.plan_id): _.plan_name for _ in plan_details}

        blocks = []
        first_plan = None

        # Building UI layout for cms

        # 0. Header
        payout_period = find_period(
            cms_date.month, start_month, payout_frequency
        )
        period_index = payout_period.get("index")
        period_label = get_period_label(
            period_index, payout_frequency, start_month, cms_date
        )
        blocks.append(
            {
                "type": "section",
                "text": {
                    "type": "mrkdwn",
                    "text": f"Hi *{emp_name}*, Your cms for *{period_label} {fiscal_year}*  ",
                },
            }
        )

        # 1. the cms date
        blocks.append(
            build_section_block(
                text=f"*{period_label} {fiscal_year}*",
                text_type="mrkdwn",
            )
        )

        # 2. cms
        blocks.append(
            build_section_block(
                text=f"*cms:* {currency_symbol}{total_payout_in_period}",
                text_type="mrkdwn",
            )
        )

        # 3. cms %
        variable_pay = get_variable_pay_per_period(payroll)
        cms_percentage = (
            (float(total_payout_in_period) / float(variable_pay)) * 100
            if variable_pay >= 1
            else 0
        )
        blocks.append(
            build_section_block(
                text=f"*cms %:* {round(cms_percentage, 2)} ",
                text_type="mrkdwn",
            )
        )

        # 4. list of plans with cms
        for payout_in_plan in payouts:
            print(f"{payout_in_plan=}")
            plan_id = next(iter(payout_in_plan))  # getting key from dict
            amount = payout_in_plan.get(plan_id)
            if first_plan is None:
                first_plan = plan_id
            blocks.append(
                build_section_block(
                    text=f"*{plan_id_name.get(plan_id)}*: {amount}",
                    text_type="mrkdwn",
                )
            )

        # 5. buttons
        view_component_args = {
            "selected_period": cms_date.strftime("%d/%m/%Y"),
            "selected_plan": first_plan,
            "client_id": client_id,
            "email_id": email_id,
            "statements_url": statements_url
        }

        change_time_period_args = {
            "client_id": client_id,
            "email_id": email_id,
        }
        buttons = [
            {
                "type": "plain_text",
                "text": "View by Components",
                "action_id": "view_by_components",
                "value": json.dumps(view_component_args),
            },
            {
                "type": "plain_text",
                "text": "My statements",
                "action_id": "my_statements",
                "value": "test",
                "url": f"{URL}/{statements_url}"
            },
            {
                "type": "plain_text",
                "text": "Change period",
                "action_id": "change_time_period",     # change time period action
                "value": json.dumps(change_time_period_args),
            },
        ]

        button_elements = []
        for button in buttons:
            button_elements.append(
                build_button_element(
                    action_id=button.get("action_id"),
                    value=button.get("value"),
                    text_type=button.get("type"),
                    text=button.get("text"),
                    url=button.get("url"),
                )
            )

        blocks.append(build_action_block(elements=button_elements))
        if update:
            message_ts = body.get("message", {}).get("ts")
            channel_id = body.get("channel", {}).get("id")
            result = client.chat_update(
                channel=channel_id,
                text="cms",
                blocks=blocks,
                ts=message_ts,
            )
        else:
            result = client.chat_postMessage(
                text="cms",
                channel=user_id,
                # as_user=True,
                blocks=blocks,
            )

    except Exception as o:
        logger.info(o)
        client.chat_postMessage(
            text="Unable to get cms. Please contact the admin.",
            channel=user_id,
        )

@app.action("change_time_period")
def handle_change_time_period(
        ack, respond, context, body, client, logger, message, say
):
    ack()
    message_ts = body.get("message", {}).get("ts")
    channel_id = body.get("channel", {}).get("id")
    actions = body.get("actions")
    period_action = {}
    for action in actions:
        if action.get("action_id") == "change_time_period":
            period_action = action
            break
    # get change time period args
    action_value = json.loads(period_action.get("value"))
    email_id = action_value.get("email_id")
    client_id = action_value.get("client_id")

    cms = list(
        cmsAccessor(client_id).cms_for_payee(email_id)
    )
    cms_periods = sorted(
        {
            cms.period_end_date
            # - datetime.timedelta(days=1)
            for cms in cms
        },
        reverse=True,
    )
    es_client = get_client(client_id)
    start_month = es_client.fiscal_start_month
    period_options = []
    for date in cms_periods:
        fiscal_year = get_fiscal_year(start_month, date)
        payroll = EmployeePayrollAccessor(client_id).get_employee_payroll(
            date, email_id
        )[0]
        cms_period = find_period(
            date.month, start_month, payroll.get("payout_frequency")
        )
        period_index = cms_period.get("index")
        period_label = get_period_label(
            period_index, payroll.get("payout_frequency"), start_month, date
        )
        period_options.append(
            {
                "label": f"{period_label} {str(fiscal_year)} ",
                "value": json.dumps(
                    {
                        "client_id": client_id,
                        "email_id": email_id,
                        "selected_period": str(date),
                    }
                ),
            }
        )

    blocks = [
        {
            "type": "section",
            "text": {
                "type": "plain_text",
                "text": "Hi! Please select a time period for which you want the cms ",
                "emoji": True,
            },
        },
        {
            "block_id": "period_select",
            "type": "section",
            "text": {"type": "mrkdwn", "text": "Pick a time period"},
            "accessory": {
                "type": "static_select",
                "placeholder": {
                    "type": "plain_text",
                    "text": "Select period",
                    "emoji": True,
                },
                "options": build_select_options(period_options),
                "action_id": "post_cms_for_a_period",
            },
        },
    ]
    result = client.chat_update(
        channel=channel_id,
        text="cms",
        blocks=blocks,
        ts=message_ts,
        # as_user=True,
    )

@app.action("post_cms_for_a_period")
def post_cms_period(client, body, ack, say, context, respond):

    ack()
    actions = body.get("actions")
    change_period_action = {}
    for action in actions:
        if action.get("action_id") == "post_cms_for_a_period":
            change_period_action = action
            break

    if change_period_action is None:
        raise Exception(f"change period action arguments not found")

    # getting action args
    action_value = json.loads(
        change_period_action.get("selected_option").get("value")
    )
    email_id = action_value.get("email_id")
    client_id = action_value.get("client_id")
    selected_period = action_value.get("selected_period")
    cms_date = convert_str_to_date(selected_period)
    post_cms(
        client_id=client_id,
        email_id=email_id,
        body=body,
        cms_date=cms_date,
        update=True,
        context=context,
    )

[seratch]

@mohan-raheja
Thanks for sharing more details. However, I don't see any specific issues with the code.

If you still occasionally encounter the 3 second timeouts, the only reason that I think of is, that your Django app may not respond to requests within 3 seconds for some reason. I would suggest checking the timing logs / access logs generated by your web server (any of the django app itself and nginx or Apache Web server) to learn how long your app spends in the scenario. If it takes more than 3 seconds, there is something that you can improve in the app.

[github-actions]

👋 It looks like this issue has been open for 30 days with no activity. We'll mark this as stale for now, and wait 10 days for an update or for further comment before closing this issue out. If you think this issue needs to be prioritized, please comment to get the thread going again! Maintainers also review issues marked as stale on a regular basis and comment or adjust status if the issue needs to be reprioritized.

[github-actions]

As this issue has been inactive for more than one month, we will be closing it. Thank you to all the participants! If you would like to raise a related issue, please create a new issue which includes your specific details and references this issue number.