wp-core-connectors 0.3.0

Core connector registry and sink runtimes for WarpParse
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
use crate::{builtin, registry};
use async_trait::async_trait;
use orion_error::conversion::{SourceErr, ToStructError};
use wp_connector_api::SinkReason;
use wp_connector_api::SinkResult;
use wp_connector_api::{
    AsyncCtrl, AsyncRawDataSink, AsyncRecordSink, ConnectorDef, SinkBuildCtx, SinkDefProvider,
    SinkFactory, SinkHandle, SinkSpec as ResolvedSinkSpec,
};
use wp_data_fmt::RecordFormatter; // for fmt_record
// no extra orion-error/conf helpers needed after route-builder removal

use crate::net::transport::{
    BackoffMode, NetSendPolicy, NetWriter, Transport, net_backoff_adaptive,
};
use crate::protocol::syslog::{EmitMessage, SyslogEncoder};

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum SyslogProtocol {
    Udp,
    Tcp,
}

impl SyslogProtocol {
    fn as_str(self) -> &'static str {
        match self {
            Self::Udp => "udp",
            Self::Tcp => "tcp",
        }
    }
}

#[derive(Clone, Debug)]
struct SyslogSinkSpec {
    addr: String,
    port: u16,
    protocol: SyslogProtocol,
    app_name: Option<String>,
}

impl SyslogSinkSpec {
    fn target_addr(&self) -> String {
        format!("{}:{}", self.addr, self.port)
    }

    fn resolved_app_name(&self, fallback: &str) -> String {
        self.app_name
            .as_ref()
            .map(|s| s.trim())
            .filter(|s| !s.is_empty())
            .map(|s| s.to_string())
            .unwrap_or_else(|| fallback.to_string())
    }
}

fn syslog_conf_from_spec(spec: &ResolvedSinkSpec) -> SinkResult<SyslogSinkSpec> {
    let addr = spec
        .params
        .get("addr")
        .and_then(|v| v.as_str())
        .ok_or_else(|| {
            SinkReason::core_conf()
                .to_err()
                .with_detail("syslog.addr must be a string")
        })?;
    if let Some(i) = spec.params.get("port").and_then(|v| v.as_i64())
        && !(1..=65535).contains(&i)
    {
        return Err(SinkReason::core_conf()
            .to_err()
            .with_detail("syslog.port must be in 1..=65535"));
    }
    if let Some(p) = spec.params.get("protocol").and_then(|v| v.as_str()) {
        let v = p.to_ascii_lowercase();
        if v != "udp" && v != "tcp" {
            return Err(SinkReason::core_conf()
                .to_err()
                .with_detail("syslog.protocol must be 'udp' or 'tcp'"));
        }
    }
    if let Some(v) = spec.params.get("app_name")
        && v.as_str().is_none()
    {
        return Err(SinkReason::core_conf()
            .to_err()
            .with_detail("syslog.app_name must be a string"));
    }
    let port = spec
        .params
        .get("port")
        .and_then(|v| v.as_i64())
        .unwrap_or(514) as u16;
    let protocol = spec
        .params
        .get("protocol")
        .and_then(|v| v.as_str())
        .unwrap_or("udp");
    let protocol = match protocol.to_ascii_lowercase().as_str() {
        "udp" => SyslogProtocol::Udp,
        "tcp" => SyslogProtocol::Tcp,
        _ => {
            return Err(SinkReason::core_conf()
                .to_err()
                .with_detail("syslog.protocol must be 'udp' or 'tcp'"));
        }
    };
    let app_name = spec
        .params
        .get("app_name")
        .and_then(|v| v.as_str())
        .map(|v| v.to_string());
    Ok(SyslogSinkSpec {
        addr: addr.to_string(),
        port,
        protocol,
        app_name,
    })
}

pub struct SyslogSink {
    // Underlying transport writer (UDP/TCP)
    writer: NetWriter,
    // Simple counter to emit first-send debug without spamming logs
    sent_cnt: u64,
    encoder: SyslogEncoder,
    hostname: String,
    app_name: String,
}

