revoltchat / backend

Monorepo for Revolt backend services.

Revolt Backend

This is a monorepo for the Revolt backend.

Crate	Path	Description
core/config	crates/core/config	Core: Configuration
core/database	crates/core/database	Core: Database Implementation
core/models	crates/core/models	Core: API Models
core/permissions	crates/core/permissions	Core: Permission Logic
core/presence	crates/core/presence	Core: User Presence
core/result	crates/core/result	Core: Result and Error types
delta	crates/delta	REST API server
bonfire	crates/bonfire	WebSocket events server

Note: january, autumn, and vortex are yet to be moved into this monorepo.

Minimum Supported Rust Version

Rust 1.70 or higher.

Development Guide

Before getting started, you'll want to install:

• Rust toolchain (rustup recommended)
• Docker
• Git
• mold (optional, faster compilation)

A default.nix is available for Nix users! Just run nix-shell and continue.

Now you can clone and build the project:

git clone https://github.com/revoltchat/backend revolt-backend
cd revolt-backend
cargo build

If you want to run the API and event servers:

# create environment file (will be deprecated in future)
cp .env.example .env

# (optionally) copy the default configuration file
cp crates/core/config/Revolt.toml Revolt.toml
# configure as necessary...

You may want to copy the following configuration:

# Revolt.toml
[database]
mongodb = "mongodb://localhost"
redis = "redis://localhost"

[hosts]
app = "http://local.revolt.chat"
api = "http://local.revolt.chat:8000"
events = "ws://local.revolt.chat:9000"
autumn = "http://local.revolt.chat:3000"
january = "http://local.revolt.chat:7000"
voso_legacy = ""
voso_legacy_ws = ""

Then continue:

# start other necessary services
docker compose up -d

# run the API server
cargo run --bin revolt-delta
# run the events server
cargo run --bin revolt-bonfire

# hint:
# mold -run <cargo build, cargo run, etc...>

You can start a web client by doing the following:

# if you do not have yarn yet and have a modern Node.js:
corepack enable

# clone the web client and run it:
git clone --recursive https://github.com/revoltchat/revite
cd revite
yarn
yarn build:deps
yarn dev --port 3001

Then go to https://local.revolt.chat:3001

Deployment Guide

Cutting new crate releases

Begin by bumping crate versions:

just patch # 0.0.X
just minor # 0.X.0
just major # X.0.0

Then commit the changes to package files.

Proceed to publish all the new crates:

just publish

Cutting new binary releases

Tag and push a new release by running:

just release

If you have bumped the crate versions, proceed to GitHub releases to create a changelog.

Testing

First, start the required services:

docker compose -f docker-compose.db.yml up -d

Now run tests for whichever database:

TEST_DB=REFERENCE cargo nextest run
TEST_DB=MONGOBD cargo nextest run

License

The Revolt backend is generally licensed under the GNU Affero General Public License v3.0.

Individual crates may supply their own licenses!

backend's Issues

prehandle_hook should be called by pubsub on incoming notifications

We currently don't subscribe to new topics.
We could change how it works with #1

Generate `ServerCreate` event for user joining server.

Include the server object and any channels the user has access to.

Split the Manage Roles permission

The manage roles permission gives two different abilities to users, to assign and remove roles on other users and to create, edit and delete roles.
Having those two always come together is unnecessary and may cause issues in many situations.
That is why the permission would be best split into two.

Allow users to reconnect within x seconds.

To prevent users disappearing / appearing on members list, allow clients to reconnect within a set period of time and then send any buffered messages to them.

Add "nsfw" flags to both channels and servers.

Currently this is handled by the client for channels by checking channel name.

The field should only be serialised if true, something like so:

#[skip_serializing_if = "it is false", default = "false"]
pub nsfw: boolean

Note: Prevent Web Push notifications being generated for nsfw channels, or otherwise add a server flag for this.

Don't provide channels we can't "View".

They should not be included in the Ready payload to avoid issues.

Specify fields to receive from Ready payload.

Allow clients to not receive the entire object.

Message Reactions

Give users a way to react to messages with emojis.

Configurable max server / channel limit for users.

Track user presence across server nodes.

Currently the server uses is_online which only checks the local WebSocket connections.

Mention regex is not global

Server error when trying to access resource without auth headers

For example GET https://api.revolt.chat/users/relationships with no auth headers returns:

<!DOCTYPE html>
<html lang="en">

<head>
	<meta charset="utf-8">
	<title>500 Internal Server Error</title>
</head>

<body align="center">
	<div role="main" align="center">
		<h1>500: Internal Server Error</h1>
		<p>The server encountered an internal error while processing this request.</p>
		<hr />
	</div>
	<div role="contentinfo" align="center">
		<small>Rocket</small>
	</div>
