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
use crate::builtin;
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

use crate::net::transport::{BackoffMode, NetSendPolicy, NetWriter, net_backoff_adaptive};

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum Framing {
    Line,
    Len,
}

#[derive(Clone, Debug)]
struct TcpSinkSpec {
    addr: String,
    port: u16,
    framing: Framing,
}

impl TcpSinkSpec {
    fn from_resolved(spec: &ResolvedSinkSpec) -> SinkResult<Self> {
        let addr = match spec.params.get("addr").and_then(|v| v.as_str()) {
            Some(s) => s.to_string(),
            None => {
                return Err(SinkReason::core_conf()
                    .to_err()
                    .with_detail("tcp.addr must be a string"));
            }
        };
        let port = match spec.params.get("port").and_then(|v| v.as_i64()) {
            Some(p) if (1..=65535).contains(&p) => p as u16,
            Some(_) => {
                return Err(SinkReason::core_conf()
                    .to_err()
                    .with_detail("tcp.port must be in 1..=65535"));
            }
            None => 9000,
        };
        let framing = spec
            .params
            .get("framing")
            .and_then(|v| v.as_str())
            .unwrap_or("line");
        let framing = match framing.to_ascii_lowercase().as_str() {
            "len" | "length" => Framing::Len,
            "line" => Framing::Line,
            _ => {
                return Err(SinkReason::core_conf()
                    .to_err()
                    .with_detail("tcp.framing must be 'line' or 'len'"));
            }
        };
        Self::ensure_bool(spec, "max_backoff")?;
        Self::ensure_bool(spec, "sendq_backpressure")?;
        Ok(Self {
            addr,
            port,
            framing,
        })
    }

