Add updater thread + Updater related functions (#253)

* first attempt at adding updater thread * rustfmt * rustfmt * many lifetimes made static to allow api to spawn separate thread * add first pass at updater thread functionality * rustfmt * add mpsc for returning status from update functions * rustfmt * add stop state, ensure update is triggered by wallet functions when wallet updater is running * rustfmt * add update status function to owner API, V3 owner api functions * rustfmt * change update warning * adding tests for new updater control functions * documentation updates * rustfmt
2026-10-17 07:11:36 +02:00 · 2019-11-18 10:49:51 +00:00
parent 355f08498c
commit e74c0e2571
17 changed files with 944 additions and 170 deletions
@@ -0,0 +1,122 @@
+// Copyright 2019 The Grin Developers
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//! Test a wallet repost command
+#[macro_use]
+extern crate log;
+extern crate grin_wallet_api as api;
+extern crate grin_wallet_controller as wallet;
+extern crate grin_wallet_impls as impls;
+extern crate grin_wallet_libwallet as libwallet;
+
+use crate::libwallet::api_impl::owner_updater::{start_updater_log_thread, StatusMessage};
+use grin_wallet_util::grin_core as core;
+
+use self::libwallet::{InitTxArgs, Slate};
+use impls::test_framework::{self, LocalWalletClient};
+use impls::{PathToSlate, SlateGetter as _, SlatePutter as _};
+use std::sync::mpsc::channel;
+use std::thread;
+use std::time::Duration;
+
+#[macro_use]
+mod common;
+use common::{clean_output_dir, create_wallet_proxy, setup};
+
+/// updater thread test impl
+fn updater_thread_test_impl(test_dir: &'static str) -> Result<(), libwallet::Error> {
+	// Create a new proxy to simulate server and wallet responses
+	let mut wallet_proxy = create_wallet_proxy(test_dir);
+	let chain = wallet_proxy.chain.clone();
+
+	// Create a new wallet test client, and set its queues to communicate with the
+	// proxy
+	create_wallet_and_add!(
+		client1,
+		wallet1,
+		mask1_i,
+		test_dir,
+		"wallet1",
+		None,
+		&mut wallet_proxy,
+		false
+	);
+	let mask1 = (&mask1_i).as_ref();
+	create_wallet_and_add!(
+		client2,
+		wallet2,
+		mask2_i,
+		test_dir,
+		"wallet2",
+		None,
+		&mut wallet_proxy,
+		false
+	);
+	let mask2 = (&mask2_i).as_ref();
+
+	// Set the wallet proxy listener running
+	thread::spawn(move || {
+		if let Err(e) = wallet_proxy.run() {
+			error!("Wallet Proxy error: {}", e);
+		}
+	});
+
+	// few values to keep things shorter
+	let reward = core::consensus::REWARD;
+
+	// add some accounts
+	wallet::controller::owner_single_use(wallet1.clone(), mask1, |api, m| {
+		api.create_account_path(m, "mining")?;
+		api.create_account_path(m, "listener")?;
+		Ok(())
+	})?;
+
+	// add some accounts
+	wallet::controller::owner_single_use(wallet2.clone(), mask2, |api, m| {
+		api.create_account_path(m, "account1")?;
+		api.create_account_path(m, "account2")?;
+		Ok(())
+	})?;
+
+	// Get some mining done
+	{
+		wallet_inst!(wallet1, w);
+		w.set_parent_key_id_by_name("mining")?;
+	}
+	let mut bh = 10u64;
+	let _ =
+		test_framework::award_blocks_to_wallet(&chain, wallet1.clone(), mask1, bh as usize, false);
+
+	let owner_api = api::Owner::new(wallet1);
+	owner_api.start_updater(mask1, Duration::from_secs(5))?;
+
+	// let updater thread run a bit
+	thread::sleep(Duration::from_secs(10));
+
+	let messages = owner_api.get_updater_messages(1000)?;
+	assert_eq!(messages.len(), 34);
+
+	owner_api.stop_updater()?;
+	thread::sleep(Duration::from_secs(2));
+	Ok(())
+}
+
+#[test]
+fn updater_thread() {
+	let test_dir = "test_output/updater_thread";
+	setup(test_dir);
+	if let Err(e) = updater_thread_test_impl(test_dir) {
+		panic!("Libwallet Error: {} - {}", e, e.backtrace().unwrap());
+	}
+	clean_output_dir(test_dir);
+}