WIP: move to the maubot plugin framework

[L0ric0]

Implemented Features:

• ipv4 and ipv6
• secret string check
• Content-Type check
• room membership check
• useable as webhook reciver
  • Push Hook
  • Tag Push Hook
  • Issue Hook
  • Note Hook
  • Merge Request Hook
  • Wiki Page Hook
  • Pipeline Hook
  • Job Hook
• commands
  • alias
    • add
    • list
    • rm
  • diff
  • issue
    • close
    • comment
    • comments
    • create
    • read
    • reopen
  • log
  • ping
  • server
    • default
    • list
    • login
    • logout
  • show
  • whoami

needs maubot/maubot#72

Fixes #26
Fixes #25
Fixes #17
Fixes #14
Fixes #11
Fixes #10
Fixes #9
Fixes #1

[tulir]

If there isn't any special requirement for a separate web server, it should probably default to using the main maubot server.

[L0ric0]

should i add the option to use a custom webserver if a port is specified in the config?

[tulir]

It's probably not needed, but I guess it can be an option if you want to add it

[tulir]

This stuff seems the exact use case for attrs (already a dependency) along with mautrix-python's SerializableAttrs. I think filter.py is a fairly good simple example on how that works.

Basically, you just make a @dataclass (from attr import dataclass) that also extends SerializableAttrs['YourClassName'] (I'm not sure if ['YourClassName'] could be omitted, type hints are complicated). After that, you simply define the fields as class properties with type hints and use YourClassName.deserialize(data_dict) and data_dict = your_class_instance.serialize().

It's also fine if that's too complicated/not documented enough, I can change this to use that later myself.

[L0ric0]

Is it possible to define a conversion funktion for the attrs?

I would like to convert the timestamps into datetime objects

[tulir]

yeah, you just need to define a type hint (e.g. just set it to datetime.datetime) and then add a serializer and deserializer for that type, something like this:

from datetime import datetime
from attr import dataclass
from mautrix.types import JSON, SerializableAttrs, serializer, deserializer

@serializer(datetime)
def datetime_serialize(dt: datetime) -> JSON:
    return int(dt.timestamp())

@deserializer(datetime)
def datetime_deserialize(data: JSON) -> datetime:
    return datetime.fromtimestamp(data)

@dataclass
class YourData(SerializableAttrs['YourData']):
    ...
    ts: datetime
    ...

[L0ric0]

it should work with now. I am thinking about adding types for urls and so on so that one doesn't have str everywhere but that could be overkill

[tulir]

I think the deserializer currently doesn't support arbitrary unions, only Union[type, None] (aka Optional[type]). I could probably make it support arbitrary unions though if gitlab really sends different types.

[L0ric0]

yes gitlab sends different types and is inconsistent everywhere. at the moment it doesn't brake anything as it seems to be parsed as a mautrix.client.api.types.util.obj.Obj (for a label change that is) but it would probably be nice to have the possibility of parsing Unions

[L0ric0]

@tulir I have a problem with the database integration.

basically i want to add multi-server support and implement a default server, so that you don't have to specify a server every time. I want to implement it as another table (default) which has the mxid as a primary key and the server_name as a forigen key (both from the token table). my problem is that sqlalchemy always throws an error that it can't find a primary join condition and I am unable to find a solution.

Can you help me with that?

[L0ric0]

the bot should now have the same functionality as the old one written in go

@tulir can you review the new code?

[L0ric0]

ping @tulir