    fn ensure_bool(spec: &ResolvedSinkSpec, key: &str) -> SinkResult<()> {
        if let Some(v) = spec.params.get(key)
            && v.as_bool().is_none()
        {
            return Err(SinkReason::core_conf()
                .to_err()
                .with_detail(format!("tcp.{key} must be a boolean")));
        }
        Ok(())
    }

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

// Max seconds to wait for kernel TCP send-queue to drain at shutdown
const TCP_DRAIN_MAX_SECS: u64 = 10;

pub struct TcpSink {
    writer: NetWriter,
    framing: Framing,
    sent_cnt: u64,
}

impl TcpSink {
    async fn connect(spec: &TcpSinkSpec, rate_limit_rps: usize) -> SinkResult<Self> {
        let target = spec.target_addr();
        // 根据限速目标决定策略:
        // - rate_limit_rps == 0(无限速):启用背压能力(ForceOn)——仅在水位/包型需要时退让;
        // - rate_limit_rps > 0(限速):关闭背压能力(ForceOff),避免与源端限速叠加造成双重退让。
        let mode = if rate_limit_rps == 0 {
            BackoffMode::ForceOn
        } else {
            BackoffMode::ForceOff
        };
        let writer = NetWriter::connect_tcp_with_policy(
            &target,
            NetSendPolicy {
                rate_limit_rps,
                backoff_mode: mode,
                adaptive: net_backoff_adaptive(),
            },
        )
        .await
        .source_err(SinkReason::Sink, "tcp sink connect tcp")?;
        log::info!("tcp sink connected: target={}", target);
        Ok(Self {
            writer,
            framing: spec.framing,
            sent_cnt: 0,
        })
    }
}

#[async_trait]
impl AsyncCtrl for TcpSink {
    async fn stop(&mut self) -> SinkResult<()> {
        // Gracefully shutdown write side so peer can drain
        self.writer.shutdown().await?;
        // Best-effort kernel send-queue drain, capped 10s
        self.writer
            .drain_until_empty(std::time::Duration::from_secs(TCP_DRAIN_MAX_SECS))
            .await;
        Ok(())
    }
    async fn reconnect(&mut self) -> SinkResult<()> {
        Ok(())
    }
}

#[async_trait]
impl AsyncRecordSink for TcpSink {
    async fn sink_record(&mut self, data: &wp_model_core::model::DataRecord) -> SinkResult<()> {
        // 复用 Raw 格式化,随后走 raw 路径
        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 TcpSink {
    async fn sink_str(&mut self, data: &str) -> SinkResult<()> {
        let payload = build_payload_bytes(data.as_bytes(), self.framing);
        if self.sent_cnt == 0 {
            log::info!(
                "tcp sink first-send: framing={:?} msg_len={} preview='{}'",
                self.framing,
                payload.len(),
                &data.chars().take(64).collect::<String>()
            );
        }
        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 payload = build_payload_bytes(data, self.framing);
        if self.sent_cnt == 0 {
            log::info!(
                "tcp sink first-send(bytes): framing={:?} msg_len={}",
                self.framing,
                payload.len(),
            );
        }
        self.writer.write(&payload).await?;
        self.sent_cnt = self.sent_cnt.saturating_add(1);
        Ok(())
    }

    async fn sink_str_batch(&mut self, data: Vec<&str>) -> SinkResult<()> {
        if data.is_empty() {
            return Ok(());
        }

        // 批量处理:根据 framing 模式决定如何合并数据
        match self.framing {
            Framing::Line => {
                // Line 模式:合并所有字符串,确保每个都有换行符
                let mut total_len = 0;
                for str_data in &data {
                    total_len += str_data.len();
                    if str_data.as_bytes().last().is_none_or(|&b| b != b'\n') {
                        total_len += 1;
                    }
                }

                let mut buffer = Vec::with_capacity(total_len);
                for str_data in &data {
                    buffer.extend_from_slice(str_data.as_bytes());
                    if str_data.as_bytes().last().is_none_or(|&b| b != b'\n') {
                        buffer.push(b'\n');
                    }
                }

                // 一次性发送所有数据
                self.writer.write(&buffer).await?;
                self.sent_cnt = self.sent_cnt.saturating_add(1);
            }
            Framing::Len => {
                // Length 模式:每个消息需要独立的长度前缀,不能简单合并
                // 但仍然可以批量发送
                let mut buffers = Vec::with_capacity(data.len());
                for str_data in &data {
                    buffers.push(build_payload_bytes(str_data.as_bytes(), self.framing));
                }

                // 合并所有消息
                let total_len: usize = buffers.iter().map(|b| b.len()).sum();
                let mut combined = Vec::with_capacity(total_len);
                for buffer in buffers {
                    combined.extend_from_slice(&buffer);
                }

                self.writer.write(&combined).await?;
                self.sent_cnt = self.sent_cnt.saturating_add(data.len() as u64);
            }
        }

        Ok(())
    }

    async fn sink_bytes_batch(&mut self, data: Vec<&[u8]>) -> SinkResult<()> {
        if data.is_empty() {
            return Ok(());
        }

        match self.framing {
            Framing::Line => {
                let mut total_len = 0;
                for bytes_data in &data {
                    total_len += bytes_data.len();
                    if bytes_data.last().is_none_or(|&b| b != b'\n') {
                        total_len += 1;
                    }
                }

                let mut buffer = Vec::with_capacity(total_len);
                for bytes_data in &data {
                    buffer.extend_from_slice(bytes_data);
                    if bytes_data.last().is_none_or(|&b| b != b'\n') {
                        buffer.push(b'\n');
                    }
                }

                self.writer.write(&buffer).await?;
                self.sent_cnt = self.sent_cnt.saturating_add(1);
            }
            Framing::Len => {
                let mut combined = Vec::new();
                for bytes_data in &data {
                    combined.extend_from_slice(&build_payload_bytes(bytes_data, self.framing));
                }
                self.writer.write(&combined).await?;
                self.sent_cnt = self.sent_cnt.saturating_add(data.len() as u64);
            }
        }
        Ok(())
    }
}

// 小工具:将 Vec<u8> 适配为 fmt::Write
fn buf_writer(buf: &mut Vec<u8>) -> impl std::fmt::Write + '_ {
    struct W<'a>(&'a mut Vec<u8>);
    impl<'a> std::fmt::Write for W<'a> {
        fn write_str(&mut self, s: &str) -> std::fmt::Result {
            self.0.extend_from_slice(s.as_bytes());
            Ok(())
        }
    }
    W(buf)
}

pub struct TcpFactory;

#[async_trait]
impl SinkFactory for TcpFactory {
    fn kind(&self) -> &'static str {
        "tcp"
    }
    fn validate_spec(&self, spec: &ResolvedSinkSpec) -> SinkResult<()> {
        TcpSinkSpec::from_resolved(spec)?;
        Ok(())
    }
    async fn build(&self, spec: &ResolvedSinkSpec, ctx: &SinkBuildCtx) -> SinkResult<SinkHandle> {
        let resolved = TcpSinkSpec::from_resolved(spec)?;
        // Internal defaults: no ACK; auto-drain at shutdown.
        // 限速目标:由 SinkBuildCtx 统一传入,TcpSink 内部据此构建 SendPolicy。
        let runtime = TcpSink::connect(&resolved, ctx.rate_limit_rps).await?;
        Ok(SinkHandle::new(Box::new(runtime)))
    }
}

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

