kg333
/
tenebrous-dicebot
forked from projectmoon/tenebrous-dicebot
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
tenebrous-dicebot/src/error.rs

106 lines
2.9 KiB
Rust
Raw Normal View History

Remove sled and all related crates from dependencies.
2021-05-21 14:21:22 +00:00
use crate::commands::CommandError;
Localize error enums to modules, better DB error reportng.
2020-10-16 12:40:25 +00:00
use crate::config::ConfigError;
Split database code into separate modules.
2020-10-24 13:08:23 +00:00
use crate::db::errors::DataError;
Implement Actix for state, refactor bot code. Instead of using an Arc Mutex for state management embedded directly into the bot, utilize actor pattern, with the idea that this will be much more useful than simply logging a message once in the future. This also refactors the bot code so that instead of a single run_bot function, the DiceBot struct now has a run() method attached to it. This also necessitated changes and cleanup to the dicebot main, which is for the better anyhow. The error and config types are also now in their own files, and implemented for more in-depth use cases.
2020-09-28 21:35:05 +00:00
use thiserror::Error;
#[derive(Error, Debug)]
pub enum BotError {
Add database and storage of user variables. This commit introduces the Sled embedded key-value store for keeping track of user variables on a per-room basis. Extensive changes were made to the command module to separate concerns and also pass the database "connection" down the line. - A new "Context" object was created to hold information and state needed for command execution (namely the database). - Database is very simple for now, storing only user variables. Refactoring later for storing more complicated types. - State actor moved into Actors struct, in preparation for either more actors, or ripping the whole thing out entirely. - Other modules are also more properly separated, notably the config module is entirely self-contained.
2020-10-15 16:52:08 +00:00
#[error("configuration error: {0}")]
ConfigurationError(#[from] ConfigError),
Implement Actix for state, refactor bot code. Instead of using an Arc Mutex for state management embedded directly into the bot, utilize actor pattern, with the idea that this will be much more useful than simply logging a message once in the future. This also refactors the bot code so that instead of a single run_bot function, the DiceBot struct now has a run() method attached to it. This also necessitated changes and cleanup to the dicebot main, which is for the better anyhow. The error and config types are also now in their own files, and implemented for more in-depth use cases.
2020-09-28 21:35:05 +00:00
/// Sync token couldn't be found.
#[error("the sync token could not be retrieved")]
SyncTokenRequired,
Reuse device ID generated by matrix SDK after first login. Adds new db tree for simple global state values (which also lays foundation for other stuff), and stores device ID in that tree after first login. The ID is then reused on subsequent runs of the application. This is simpler than storing device ID in config file. Fixes #9.
2021-02-07 14:21:28 +00:00
#[error("could not retrieve device id")]
NoDeviceIdFound,
Add database and storage of user variables. This commit introduces the Sled embedded key-value store for keeping track of user variables on a per-room basis. Extensive changes were made to the command module to separate concerns and also pass the database "connection" down the line. - A new "Context" object was created to hold information and state needed for command execution (namely the database). - Database is very simple for now, storing only user variables. Refactoring later for storing more complicated types. - State actor moved into Actors struct, in preparation for either more actors, or ripping the whole thing out entirely. - Other modules are also more properly separated, notably the config module is entirely self-contained.
2020-10-15 16:52:08 +00:00
#[error("command error: {0}")]
CommandError(#[from] CommandError),
#[error("database error: {0}")]
DataError(#[from] DataError),
Encapsulate config with Arc. Further bot code cleanup. Only expose config settings via methods on the Config struct. This allows default value handling to live entirely inside the config code, solves various borrowing issues with the "create default bot config value" solution, and allows us to avoid cloning the bot config values. The downside is that the config must now be in an Arc since its ownership is shared in multiple places and the matrix SDK requires thread-safe types (perhaps in the future we re-compose traits and use Rc for config instead). This commit also further cleans up and splits up the bot code for the matrix connection, notably making the main message event handler smaller by splitting out the "should we process the message" checks into a separate function.
2020-10-03 20:31:42 +00:00
#[error("the message should not be processed because it failed validation")]
ShouldNotProcessError,
Implement Actix for state, refactor bot code. Instead of using an Arc Mutex for state management embedded directly into the bot, utilize actor pattern, with the idea that this will be much more useful than simply logging a message once in the future. This also refactors the bot code so that instead of a single run_bot function, the DiceBot struct now has a run() method attached to it. This also necessitated changes and cleanup to the dicebot main, which is for the better anyhow. The error and config types are also now in their own files, and implemented for more in-depth use cases.
2020-09-28 21:35:05 +00:00
#[error("no cache directory found")]
NoCacheDirectoryError,
#[error("could not parse URL")]
UrlParseError(#[from] url::ParseError),
Upgrade to Matrix SDK latest (Store Rewrite) and Tokio 1.0 This upgrade introduces a handful of breaking changes in the Rust Matrix SDK. - Some types have disappeared and changed name. - Some functions are no longer async. - Room display name now has a Result type instead of just returning the value. - Client state store has breaking changes (not really a big deal). This required introduction of a new type to store room information that we are interested in on the context struct. This new RoomContext is required mostly due to unit tests, because it is no longer possible to instantiate the Room type in the Matrix SDK.
2021-01-29 22:35:07 +00:00
#[error("error in matrix state store: {0}")]
MatrixStateStoreError(#[from] matrix_sdk::StoreError),
Add proper constraints to db tables. Report errors when listing users.
2021-05-16 21:39:19 +00:00
#[error("uncategorized matrix SDK error: {0}")]
Implement Actix for state, refactor bot code. Instead of using an Arc Mutex for state management embedded directly into the bot, utilize actor pattern, with the idea that this will be much more useful than simply logging a message once in the future. This also refactors the bot code so that instead of a single run_bot function, the DiceBot struct now has a run() method attached to it. This also necessitated changes and cleanup to the dicebot main, which is for the better anyhow. The error and config types are also now in their own files, and implemented for more in-depth use cases.
2020-09-28 21:35:05 +00:00
MatrixError(#[from] matrix_sdk::Error),
Add proper constraints to db tables. Report errors when listing users.
2021-05-16 21:39:19 +00:00
#[error("uncategorized matrix SDK base error: {0}")]
Implement Actix for state, refactor bot code. Instead of using an Arc Mutex for state management embedded directly into the bot, utilize actor pattern, with the idea that this will be much more useful than simply logging a message once in the future. This also refactors the bot code so that instead of a single run_bot function, the DiceBot struct now has a run() method attached to it. This also necessitated changes and cleanup to the dicebot main, which is for the better anyhow. The error and config types are also now in their own files, and implemented for more in-depth use cases.
2020-09-28 21:35:05 +00:00
MatrixBaseError(#[from] matrix_sdk::BaseError),
#[error("future canceled")]
FutureCanceledError,
//de = deserialization
#[error("toml parsing error")]
TomlParsingError(#[from] toml::de::Error),
Add database and storage of user variables. This commit introduces the Sled embedded key-value store for keeping track of user variables on a per-room basis. Extensive changes were made to the command module to separate concerns and also pass the database "connection" down the line. - A new "Context" object was created to hold information and state needed for command execution (namely the database). - Database is very simple for now, storing only user variables. Refactoring later for storing more complicated types. - State actor moved into Actors struct, in preparation for either more actors, or ripping the whole thing out entirely. - Other modules are also more properly separated, notably the config module is entirely self-contained.
2020-10-15 16:52:08 +00:00
#[error("i/o error: {0}")]
Implement Actix for state, refactor bot code. Instead of using an Arc Mutex for state management embedded directly into the bot, utilize actor pattern, with the idea that this will be much more useful than simply logging a message once in the future. This also refactors the bot code so that instead of a single run_bot function, the DiceBot struct now has a run() method attached to it. This also necessitated changes and cleanup to the dicebot main, which is for the better anyhow. The error and config types are also now in their own files, and implemented for more in-depth use cases.
2020-09-28 21:35:05 +00:00
IoError(#[from] std::io::Error),
Dice pool and command parser rewrite to prepare for user variables. This commit refactors the parsing and rolling for the dice pool system to prepare for support of user variables. The nom parser was dropped in favor of the easier-to-understand combine parser in most parts of the code. A breaking change was introduced into the dice pool syntax to allow for proper expressions and variables. The syntax is now "modifiers:pool-amount", e.g. "n:gnosis+8". The simple single-number syntax with no modifiers is also still understood. Dice pool expressions are translated into a Vec of "Amount" objects, stored by the DicePool struct. They have an operator (+ or -) and either a number or variable name. When the dice pool is rolled, this list of Amonuts are is collapsed into a single number that is rolled, as it was before the refactor. The following changes were made to the dice rolling code: - Store Vec<Amount> on DicePool instead of single number to roll. - New struct RolledDicePool to store result of a dice pool roll. - Remove Display trait from DicePool, move it over to RolledDicePool. - Separate extra dice pool info into DicePoolModifiers. - DicePoolModifiers is shared between DicePool and RolledDicePool. - Dice parsing and rolling now return standard Result objects. This commit does NOT enable support of actually using variables. Any dice pool roll containing a variable will result in an eror. The command parser was also rewritten to use combine and rely on the standard Result pattern.
2020-10-04 21:32:50 +00:00
Add database and storage of user variables. This commit introduces the Sled embedded key-value store for keeping track of user variables on a per-room basis. Extensive changes were made to the command module to separate concerns and also pass the database "connection" down the line. - A new "Context" object was created to hold information and state needed for command execution (namely the database). - Database is very simple for now, storing only user variables. Refactoring later for storing more complicated types. - State actor moved into Actors struct, in preparation for either more actors, or ripping the whole thing out entirely. - Other modules are also more properly separated, notably the config module is entirely self-contained.
2020-10-15 16:52:08 +00:00
#[error("dice parsing error: {0}")]
Consolidate dice and variable parsers under parser module.
2021-05-21 14:44:03 +00:00
DiceParsingError(#[from] crate::parser::dice::DiceParsingError),
Centralize common parsing code. Needed for further development of different systems that rely on these kind of expressions, and lays groundwork for future changes.
2020-10-31 13:52:46 +00:00
#[error("command parsing error: {0}")]
CommandParsingError(#[from] crate::commands::parser::CommandParsingError),
Dice pool and command parser rewrite to prepare for user variables. This commit refactors the parsing and rolling for the dice pool system to prepare for support of user variables. The nom parser was dropped in favor of the easier-to-understand combine parser in most parts of the code. A breaking change was introduced into the dice pool syntax to allow for proper expressions and variables. The syntax is now "modifiers:pool-amount", e.g. "n:gnosis+8". The simple single-number syntax with no modifiers is also still understood. Dice pool expressions are translated into a Vec of "Amount" objects, stored by the DicePool struct. They have an operator (+ or -) and either a number or variable name. When the dice pool is rolled, this list of Amonuts are is collapsed into a single number that is rolled, as it was before the refactor. The following changes were made to the dice rolling code: - Store Vec<Amount> on DicePool instead of single number to roll. - New struct RolledDicePool to store result of a dice pool roll. - Remove Display trait from DicePool, move it over to RolledDicePool. - Separate extra dice pool info into DicePoolModifiers. - DicePoolModifiers is shared between DicePool and RolledDicePool. - Dice parsing and rolling now return standard Result objects. This commit does NOT enable support of actually using variables. Any dice pool roll containing a variable will result in an eror. The command parser was also rewritten to use combine and rely on the standard Result pattern.
2020-10-04 21:32:50 +00:00
Implement support for user variables in CoC dice rolling. Also comes with reorganization of the dice rolling code to centralize the variable -> dice amount logic, and changes the way the results of those rolls are displayed.
2020-11-04 20:09:39 +00:00
#[error("dice rolling error: {0}")]
Reject dice pool expressions over 100 elements.
2020-10-16 22:02:25 +00:00
DiceRollingError(#[from] DiceRollingError),
Better error message when dice pool variable not defined.
2020-10-16 21:30:02 +00:00
Add database and storage of user variables. This commit introduces the Sled embedded key-value store for keeping track of user variables on a per-room basis. Extensive changes were made to the command module to separate concerns and also pass the database "connection" down the line. - A new "Context" object was created to hold information and state needed for command execution (namely the database). - Database is very simple for now, storing only user variables. Refactoring later for storing more complicated types. - State actor moved into Actors struct, in preparation for either more actors, or ripping the whole thing out entirely. - Other modules are also more properly separated, notably the config module is entirely self-contained.
2020-10-15 16:52:08 +00:00
#[error("variable parsing error: {0}")]
Consolidate dice and variable parsers under parser module.
2021-05-21 14:44:03 +00:00
VariableParsingError(#[from] crate::parser::variables::VariableParsingError),
Add database and storage of user variables. This commit introduces the Sled embedded key-value store for keeping track of user variables on a per-room basis. Extensive changes were made to the command module to separate concerns and also pass the database "connection" down the line. - A new "Context" object was created to hold information and state needed for command execution (namely the database). - Database is very simple for now, storing only user variables. Refactoring later for storing more complicated types. - State actor moved into Actors struct, in preparation for either more actors, or ripping the whole thing out entirely. - Other modules are also more properly separated, notably the config module is entirely self-contained.
2020-10-15 16:52:08 +00:00
Dice pool and command parser rewrite to prepare for user variables. This commit refactors the parsing and rolling for the dice pool system to prepare for support of user variables. The nom parser was dropped in favor of the easier-to-understand combine parser in most parts of the code. A breaking change was introduced into the dice pool syntax to allow for proper expressions and variables. The syntax is now "modifiers:pool-amount", e.g. "n:gnosis+8". The simple single-number syntax with no modifiers is also still understood. Dice pool expressions are translated into a Vec of "Amount" objects, stored by the DicePool struct. They have an operator (+ or -) and either a number or variable name. When the dice pool is rolled, this list of Amonuts are is collapsed into a single number that is rolled, as it was before the refactor. The following changes were made to the dice rolling code: - Store Vec<Amount> on DicePool instead of single number to roll. - New struct RolledDicePool to store result of a dice pool roll. - Remove Display trait from DicePool, move it over to RolledDicePool. - Separate extra dice pool info into DicePoolModifiers. - DicePoolModifiers is shared between DicePool and RolledDicePool. - Dice parsing and rolling now return standard Result objects. This commit does NOT enable support of actually using variables. Any dice pool roll containing a variable will result in an eror. The command parser was also rewritten to use combine and rely on the standard Result pattern.
2020-10-04 21:32:50 +00:00
#[error("legacy parsing error")]
NomParserError(nom::error::ErrorKind),
#[error("legacy parsing error: not enough data")]
NomParserIncomplete,
#[error("variables not yet supported")]
VariablesNotSupported,
Add database and storage of user variables. This commit introduces the Sled embedded key-value store for keeping track of user variables on a per-room basis. Extensive changes were made to the command module to separate concerns and also pass the database "connection" down the line. - A new "Context" object was created to hold information and state needed for command execution (namely the database). - Database is very simple for now, storing only user variables. Refactoring later for storing more complicated types. - State actor moved into Actors struct, in preparation for either more actors, or ripping the whole thing out entirely. - Other modules are also more properly separated, notably the config module is entirely self-contained.
2020-10-15 16:52:08 +00:00
Allow up to 50 commands per message. If the amount of commands in a single message is greater, the bot will now return an error. Includes slight refactoring of command execution code to make use of streams for async iter-like mapping of the command list. Fixes #24.
2021-02-02 21:41:16 +00:00
#[error("too many commands or message was too large")]
MessageTooLarge,
Update variables on advancement rolls.
2021-05-13 20:52:01 +00:00
#[error("could not convert to proper integer type")]
TryFromIntError(#[from] std::num::TryFromIntError),
Consider command execution secure when proper conditions are met. - If the room is end-to-end encrypted. - If only the sending user and the bot are present in the room. This lays groundwork for sensitive commands like registering a user account with the bot.
2021-05-21 22:01:52 +00:00
#[error("identifier error: {0}")]
IdentifierError(#[from] matrix_sdk::identifiers::Error),
Functional user account registration.
2021-05-22 14:52:32 +00:00
#[error("password creation error: {0}")]
PasswordCreationError(argon2::Error),
Add check password command.
2021-05-22 22:25:00 +00:00
#[error("account does not exist, or password incorrect")]
AuthenticationError,
Add an account deletion command.
2021-05-22 23:12:17 +00:00
#[error("user account does not exist, try registering")]
AccountDoesNotExist,
Separate registering and linking accounts. Can register an account with the bot to manage variables and stuff in private room, and then separately "link" it with a password, which makes it available to anything using the bot API (aka web app). Can also unlink and unregister. Check command no longer validates password. It just checks and reports your account status.
2021-05-26 15:28:59 +00:00
#[error("user account already exists")]
AccountAlreadyExists,
Implement Actix for state, refactor bot code. Instead of using an Arc Mutex for state management embedded directly into the bot, utilize actor pattern, with the idea that this will be much more useful than simply logging a message once in the future. This also refactors the bot code so that instead of a single run_bot function, the DiceBot struct now has a run() method attached to it. This also necessitated changes and cleanup to the dicebot main, which is for the better anyhow. The error and config types are also now in their own files, and implemented for more in-depth use cases.
2020-09-28 21:35:05 +00:00
}
Implement support for user variables in CoC dice rolling. Also comes with reorganization of the dice rolling code to centralize the variable -> dice amount logic, and changes the way the results of those rolls are displayed.
2020-11-04 20:09:39 +00:00
#[derive(Error, Debug)]
pub enum DiceRollingError {
#[error("variable not found: {0}")]
VariableNotFound(String),
#[error("invalid amount")]
InvalidAmount,
#[error("dice pool expression too large")]
ExpressionTooLarge,
}