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
127
128
129
130
131

//
// 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 nu_engine::{CallExt, ClosureEval};
use nu_protocol::{
    engine::{Call, Closure, Command, EngineState, Stack},
    ListStream, PipelineData, ShellError, Signature, SyntaxShape, Type, Value,
};
use zenoh::Wait;

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

#[derive(Clone)]
pub(crate) struct Queryable {
    state: State,
}

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

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

    fn signature(&self) -> Signature {
        Signature::build(self.name())
            .input_output_type(Type::Nothing, Type::list(Type::record()))
            .session()
            .zenoh_category()
            .keyexpr()
            .required(
                "hanlder",
                SyntaxShape::Closure(Some(vec![SyntaxShape::Any])),
                "handler",
            )
            .complete()
            .allowed_origin()
    }

    fn description(&self) -> &str {
        "Declare a queryable"
    }

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

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

        let handler = call.req::<Closure>(engine_state, stack, 1)?;
        let mut closure = ClosureEval::new(engine_state, stack, handler);
        let signals = engine_state.signals().clone();
        let engine = engine_state.clone();

        let queryable = self
            .state
            .with_session(&call.session(engine_state, stack)?, |sess| {
                let mut queryable = sess
                    .declare_queryable(call.req::<String>(engine_state, stack, 0)?)
                    .callback(move |query| {
                        let _ = tx.send(query);
                    });

                if let Some(origin) = call.allowed_origin(engine_state, stack)? {
                    queryable = queryable.allowed_origin(origin);
                }

                if let Some(complete) = call.complete(engine_state, stack)? {
                    queryable = queryable.complete(complete);
                }

                queryable.wait()
            })?
            .map_err(|e| {
                nu_protocol::LabeledError::new("Queryable declaration failed")
                    .with_label(format!("Zenoh queryable failed: {e}"), span)
            })?;

        let iter = InterruptibleChannel::with_data(rx, engine.signals().clone(), queryable).map(
            move |query| {
                let value = conv::query_to_record_value(&query, span);

                match closure.run_with_value(value) {
                    Ok(stream) => {
                        for value in stream {
                            let bytes = match conv::value_to_bytes(&value) {
                                Ok(bytes) => bytes,
                                Err(err) => return Value::error(err, span),
                            };

                            if let Err(err) = query.reply(query.key_expr(), bytes).wait() {
                                return Value::error(ShellError::from(err), span);
                            }
                        }

                        Value::nothing(span)
                    }
                    Err(err) => match query.reply_err(err.to_string()).wait() {
                        Ok(()) => Value::nothing(span),
                        Err(err) => Value::error(ShellError::from(err), span),
                    },
                }
            },
        );

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