erebion/libervia-backend
Watch
1
0
Fork
You've already forked libervia-backend
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

backend, frontend: messages refactoring (huge commit, not finished):

Browse source 
/!\ database schema has been modified, do a backup before updating

    message have been refactored, here are the main changes:

    - languages are now handled
    - all messages have an uid (internal to SàT)
    - message updating is anticipated
    - subject is now first class
    - new naming scheme is used newMessage => messageNew, getHistory => historyGet, sendMessage => messageSend
    - minimal compatibility refactoring in quick_frontend/Primitivus, better refactoring should follow
    - threads handling
    - delayed messages are saved into history
    - info messages may also be saved in history (e.g. to keep track of people joining/leaving a room)
    - duplicate messages should be avoided
    - historyGet return messages in right order, no need to sort again
    - plugins have been updated to follow new features, some of them need to be reworked (e.g. OTR)
    - XEP-0203 (Delayed Delivery) is now fully handled in core, the plugin just handle disco and creation of a delay element
    - /!\ jp and Libervia are currently broken, as some features of Primitivus

    It has been put in one huge commit to avoid breaking messaging between changes.
    This is the main part of message refactoring, other commits will follow to take profit of the new features/behaviour.
This commit is contained in:
Goffi 2016-05-24 22:11:04 +02:00
commit f12803fa65
5 changed files with 784 additions and 453 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/test/helpers.py
View file

@ -104,7 +104,7 @@ class FakeSAT(object):
def registerCallback(self, callback, *args, **kwargs):
pass
def sendMessage(self, to_s, msg, subject=None, mess_type='auto', extra={}, profile_key='@NONE@'):
def messageSend(self, to_s, msg, subject=None, mess_type='auto', extra={}, profile_key='@NONE@'):
self.sendAndStoreMessage({"to": JID(to_s)})
def _sendMessageToStream(self, mess_data, client):

2
src/test/test_core_xmpp.py
View file