impl SyslogSink {
    async fn udp(addr: &str, app_name: Option<String>) -> SinkResult<Self> {
        let writer = NetWriter::connect_udp(addr)
            .await
            .source_err(SinkReason::Sink, "syslog udp connect")?;
        // Log effective endpoints once (target/local)
        if let Transport::Udp(sock) = &writer.transport {
            if let Ok(local_addr) = sock.local_addr() {
                log::info!(
                    "syslog udp sink connected: target={} local={}",
                    addr,
                    local_addr
                );
            } else {
                log::info!("syslog udp sink connected: target={}", addr);
            }
        } else {
            log::info!("syslog udp sink connected: target={}", addr);
        }
        Ok(Self::with_writer(writer, app_name))
    }
    async fn tcp(addr: &str, app_name: Option<String>, rate_limit_rps: usize) -> SinkResult<Self> {
        // Align to TcpSink: enable backpressure when unlimited
        let mode = if rate_limit_rps == 0 {
            BackoffMode::ForceOn
        } else {
            BackoffMode::ForceOff
        };
        let writer = NetWriter::connect_tcp_with_policy(
            addr,
            NetSendPolicy {
                rate_limit_rps,
                backoff_mode: mode,
                adaptive: net_backoff_adaptive(),
            },
        )
        .await
        .source_err(SinkReason::Sink, "syslog tcp connect")?;
        log::info!("syslog tcp sink connected: target={}", addr);
        Ok(Self::with_writer(writer, app_name))
    }

    fn current_process_name() -> String {
        std::env::current_exe()
            .ok()
            .and_then(|p| p.file_stem().map(|s| s.to_string_lossy().to_string()))
            .filter(|s| !s.is_empty())
            .unwrap_or_else(|| "wp-engine".to_string())
    }

    fn with_writer(writer: NetWriter, app_name: Option<String>) -> Self {
        let hostname = hostname::get()
            .ok()
            .and_then(|h| h.into_string().ok())
            .unwrap_or_else(|| "localhost".to_string());
        Self {
            writer,
            sent_cnt: 0,
            encoder: SyslogEncoder::new(),
            hostname,
            app_name: app_name.unwrap_or_else(Self::current_process_name),
        }
    }
}

#[async_trait]
impl AsyncCtrl for SyslogSink {
    async fn stop(&mut self) -> SinkResult<()> {
        // For TCP, try graceful shutdown and drain
        if let Transport::Tcp(_) = &self.writer.transport {
            self.writer.shutdown().await?;
            self.writer
                .drain_until_empty(std::time::Duration::from_secs(10))
                .await;
        }
        Ok(())
    }
    async fn reconnect(&mut self) -> SinkResult<()> {
        Ok(())
    }
}

#[async_trait]
impl AsyncRecordSink for SyslogSink {
    async fn sink_record(&mut self, data: &wp_model_core::model::DataRecord) -> SinkResult<()> {
        // Format record to raw text then reuse raw path
        let raw = wp_data_fmt::Raw::new().fmt_record(data);
        AsyncRawDataSink::sink_str(self, raw.as_str()).await
    }

    async fn sink_records(
        &mut self,
        data: Vec<std::sync::Arc<wp_model_core::model::DataRecord>>,
    ) -> SinkResult<()> {
        for record in data {
            self.sink_record(&record).await?;
        }
        Ok(())
    }
}

#[async_trait]
impl AsyncRawDataSink for SyslogSink {
    async fn sink_str(&mut self, data: &str) -> SinkResult<()> {
        // Format as RFC3164 syslog message
        let mut emit = EmitMessage::new(data);
        emit.priority = 13;
        emit.hostname = Some(self.hostname.as_str());
        emit.app_name = Some(self.app_name.as_str());
        emit.append_newline = matches!(self.writer.transport, Transport::Tcp(_));

        let syslog_msg = self.encoder.encode_rfc3164(&emit);
        let payload = syslog_msg.as_ref();
        if self.sent_cnt == 0 {
            let tag = match self.writer.transport {
                Transport::Udp(_) => "udp",
                Transport::Tcp(_) => "tcp",
                #[cfg(test)]
                Transport::Null => "null",
            };
            log::info!(
                "syslog {} sink first-send: msg_len={} preview='{}'",
                tag,
                payload.len(),
                String::from_utf8_lossy(&payload[..payload.len().min(64)])
            );
        }
        log::trace!(
            "syslog {} sink send seq={} bytes={}",
            match self.writer.transport {
                Transport::Udp(_) => "udp",
                Transport::Tcp(_) => "tcp",
                #[cfg(test)]
                Transport::Null => "null",
            },
            self.sent_cnt + 1,
            payload.len()
        );
        self.writer.write(payload).await?;
        self.sent_cnt = self.sent_cnt.saturating_add(1);
        Ok(())
    }
    async fn sink_bytes(&mut self, _data: &[u8]) -> SinkResult<()> {
        let text = String::from_utf8_lossy(_data);
        self.sink_str(text.as_ref()).await
    }

