increased version to 1.1.0

Remove logging of incoming messages

.gitignore

@@ -3,6 +3,7 @@
 __pycache__/
 /.tox/
 /build/
+/dist/
 /venv/
 bot.db/
 teams_bot_data/

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = team_bot
-version = 1.0.0
+version = 1.1.0
 author = missytake
 author_email = missytake@systemli.org
 description = This bot connects your team to the outside and makes it addressable.
@@ -24,7 +24,7 @@ install_requires =
     pyinfra
     pickleDB
     qrcode
-    deltachat>=1.133.1
+    deltachat>=1.136.2
 
 [options.packages.find]
 where = src

src/team_bot/bot.py

@@ -11,6 +11,7 @@ from .commands import (
     crew_help,
     set_display_name,
     set_avatar,
+    generate_invite,
     start_chat,
     outside_help,
     set_outside_help,
@@ -68,12 +69,6 @@ class RelayPlugin:
     @account_hookimpl
     def ac_incoming_message(self, message: deltachat.Message):
         """This method is called on every incoming message and decides what to do with it."""
-        logging.info(
-            "New message from %s in chat %s: %s",
-            message.get_sender_contact().addr,
-            message.chat.get_name(),
-            message.text,
-        )
 
         if message.is_system_message():
             if message.chat.id == self.crew.id:
@@ -114,6 +109,9 @@ class RelayPlugin:
                 if arguments[0] == "/set_avatar":
                     result = set_avatar(self.account, message, self.crew)
                     self.reply(message.chat, result, quote=message)
+                if arguments[0] == "/generate-invite":
+                    text = generate_invite(self.account)
+                    self.reply(message.chat, text, quote=message)
                 if arguments[0] == "/start_chat":
                     outside_chat, result = start_chat(
                         self.account,

src/team_bot/commands.py

@@ -15,6 +15,7 @@ def crew_help() -> str:
 Start a chat:\t/start_chat alice@example.org,bob@example.org Chat_Title Hello friends!
 Change the bot's name:\t/set_name Name
 Change the bot's avatar:\t/set_avatar <attach image>
+Generate invite link:\t\t/generate-invite
 Show this help text:\t\t/help
 Change the help message for outsiders:\t/set_outside_help Hello outsider
     """
@@ -63,6 +64,14 @@ def set_avatar(
     return "Avatar changed to this image."
 
 
+def generate_invite(account: deltachat.Account) -> str:
+    """Return a https://i.delta.chat invite link for chatting with the bot.
+
+    :return: the invite link, e.g.: https://i.delta.chat
+    """
+    return account.get_setup_contact_qr()
+
+
 def start_chat(
     ac: deltachat.Account,
     command: deltachat.Message,

tests/conftest.py

@@ -80,7 +80,7 @@ def tmp_file_path(request, tmpdir):
 
 
 @pytest.fixture
-def relaycrew(crew):
+def relaycrew(crew) -> deltachat.Chat:
     crew.bot.relayplugin = RelayPlugin(crew.bot, crew.kvstore)
     crew.bot.add_account_plugin(crew.bot.relayplugin)
     assert not crew.bot.relayplugin.is_relay_group(crew)
@@ -88,7 +88,7 @@ def relaycrew(crew):
 
 
 @pytest.fixture
-def crew(team_bot, team_user, tmpdir):
+def crew(team_bot, team_user, tmpdir) -> deltachat.Chat:
     from team_bot.bot import SetupPlugin
 
     crew = team_bot.create_group_chat(
@@ -104,12 +104,8 @@ def crew(team_bot, team_user, tmpdir):
     crew.bot.setupplugin = setupplugin
 
     # wait until old user is properly added to crew
-    last_message = team_user.wait_next_incoming_message().text
-    while (
-        f"Member Me ({team_user.get_config('addr')}) added by bot" not in last_message
-    ):
-        print("User received message:", last_message)
-        last_message = team_user.wait_next_incoming_message().text
+    team_user._evtracker.wait_securejoin_joiner_progress(1000)
+    team_user._evtracker.wait_next_incoming_message()  # member added message
 
     crew.kvstore = pickledb.load(tmpdir + "pickle.db", True)
     crew.kvstore.set("crew_id", crew.id)
@@ -117,7 +113,7 @@ def crew(team_bot, team_user, tmpdir):
 
 
 @pytest.fixture
-def team_bot(tmpdir):
+def team_bot(tmpdir) -> deltachat.Account:
     ac = account(tmpdir + "/bot.sqlite", show_ffi=True)
     yield ac
     ac.shutdown()
@@ -125,7 +121,7 @@ def team_bot(tmpdir):
 
 
 @pytest.fixture
-def team_user(tmpdir):
+def team_user(tmpdir) -> deltachat.Account:
     ac = account(tmpdir + "/user.sqlite")
     yield ac
     ac.shutdown()
@@ -133,19 +129,20 @@ def team_user(tmpdir):
 
 
 @pytest.fixture
-def outsider(tmpdir):
+def outsider(tmpdir) -> deltachat.Account:
     ac = account(tmpdir + "/outsider.sqlite")
     yield ac
     ac.shutdown()
     ac.wait_shutdown()
 
 
-def account(db_path, show_ffi=False):
+def account(db_path, show_ffi=False) -> deltachat.Account:
     token = os.environ.get(
         "DCC_NEW_TMP_EMAIL", "https://nine.testrun.org/cgi-bin/newemail.py"
     )
     print(token)
     ac = deltachat.Account(str(db_path))
+    ac._evtracker = ac.add_account_plugin(deltachat.events.FFIEventTracker(ac))
     credentials = requests.post(token).json()
     email = credentials["email"]
     password = credentials["password"]

tests/test_bot.py

@@ -9,43 +9,60 @@ from deltachat.capi import lib as dclib
 TIMEOUT = 20
 
 
-@pytest.mark.timeout(60)
-def test_not_relay_groups(relaycrew, outsider):
+def get_user_crew(crewuser: deltachat.Account) -> deltachat.Chat:
+    """Get the Team chat from the team member's point of view.
+
+    :param crewuser: the account object of the team member
+    :return: the chat object of the team chat
+    """
+    for chat in crewuser.get_chats():
+        print(chat.id, chat.get_name())
+    user_crew = crewuser.get_chat_by_id(11)
+    assert user_crew.get_name().startswith("Team")
+    return user_crew
+
+
+@pytest.mark.timeout(TIMEOUT)
+def test_not_relay_groups(relaycrew, outsider, lp):
     bot = relaycrew.bot
     user = relaycrew.user
 
-    # bot <-> outsider 1:1 chat
+    lp.sec("bot <-> outsider 1:1 chat")
     outsider_botcontact = outsider.create_contact(bot.get_config("addr"))
     outsider_outside_chat = outsider.create_chat(outsider_botcontact)
     outsider_outside_chat.send_text("test 1:1 message to bot")
 
-    bot_message_from_outsider = bot.wait_next_incoming_message()
+    bot_message_from_outsider = bot._evtracker.wait_next_incoming_message()
     bot_outside_chat = bot_message_from_outsider.chat
     assert not bot.relayplugin.is_relay_group(bot_outside_chat)
 
-    # bot <-> outsider group chat
+    lp.sec("bot <-> outsider group chat")
     outsider_bot_group = outsider.create_group_chat(
         "test with outsider", contacts=[outsider_botcontact]
     )
     outsider_bot_group.send_text("test message to outsider group")
-    bot_message_from_outsider = bot.wait_next_incoming_message()
+    bot_message_from_outsider = bot._evtracker.wait_next_incoming_message()
     assert not bot.relayplugin.is_relay_group(bot_message_from_outsider.chat)
 
-    # bot <-> user 1:1 chat
+    lp.sec("bot <-> user 1:1 chat")
     user_botcontact = user.create_contact(bot.get_config("addr"))
     user_to_bot = user.create_chat(user_botcontact)
     user_to_bot.send_text("test message to bot")
-    bot_message_from_user = bot.wait_next_incoming_message()
+    # somehow the message doesn't trigger DC_EVENT_INCOMING_MSG
+    bot_message_from_user = bot.get_chats()[-3].get_messages()[-1]  # bot._evtracker.wait_next_incoming_message()
+    while bot_message_from_user.text != "test message to bot":
+        bot_message_from_user = bot.get_chats()[-3].get_messages()[-1]  # bot._evtracker.wait_next_incoming_message()
+        time.sleep(1)
     assert not bot.relayplugin.is_relay_group(bot_message_from_user.chat)
 
-    # bot <-> user group chat
+    lp.sec("bot <-> user group chat")
     user_group = user.create_group_chat("test with user", contacts=[user_botcontact])
     user_group.send_text("testing message to user group")
-    bot_message_from_user = bot.wait_next_incoming_message()
+    bot_message_from_user = bot._evtracker.wait_next_incoming_message()
     assert not bot.relayplugin.is_relay_group(bot_message_from_user.chat)
 
 
-@pytest.mark.timeout(60)
+@pytest.mark.timeout(TIMEOUT)
 def test_relay_group_forwarding(relaycrew, outsider):
     bot = relaycrew.bot
     user = relaycrew.user
@@ -56,18 +73,17 @@ def test_relay_group_forwarding(relaycrew, outsider):
     outsider_outside_chat.send_text("test 1:1 message to bot")
 
     # get outside chat
-    message_from_outsider = bot.wait_next_incoming_message()
+    message_from_outsider = bot._evtracker.wait_next_incoming_message()
     bot_outside_chat = message_from_outsider.chat
     assert not bot.relayplugin.is_relay_group(bot_outside_chat)
 
     # get relay group
-    user.wait_next_incoming_message()  # group added message
-    user_forwarded_message_from_outsider = user.wait_next_incoming_message()
+    user_forwarded_message_from_outsider = user._evtracker.wait_next_incoming_message()
     user_relay_group = user_forwarded_message_from_outsider.create_chat()
     user_relay_group.send_text(
         "Chatter in relay group"
     )  # send normal reply, not forwarded
-    bot_chatter_in_relay_group = bot.wait_next_incoming_message()
+    bot_chatter_in_relay_group = bot._evtracker.wait_next_incoming_message()
     bot_relay_group = bot_chatter_in_relay_group.chat
 
     # check if relay group has relay group properties
@@ -91,7 +107,7 @@ def test_relay_group_forwarding(relaycrew, outsider):
     assert sent_id == user_direct_reply.id
 
     # check that direct reply was forwarded to outsider
-    outsider_direct_reply = outsider.wait_next_incoming_message()
+    outsider_direct_reply = outsider._evtracker.wait_next_incoming_message()
     assert outsider_direct_reply.text == "This should be forwarded to the outsider"
     assert outsider_direct_reply.chat == outsider_outside_chat
     assert outsider_direct_reply.get_sender_contact() == outsider_botcontact
@@ -105,7 +121,7 @@ def test_relay_group_forwarding(relaycrew, outsider):
     outsider_outside_chat.send_text("Second message by outsider")
 
     # check that outsider's reply ends up in the same chat
-    user_second_message_from_outsider = user.wait_next_incoming_message()
+    user_second_message_from_outsider = user._evtracker.wait_next_incoming_message()
     assert user_second_message_from_outsider.chat == user_relay_group
 
     # check that relay group explanation is not forwarded to outsider
@@ -114,6 +130,7 @@ def test_relay_group_forwarding(relaycrew, outsider):
             assert "This is the relay group for" not in msg.text
 
 
+@pytest.mark.timeout(TIMEOUT)
 def test_default_outside_help(relaycrew, outsider):
     bot = relaycrew.bot
     user = relaycrew.user
@@ -124,7 +141,7 @@ def test_default_outside_help(relaycrew, outsider):
     outsider_outside_chat.send_text("/help")
 
     # get response
-    outside_help_message = outsider.wait_next_incoming_message()
+    outside_help_message = outsider._evtracker.wait_next_incoming_message()
     assert "I forward messages to the " in outside_help_message.text
 
     # assert no relay group was created
@@ -132,6 +149,7 @@ def test_default_outside_help(relaycrew, outsider):
     assert len(user.get_chats()) == 1
 
 
+@pytest.mark.timeout(TIMEOUT)
 def test_empty_outside_help(relaycrew, outsider):
     bot = relaycrew.bot
     user = relaycrew.user
@@ -143,7 +161,7 @@ def test_empty_outside_help(relaycrew, outsider):
     assert user_crew.get_name().startswith("Team")
     user_crew.send_text("/set_outside_help")
     # ensure /set_outside_help arrives before sending /help
-    bot.wait_next_incoming_message()
+    bot._evtracker.wait_next_incoming_message()
 
     # create outside chat
     outsider_botcontact = outsider.create_contact(bot.get_config("addr"))
@@ -151,12 +169,13 @@ def test_empty_outside_help(relaycrew, outsider):
     outsider_outside_chat.send_text("/help")
 
     # get forwarded /help message
-    user.wait_next_incoming_message()  # group added message
-    user.wait_next_incoming_message()  # explanation message
-    user_forwarded_message_from_outsider = user.wait_next_incoming_message()
+    user._evtracker.wait_next_incoming_message()  # "Removed help message for outsiders"
+    user._evtracker.wait_next_incoming_message()  # explanation message
+    user_forwarded_message_from_outsider = user._evtracker.wait_next_incoming_message()
     assert user_forwarded_message_from_outsider.text == "/help"
 
 
+@pytest.mark.timeout(TIMEOUT)
 def test_changed_outside_help(relaycrew, outsider):
     bot = relaycrew.bot
     user = relaycrew.user
@@ -169,7 +188,7 @@ def test_changed_outside_help(relaycrew, outsider):
     outside_help_text = "Hi friend :) send me messages to chat with the team"
     user_crew.send_text("/set_outside_help " + outside_help_text)
     # ensure /set_outside_help arrives before sending /help
-    bot.wait_next_incoming_message()
+    bot._evtracker.wait_next_incoming_message()
 
     # create outside chat
     outsider_botcontact = outsider.create_contact(bot.get_config("addr"))
@@ -177,7 +196,7 @@ def test_changed_outside_help(relaycrew, outsider):
     outsider_outside_chat.send_text("/help")
 
     # get response
-    outside_help_message = outsider.wait_next_incoming_message()
+    outside_help_message = outsider._evtracker.wait_next_incoming_message()
     assert outside_help_message.text == outside_help_text
 
     # assert no relay group was created
@@ -185,6 +204,7 @@ def test_changed_outside_help(relaycrew, outsider):
     assert len(user.get_chats()) == 1
 
 
+@pytest.mark.timeout(TIMEOUT)
 def test_change_avatar(relaycrew):
     bot = relaycrew.bot
     user = relaycrew.user
@@ -202,25 +222,23 @@ def test_change_avatar(relaycrew):
         pytest.skip(f"example image not available: {example_png_path}")
 
     # set avatar to example image
-    for chat in user.get_chats():
-        print(chat.id, chat.get_name())
-    user_crew = user.get_chat_by_id(11)
-    assert user_crew.get_name().startswith("Team")
+    user_crew = get_user_crew(user)
     msg = deltachat.Message.new_empty(user, "image")
     msg.set_text("/set_avatar")
     msg.set_file(example_png_path)
     sent_id = dclib.dc_send_msg(user._dc_context, user_crew.id, msg._dc_msg)
     assert sent_id == msg.id
 
-    group_avatar_changed_msg = user.wait_next_incoming_message()
+    group_avatar_changed_msg = user._evtracker.wait_next_incoming_message()
     assert "Group image changed" in group_avatar_changed_msg.text
     assert user_crew.get_profile_image()
 
-    confirmation_msg = user.wait_next_incoming_message()
+    confirmation_msg = user._evtracker.wait_next_incoming_message()
     assert confirmation_msg.text == "Avatar changed to this image."
     assert botcontact.get_profile_image()
 
 
+@pytest.mark.timeout(TIMEOUT * 2)
 def test_forward_sending_errors_to_relay_group(relaycrew):
     usercrew = relaycrew.user.get_chats()[-1]
     usercrew.send_text("/start_chat alice@example.org This_Message_will_fail test")
@@ -237,7 +255,9 @@ def test_forward_sending_errors_to_relay_group(relaycrew):
 
     while len(relaycrew.user.get_chats()) < 2 and int(time.time()) < begin + TIMEOUT:
         time.sleep(0.1)
-    relay_group = relaycrew.user.get_chats()[-2]
+    for chat in relaycrew.user.get_chats():
+        if "This Message will fail" in chat.get_name():
+            relay_group = chat
 
     while len(relay_group.get_messages()) < 3 and int(time.time()) < begin + TIMEOUT:
         print(relay_group.get_messages()[-1].text)
@@ -250,3 +270,21 @@ def test_forward_sending_errors_to_relay_group(relaycrew):
         "Invalid unencrypted mail to <alice@example.org>"
         in relay_group.get_messages()[-1].text
     )
+
+
+@pytest.mark.timeout(TIMEOUT)
+def test_public_invite(relaycrew, outsider):
+    crew = get_user_crew(relaycrew.user)
+    crew.send_text("/generate-invite")
+    result = relaycrew.user._evtracker.wait_next_incoming_message()
+    # assert result.filename
+    # assert result.text.startswith("https://i.delta.chat")
+
+    # qr = result.filename
+    # invite = "OPENPGP4FPR:" + result.text[22::]
+    chat = outsider.qr_setup_contact(result.text)
+    outsider._evtracker.wait_securejoin_joiner_progress(1000)
+
+    while not chat.is_protected():
+        print(chat.get_messages()[-1].text)
+        time.sleep(1)