plugins tickets, merge-requests: ticketsGet and mergeRequestsGet serialisation:

those methods now return data serialised with `data_format.serialise`
This commit is contained in:
Goffi 2020-07-16 09:07:26 +02:00
commit 95096df52f
5 changed files with 71 additions and 57 deletions

View file

@ -1,6 +1,5 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
# SAT plugin for Pubsub Schemas # SAT plugin for Pubsub Schemas
# Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.org) # Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.org)
@ -535,6 +534,7 @@ class PubsubSchema(object):
filters=filters, filters=filters,
) )
d.addCallback(self._p.transItemsData) d.addCallback(self._p.transItemsData)
d.addCallback(lambda data: data_format.serialise(data))
return d return d
def prepareBridgeSet(self, service, node, schema, item_id, extra, profile_key): def prepareBridgeSet(self, service, node, schema, item_id, extra, profile_key):
@ -601,7 +601,7 @@ class PubsubSchema(object):
client, service, node, schema, item_id, extra = self.prepareBridgeSet( client, service, node, schema, item_id, extra = self.prepareBridgeSet(
service, node, schema, item_id, extra service, node, schema, item_id, extra
) )
d = self.set( d = defer.ensureDeferred(self.set(
client, client,
service, service,
node, node,
@ -613,12 +613,12 @@ class PubsubSchema(object):
form_ns=form_ns, form_ns=form_ns,
default_node=default_node, default_node=default_node,
fill_author=fill_author, fill_author=fill_author,
) ))
d.addCallback(lambda ret: ret or "") d.addCallback(lambda ret: ret or "")
return d return d
@defer.inlineCallbacks async def set(
def set(self, client, service, node, values, schema, item_id, extra, deserialise, self, client, service, node, values, schema, item_id, extra, deserialise,
form_ns, default_node=None, fill_author=True): form_ns, default_node=None, fill_author=True):
"""Set an item in a node with a schema """Set an item in a node with a schema
@ -651,19 +651,19 @@ class PubsubSchema(object):
raise exceptions.DataError( raise exceptions.DataError(
_('if extra["update"] is set, item_id must be set too') _('if extra["update"] is set, item_id must be set too')
) )
yield self.copyMissingValues(client, service, node, item_id, form_ns, values) await self.copyMissingValues(client, service, node, item_id, form_ns, values)
values["updated"] = now values["updated"] = now
if fill_author: if fill_author:
if not values.get("author"): if not values.get("author"):
id_data = yield self._i.getIdentity(client, None, ["nicknames"]) id_data = await self._i.getIdentity(client, None, ["nicknames"])
values["author"] = id_data['nicknames'][0] values["author"] = id_data['nicknames'][0]
if not values.get("author_jid"): if not values.get("author_jid"):
values["author_jid"] = client.jid.full() values["author_jid"] = client.jid.full()
item_id = yield self.sendDataFormItem( item_id = await self.sendDataFormItem(
client, service, node, values, schema, item_id, extra, deserialise client, service, node, values, schema, item_id, extra, deserialise
) )
defer.returnValue(item_id) return item_id
@implementer(iwokkel.IDisco) @implementer(iwokkel.IDisco)

View file