</body>

</html>

This isn't specific to the listed endpoint and is happening to more endpoints (e.g. /users/:user or /channels/:channel)

Implement Ping / Pong.

Ping packets do not get a response right now.

E: Switch to WS spec ping packets.

Implement rate limits for more routes.

Rate limiting is now available, add it to the remaining routes.

Make color and colour consistent

It seems that most of the API uses colour but there's one color field in the Embed metadata which is a bit inconsistent.

Allow roles to be hoisted.

(WebSocket): Add invite create/delete events

Emojis

Add role ranking.

Return updated object on PATCH.

Right now we rely on the web socket to find out what attachment objects become and do guess work on the library's part in other cases.

This change requires changes to https://gitlab.insrt.uk/revolt/api

User's invisibility status is exposed

API reports a user's status as Invisible instead of reporting it as if the user was actually offline.

Use Redis as message broker.

Instead of using MongoDB to pass around events, instead use Redis's Pub/Sub.
If anyone has any alternatives to consider please list them below.

Update README to be consistent across all projects.

why i cant login in kor?

but i can login with jp vpn
why is this happening?

feat: report message + attachment.

Allow users to report a message or attachment.

Channel Webhooks

Add a way to send messages into channels using an unauthenticated (does not require session token) HTTP request (secret key in path).

Default channel and server notification options.

Allow users to customise whether server members get notifications in a server or channel.

Bug: PATCH /users/id

Bug in Websocket, Useless packets

Updating the user status causes to:

The above data from the websocket, UserUpdate

• Note: I've changed the user stutus only two times!

Use local-request state for guards.

This might not be necessary, but check whether we can optimise getting guards.

Respond to malformed WS packets.

Let clients know when they're sending bad data for better debugging.

Consider role ranking in permissions calculations.

Add a way to rank roles against each other.

Support msgpack for WebSocket notifications.

feat: 2fa totp login

authifier/authifier#20

Usernames aren't case-sensitive, can't change username to lowercase

Basically we should allow changing to the same nickname

feat: allow settings group icon and users when creating group

Allow users to select a group icon and users when creating a group.
Requires API work to support icons on creation.

Bot API

Specification is ready, now implementing.

Routes to implement:

• Create Bot
• Fetch Owned Bots
• Fetch Bot
• Edit Bot
• Delete Bot
• Fetch Public Bot
• Invite Public Bot

Add @everyone pings.

Give users the ability to mention all users in a server.
This will also require a separate permission for sending it.

Voice channels can be set as system message channels in server settings

Summary

Inside the "System Message Channels" section of server settings, you can set voice channels as a system message channel. Voice channels do not have text chats for system messages so they should not be listed.

Steps to Reproduce

1. Open the settings page for a server you have permissions to change settings of and that has at least 1 voice channel and text channel added to the server.
2. Scroll to the bottom of the "Overview" page to the section "System Message Channels"
3. Click on one of the drop-downs. Voice channels will be listed in them.

Potential Fixes

• Only list text channels in the "System Message Channels" drop-downs. Filter out voice channels.
• Add some form of system message support to voice channels that makes sense (Ex. text channels grouped with voice channels, voice notifications).

Screenshot

Unify server configuration in one place

Instead of relying on environment variables, configure Revolt nodes through the database.
We should also merge the file server configuration into the database and serve it to clients.

Include system message users when fetching messages.

This so we can avoid this problem:

Routes with no body should return 204 No Content.

Tracking issue for Revolt to update to rAuth v1.0

Allow users to prevent link embed by surrounding links with <>

Oops wrong place

Generate Web Push notifications on server.

Instead of sending the Message packet to clients, we should generate the Notification object clients display instead.

Note: We also need to handle mentions in servers!

Deprecate and remove "Fetch Relationship(s)" routes.

The following two routes should be deprecated:

• GET /users/relationships
• GET /users/:id/relationship

DMs open to non-friends option

Have an option in the setting for non-friends to open direct messages with you.
Some users might prefer to have clean friend lists while still talking with many users from their servers.
Possibly two levels, one for friends and people from your servers and another for anyone on the platform.

Users can't see their own beta badge.

Marking as high priority so people stop bugging me about it.

Unify `last_message` field to always be just an ID

See here for a bit of reasoning:
https://app.revolt.chat/server/01F7ZSBSFHQ8TA81725KQCSDDP/channel/01F8PZ2ZHPZFCHAEGQQWSMMF3N/01FDJVA29TSRY2NQD3R4D6FTXH

Optionally return user object from fetch member route.

Provide a query parameter such as include_user