    async fn sink_str_batch(&mut self, data: Vec<&str>) -> SinkResult<()> {
        if data.is_empty() {
            return Ok(());
        }
        let is_tcp = matches!(self.writer.transport, Transport::Tcp(_));
        let mut total = 0usize;
        for s in &data {
            total = total.saturating_add(s.len() + 64);
        }
        let mut buf: Vec<u8> = Vec::with_capacity(total);
        for str_data in data.iter() {
            let mut emit = EmitMessage::new(str_data);
            emit.priority = 13;
            emit.hostname = Some(self.hostname.as_str());
            emit.app_name = Some(self.app_name.as_str());
            emit.append_newline = is_tcp;
            let msg = self.encoder.encode_rfc3164(&emit);
            buf.extend_from_slice(msg.as_ref());
        }
        let record_cnt = data.len();
        log::trace!(
            "syslog {} sink send-batch seq={} records={} bytes={}",
            if is_tcp { "tcp" } else { "udp" },
            self.sent_cnt + 1,
            record_cnt,
            buf.len()
        );
        self.writer.write(&buf).await?;
        self.sent_cnt = self.sent_cnt.saturating_add(1);
        Ok(())
    }

    async fn sink_bytes_batch(&mut self, data: Vec<&[u8]>) -> SinkResult<()> {
        if data.is_empty() {
            return Ok(());
        }
        let texts: Vec<String> = data
            .into_iter()
            .map(|bytes| String::from_utf8_lossy(bytes).into_owned())
            .collect();
        let refs: Vec<&str> = texts.iter().map(|s| s.as_str()).collect();
        self.sink_str_batch(refs).await
    }
}

pub fn register_factory_syslog() {
    registry::register_sink_factory(SyslogFactory);
}

// ---- Runtime factory from resolved route (for future decoupling) ----

pub struct SyslogFactory;

#[async_trait]
impl SinkFactory for SyslogFactory {
    fn kind(&self) -> &'static str {
        "syslog"
    }
    fn validate_spec(&self, spec: &ResolvedSinkSpec) -> SinkResult<()> {
        syslog_conf_from_spec(spec)?;
        Ok(())
    }
    async fn build(&self, spec: &ResolvedSinkSpec, _ctx: &SinkBuildCtx) -> SinkResult<SinkHandle> {
        let conf = syslog_conf_from_spec(spec)?;
        let proto = conf.protocol;
        let target = conf.target_addr();
        // Log resolved target to aid diagnosing mismatched params
        log::info!(
            "syslog sink build: target={} protocol={}",
            target,
            proto.as_str()
        );
        let app_name = conf.resolved_app_name(&spec.name);

        // Build runtime sink directly; pass rate_limit_rps to TCP writer
        let runtime = match proto {
            SyslogProtocol::Udp => SyslogSink::udp(target.as_str(), Some(app_name.clone())).await?,
            SyslogProtocol::Tcp => {
                SyslogSink::tcp(target.as_str(), Some(app_name.clone()), _ctx.rate_limit_rps)
                    .await?
            }
        };
        Ok(SinkHandle::new(Box::new(runtime)))
    }
}