@ -53,7 +53,7 @@ class SatMessageProtocolTest(unittest.TestCase):
</message>
"""
stanza = parseXml(xml)
self.host.bridge.expectCall("newMessage", u"sender@example.net/house", u"test", u"chat", u"test@example.org/SàT", {}, profile=Const.PROFILE[0])
self.host.bridge.expectCall("messageNew", u"sender@example.net/house", u"test", u"chat", u"test@example.org/SàT", {}, profile=Const.PROFILE[0])
self.message.onMessage(stanza)

19
src/test/test_plugin_xep_0033.py
View file

@ -27,7 +27,6 @@ from sat.core.exceptions import CancelError
from twisted.internet import defer
from wokkel.generic import parseXml
from twisted.words.protocols.jabber.jid import JID
from logging import ERROR
PROFILE_INDEX = 0
PROFILE = Const.PROFILE[PROFILE_INDEX]
@ -60,7 +59,7 @@ class XEP_0033Test(helpers.SatTestCase):
""" % (JID_STR_FROM, JID_STR_TO, JID_STR_X_TO, JID_STR_X_CC, JID_STR_X_BCC)
stanza = parseXml(xml.encode("utf-8"))
treatments = defer.Deferred()
self.plugin.messageReceivedTrigger(stanza, treatments, PROFILE)
self.plugin.messageReceivedTrigger(self.host.getClient(PROFILE), stanza, treatments)
data = {'extra': {}}
def cb(data):
@ -87,7 +86,7 @@ class XEP_0033Test(helpers.SatTestCase):
return mess_data
def _assertAddresses(self, mess_data):
"""The mess_data that we got here has been modified by self.plugin.sendMessageTrigger,
"""The mess_data that we got here has been modified by self.plugin.messageSendTrigger,
check that the addresses element has been added to the stanza."""
expected = self._get_mess_data()['xml']
addresses_extra = """
@ -135,28 +134,28 @@ class XEP_0033Test(helpers.SatTestCase):
return defer.DeferredList(d_list).addCallback(cb_list)
def _trigger(self, data):
"""Execute self.plugin.sendMessageTrigger with a different logging
"""Execute self.plugin.messageSendTrigger with a different logging
level to not pollute the output, then check that the plugin did its
job. It should abort sending the message or add the extended
addressing information to the stanza.
@param data: the data to be processed by self.plugin.sendMessageTrigger
@param data: the data to be processed by self.plugin.messageSendTrigger
"""
pre_treatments = defer.Deferred()
post_treatments = defer.Deferred()
helpers.muteLogging()
self.plugin.sendMessageTrigger(data, pre_treatments, post_treatments, PROFILE)
self.plugin.messageSendTrigger(self.host.getClient[PROFILE], data, pre_treatments, post_treatments)
post_treatments.callback(data)
helpers.unmuteLogging()
post_treatments.addCallbacks(self._assertAddresses, lambda failure: failure.trap(CancelError))
return post_treatments
def test_sendMessageTriggerFeatureNotSupported(self):
def test_messageSendTriggerFeatureNotSupported(self):
# feature is not supported, abort the message
self.host.memory.reinit()
data = self._get_mess_data()
return self._trigger(data)
def test_sendMessageTriggerFeatureSupported(self):
def test_messageSendTriggerFeatureSupported(self):
# feature is supported by the main target server
self.host.reinit()
self.host.addFeature(JID(JID_STR_TO), plugin.NS_ADDRESS, PROFILE)
@ -164,7 +163,7 @@ class XEP_0033Test(helpers.SatTestCase):
d = self._trigger(data)
return d.addCallback(lambda dummy: self._checkSentAndStored())
def test_sendMessageTriggerFeatureFullySupported(self):
def test_messageSendTriggerFeatureFullySupported(self):
# feature is supported by all target servers
self.host.reinit()
self.host.addFeature(JID(JID_STR_TO), plugin.NS_ADDRESS, PROFILE)
@ -174,7 +173,7 @@ class XEP_0033Test(helpers.SatTestCase):
d = self._trigger(data)
return d.addCallback(lambda dummy: self._checkSentAndStored())
def test_sendMessageTriggerFixWrongEntity(self):
def test_messageSendTriggerFixWrongEntity(self):
# check that a wrong recipient entity is fixed by the backend
self.host.reinit()
self.host.addFeature(JID(JID_STR_TO), plugin.NS_ADDRESS, PROFILE)

6
src/test/test_plugin_xep_0085.py
View file

@ -49,9 +49,9 @@ class XEP_0085Test(helpers.SatTestCase):
state, plugin.NS_CHAT_STATES)
stanza = parseXml(xml.encode("utf-8"))
self.host.bridge.expectCall("chatStateReceived", Const.JID_STR[1], state, Const.PROFILE[0])
self.plugin.messageReceivedTrigger(stanza, None, Const.PROFILE[0])
self.plugin.messageReceivedTrigger(self.host.getClient(Const.PROFILE[0]), stanza, None)
def test_sendMessageTrigger(self):
def test_messageSendTrigger(self):
def cb(data):
xml = data['xml'].toXml().encode("utf-8")
self.assertEqualXML(xml, expected.toXml().encode("utf-8"))
@ -73,7 +73,7 @@ class XEP_0085Test(helpers.SatTestCase):
expected = deepcopy(mess_data['xml'])
expected.addElement(state, plugin.NS_CHAT_STATES)
post_treatments = defer.Deferred()
self.plugin.sendMessageTrigger(mess_data, None, post_treatments, Const.PROFILE[0])
self.plugin.messageSendTrigger(self.host.getClient(Const.PROFILE[0]), mess_data, None, post_treatments)
post_treatments.addCallback(cb)
post_treatments.callback(mess_data)

6
src/test/test_plugin_xep_0334.py
View file

@ -36,7 +36,7 @@ class XEP_0334Test(helpers.SatTestCase):
self.host = helpers.FakeSAT()
self.plugin = XEP_0334(self.host)
def test_sendMessageTrigger(self):
def test_messageSendTrigger(self):
template_xml = """
<message
from='romeo@montague.net/orchard'
@ -59,7 +59,7 @@ class XEP_0334Test(helpers.SatTestCase):
'extra': {key: True}
}
treatments = defer.Deferred()
self.plugin.sendMessageTrigger(mess_data, defer.Deferred(), treatments, C.PROFILE[0])
self.plugin.messageSendTrigger(self.host.getClient(C.PROFILE[0]), mess_data, defer.Deferred(), treatments)
if treatments.callbacks: # the trigger added a callback
expected_xml = template_xml % ('<%s xmlns="urn:xmpp:hints"/>' % key)
treatments.addCallback(cb, expected_xml)
@ -90,7 +90,7 @@ class XEP_0334Test(helpers.SatTestCase):
for key in (HINTS + ('dummy_hint',)):
message = parseXml(template_xml % ('<%s xmlns="urn:xmpp:hints"/>' % key))
post_treat = defer.Deferred()
self.plugin.messageReceivedTrigger(message, post_treat, C.PROFILE[0])
self.plugin.messageReceivedTrigger(self.host.getClient(C.PROFILE[0]), message, post_treat)
if post_treat.callbacks:
assert(key in ('no-permanent-storage', 'no-storage'))
post_treat.addCallbacks(cb, eb)