nu-zenoh 0.3.0

Nu-Zenoh integration
Documentation 
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

//
// Copyright (c) 2025 ZettaScale Technology
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
//
// Contributors:
//   ZettaScale Zenoh Team, <zenoh@zettascale.tech>
//

use std::time::Instant;

use nu_engine::CallExt;
use nu_protocol::{
    engine::{Call, Command, EngineState, Stack},
    record,
    shell_error::generic::GenericError,
    IntoValue, ListStream, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value,
};
use zenoh::{config::WhatAmIMatcher, scouting::Hello, Config, Wait};

use crate::{
    call_ext2::CallExt2, conv, interruptible_channel::InterruptibleChannel,
    signature_ext::SignatureExt, State,
};

#[derive(Clone)]
pub(crate) struct Scout {
    _state: State,
}

impl Scout {
    pub(crate) fn new(state: State) -> Self {
        Self { _state: state }
    }
}

impl Command for Scout {
    fn name(&self) -> &str {
        "zenoh scout"
    }

    fn signature(&self) -> Signature {
        // FIXME: add a config option?
        Signature::build(self.name())
            .named("timeout", SyntaxShape::Duration, "Scouting timeout", None)
            .zenoh_category()
            .config()
            .input_output_type(Type::Nothing, Type::list(Type::record()))
    }

    fn description(&self) -> &str {
        "Scout the Zenoh network"
    }

    fn run(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        call: &Call,
        _input: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        let span = call.head;

        const SCOUT_CHANNEL_SIZE: usize = 256;
        let (tx, rx) = flume::bounded(SCOUT_CHANNEL_SIZE);

        let config_record = call.opt::<Value>(engine_state, stack, 0)?;

        let config = match config_record {
            Some(val @ Value::Record { .. }) => {
                let json_value = conv::value_to_json_value(engine_state, &val, call.head, false)?;
                zenoh::Config::from_json5(&json_value.to_string()).map_err(|e| {
                    nu_protocol::LabeledError::new("Failed to parse config record")
                        .with_label(format!("Could not parse config record: {e}"), call.head)
                })?
            }
            Some(_) => {
                return Err(ShellError::Generic(
                    GenericError::new("Invalid config type", "Config must be a record", call.head)
                        .with_help("Provide a record with Zenoh configuration options"),
                ));
            }
            None => Config::default(),
        };

        let scout = zenoh::scout(WhatAmIMatcher::empty().client().peer().router(), config)
            .callback(move |scout| {
                let _ = tx.send(scout);
            })
            .wait()
            .map_err(|e| {
                nu_protocol::LabeledError::new("Scout operation failed")
                    .with_label(format!("Zenoh scout failed: {e}"), call.head)
            })?;

        fn hello_to_value(hello: &Hello, span: Span) -> Value {
            record!(
                    "zid" => hello.zid().to_string().into_value(span),
                    "whatami" => hello.whatami().to_string().into_value(span),
                    "locators" => hello.locators().iter().map(|l| l.to_string().into_value(span)).collect::<Vec<_>>().into_value(span),
                )
                .into_value(span)
        }

        if let Some(timeout) = call.timeout(engine_state, stack)? {
            let deadline = Instant::now() + timeout;
            let mut values = Vec::new();

            while let Ok(hello) = rx.recv_deadline(deadline) {
                values.push(hello_to_value(&hello, span))
            }

            Ok(PipelineData::Value(Value::list(values, span), None))
        } else {
            let iter = InterruptibleChannel::with_data(rx, engine_state.signals().clone(), scout)
                .map(move |hello| hello_to_value(&hello, span));

            Ok(ListStream::new(iter, span, engine_state.signals().clone()).into())
        }
    }
}