// No external ACK mode; keep sink simple

// --- pure helper for payload framing ---
fn build_payload_bytes(data: &[u8], framing: Framing) -> Vec<u8> {
    match framing {
        Framing::Line => {
            if data.last() == Some(&b'\n') {
                data.to_vec()
            } else {
                let mut buf = Vec::with_capacity(data.len() + 1);
                buf.extend_from_slice(data);
                buf.push(b'\n');
                buf
            }
        }
        Framing::Len => {
            let mut buf = Vec::with_capacity(16 + data.len());
            let _ = std::fmt::Write::write_fmt(
                &mut buf_writer(&mut buf),
                format_args!("{} ", data.len()),
            );
            buf.extend_from_slice(data);
            buf
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use tokio::io::AsyncReadExt;
    use tokio::net::TcpListener;
    use wp_connector_api::{AsyncRawDataSink, SinkFactory};

    #[tokio::test(flavor = "multi_thread")]
    async fn tcp_sink_sends_line() -> anyhow::Result<()> {
        if std::env::var("WP_NET_TESTS").unwrap_or_default() != "1" {
            return Ok(());
        }
        // server
        let listener = TcpListener::bind("127.0.0.1:0").await?;
        let port = listener.local_addr()?.port();
        let srv = tokio::spawn(async move {
            let (mut s, _) = listener.accept().await.unwrap();
            let mut buf = vec![0u8; 16];
            let n = s.read(&mut buf).await.unwrap();
            String::from_utf8_lossy(&buf[..n]).into_owned()
        });
        // sink
        let fac = TcpFactory;
        let mut params = toml::map::Map::new();
        params.insert("addr".into(), toml::Value::String("127.0.0.1".into()));
        params.insert("port".into(), toml::Value::Integer(port as i64));
        params.insert("framing".into(), toml::Value::String("line".into()));
        let spec = wp_connector_api::SinkSpec {
            group: String::new(),
            name: "t".into(),
            kind: "tcp".into(),
            connector_id: String::new(),
            params: wp_connector_api::parammap_from_toml_map(params),
            filter: None,
        };
        let ctx = wp_connector_api::SinkBuildCtx::new(std::env::current_dir().unwrap());
        let mut h = fac
            .build(&spec, &ctx)
            .await
            .map_err(|e| anyhow::anyhow!("{e}"))?;
        AsyncRawDataSink::sink_str(h.sink.as_mut(), "abc")
            .await
            .map_err(|e| anyhow::anyhow!("{e}"))?;
        let body = srv.await.unwrap();
        assert_eq!(body, "abc\n");
        Ok(())
    }

    #[test]
    fn payload_builder_line_and_len() {
        let p1 = build_payload_bytes(b"abc", Framing::Line);
        assert_eq!(p1, b"abc\n");
        let p2 = build_payload_bytes(b"hello", Framing::Len);
        assert_eq!(p2, b"5 hello");
    }

    #[tokio::test(flavor = "multi_thread")]
    async fn tcp_sink_sends_len() -> anyhow::Result<()> {
        if std::env::var("WP_NET_TESTS").unwrap_or_default() != "1" {
            return Ok(());
        }
        let listener = TcpListener::bind("127.0.0.1:0").await?;
        let port = listener.local_addr()?.port();
        let srv = tokio::spawn(async move {
            let (mut s, _) = listener.accept().await.unwrap();
            let mut buf = vec![0u8; 32];
            let n = s.read(&mut buf).await.unwrap();
            buf[..n].to_vec()
        });
        let fac = TcpFactory;
        let mut params = toml::map::Map::new();
        params.insert("addr".into(), toml::Value::String("127.0.0.1".into()));
        params.insert("port".into(), toml::Value::Integer(port as i64));
        params.insert("framing".into(), toml::Value::String("len".into()));
        let spec = wp_connector_api::SinkSpec {
            group: String::new(),
            name: "t".into(),
            kind: "tcp".into(),
            connector_id: String::new(),
            params: wp_connector_api::parammap_from_toml_map(params),
            filter: None,
        };
        let ctx = wp_connector_api::SinkBuildCtx::new(std::env::current_dir().unwrap());
        let mut h = fac
            .build(&spec, &ctx)
            .await
            .map_err(|e| anyhow::anyhow!("{e}"))?;
        AsyncRawDataSink::sink_str(h.sink.as_mut(), "hello")
            .await
            .map_err(|e| anyhow::anyhow!("{e}"))?;
        let body = srv.await.unwrap();
        assert_eq!(body, b"5 hello");
        Ok(())
    }
}