gear_node_wrapper/
instance.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
// This file is part of Gear.
//
// Copyright (C) 2024 Gear Technologies Inc.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

use crate::Log;
use anyhow::{anyhow, Result};
use std::{net::SocketAddrV4, process::Child};

/// The instance of the node
///
/// NOTE: This instance should be built from [`Node`].
pub struct NodeInstance {
    /// RPC address of this node
    pub address: SocketAddrV4,
    /// Node log interface
    pub(crate) log: Log,
    /// Node process
    pub(crate) process: Child,
}

impl NodeInstance {
    /// Get the RPC address in string.
    ///
    /// NOTE: If you want [`SocketAddrV4`], just call [`NodeInstance::address`]
    pub fn ws(&self) -> String {
        format!("ws://{}", self.address)
    }

    /// Get the recent cached node logs, the max limit is 256 lines.
    pub fn logs(&self) -> Result<Vec<String>> {
        let Ok(logs) = self.log.logs.read() else {
            return Err(anyhow!("Failed to read logs from the node process."));
        };

        Ok(logs.clone().into_vec())
    }
}

impl Drop for NodeInstance {
    fn drop(&mut self) {
        self.process.kill().expect("Unable to kill node process.")
    }
}