Skip to content

Commit

Permalink
refactor(core): plugin initialization return value (#1575)
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasfernog committed Apr 22, 2021
1 parent f708ff8 commit 508eddc
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .changes/plugin-initialization-result.md
@@ -0,0 +1,5 @@
---
"tauri": patch
---

Change plugin trait `initialization` return type to `std::result::Result<(), Box<dyn std::error::Error>>`.
3 changes: 3 additions & 0 deletions core/tauri/src/error.rs
Expand Up @@ -57,6 +57,9 @@ pub enum Error {
#[cfg(feature = "updater")]
#[error("Updater: {0}")]
TauriUpdater(#[from] crate::updater::Error),
/// Error initializing plugin.
#[error("failed to initialize plugin `{0}`: {1}")]
PluginInitialization(String, String),
}

impl From<serde_json::Error> for Error {
Expand Down
9 changes: 7 additions & 2 deletions core/tauri/src/plugin.rs
Expand Up @@ -12,14 +12,17 @@ use crate::{
use serde_json::Value as JsonValue;
use std::collections::HashMap;

/// The plugin result type.
pub type Result<T> = std::result::Result<T, Box<dyn std::error::Error>>;

/// The plugin interface.
pub trait Plugin<M: Params>: Send {
/// The plugin name. Used as key on the plugin config object.
fn name(&self) -> &'static str;

/// Initialize the plugin.
#[allow(unused_variables)]
fn initialize(&mut self, config: JsonValue) -> crate::Result<()> {
fn initialize(&mut self, config: JsonValue) -> Result<()> {
Ok(())
}

Expand Down Expand Up @@ -69,7 +72,9 @@ impl<M: Params> PluginStore<M> {
/// Initializes all plugins in the store.
pub(crate) fn initialize(&mut self, config: &PluginConfig) -> crate::Result<()> {
self.store.values_mut().try_for_each(|plugin| {
plugin.initialize(config.0.get(plugin.name()).cloned().unwrap_or_default())
plugin
.initialize(config.0.get(plugin.name()).cloned().unwrap_or_default())
.map_err(|e| crate::Error::PluginInitialization(plugin.name().to_string(), e.to_string()))
})
}

Expand Down

0 comments on commit 508eddc

Please sign in to comment.