lavina/crates
Nikita Vilunov ff806cc3d9 xmpp: split off stanza and update handling into modules (#27)
Reviewed-on: lavina/lavina#27
2023-10-13 20:09:08 +00:00
..
lavina-core add author id in messages schema 2023-10-04 18:32:08 +02:00
mgmt-api add management API endpoints 2023-09-24 22:59:34 +02:00
projection-irc irc: improve integration test 2023-10-13 16:30:31 +02:00
projection-xmpp xmpp: split off stanza and update handling into modules (#27) 2023-10-13 20:09:08 +00:00
proto-irc sanitize IRC parsing (#23) 2023-10-04 18:27:43 +00:00
proto-xmpp xmpp: logopass auth (#19) 2023-10-08 13:53:39 +00:00
readme.md update docs 2023-10-10 02:30:50 +02:00

readme.md

Dependency diagram of the project

graph TD;
    lavina-->mgmt-api;
    lavina-->projection-irc;
    lavina-->projection-xmpp;
    lavina-->lavina-core;

    projection-irc-->proto-irc;
    projection-irc-->lavina-core;
    
    projection-xmpp-->proto-xmpp;
    projection-xmpp-->lavina-core;

    sim-irc-->proto-irc;
    sim-irc-->mgmt-api;

    sim-xmpp-->proto-xmpp;
    sim-xmpp-->mgmt-api;

    workspace-->lavina;
    workspace-->sim-irc;
    workspace-->sim-xmpp;

A few rules:

  • Only projections should be direct deps of lavina, there is no need to depend on proto-* crates.
  • On the other hand, projections should not be dependencies of sim-* crates.
  • lavina-core does not depend on protocol-specific crates.

Lavina

lavina-core. This crate implements the core functionality of the server not specific to public interfaces. It includes handling general persistence, message casts, in future room authorization and cross-node communication.

lavina. The application crate. It's used to link other crates together and build the final binary with support for all protocols.

mgmt-api. Model definitions for management API to be used both in the server and client implementations.

IRC

proto-irc. Protocol definition for IRC, includes both server-side and client-side messages and both serialization and deserialization where needed.

projection-irc. Projection of lavina-core onto the IRC client-to-server protocol implementation.

sim-irc. Future implementation of IRC client simulator to be used in integration and load testing.