continuwuity/src/admin/query/sending.rs
Jade Ellis d98ce2c7b9
feat: Generate admin command documentation
The first part of getting admin command docs on the website.

There's also the beginnings of manpage generation here, although it's
kinda sus and I'm not sure how it's supposed to work. I'll leave that to
anyone who wants to package it.

We introduce the beginings of the xtask pattern here - we do a lot of
file generation, I thought it would be best to avoid doing that on every
compilation. It also helps avoid lots of runtime deps.

We'll need to document generating this stuff & probably add pre-commit
hooks for it, though.
2025-07-06 22:58:00 +01:00

236 lines
6.5 KiB
Rust

use clap::Subcommand;
use conduwuit::{Err, Result};
use futures::StreamExt;
use ruma::{OwnedServerName, OwnedUserId};
use service::sending::Destination;
use crate::Context;
#[derive(Debug, Subcommand)]
/// All the getters and iterators from src/database/key_value/sending.rs
pub enum SendingCommand {
/// - Queries database for all `servercurrentevent_data`
ActiveRequests,
/// - Queries database for `servercurrentevent_data` but for a specific
/// destination
///
/// This command takes only *one* format of these arguments:
///
/// appservice_id
/// server_name
/// user_id AND push_key
///
/// See src/service/sending/mod.rs for the definition of the `Destination`
/// enum
ActiveRequestsFor {
#[arg(short, long)]
appservice_id: Option<String>,
#[arg(short, long)]
server_name: Option<OwnedServerName>,
#[arg(short, long)]
user_id: Option<OwnedUserId>,
#[arg(short, long)]
push_key: Option<String>,
},
/// - Queries database for `servernameevent_data` which are the queued up
/// requests that will eventually be sent
///
/// This command takes only *one* format of these arguments:
///
/// appservice_id
/// server_name
/// user_id AND push_key
///
/// See src/service/sending/mod.rs for the definition of the `Destination`
/// enum
QueuedRequests {
#[arg(short, long)]
appservice_id: Option<String>,
#[arg(short, long)]
server_name: Option<OwnedServerName>,
#[arg(short, long)]
user_id: Option<OwnedUserId>,
#[arg(short, long)]
push_key: Option<String>,
},
GetLatestEduCount {
server_name: OwnedServerName,
},
}
/// All the getters and iterators in key_value/sending.rs
pub(super) async fn process(subcommand: SendingCommand, context: &Context<'_>) -> Result {
let services = context.services;
match subcommand {
| SendingCommand::ActiveRequests => {
let timer = tokio::time::Instant::now();
let results = services.sending.db.active_requests();
let active_requests = results.collect::<Vec<_>>().await;
let query_time = timer.elapsed();
context
.write_str(&format!(
"Query completed in {query_time:?}:\n\n```rs\n{active_requests:#?}\n```"
))
.await
},
| SendingCommand::QueuedRequests {
appservice_id,
server_name,
user_id,
push_key,
} => {
if appservice_id.is_none()
&& server_name.is_none()
&& user_id.is_none()
&& push_key.is_none()
{
return Err!(
"An appservice ID, server name, or a user ID with push key must be \
specified via arguments. See --help for more details.",
);
}
let timer = tokio::time::Instant::now();
let results = match (appservice_id, server_name, user_id, push_key) {
| (Some(appservice_id), None, None, None) => {
if appservice_id.is_empty() {
return Err!(
"An appservice ID, server name, or a user ID with push key must be \
specified via arguments. See --help for more details.",
);
}
services
.sending
.db
.queued_requests(&Destination::Appservice(appservice_id))
},
| (None, Some(server_name), None, None) => services
.sending
.db
.queued_requests(&Destination::Federation(server_name)),
| (None, None, Some(user_id), Some(push_key)) => {
if push_key.is_empty() {
return Err!(
"An appservice ID, server name, or a user ID with push key must be \
specified via arguments. See --help for more details.",
);
}
services
.sending
.db
.queued_requests(&Destination::Push(user_id, push_key))
},
| (Some(_), Some(_), Some(_), Some(_)) => {
return Err!(
"An appservice ID, server name, or a user ID with push key must be \
specified via arguments. Not all of them See --help for more details.",
);
},
| _ => {
return Err!(
"An appservice ID, server name, or a user ID with push key must be \
specified via arguments. See --help for more details.",
);
},
};
let queued_requests = results.collect::<Vec<_>>().await;
let query_time = timer.elapsed();
context
.write_str(&format!(
"Query completed in {query_time:?}:\n\n```rs\n{queued_requests:#?}\n```"
))
.await
},
| SendingCommand::ActiveRequestsFor {
appservice_id,
server_name,
user_id,
push_key,
} => {
if appservice_id.is_none()
&& server_name.is_none()
&& user_id.is_none()
&& push_key.is_none()
{
return Err!(
"An appservice ID, server name, or a user ID with push key must be \
specified via arguments. See --help for more details.",
);
}
let timer = tokio::time::Instant::now();
let results = match (appservice_id, server_name, user_id, push_key) {
| (Some(appservice_id), None, None, None) => {
if appservice_id.is_empty() {
return Err!(
"An appservice ID, server name, or a user ID with push key must be \
specified via arguments. See --help for more details.",
);
}
services
.sending
.db
.active_requests_for(&Destination::Appservice(appservice_id))
},
| (None, Some(server_name), None, None) => services
.sending
.db
.active_requests_for(&Destination::Federation(server_name)),
| (None, None, Some(user_id), Some(push_key)) => {
if push_key.is_empty() {
return Err!(
"An appservice ID, server name, or a user ID with push key must be \
specified via arguments. See --help for more details.",
);
}
services
.sending
.db
.active_requests_for(&Destination::Push(user_id, push_key))
},
| (Some(_), Some(_), Some(_), Some(_)) => {
return Err!(
"An appservice ID, server name, or a user ID with push key must be \
specified via arguments. Not all of them See --help for more details.",
);
},
| _ => {
return Err!(
"An appservice ID, server name, or a user ID with push key must be \
specified via arguments. See --help for more details.",
);
},
};
let active_requests = results.collect::<Vec<_>>().await;
let query_time = timer.elapsed();
context
.write_str(&format!(
"Query completed in {query_time:?}:\n\n```rs\n{active_requests:#?}\n```"
))
.await
},
| SendingCommand::GetLatestEduCount { server_name } => {
let timer = tokio::time::Instant::now();
let results = services.sending.db.get_latest_educount(&server_name).await;
let query_time = timer.elapsed();
context
.write_str(&format!(
"Query completed in {query_time:?}:\n\n```rs\n{results:#?}\n```"
))
.await
},
}
}