This Week in Ruma
› published on byFrom the editor
Lots of progress this week!
As expected, I finished the /login endpoint, so I can now move on to the real stuff: rooms and the event stream.
This week also saw two nice milestones:
Ruma's first pull request was merged, and I successfully registered an account with a locally running Ruma server via a locally running Vector client.
(The latter also uncovered an undocumented API that Vector was attempting to use which I've brought up with the Matrix team.)
Before taking the plunge into rooms and events, I'm taking some time to think and plan about how to structure the data, and have been talking with the Matrix team about how Synapse handles things, lessons learned, and the trade offs of different approaches. A few months ago, Erik Johnston of the core team wrote up some notes on data storage in Matrix which has been very useful in this planning stage. It's a great read if you're interested in some of the tricky issues in Matrix development.
There was also a little discussion on how difficult it is to represent certain JSON structures in the API as Rust types. There are several data structures in the API that are effectively enums, but can't be automatically deserialized by Serde because of two things: how Serde currently handles enums and the fact that variants can only be determined by examining the values of some of their fields. The latter currently requires manual implementation of deserialization, which gets cumbersome very quickly. The way I'm probably going to address this is to deserialize these types of data structures to an intermediate type so simple deserialization from JSON can be separated from higher level detection and validation logic. To that end, I built the validations library, which provides both an interface for validating a type, and types for representing validation errors.
Notable changes to ruma
- Finished a simple working version of the
/loginAPI endpoint. - Added CORS support to all endpoints.
- Reexported the Iron handlers for API endpoints from their parent module to make imports a little less verbose.
- Renamed the
FinalConfigtype toConfig, and the previously namedConfigto the now privateRawConfigtype. - Revised the README with full documentation of the configuration file's format along with some other improvements.