bot_server: Support trigger value private_message renamed to direct_message.

[prakhar1144]

CZO Discussion

The JSON payload that Zulip server POST for outgoing webhooks has trigger as one of the fields.

In zulip/zulip@c4e4737, we renamed the private_message value to direct_message.

This commit adds support to the botserver for handling direct_message as a trigger value. It still supports
private_message for self-hosted server compatibility.

[prakhar1144]

I didn't rename private_message to direct_message in these places:

zulip/integrations/jabber/jabber_mirror_backend.py:                    self.private_message(message)
zulip/integrations/jabber/jabber_mirror_backend.py:    def private_message(self, msg: Dict[str, Any]) -> None:
zulip_bots/zulip_bots/bots/game_handler_bot/test_game_handler_bot.py:    def test_private_message_error(self) -> None:
zulip_bots/zulip_bots/lib.py:def is_private_message_but_not_group_pm(
zulip_bots/zulip_bots/lib.py:        is_private_message = is_private_message_but_not_group_pm(message, restricted_client)
zulip_bots/zulip_bots/lib.py:        if is_private_message or is_mentioned:
zulip_bots/zulip_bots/tests/test_lib.py:    is_private_message_but_not_group_pm,
zulip_bots/zulip_bots/tests/test_lib.py:    def test_is_private_message_but_not_group_pm(self):
zulip_bots/zulip_bots/tests/test_lib.py:        self.assertFalse(is_private_message_but_not_group_pm(message, handler))
zulip_bots/zulip_bots/tests/test_lib.py:        self.assertFalse(is_private_message_but_not_group_pm(message, handler))
zulip_bots/zulip_bots/tests/test_lib.py:        self.assertTrue(is_private_message_but_not_group_pm(message, handler))
zulip_bots/zulip_bots/tests/test_lib.py:        self.assertFalse(is_private_message_but_not_group_pm(message, handler))

as they are related to message["type"] == "private". We should rename it while changing the type from private to direct.

This PR is restricted to handling the outgoing webhook issue we encountered.

[prakhar1144]

Should we add a TODO/compatibility comment here to remove private_message in future? I don't see it included in
Zulip PyPI packages release checklist

[mateuszmandera]

Yeah I think it would be valuable to put that kind of comment here to have a record why this is needed and to remove it at some point

[prakhar1144]

Added a comment:

    # TODO/compatibility: Remove the support for "private_message" as a valid
    # trigger value when one can no longer directly upgrade from 0.8.x to main.

[mateuszmandera]

Looks good to me

[timabbott]

The compatibility comment was a great idea, but I changed it to state clearly the condition when we remove it -- namely when we no longer support pre-8.0 Zulip servers, since 8.0 will be the first Zulip server release with this change.

I think we can rename the is_private_message_but_not_group_pm to is_non_group_direct_message (and make its implementation check for both direct and private as types -- doing that now will be helpful down the line. API design discussion: https://chat.zulip.org/#narrow/stream/378-api-design/topic/.22private.22.20.3D.3E.20.22direct.22.20in.20message.20type/near/1644682.