impl SinkDefProvider for SyslogFactory {
    fn sink_def(&self) -> ConnectorDef {
        builtin::sink_def("syslog_sink").expect("builtin sink def missing: syslog_sink")
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;
    use tokio::net::TcpListener;

    fn mk_spec(params: &[(&str, serde_json::Value)]) -> ResolvedSinkSpec {
        let mut map = wp_connector_api::ParamMap::new();
        for (k, v) in params {
            map.insert((*k).to_string(), v.clone());
        }
        ResolvedSinkSpec {
            group: "g".into(),
            name: "syslog_demo".into(),
            kind: "syslog".into(),
            connector_id: "syslog_sink".into(),
            params: map,
            filter: None,
        }
    }

    #[test]
    fn syslog_conf_defaults_to_udp_514() {
        let spec = mk_spec(&[("addr", json!("127.0.0.1"))]);
        let conf = syslog_conf_from_spec(&spec).expect("parse syslog spec");
        assert_eq!(conf.addr, "127.0.0.1");
        assert_eq!(conf.port, 514);
        assert_eq!(conf.protocol, SyslogProtocol::Udp);
        assert_eq!(conf.target_addr(), "127.0.0.1:514");
    }

    #[test]
    fn syslog_conf_accepts_tcp_and_custom_app_name() {
        let spec = mk_spec(&[
            ("addr", json!("10.0.0.1")),
            ("port", json!(1514)),
            ("protocol", json!("TCP")),
            ("app_name", json!("my_app")),
        ]);
        let conf = syslog_conf_from_spec(&spec).expect("parse syslog spec");
        assert_eq!(conf.addr, "10.0.0.1");
        assert_eq!(conf.port, 1514);
        assert_eq!(conf.protocol, SyslogProtocol::Tcp);
        assert_eq!(conf.resolved_app_name("fallback"), "my_app");
    }

    #[test]
    fn syslog_conf_falls_back_when_app_name_is_blank() {
        let spec = mk_spec(&[("addr", json!("127.0.0.1")), ("app_name", json!("   "))]);
        let conf = syslog_conf_from_spec(&spec).expect("parse syslog spec");
        assert_eq!(conf.resolved_app_name("fallback_app"), "fallback_app");
    }

    #[test]
    fn syslog_conf_rejects_invalid_protocol() {
        let spec = mk_spec(&[("addr", json!("127.0.0.1")), ("protocol", json!("unix"))]);
        let err = syslog_conf_from_spec(&spec).expect_err("protocol should be rejected");
        assert!(err.to_string().contains("syslog.protocol"));
    }

    #[test]
    fn syslog_conf_rejects_invalid_port() {
        let spec = mk_spec(&[("addr", json!("127.0.0.1")), ("port", json!(70000))]);
        let err = syslog_conf_from_spec(&spec).expect_err("port should be rejected");
        assert!(err.to_string().contains("syslog.port"));
    }

    #[test]
    fn syslog_conf_rejects_non_string_app_name() {
        let spec = mk_spec(&[("addr", json!("127.0.0.1")), ("app_name", json!(123))]);
        let err = syslog_conf_from_spec(&spec).expect_err("app_name should be rejected");
        assert!(err.to_string().contains("syslog.app_name"));
    }

    #[tokio::test]
    async fn syslog_sink_tcp_emits_rfc3164_message() {
        let listener = match TcpListener::bind("127.0.0.1:0").await {
            Ok(lst) => lst,
            Err(e) if e.kind() == std::io::ErrorKind::PermissionDenied => return,
            Err(e) => panic!("bind test listener: {}", e),
        };
        let addr = listener.local_addr().expect("addr");

        let mut sink = SyslogSink::tcp(addr.to_string().as_str(), Some("wpgen".into()), 0)
            .await
            .expect("build tcp sink");

        let accept_task = tokio::spawn(async move {
            let (mut stream, _) = listener.accept().await.expect("accept");
            let mut buf = Vec::new();
            use tokio::io::AsyncReadExt;
            stream.read_to_end(&mut buf).await.expect("read");
            buf
        });

        sink.sink_str("syslog body").await.expect("sink str");
        sink.stop().await.expect("stop");

        let bytes = accept_task.await.expect("join");
        let text = String::from_utf8(bytes).expect("utf8");
        assert!(
            text.starts_with("<13>"),
            "missing priority header: {}",
            text
        );
        assert!(text.contains("wpgen"), "app name missing");
        assert!(text.ends_with('\n'), "tcp syslog should end with newline");
        assert!(
            text.trim_end().ends_with("syslog body"),
            "body mismatch: {}",
            text
        );
    }
}