@ -17,14 +17,16 @@
# You should have received a copy of the GNU Affero General Public License # You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
from collections import namedtuple
from twisted.internet import defer
from twisted.words.protocols.jabber import jid
from sat.core.i18n import _ from sat.core.i18n import _
from sat.core.constants import Const as C from sat.core.constants import Const as C
from sat.core import exceptions from sat.core import exceptions
from twisted.internet import defer from sat.tools.common import data_format
from twisted.words.protocols.jabber import jid
from collections import namedtuple
from sat.core.log import getLogger from sat.core.log import getLogger
log = getLogger(__name__) log = getLogger(__name__)
NS_MERGE_REQUESTS = 'org.salut-a-toi.merge_requests:0' NS_MERGE_REQUESTS = 'org.salut-a-toi.merge_requests:0'
@ -74,7 +76,7 @@ class MergeRequests(object):
self._handlers_list = [] # handlers sorted by priority self._handlers_list = [] # handlers sorted by priority
self._type_handlers = {} # data type => handler map self._type_handlers = {} # data type => handler map
host.bridge.addMethod("mergeRequestsGet", ".plugin", host.bridge.addMethod("mergeRequestsGet", ".plugin",
in_sign='ssiassa{ss}s', out_sign='(asa{ss}aaa{ss})', in_sign='ssiassa{ss}s', out_sign='s',
method=self._get, method=self._get,
async_=True async_=True
) )
@ -136,6 +138,15 @@ class MergeRequests(object):
continue continue
self._type_handlers[data_type] = self._handlers[name] self._type_handlers[data_type] = self._handlers[name]
def serialise(self, get_data):
tickets_xmlui, metadata, items_patches = get_data
tickets_xmlui_s, metadata = self._p.transItemsData((tickets_xmlui, metadata))
return data_format.serialise({
"items": tickets_xmlui_s,
"metadata": metadata,
"items_patches": items_patches,
})
def _get(self, service='', node='', max_items=10, item_ids=None, sub_id=None, def _get(self, service='', node='', max_items=10, item_ids=None, sub_id=None,
extra_dict=None, profile_key=C.PROF_KEY_NONE): extra_dict=None, profile_key=C.PROF_KEY_NONE):
if extra_dict and 'parse' in extra_dict: if extra_dict and 'parse' in extra_dict:
@ -144,10 +155,7 @@ class MergeRequests(object):
service, node, max_items, sub_id, extra_dict, profile_key) service, node, max_items, sub_id, extra_dict, profile_key)
d = self.get(client, service, node or None, max_items, item_ids, sub_id or None, d = self.get(client, service, node or None, max_items, item_ids, sub_id or None,
extra.rsm_request, extra.extra) extra.rsm_request, extra.extra)
d.addCallback(lambda tickets_metadata_parsed_patches: ( d.addCallback(self.serialise)
self._p.transItemsData((tickets_metadata_parsed_patches[0], tickets_metadata_parsed_patches[1])) +
([[{key: str(value) for key, value in p.items()}
for p in patches] for patches in tickets_metadata_parsed_patches[2]],)))
return d return d
@defer.inlineCallbacks @defer.inlineCallbacks
@ -197,13 +205,16 @@ class MergeRequests(object):
extra="", profile_key=C.PROF_KEY_NONE): extra="", profile_key=C.PROF_KEY_NONE):
client, service, node, schema, item_id, extra = self._s.prepareBridgeSet( client, service, node, schema, item_id, extra = self._s.prepareBridgeSet(
service, node, schema, item_id, extra, profile_key) service, node, schema, item_id, extra, profile_key)
d = self.set(client, service, node, repository, method, values, schema, d = defer.ensureDeferred(
item_id or None, extra, deserialise=True) self.set(
client, service, node, repository, method, values, schema,
item_id or None, extra, deserialise=True
)
)
d.addCallback(lambda ret: ret or '') d.addCallback(lambda ret: ret or '')
return d return d
@defer.inlineCallbacks async def set(self, client, service, node, repository, method='auto', values=None,
def set(self, client, service, node, repository, method='auto', values=None,
schema=None, item_id=None, extra=None, deserialise=False): schema=None, item_id=None, extra=None, deserialise=False):
"""Publish a tickets """Publish a tickets
@ -234,7 +245,7 @@ class MergeRequests(object):
if method == 'auto': if method == 'auto':
for name in self._handlers_list: for name in self._handlers_list:
handler = self._handlers[name].handler handler = self._handlers[name].handler
can_handle = yield handler.check(repository) can_handle = await handler.check(repository)
if can_handle: if can_handle:
log.info(_("{name} handler will be used").format(name=name)) log.info(_("{name} handler will be used").format(name=name))
break break
@ -250,20 +261,20 @@ class MergeRequests(object):
except KeyError: except KeyError:
raise exceptions.NotFound(_("No handler of this name found")) raise exceptions.NotFound(_("No handler of this name found"))
data = yield handler.export(repository) data = await handler.export(repository)
if not data.strip(): if not data.strip():
raise exceptions.DataError(_('export data is empty, do you have any ' raise exceptions.DataError(_('export data is empty, do you have any '
'change to send?')) 'change to send?'))
if not values.get('title') or not values.get('body'): if not values.get('title') or not values.get('body'):
patches = yield handler.parse(data, values.get(FIELD_DATA_TYPE)) patches = await handler.parse(data, values.get(FIELD_DATA_TYPE))
commits_msg = patches[-1][self.META_COMMIT_MSG] commits_msg = patches[-1][self.META_COMMIT_MSG]
msg_lines = commits_msg.splitlines() msg_lines = commits_msg.splitlines()
if not values.get('title'): if not values.get('title'):
values['title'] = msg_lines[0] values['title'] = msg_lines[0]
if not values.get('body'): if not values.get('body'):
ts = self.host.plugins['TEXT_SYNTAXES'] ts = self.host.plugins['TEXT_SYNTAXES']
xhtml = yield ts.convert( xhtml = await ts.convert(
'\n'.join(msg_lines[1:]), '\n'.join(msg_lines[1:]),
syntax_from = ts.SYNTAX_TEXT, syntax_from = ts.SYNTAX_TEXT,
syntax_to = ts.SYNTAX_XHTML, syntax_to = ts.SYNTAX_XHTML,
@ -273,9 +284,9 @@ class MergeRequests(object):
values[FIELD_DATA] = data values[FIELD_DATA] = data
item_id = yield self._t.set(client, service, node, values, schema, item_id, extra, item_id = await self._t.set(client, service, node, values, schema, item_id, extra,
deserialise, form_ns=NS_MERGE_REQUESTS) deserialise, form_ns=NS_MERGE_REQUESTS)
defer.returnValue(item_id) return item_id
def _parseData(self, data_type, data): def _parseData(self, data_type, data):
d = self.parseData(data_type, data) d = self.parseData(data_type, data)

View file

@ -1,6 +1,5 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
# SAT plugin for Pubsub Schemas # SAT plugin for Pubsub Schemas
# Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.org) # Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.org)
@ -52,7 +51,7 @@ class Tickets(object):
"ticketsGet", "ticketsGet",
".plugin", ".plugin",
in_sign="ssiassa{ss}s", in_sign="ssiassa{ss}s",
out_sign="(asa{ss})", out_sign="s",
method=lambda service, node, max_items, items_ids, sub_id, extra, profile_key: method=lambda service, node, max_items, items_ids, sub_id, extra, profile_key:
self._s._get( self._s._get(
service, service,
@ -95,14 +94,13 @@ class Tickets(object):
client, service, node, schema, item_id, extra = self._s.prepareBridgeSet( client, service, node, schema, item_id, extra = self._s.prepareBridgeSet(
service, node, schema, item_id, extra, profile_key service, node, schema, item_id, extra, profile_key
) )
d = self.set( d = defer.ensureDeferred(self.set(
client, service, node, values, schema, item_id, extra, deserialise=True client, service, node, values, schema, item_id, extra, deserialise=True
) ))
d.addCallback(lambda ret: ret or "") d.addCallback(lambda ret: ret or "")
return d return d
@defer.inlineCallbacks async def set(self, client, service, node, values, schema=None, item_id=None, extra=None,
def set(self, client, service, node, values, schema=None, item_id=None, extra=None,
deserialise=False, form_ns=NS_TICKETS): deserialise=False, form_ns=NS_TICKETS):
"""Publish a tickets """Publish a tickets
@ -124,7 +122,7 @@ class Tickets(object):
node = NS_TICKETS node = NS_TICKETS
if not item_id: if not item_id:
comments_service = yield self._m.getCommentsService(client, service) comments_service = await self._m.getCommentsService(client, service)
# we need to use uuid for comments node, because we don't know item id in # we need to use uuid for comments node, because we don't know item id in
# advance (we don't want to set it ourselves to let the server choose, so we # advance (we don't want to set it ourselves to let the server choose, so we
@ -140,7 +138,7 @@ class Tickets(object):
self._p.OPT_SEND_ITEM_SUBSCRIBE: 1, self._p.OPT_SEND_ITEM_SUBSCRIBE: 1,
self._p.OPT_PUBLISH_MODEL: self._p.ACCESS_OPEN, self._p.OPT_PUBLISH_MODEL: self._p.ACCESS_OPEN,
} }
yield self._p.createNode(client, comments_service, comments_node, options) await self._p.createNode(client, comments_service, comments_node, options)
values["comments_uri"] = uri.buildXMPPUri( values["comments_uri"] = uri.buildXMPPUri(
"pubsub", "pubsub",
subtype="microblog", subtype="microblog",
@ -148,7 +146,6 @@ class Tickets(object):
node=comments_node, node=comments_node,
) )
item_id = yield self._s.set( return await self._s.set(
client, service, node, values, schema, item_id, extra, deserialise, form_ns client, service, node, values, schema, item_id, extra, deserialise, form_ns
) )
defer.returnValue(item_id)

View file

@ -129,14 +129,16 @@ class Get(base.CommandBase):
self, os.getcwd(), "merge requests", meta_map={}) self, os.getcwd(), "merge requests", meta_map={})
extra = {} extra = {}
try: try:
requests_data = await self.host.bridge.mergeRequestsGet( requests_data = data_format.deserialise(
self.args.service, await self.host.bridge.mergeRequestsGet(
self.args.node, self.args.service,
self.args.max, self.args.node,
self.args.items, self.args.max,
"", self.args.items,
extra, "",
self.profile, extra,
self.profile,
)
) )
except Exception as e: except Exception as e:
self.disp(f"can't get merge request: {e}", error=True) self.disp(f"can't get merge request: {e}", error=True)
@ -146,7 +148,7 @@ class Get(base.CommandBase):
whitelist = None whitelist = None
else: else:
whitelist = {"id", "title", "body"} whitelist = {"id", "title", "body"}
for request_xmlui in requests_data[0]: for request_xmlui in requests_data['items']:
xmlui = xmlui_manager.create(self.host, request_xmlui, whitelist=whitelist) xmlui = xmlui_manager.create(self.host, request_xmlui, whitelist=whitelist)
await xmlui.show(values_only=True) await xmlui.show(values_only=True)
self.disp("") self.disp("")

View file

@ -18,12 +18,13 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
from . import base
from sat.core.i18n import _
from sat_frontends.jp import common
from sat_frontends.jp.constants import Const as C
import json import json
import os import os
from sat.core.i18n import _
from sat.tools.common import data_format
from sat_frontends.jp import common
from sat_frontends.jp.constants import Const as C
from . import base
__commands__ = ["Ticket"] __commands__ = ["Ticket"]
@ -50,14 +51,17 @@ class Get(base.CommandBase):
async def start(self): async def start(self):
await common.fill_well_known_uri(self, os.getcwd(), "tickets", meta_map={}) await common.fill_well_known_uri(self, os.getcwd(), "tickets", meta_map={})
try: try:
tickets_data = await self.host.bridge.ticketsGet( tickets_data = data_format.deserialise(
self.args.service, await self.host.bridge.ticketsGet(
self.args.node, self.args.service,
self.args.max, self.args.node,
self.args.items, self.args.max,
"", self.args.items,
self.getPubsubExtra(), "",
self.profile, self.getPubsubExtra(),
self.profile,
),
type_check=list
) )
except Exception as e: except Exception as e:
self.disp(f"can't get tickets: {e}", error=True) self.disp(f"can't get tickets: {e}", error=True)