add part 5 draft progress
This commit is contained in:
parent
8a3daf1085
commit
63fb07322f
|
|
@ -0,0 +1,17 @@
|
|||
[package]
|
||||
name = "part_5_task_loop"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||
|
||||
[dependencies]
|
||||
async-std = "1.10"
|
||||
bincode = "1.3"
|
||||
golgi = { git = "https://git.coopcloud.tech/golgi-ssb/golgi.git" }
|
||||
log = "0.4"
|
||||
rocket = "0.5.0-rc.1"
|
||||
rocket_dyn_templates = { version = "0.1.0-rc.1", features = ["tera"] }
|
||||
serde = "1"
|
||||
sled = "0.34"
|
||||
xdg = "2.4.1"
|
||||
|
|
@ -0,0 +1,179 @@
|
|||
# lykin tutorial
|
||||
|
||||
## Part 5: Task Loop and Post Fetching
|
||||
|
||||
### Introduction
|
||||
|
||||
In the last installment we added support to our key-value database for dealing with Scuttlebutt posts and wrote code to create and filter streams of Scuttlebutt messages. Since our peers may have authored tens of thousands of messages, it's useful to create a way of fetching and filtering message streams as a background process. Today we'll do just that; writing a task loop that we can be invoked from our web application route handlers and used to execute potentially long-running processes.
|
||||
|
||||
### Outline
|
||||
|
||||
Here's what we'll tackle in this fifth part of the series:
|
||||
|
||||
- Create an asynchronous task loop
|
||||
- Create a message passing channel and spawn the task loop
|
||||
- Write sbot-related task functions
|
||||
- Fetch root posts on subscription
|
||||
|
||||
### Libraries
|
||||
|
||||
The following libraries are introduced in this part:
|
||||
|
||||
- [`async-std`](https://crates.io/crates/async-std)
|
||||
|
||||
### Create an Asynchronous Task Loop
|
||||
|
||||
Let's start by defining a task type that enumerates the various tasks we might want to carry out. We'll create a separate module for our task loop:
|
||||
|
||||
`src/task_loop.rs`
|
||||
|
||||
```rust
|
||||
pub enum Task {
|
||||
Cancel,
|
||||
FetchAllPosts(String),
|
||||
FetchLatestName(String),
|
||||
}
|
||||
```
|
||||
|
||||
The `Task` enum is simple enough: we can fetch all the posts by a given peer (the `String` value is the public key of the peer we're interested in), fetch the latest name assigned to a peer or cancel the task loop.
|
||||
|
||||
We're going to use a message passing approach in order to trigger tasks inside the loop. Let's write the basic loop code now, adding it below the `Task` we just defined, while also adding the necessary crate imports:
|
||||
|
||||
```rust
|
||||
use async_std::{channel::Receiver, task};
|
||||
use log::info;
|
||||
|
||||
// Spawn an asynchronous loop which receives tasks over an unbounded channel
|
||||
// and invokes task functions accordingly.
|
||||
pub async fn spawn(rx: Receiver<Task>) {
|
||||
task::spawn(async move {
|
||||
while let Ok(task) = rx.recv().await {
|
||||
match task {
|
||||
// Fetch all messages authored by the given peer, filter
|
||||
// the root posts and insert them into the posts tree of the
|
||||
// database.
|
||||
Task::FetchAllPosts(peer_id) => {
|
||||
info!("Fetching all posts for peer: {}", peer_id);
|
||||
}
|
||||
// Fetch the latest name for the given peer and update the
|
||||
// peer entry in the peers tree of the database.
|
||||
Task::FetchLatestName(peer_id) => {
|
||||
info!("Fetching latest name for peer: {}", peer_id);
|
||||
}
|
||||
// Break out of the task loop.
|
||||
Task::Cancel => {
|
||||
info!("Exiting task loop...");
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
The loop spawning function is fairly simple: it takes the receiver half of a channel and expects messages of type `Task` to be delivered; it matches on the `Task` variant each time a message is received on the channel and acts accordingly. Writing an async loop like this means that we can call functions without blocking the execution of the rest of our program. This is a particularly useful in route handlers where we want to be able to trigger a task and then immediately respond to the request in order to keep the UI snappy and responsive.
|
||||
|
||||
### Create Message Passing Channel and Spawn the Task Loop
|
||||
|
||||
Let's return to the root of our application to create the message passing channel, spawn the task loop and add the channel transmitter to managed state:
|
||||
|
||||
`src/main.rs`
|
||||
|
||||
```rust
|
||||
mod task_loop;
|
||||
|
||||
use async_std::channel;
|
||||
use log::info;
|
||||
use rocket::fairing::AdHoc;
|
||||
|
||||
use crate::task_loop::Task;
|
||||
|
||||
#[launch] async fn rocket() -> _ {
|
||||
// ...
|
||||
|
||||
// Create the key-value database.
|
||||
// ...
|
||||
|
||||
// Create a message passing channel.
|
||||
let (tx, rx) = channel::unbounded();
|
||||
let tx_clone = tx.clone();
|
||||
|
||||
// Spawn the task loop, passing in the receiver half of the channel.
|
||||
info!("Spawning task loop");
|
||||
task_loop::spawn(rx).await;
|
||||
|
||||
rocket::build()
|
||||
.manage(db)
|
||||
// Add the transmitter half of the channel to the managed state
|
||||
// of the Rocket application.
|
||||
.manage(tx)
|
||||
// ...
|
||||
// Send a task loop cancellation message when the application
|
||||
// is shutting down.
|
||||
.attach(AdHoc::on_shutdown("cancel task loop", |_| {
|
||||
Box::pin(async move {
|
||||
tx_clone.send(Task::Cancel).await.unwrap();
|
||||
})
|
||||
}))
|
||||
}
|
||||
```
|
||||
|
||||
Reviewing the code above: first an unbounded, asynchronous channel is created and split into transmitting (`tx`) and receiving (`rx`) ends, after which the transmitting channel is cloned. The task loop is then spawned and takes with it the receiving end of the channel. As we did previously with the `db` instance, the transmitting half of the channel is added to the managed state of the Rocket application; this will allow us to transmit tasks to the task loop from our web route handlers. And finaly, a shutdown handler is attached to the Rocket application in order to send a cancellation task to the task loop before the program ends. This ensures that the task loop closes cleanly.
|
||||
|
||||
### Write Sbot-Related Task Functions
|
||||
|
||||
Now it's time to write the functions that will be executed when the `FetchAllPosts` and `FetchLatestName` tasks are invoked. These functions will be responsible for retrieving data from the sbot and updating the database with the latest values:
|
||||
|
||||
`src/task_loop.rs`
|
||||
|
||||
```rust
|
||||
async fn fetch_posts_and_update_db(db: &Database, peer_id: String, after_sequence: u64) {
|
||||
let peer_msgs = sbot::get_message_stream(&peer_id, after_sequence).await;
|
||||
let (latest_sequence, root_posts) = sbot::get_root_posts(peer_msgs).await;
|
||||
|
||||
match db.add_post_batch(&peer_id, root_posts) {
|
||||
Ok(_) => {
|
||||
info!(
|
||||
"Inserted batch of posts into database post tree for peer: {}",
|
||||
&peer_id
|
||||
)
|
||||
}
|
||||
Err(e) => warn!(
|
||||
"Failed to insert batch of posts into database post tree for peer: {}: {}",
|
||||
&peer_id, e
|
||||
),
|
||||
}
|
||||
|
||||
// Update the value of the latest sequence number for
|
||||
// the peer (this is stored in the database).
|
||||
if let Ok(Some(peer)) = db.get_peer(&peer_id) {
|
||||
db.add_peer(peer.set_latest_sequence(latest_sequence))
|
||||
.unwrap();
|
||||
}
|
||||
}
|
||||
|
||||
/// Request the name of the peer represented by the given public key (ID)
|
||||
/// and update the existing entry in the database.
|
||||
async fn fetch_name_and_update_db(db: &Database, peer_id: String) {
|
||||
match sbot::get_name(&peer_id).await {
|
||||
Ok(name) => {
|
||||
if let Ok(Some(peer)) = db.get_peer(&peer_id) {
|
||||
let updated_peer = peer.set_name(&name);
|
||||
match db.add_peer(updated_peer) {
|
||||
Ok(_) => info!("Updated name for peer: {}", &peer_id),
|
||||
Err(e) => {
|
||||
warn!("Failed to update name for peer: {}: {}", &peer_id, e)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Err(e) => warn!("Failed to fetch name for {}: {}", &peer_id, e),
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Fetch Root Posts on Subscription
|
||||
|
||||
### Conclusion
|
||||
|
||||
## Funding
|
||||
|
|
@ -0,0 +1,81 @@
|
|||
use std::path::Path;
|
||||
|
||||
use log::{debug, info};
|
||||
use serde::{Deserialize, Serialize};
|
||||
use sled::{Db, IVec, Result, Tree};
|
||||
|
||||
/// Scuttlebutt peer data.
|
||||
#[derive(Debug, Deserialize, Serialize)]
|
||||
pub struct Peer {
|
||||
pub public_key: String,
|
||||
pub name: String,
|
||||
}
|
||||
|
||||
impl Peer {
|
||||
/// Create a new instance of the Peer struct using the given public
|
||||
/// key. A default value is set for name.
|
||||
pub fn new(public_key: &str) -> Peer {
|
||||
Peer {
|
||||
public_key: public_key.to_string(),
|
||||
name: "".to_string(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Modify the name field of an instance of the Peer struct, leaving
|
||||
/// the other values unchanged.
|
||||
pub fn set_name(self, name: &str) -> Peer {
|
||||
Self {
|
||||
name: name.to_string(),
|
||||
..self
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// An instance of the key-value database and relevant trees.
|
||||
#[allow(dead_code)]
|
||||
#[derive(Clone)]
|
||||
pub struct Database {
|
||||
/// The sled database instance.
|
||||
db: Db,
|
||||
/// A database tree containing Peer struct instances for all the peers
|
||||
/// we are subscribed to.
|
||||
peer_tree: Tree,
|
||||
}
|
||||
|
||||
impl Database {
|
||||
/// Initialise the database by opening the database file, loading the
|
||||
/// peers tree and returning an instantiated Database struct.
|
||||
pub fn init(path: &Path) -> Self {
|
||||
// Open the database at the given path.
|
||||
// The database will be created if it does not yet exist.
|
||||
// This code will panic if an IO error is encountered.
|
||||
info!("Initialising sled database");
|
||||
let db = sled::open(path).expect("Failed to open database");
|
||||
debug!("Opening 'peers' database tree");
|
||||
let peer_tree = db
|
||||
.open_tree("peers")
|
||||
.expect("Failed to open 'peers' database tree");
|
||||
|
||||
Database { db, peer_tree }
|
||||
}
|
||||
|
||||
/// Add a peer to the database by inserting the public key into the peer
|
||||
/// tree.
|
||||
pub fn add_peer(&self, peer: Peer) -> Result<Option<IVec>> {
|
||||
debug!("Serializing peer data for {} to bincode", &peer.public_key);
|
||||
let peer_bytes = bincode::serialize(&peer).unwrap();
|
||||
|
||||
debug!(
|
||||
"Inserting peer {} into 'peers' database tree",
|
||||
&peer.public_key
|
||||
);
|
||||
self.peer_tree.insert(&peer.public_key, peer_bytes)
|
||||
}
|
||||
|
||||
/// Remove a peer from the database, as represented by the given public
|
||||
/// key.
|
||||
pub fn remove_peer(&self, public_key: &str) -> Result<()> {
|
||||
debug!("Removing peer {} from 'peers' database tree", &public_key);
|
||||
self.peer_tree.remove(&public_key).map(|_| ())
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
mod db;
|
||||
mod routes;
|
||||
mod sbot;
|
||||
mod task_loop;
|
||||
mod utils;
|
||||
|
||||
use async_std::channel;
|
||||
use log::info;
|
||||
use rocket::{fairing::AdHoc, launch, routes};
|
||||
use rocket_dyn_templates::Template;
|
||||
use xdg::BaseDirectories;
|
||||
|
||||
use crate::{db::Database, routes::*, task_loop::Task};
|
||||
|
||||
#[launch]
|
||||
async fn rocket() -> _ {
|
||||
// Create the key-value database.
|
||||
let xdg_dirs = BaseDirectories::with_prefix("lykin").unwrap();
|
||||
let db_path = xdg_dirs
|
||||
.place_config_file("database")
|
||||
.expect("cannot create database directory");
|
||||
let db = Database::init(&db_path);
|
||||
|
||||
// Create a message passing channel.
|
||||
let (tx, rx) = channel::unbounded();
|
||||
let tx_clone = tx.clone();
|
||||
|
||||
// Spawn the task loop, passing in the receiver half of the channel.
|
||||
info!("Spawning task loop");
|
||||
task_loop::spawn(rx).await;
|
||||
|
||||
rocket::build()
|
||||
.manage(db)
|
||||
.manage(tx)
|
||||
.attach(Template::fairing())
|
||||
.mount("/", routes![home, subscribe_form, unsubscribe_form])
|
||||
.attach(AdHoc::on_shutdown("cancel task loop", |_| {
|
||||
Box::pin(async move {
|
||||
tx_clone.send(Task::Cancel).await.unwrap();
|
||||
})
|
||||
}))
|
||||
}
|
||||
|
|
@ -0,0 +1,141 @@
|
|||
use log::{info, warn};
|
||||
use rocket::{
|
||||
form::Form,
|
||||
get, post,
|
||||
request::FlashMessage,
|
||||
response::{Flash, Redirect},
|
||||
uri, FromForm, State,
|
||||
};
|
||||
use rocket_dyn_templates::{context, Template};
|
||||
|
||||
use crate::{
|
||||
db::{Database, Peer},
|
||||
sbot, utils,
|
||||
};
|
||||
|
||||
#[derive(FromForm)]
|
||||
pub struct PeerForm {
|
||||
pub public_key: String,
|
||||
}
|
||||
|
||||
#[get("/")]
|
||||
pub async fn home(flash: Option<FlashMessage<'_>>) -> Template {
|
||||
let whoami = match sbot::whoami().await {
|
||||
Ok(id) => id,
|
||||
Err(e) => format!("Error making `whoami` RPC call: {}. Please ensure the local go-sbot is running and refresh.", e),
|
||||
};
|
||||
|
||||
Template::render("base", context! { whoami: whoami, flash: flash })
|
||||
}
|
||||
|
||||
#[post("/subscribe", data = "<peer>")]
|
||||
pub async fn subscribe_form(
|
||||
db: &State<Database>,
|
||||
peer: Form<PeerForm>,
|
||||
) -> Result<Redirect, Flash<Redirect>> {
|
||||
if let Err(e) = utils::validate_public_key(&peer.public_key) {
|
||||
let validation_err_msg = format!("Public key {} is invalid: {}", &peer.public_key, e);
|
||||
warn!("{}", validation_err_msg);
|
||||
return Err(Flash::error(Redirect::to(uri!(home)), validation_err_msg));
|
||||
} else {
|
||||
info!("Public key {} is valid", &peer.public_key);
|
||||
// Retrieve the name of the peer to which we are subscribing.
|
||||
let peer_name = match sbot::get_name(&peer.public_key).await {
|
||||
Ok(name) => name,
|
||||
Err(e) => {
|
||||
warn!("Failed to fetch name for peer {}: {}", &peer.public_key, e);
|
||||
// Return an empty string if an error occurs.
|
||||
String::from("")
|
||||
}
|
||||
};
|
||||
let peer_info = Peer::new(&peer.public_key).set_name(&peer_name);
|
||||
|
||||
match sbot::follow_if_not_following(&peer.public_key).await {
|
||||
Ok(_) => {
|
||||
// Add the peer to the database.
|
||||
if db.add_peer(peer_info).is_ok() {
|
||||
info!("Added {} to 'peers' database tree", &peer.public_key);
|
||||
} else {
|
||||
let err_msg = format!(
|
||||
"Failed to add peer {} to 'peers' database tree",
|
||||
&peer.public_key
|
||||
);
|
||||
warn!("{}", err_msg);
|
||||
return Err(Flash::error(Redirect::to(uri!(home)), err_msg));
|
||||
}
|
||||
}
|
||||
Err(e) => {
|
||||
warn!("{}", e);
|
||||
return Err(Flash::error(Redirect::to(uri!(home)), e));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Ok(Redirect::to(uri!(home)))
|
||||
}
|
||||
|
||||
#[post("/unsubscribe", data = "<peer>")]
|
||||
pub async fn unsubscribe_form(
|
||||
db: &State<Database>,
|
||||
peer: Form<PeerForm>,
|
||||
) -> Result<Redirect, Flash<Redirect>> {
|
||||
if let Err(e) = utils::validate_public_key(&peer.public_key) {
|
||||
let validation_err_msg = format!("Public key {} is invalid: {}", &peer.public_key, e);
|
||||
warn!("{}", validation_err_msg);
|
||||
return Err(Flash::error(Redirect::to(uri!(home)), validation_err_msg));
|
||||
} else {
|
||||
info!("Public key {} is valid", &peer.public_key);
|
||||
match sbot::unfollow_if_following(&peer.public_key).await {
|
||||
Ok(_) => {
|
||||
// Remove the peer from the database.
|
||||
if db.remove_peer(&peer.public_key).is_ok() {
|
||||
info!(
|
||||
"Removed peer {} from 'peers' database tree",
|
||||
&peer.public_key
|
||||
);
|
||||
} else {
|
||||
warn!(
|
||||
"Failed to remove peer {} from 'peers' database tree",
|
||||
&peer.public_key
|
||||
);
|
||||
}
|
||||
}
|
||||
Err(e) => {
|
||||
warn!("{}", e);
|
||||
return Err(Flash::error(Redirect::to(uri!(home)), e));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Ok(Redirect::to(uri!(home)))
|
||||
}
|
||||
|
||||
/*
|
||||
#[post("/subscribe", data = "<peer>")]
|
||||
pub async fn subscribe_form(peer: Form<PeerForm>) -> Result<Redirect, Flash<Redirect>> {
|
||||
if let Err(e) = utils::validate_public_key(&peer.public_key) {
|
||||
let validation_err_msg = format!("Public key {} is invalid: {}", &peer.public_key, e);
|
||||
warn!("{}", validation_err_msg);
|
||||
return Err(Flash::error(Redirect::to(uri!(home)), validation_err_msg));
|
||||
} else {
|
||||
info!("Public key {} is valid", &peer.public_key);
|
||||
sbot::follow_if_not_following(&peer.public_key).await;
|
||||
}
|
||||
|
||||
Ok(Redirect::to(uri!(home)))
|
||||
}
|
||||
|
||||
#[post("/unsubscribe", data = "<peer>")]
|
||||
pub async fn unsubscribe_form(peer: Form<PeerForm>) -> Result<Redirect, Flash<Redirect>> {
|
||||
if let Err(e) = utils::validate_public_key(&peer.public_key) {
|
||||
let validation_err_msg = format!("Public key {} is invalid: {}", &peer.public_key, e);
|
||||
warn!("{}", validation_err_msg);
|
||||
return Err(Flash::error(Redirect::to(uri!(home)), validation_err_msg));
|
||||
} else {
|
||||
info!("Public key {} is valid", &peer.public_key);
|
||||
sbot::unfollow_if_following(&peer.public_key).await;
|
||||
}
|
||||
|
||||
Ok(Redirect::to(uri!(home)))
|
||||
}
|
||||
*/
|
||||
|
|
@ -0,0 +1,130 @@
|
|||
use std::env;
|
||||
|
||||
use golgi::{api::friends::RelationshipQuery, sbot::Keystore, Sbot};
|
||||
use log::{info, warn};
|
||||
|
||||
/// Initialise a connection to a Scuttlebutt server.
|
||||
pub async fn init_sbot() -> Result<Sbot, String> {
|
||||
let go_sbot_port = env::var("GO_SBOT_PORT").unwrap_or_else(|_| "8021".to_string());
|
||||
|
||||
let keystore = Keystore::GoSbot;
|
||||
let ip_port = Some(format!("127.0.0.1:{}", go_sbot_port));
|
||||
let net_id = None;
|
||||
|
||||
Sbot::init(keystore, ip_port, net_id)
|
||||
.await
|
||||
.map_err(|e| e.to_string())
|
||||
}
|
||||
|
||||
/// Return the public key of the local sbot instance.
|
||||
pub async fn whoami() -> Result<String, String> {
|
||||
let mut sbot = init_sbot().await?;
|
||||
|
||||
sbot.whoami().await.map_err(|e| e.to_string())
|
||||
}
|
||||
|
||||
/// Check follow status.
|
||||
///
|
||||
/// Is peer A (`public_key_a`) following peer B (`public_key_b`)?
|
||||
pub async fn is_following(public_key_a: &str, public_key_b: &str) -> Result<String, String> {
|
||||
let mut sbot = init_sbot().await?;
|
||||
|
||||
let query = RelationshipQuery {
|
||||
source: public_key_a.to_string(),
|
||||
dest: public_key_b.to_string(),
|
||||
};
|
||||
|
||||
sbot.friends_is_following(query)
|
||||
.await
|
||||
.map_err(|e| e.to_string())
|
||||
}
|
||||
|
||||
/// Follow a peer.
|
||||
pub async fn follow_peer(public_key: &str) -> Result<String, String> {
|
||||
let mut sbot = init_sbot().await?;
|
||||
|
||||
sbot.follow(public_key).await.map_err(|e| e.to_string())
|
||||
}
|
||||
|
||||
/// Unfollow a peer.
|
||||
pub async fn unfollow_peer(public_key: &str) -> Result<String, String> {
|
||||
let mut sbot = init_sbot().await?;
|
||||
|
||||
sbot.unfollow(public_key).await.map_err(|e| e.to_string())
|
||||
}
|
||||
|
||||
/// Return the name (self-identifier) for the peer associated with the given
|
||||
/// public key.
|
||||
///
|
||||
/// The public key of the peer will be returned if a name is not found.
|
||||
pub async fn get_name(public_key: &str) -> Result<String, String> {
|
||||
let mut sbot = init_sbot().await?;
|
||||
|
||||
sbot.get_name(public_key).await.map_err(|e| e.to_string())
|
||||
}
|
||||
|
||||
/// Check the follow status of a remote peer and follow them if not already
|
||||
/// following.
|
||||
pub async fn follow_if_not_following(remote_peer: &str) -> Result<(), String> {
|
||||
if let Ok(whoami) = whoami().await {
|
||||
match is_following(&whoami, remote_peer).await {
|
||||
Ok(status) if status.as_str() == "false" => match follow_peer(remote_peer).await {
|
||||
Ok(_) => {
|
||||
info!("Followed peer {}", &remote_peer);
|
||||
Ok(())
|
||||
}
|
||||
Err(e) => {
|
||||
let err_msg = format!("Failed to follow peer {}: {}", &remote_peer, e);
|
||||
warn!("{}", err_msg);
|
||||
Err(err_msg)
|
||||
}
|
||||
},
|
||||
Ok(status) if status.as_str() == "true" => {
|
||||
info!(
|
||||
"Already following peer {}. No further action taken",
|
||||
&remote_peer
|
||||
);
|
||||
Ok(())
|
||||
}
|
||||
_ => Err(
|
||||
"Failed to determine follow status: received unrecognised response from local sbot"
|
||||
.to_string(),
|
||||
),
|
||||
}
|
||||
} else {
|
||||
let err_msg = String::from("Received an error during `whoami` RPC call. Please ensure the go-sbot is running and try again");
|
||||
warn!("{}", err_msg);
|
||||
Err(err_msg)
|
||||
}
|
||||
}
|
||||
|
||||
/// Check the follow status of a remote peer and unfollow them if already
|
||||
/// following.
|
||||
pub async fn unfollow_if_following(remote_peer: &str) -> Result<(), String> {
|
||||
if let Ok(whoami) = whoami().await {
|
||||
match is_following(&whoami, remote_peer).await {
|
||||
Ok(status) if status.as_str() == "true" => {
|
||||
info!("Unfollowing peer {}", &remote_peer);
|
||||
match unfollow_peer(remote_peer).await {
|
||||
Ok(_) => {
|
||||
info!("Unfollowed peer {}", &remote_peer);
|
||||
Ok(())
|
||||
}
|
||||
Err(e) => {
|
||||
let err_msg = format!("Failed to unfollow peer {}: {}", &remote_peer, e);
|
||||
warn!("{}", err_msg);
|
||||
Err(err_msg)
|
||||
}
|
||||
}
|
||||
}
|
||||
_ => Err(
|
||||
"Failed to determine follow status: received unrecognised response from local sbot"
|
||||
.to_string(),
|
||||
),
|
||||
}
|
||||
} else {
|
||||
let err_msg = String::from("Received an error during `whoami` RPC call. Please ensure the go-sbot is running and try again");
|
||||
warn!("{}", err_msg);
|
||||
Err(err_msg)
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
use async_std::{channel::Receiver, task};
|
||||
use log::info;
|
||||
|
||||
pub enum Task {
|
||||
Cancel,
|
||||
FetchAllPosts(String),
|
||||
FetchLatestName(String),
|
||||
}
|
||||
|
||||
/// Spawn an asynchronous loop which receives tasks over an unbounded channel
|
||||
/// and invokes task functions accordingly.
|
||||
pub async fn spawn(rx: Receiver<Task>) {
|
||||
task::spawn(async move {
|
||||
while let Ok(task) = rx.recv().await {
|
||||
match task {
|
||||
// Fetch all messages authored by the given peer, filter
|
||||
// the root posts and insert them into the posts tree of the
|
||||
// database.
|
||||
Task::FetchAllPosts(peer_id) => {
|
||||
info!("Fetching all posts for peer: {}", peer_id);
|
||||
}
|
||||
// Fetch the latest name for the given peer and update the
|
||||
// peer entry in the peers tree of the database.
|
||||
Task::FetchLatestName(peer_id) => {
|
||||
info!("Fetching latest name for peer: {}", peer_id);
|
||||
}
|
||||
// Break out of the task loop.
|
||||
Task::Cancel => {
|
||||
info!("Exiting task loop...");
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
//! Public key validation.
|
||||
|
||||
/// Ensure that the given public key is a valid ed25519 key.
|
||||
///
|
||||
/// Return an error string if the key is invalid.
|
||||
pub fn validate_public_key(public_key: &str) -> Result<(), String> {
|
||||
// Ensure the ID starts with the correct sigil link.
|
||||
if !public_key.starts_with('@') {
|
||||
return Err("expected '@' sigil as first character".to_string());
|
||||
}
|
||||
|
||||
// Find the dot index denoting the start of the algorithm definition tag.
|
||||
let dot_index = match public_key.rfind('.') {
|
||||
Some(index) => index,
|
||||
None => return Err("no dot index was found".to_string()),
|
||||
};
|
||||
|
||||
// Check the hashing algorithm (must end with ".ed25519").
|
||||
if !&public_key.ends_with(".ed25519") {
|
||||
return Err("hashing algorithm must be ed25519".to_string());
|
||||
}
|
||||
|
||||
// Obtain the base64 portion (substring) of the public key.
|
||||
let base64_str = &public_key[1..dot_index];
|
||||
|
||||
// Ensure the length of the base64 encoded ed25519 public key is correct.
|
||||
if base64_str.len() != 44 {
|
||||
return Err("base64 data length is incorrect".to_string());
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>lykin</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
</head>
|
||||
<body>
|
||||
<h1><a href="/">lykin</a></h1>
|
||||
<p>{{ whoami }}</p>
|
||||
<form action="/subscribe" method="post">
|
||||
<label for="public_key">Public Key</label>
|
||||
<input type="text" id="public_key" name="public_key" maxlength=53>
|
||||
<input type="submit" value="Subscribe">
|
||||
<input type="submit" value="Unsubscribe" formaction="/unsubscribe">
|
||||
</form>
|
||||
{% if flash and flash.kind == "error" %}
|
||||
<p style="color: red;">[ {{ flash.message }} ]</p>
|
||||
{% endif %}
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Reference in New Issue