Bump version: 1.9.5 → 1.9.6

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.9.4
+current_version = 1.9.6
 commit = True
 tag = True
 

fbchat/__init__.py

@@ -13,7 +13,7 @@ from ._client import Client
 from ._util import log  # TODO: Remove this (from examples too)
 
 __title__ = "fbchat"
-__version__ = "1.9.4"
+__version__ = "1.9.6"
 __description__ = "Facebook Chat (Messenger) for Python"
 
 __copyright__ = "Copyright 2015 - 2019 by Taehoon Kim"

fbchat/_client.py

@@ -2271,6 +2271,16 @@ class Client(object):
         elif delta_class == "ForcedFetch":
             mid = delta.get("messageId")
             if mid is None:
+                if delta["threadKey"] is not None:
+                    # Looks like the whole delta is metadata in this case
+                    thread_id, thread_type = getThreadIdAndThreadType(delta)
+                    self.onPendingMessage(
+                        thread_id=thread_id,
+                        thread_type=thread_type,
+                        metadata=delta,
+                        msg=delta,
+                    )
+                else:
                     self.onUnknownMesssageType(msg=delta)
             else:
                 thread_id = str(delta["threadKey"]["threadFbId"])
@@ -2727,6 +2737,14 @@ class Client(object):
                 msg=delta,
             )
 
+        # New pending message
+        elif delta_class == "ThreadFolder" and delta.get("folder") == "FOLDER_PENDING":
+            # Looks like the whole delta is metadata in this case
+            thread_id, thread_type = getThreadIdAndThreadType(delta)
+            self.onPendingMessage(
+                thread_id=thread_id, thread_type=thread_type, metadata=delta, msg=delta
+            )
+
         # Unknown message type
         else:
             self.onUnknownMesssageType(msg=delta)
@@ -2949,6 +2967,21 @@ class Client(object):
         """
         log.info("{} from {} in {}".format(message_object, thread_id, thread_type.name))
 
+    def onPendingMessage(
+        self, thread_id=None, thread_type=None, metadata=None, msg=None
+    ):
+        """Called when the client is listening, and somebody that isn't
+         connected with you on either Facebook or Messenger sends a message.
+         After that, you need to use fetchThreadList to actually read the message.
+
+         Args:
+            thread_id: Thread ID that the message was sent to. See :ref:`intro_threads`
+            thread_type (ThreadType): Type of thread that the message was sent to. See :ref:`intro_threads`
+            metadata: Extra metadata about the message
+            msg: A full set of the data received
+        """
+        log.info("New pending message from {}".format(thread_id))
+
     def onColorChange(
         self,
         mid=None,

fbchat/_mqtt.py

@@ -79,6 +79,8 @@ class Mqtt(object):
             log.exception("Failed parsing MQTT data on %s as JSON", message.topic)
             return
 
+        log.debug("MQTT payload: %s, %s", message.topic, j)
+
         if message.topic == "/t_ms":
             # Update sync_token when received
             # This is received in the first message after we've created a messenger
@@ -86,18 +88,31 @@ class Mqtt(object):
             if "syncToken" in j and "firstDeltaSeqId" in j:
                 self._sync_token = j["syncToken"]
                 self._sequence_id = j["firstDeltaSeqId"]
+                return
 
             # Update last sequence id when received
             if "lastIssuedSeqId" in j:
                 self._sequence_id = j["lastIssuedSeqId"]
 
             if "errorCode" in j:
-                # Known types: ERROR_QUEUE_OVERFLOW | ERROR_QUEUE_NOT_FOUND
+                error = j["errorCode"]
-                # 'F\xfa\x84\x8c\x85\xf8\xbc-\x88 FB_PAGES_INSUFFICIENT_PERMISSION\x00'
+                # TODO: 'F\xfa\x84\x8c\x85\xf8\xbc-\x88 FB_PAGES_INSUFFICIENT_PERMISSION\x00'
-                log.error("MQTT error code %s received", j["errorCode"])
+                if error in ("ERROR_QUEUE_NOT_FOUND", "ERROR_QUEUE_OVERFLOW"):
-                # TODO: Consider resetting the sync_token and sequence ID here?
+                    # ERROR_QUEUE_NOT_FOUND means that the queue was deleted, since too
-
+                    # much time passed, or that it was simply missing
-        log.debug("MQTT payload: %s, %s", message.topic, j)
+                    # ERROR_QUEUE_OVERFLOW means that the sequence id was too small, so
+                    # the desired events could not be retrieved
+                    log.error(
+                        "The MQTT listener was disconnected for too long,"
+                        " events may have been lost"
+                    )
+                    self._sync_token = None
+                    self._sequence_id = self._fetch_sequence_id(self._state)
+                    self._messenger_queue_publish()
+                    # TODO: Signal to the user that they should reload their data!
+                    return
+                log.error("MQTT error code %s received", error)
+                return
 
         # Call the external callback
         self._on_message(message.topic, j)
@@ -129,6 +144,9 @@ class Mqtt(object):
         if rc != 0:
             return  # Don't try to send publish if the connection failed
 
+        self._messenger_queue_publish()
+
+    def _messenger_queue_publish(self):
         # configure receiving messages.
         payload = {
             "sync_api_version": 10,
@@ -171,6 +189,10 @@ class Mqtt(object):
             "/br_sr",
             # Response to /br_sr
             "/sr_res",
+            # Data about user-to-user calls
+            # TODO: Investigate the response from this! (A bunch of binary data)
+            # "/t_rtc",
+            # TODO: Find out what this does!
             # TODO: Investigate the response from this! (A bunch of binary data)
             # "/t_p",
             # TODO: Find out what this does!
@@ -186,7 +208,6 @@ class Mqtt(object):
             "/messaging_events",
             "/orca_message_notifications",
             "/pp",
-            "/t_rtc",
             "/webrtc_response",
         ]