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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
use std::{cmp::Ordering, collections::BTreeMap, num::NonZeroU32, path::Path};

use sea_streamer_types::{
    export::futures::{future::BoxFuture, FutureExt},
    Buffer, Message as MessageTrait, MessageHeader, OwnedMessage, SeqNo, SeqPos, ShardId,
    SharedMessage, StreamKey, Timestamp, SEA_STREAMER_INTERNAL,
};

use crate::{
    format::{Beacon, Checksum, FormatErr, Header, Marker, Message, RunningChecksum},
    AsyncFile, BeaconReader, ByteBuffer, ByteSource, Bytes, DynFileSource, FileErr, FileId,
    FileReader, FileSink, FileSourceType, SeekErr, StreamMode, SurveyResult, Surveyor,
    SEA_STREAMER_WILDCARD,
};

pub const END_OF_STREAM: &str = "EOS";
pub const PULSE_MESSAGE: &str = "PULSE";

/// A high level file reader that demux messages and beacon
pub struct MessageSource {
    header: Header,
    source: DynFileSource,
    buffer: ByteBuffer,
    offset: u64,
    beacon: (u32, Vec<Marker>),
    pending: Option<Message>,
}

/// A high level file writer that mux messages and beacon
pub struct MessageSink {
    sink: FileSinkState,
    offset: u64,
    beacon_interval: u32,
    beacon: BTreeMap<(StreamKey, ShardId), BeaconState>,
    beacon_count: u32,
    message_count: u32,
    started_from: u64,
}

enum FileSinkState {
    Alive(FileSink),
    Dead,
}

impl Default for FileSinkState {
    fn default() -> Self {
        Self::Dead
    }
}

pub enum SeekTarget {
    SeqNo(SeqNo),
    Timestamp(Timestamp),
    Beginning,
    End,
}

pub(crate) struct BeaconState {
    pub(crate) seq_no: SeqNo,
    pub(crate) ts: Timestamp,
    pub(crate) running_checksum: RunningChecksum,
}

impl MessageSource {
    /// Creates a new message source. First, the stream Header is read
    /// from the file's beginning.
    ///
    /// If StreamMode is `Live`, it will fast forward to the file's end.
    pub async fn new(file_id: FileId, mode: StreamMode) -> Result<Self, FileErr> {
        let source = DynFileSource::new(
            file_id,
            match mode {
                StreamMode::Live | StreamMode::LiveReplay => FileSourceType::FileSource,
                StreamMode::Replay => FileSourceType::FileReader,
            },
        )
        .await?;
        Self::new_with(source, mode).await
    }

    pub(crate) async fn new_with(
        mut source: DynFileSource,
        mode: StreamMode,
    ) -> Result<Self, FileErr> {
        let header = Header::read_from(&mut source).await?;
        assert!(Header::size() <= header.beacon_interval as usize);
        let mut stream = Self {
            header,
            source,
            buffer: ByteBuffer::new(),
            offset: Header::size() as u64,
            beacon: (0, Vec::new()),
            pending: None,
        };
        if mode == StreamMode::Live {
            stream.rewind(SeqPos::End).await?;
        }
        Ok(stream)
    }

    pub fn file_header(&self) -> &Header {
        &self.header
    }

    /// Rewind the message stream to a coarse position.
    /// SeqNo is regarded as the N-th beacon.
    /// Returns the current location in terms of N-th beacon.
    ///
    /// Warning: This future must not be canceled.
    pub async fn rewind(&mut self, target: SeqPos) -> Result<u32, FileErr> {
        let pos = match target {
            SeqPos::Beginning | SeqPos::At(0) => SeqPos::At(Header::size() as u64),
            SeqPos::End => SeqPos::End,
            SeqPos::At(nth) => {
                let at = nth * self.beacon_interval();
                if at < self.known_size() {
                    SeqPos::At(at)
                } else {
                    SeqPos::End
                }
            }
        };
        self.offset = self.source.seek(pos).await?;

        // Align at a beacon
        if pos == SeqPos::End {
            let max = self.known_size() - (self.known_size() % self.beacon_interval());
            let max = std::cmp::max(max, Header::size() as u64);
            let pos = match target {
                SeqPos::Beginning | SeqPos::At(0) => unreachable!(),
                SeqPos::End => max,
                SeqPos::At(nth) => {
                    let at = nth * self.beacon_interval();
                    if at < self.known_size() {
                        at
                    } else {
                        max
                    }
                }
            };
            if self.offset != pos {
                self.offset = self.source.seek(SeqPos::At(pos)).await?;
            }
        }

        self.buffer.clear();
        self.clear_beacon();

        // Read until the start of the next message
        while let Some(i) = self.has_beacon(self.offset) {
            let beacon = Beacon::read_from(&mut self.source).await?;
            let beacon_size = beacon.size();
            self.offset += beacon_size as u64;
            self.beacon = (i, beacon.items);

            let bytes = self
                .source
                .request_bytes(std::cmp::min(
                    beacon.remaining_messages_bytes as usize,
                    self.beacon_interval() as usize - beacon_size,
                ))
                .await?;
            self.offset += bytes.len() as u64;
        }

        // Now we are at the first message after the last beacon,
        // we want to consume all messages up to known size
        if matches!(target, SeqPos::End) && self.offset < self.known_size() {
            let mut next = self.offset;
            let bytes = self
                .source
                .request_bytes((self.known_size() - self.offset) as usize)
                .await?;
            let mut buffer = ByteBuffer::one(bytes);
            while let Ok(message) = Message::read_from(&mut buffer).await {
                next += message.size() as u64;
            }
            self.offset = self.source.seek(SeqPos::At(next)).await?;
        }

        Ok((self.offset / self.beacon_interval()) as u32)
    }

    /// Warning: This future must not be canceled.
    pub async fn seek(
        &mut self,
        stream_key: &StreamKey,
        shard_id: &ShardId,
        to: SeekTarget,
    ) -> Result<(), FileErr> {
        // a short cut
        match to {
            SeekTarget::Beginning => return self.rewind(SeqPos::Beginning).await.map(|_| ()),
            SeekTarget::End => return self.rewind(SeqPos::End).await.map(|_| ()),
            _ => (),
        }
        let savepoint = self.offset;
        let source_type = self.source.source_type();
        let source = std::mem::replace(&mut self.source, DynFileSource::Dead);
        self.source = source.switch_to(FileSourceType::FileReader).await?;
        self.source.resize().await?;
        #[allow(clippy::never_loop)]
        let res = 'outer: loop {
            // survey the beacons to narrow down the scope of search
            let surveyor = Surveyor::new(self, |b: &Beacon| {
                for item in b.items.iter() {
                    if (stream_key, shard_id) == (item.header.stream_key(), item.header.shard_id())
                    {
                        return compare(&to, &item.header);
                    }
                }
                SurveyResult::Undecided
            })
            .await;

            let surveyor = match surveyor {
                Ok(s) => s,
                Err(e) => {
                    break Err(e);
                }
            };
            let (pos, _) = match surveyor.run().await {
                Ok(s) => s,
                Err(e) => {
                    break Err(e);
                }
            };
            // now we know roughly where's the message
            match self.rewind(SeqPos::At(pos as u64)).await {
                Ok(_) => (),
                Err(e) => {
                    break 'outer match e {
                        FileErr::NotEnoughBytes => Err(FileErr::SeekErr(SeekErr::OutOfBound)),
                        e => Err(e),
                    }
                }
            };
            // read until we found what we want
            loop {
                let mess = match self.next().await {
                    Ok(m) => m,
                    Err(e) => {
                        break 'outer match e {
                            FileErr::NotEnoughBytes => Err(FileErr::SeekErr(SeekErr::OutOfBound)),
                            e => Err(e),
                        }
                    }
                };
                if let SurveyResult::Right = compare(&to, mess.message.header()) {
                    // This is a wanted message!
                    self.pending = Some(mess);
                    break;
                }
            }
            break Ok(());
        };

        // Restore file source to original state
        let source = std::mem::replace(&mut self.source, DynFileSource::Dead);
        self.source = source.switch_to(source_type).await?;

        if res.is_err() {
            self.source.seek(SeqPos::At(savepoint)).await?;
            self.buffer.clear();
            self.pending.take();
        }

        /// In the nutshell, for SeqNo the condition is >= N.
        /// While for Timestamp, the condition is > N.
        ///
        /// Reason being, SeqNo is a discrete time thus precise;
        /// Timestamp is a continuous time, thus, should be treated as a real number.
        fn compare(to: &SeekTarget, header: &MessageHeader) -> SurveyResult {
            match to {
                SeekTarget::Beginning | SeekTarget::End => panic!("Should not appear here"),
                SeekTarget::SeqNo(no) => match header.sequence().cmp(no) {
                    Ordering::Less => SurveyResult::Left,
                    Ordering::Greater | Ordering::Equal => SurveyResult::Right,
                },
                SeekTarget::Timestamp(ts) => match header.timestamp().cmp(ts) {
                    Ordering::Less | Ordering::Equal => SurveyResult::Left,
                    Ordering::Greater => SurveyResult::Right,
                },
            }
        }

        res
    }

    #[inline]
    fn beacon_interval(&self) -> u64 {
        self.header.beacon_interval as u64
    }

    fn has_beacon(&self, offset: u64) -> Option<u32> {
        if offset > 0 && offset % self.beacon_interval() == 0 {
            Some((offset / self.beacon_interval()) as u32)
        } else {
            None
        }
    }

    async fn request_bytes(&mut self, size: usize) -> Result<Bytes, FileErr> {
        loop {
            if let Some(i) = self.has_beacon(self.offset) {
                let beacon = Beacon::read_from(&mut self.source).await?;
                self.offset += beacon.size() as u64;
                self.beacon = (i, beacon.items);
            }

            let chunk = std::cmp::min(
                size - self.buffer.size(), // remaining size
                self.beacon_interval() as usize - (self.offset % self.beacon_interval()) as usize, // should not read past the next beacon
            );
            let bytes = self.source.request_bytes(chunk).await?;
            self.offset += chunk as u64;
            self.buffer.append(bytes); // these are message bytes

            debug_assert!(self.buffer.size() <= size, "we should never over-read");
            if self.buffer.size() == size {
                return Ok(self.buffer.consume(size));
            }
        }
    }

    /// Switch the file source type.
    ///
    /// Warning: This future must not be canceled.
    pub async fn switch_to(&mut self, stype: FileSourceType) -> Result<(), FileErr> {
        let source = std::mem::replace(&mut self.source, DynFileSource::Dead);
        self.source = source.switch_to(stype).await?;
        Ok(())
    }

    /// Read the next message.
    pub async fn next(&mut self) -> Result<Message, FileErr> {
        let message = match self.pending.take() {
            Some(m) => m,
            None => Message::read_from(self).await?,
        };
        let computed = message.compute_checksum();
        if message.checksum != computed {
            Err(FileErr::FormatErr(FormatErr::ChecksumErr {
                received: message.checksum,
                computed,
            }))
        } else {
            Ok(message)
        }
    }

    /// Get the most recent Beacon and it's index. Note that it is cleared (rather than carry-over)
    /// on each Beacon point.
    ///
    /// Beacon index starts from 1 (don't wary, because 0 is the header), and we have the following
    /// equation:
    ///
    /// ```ignore
    /// file offset = beacon index * beacon interval
    /// ```
    pub fn beacon(&self) -> (u32, &[Marker]) {
        (self.beacon.0, &self.beacon.1)
    }

    fn clear_beacon(&mut self) {
        self.beacon.0 = 0;
        self.beacon.1.clear();
    }

    #[inline]
    pub fn offset(&self) -> u64 {
        self.offset
    }

    #[inline]
    fn known_size(&self) -> u64 {
        self.source.file_size()
    }

    pub(crate) fn take_source(self) -> DynFileSource {
        self.source
    }
}

impl ByteSource for MessageSource {
    /// Too complex to unroll by hand. Let's just box it.
    type Future<'a> = BoxFuture<'a, Result<Bytes, FileErr>>;

    /// Although this is exposed as public. Do not call this directly,
    /// this will interfere the Message Stream.
    fn request_bytes(&mut self, size: usize) -> Self::Future<'_> {
        self.request_bytes(size).boxed()
    }
}

impl BeaconReader for MessageSource {
    type Future<'a> = BoxFuture<'a, Result<Beacon, FileErr>>;

    fn survey(&mut self, at: NonZeroU32) -> Self::Future<'_> {
        async move {
            let at = at.get() as u64 * self.beacon_interval();
            let offset = self.source.seek(SeqPos::At(at)).await?;
            if at == offset {
                let beacon = Beacon::read_from(&mut self.source).await?;
                Ok(beacon)
            } else {
                Err(FileErr::NotEnoughBytes)
            }
        }
        .boxed()
    }

    fn max_beacons(&self) -> u32 {
        (self.source.file_size() / self.beacon_interval()) as u32
    }
}

impl MessageSink {
    /// Create a fresh sink. Overwrite if file already exists.
    pub async fn new(file_id: FileId, beacon_interval: u32, limit: u64) -> Result<Self, FileErr> {
        let file = AsyncFile::new_ow(file_id).await?;
        Self::new_with(file, beacon_interval, limit).await
    }

    /// Create a sink. Append if file already exists, and follow its beacon interval.
    pub async fn append(
        file_id: FileId,
        beacon_interval: u32,
        limit: u64,
    ) -> Result<Self, FileErr> {
        let file = AsyncFile::new_rw(file_id.clone()).await?;
        if file.size() == 0 {
            Self::new_with(file, beacon_interval, limit).await
        } else {
            let source =
                DynFileSource::FileReader(FileReader::new_with(file, 0, Default::default())?);
            let mut source = MessageSource::new_with(source, StreamMode::Replay).await?;
            let mut offset = 0;
            match source.rewind(SeqPos::End).await {
                Ok(mut nth) => {
                    offset = source.offset;
                    // we must read the last message, and truncate the EOS
                    let mut read = false;
                    loop {
                        match source.next().await {
                            Ok(m) => {
                                if is_end_of_stream(&m.message) {
                                    if read {
                                        // the file ends with a EOS
                                        break;
                                    } else {
                                        // the next iteration will be NotEnoughBytes
                                    }
                                } else {
                                    // got a normal message
                                    offset = source.offset;
                                    read = true;
                                }
                            }
                            Err(FileErr::NotEnoughBytes) => {
                                if !read {
                                    if nth > 0 {
                                        // we need to rewind further backwards
                                        nth -= 1;
                                        source.rewind(SeqPos::At(nth as u64)).await?;
                                    } else {
                                        // we reached the start now
                                        break;
                                    }
                                } else {
                                    // the file ended without an EOS
                                    break;
                                }
                            }
                            Err(e) => return Err(e),
                        }
                    }
                }
                Err(FileErr::NotEnoughBytes) => {
                    // the file has no messages
                }
                Err(e) => return Err(e),
            }
            if beacon_interval != source.header.beacon_interval {
                log::warn!(
                    "Beacon interval mismatch: expected {}, got {}",
                    beacon_interval,
                    source.header.beacon_interval
                );
            }
            let beacon_interval = source.header.beacon_interval;
            let has_beacon = source.has_beacon(offset).is_some();
            if let DynFileSource::FileReader(reader) = source.source {
                let (mut file, _, _) = reader.end();
                assert_eq!(offset, file.seek(SeqPos::At(offset)).await?);
                let mut sink = FileSink::new(file, limit)?;

                if has_beacon {
                    // if coincidentally we are at a beacon location
                    offset += Beacon {
                        remaining_messages_bytes: 0,
                        items: Default::default(),
                    }
                    .write_to(&mut sink)? as u64;
                    sink.flush(0).await?;
                }

                Ok(Self {
                    sink: FileSinkState::Alive(sink),
                    offset,
                    beacon_interval,
                    beacon: Default::default(),
                    beacon_count: 0,
                    message_count: 0,
                    started_from: offset,
                })
            } else {
                unreachable!()
            }
        }
    }

    async fn new_with(file: AsyncFile, beacon_interval: u32, limit: u64) -> Result<Self, FileErr> {
        assert!(Header::size() <= beacon_interval as usize);
        let header = Self::new_header(&file, beacon_interval);
        let mut sink = FileSink::new(file, limit)?;
        let mut offset = header.write_to(&mut sink)?;
        if offset == beacon_interval as usize {
            // a very special case
            offset += Beacon {
                remaining_messages_bytes: 0,
                items: Default::default(),
            }
            .write_to(&mut sink)?;
        }
        sink.flush(0).await?;

        Ok(Self {
            sink: FileSinkState::Alive(sink),
            offset: offset as u64,
            beacon_interval,
            beacon: Default::default(),
            beacon_count: 0,
            message_count: 0,
            started_from: offset as u64,
        })
    }

    fn new_header(file: &AsyncFile, beacon_interval: u32) -> Header {
        let path = file.id();
        let path = path.path();
        let path: &Path = path.as_ref();
        let file_name: String = path.file_name().unwrap().to_str().unwrap().to_owned();
        Header {
            file_name,
            created_at: Timestamp::now_utc(),
            beacon_interval,
        }
    }

    /// This method does not block. To make sure messages have been written, call [`MessageSink::flush`].
    pub fn write(&mut self, message: OwnedMessage) -> Result<Checksum, FileErr> {
        let key = (message.stream_key(), message.shard_id());
        let (seq_no, ts) = (message.sequence(), message.timestamp());
        let message = Message {
            message,
            checksum: 0,
        };
        let mut buffer = ByteBuffer::new();
        let (_, checksum) = message.write_to(&mut buffer)?;
        let entry = self.beacon.entry(key).or_insert(BeaconState {
            seq_no,
            ts,
            running_checksum: RunningChecksum::new(),
        });
        entry.seq_no = std::cmp::max(seq_no, entry.seq_no);
        entry.ts = std::cmp::max(ts, entry.ts);
        entry.running_checksum.update(checksum);

        while !buffer.is_empty() {
            let chunk = self.beacon_interval as usize
                - (self.offset % self.beacon_interval as u64) as usize;
            let chunk: ByteBuffer = buffer.consume(std::cmp::min(chunk, buffer.size()));
            self.offset += chunk.write_to(self.sink())? as u64;

            if self.offset > 0 && self.offset % self.beacon_interval as u64 == 0 {
                let num_markers = Beacon::num_markers(self.beacon_interval as usize);
                let mut items = Vec::new();
                // We may not have enough space to fit in all beacon for every stream.
                // In which case, we'll round-robin among them.
                for ((key, sid), beacon) in self
                    .beacon
                    .iter()
                    .skip(self.beacon_count as usize % self.beacon.len())
                    .chain(self.beacon.iter())
                    .take(std::cmp::min(self.beacon.len(), num_markers))
                {
                    items.push(Marker {
                        header: MessageHeader::new(key.to_owned(), *sid, beacon.seq_no, beacon.ts),
                        running_checksum: beacon.running_checksum.crc(),
                    });
                }
                let beacon_count = items.len();
                let beacon = Beacon {
                    remaining_messages_bytes: buffer.size() as u32,
                    items,
                };
                self.offset += beacon.write_to(self.sink())? as u64;
                self.beacon_count += beacon_count as u32;
            }
        }

        self.message_count += 1;

        Ok(checksum)
    }

    #[inline]
    pub fn offset(&self) -> u64 {
        self.offset
    }

    /// Where this sink was started
    #[inline]
    pub fn started_from(&self) -> u64 {
        self.started_from
    }

    pub async fn flush(&mut self) -> Result<(), FileErr> {
        let c = self.message_count;
        self.sink().flush(c).await
    }

    /// End this stream gracefully, with an optional EOS message
    pub async fn end(mut self, eos: bool) -> Result<(), FileErr> {
        if eos {
            self.write(end_of_stream())?;
        }
        self.flush().await?;
        self.sink().sync_all().await
    }

    fn sink(&mut self) -> &mut FileSink {
        match &mut self.sink {
            FileSinkState::Alive(sink) => sink,
            FileSinkState::Dead => panic!("FileSinkState::Dead"),
        }
    }

    /// Take ownership of the file sink
    pub(crate) async fn take_file(&mut self) -> Result<AsyncFile, FileErr> {
        let sink = std::mem::take(&mut self.sink);
        match sink {
            FileSinkState::Alive(sink) => sink.end().await,
            FileSinkState::Dead => panic!("FileSinkState::Dead"),
        }
    }

    /// Return the file sink
    pub(crate) fn use_file(&mut self, sink: FileSink) {
        self.sink = FileSinkState::Alive(sink);
    }

    pub(crate) fn update_stream_state(&mut self, key: (StreamKey, ShardId), state: BeaconState) {
        self.beacon.insert(key, state);
    }
}

pub trait HasMessageHeader: MessageTrait {
    fn header(&self) -> &MessageHeader;
}
impl HasMessageHeader for SharedMessage {
    fn header(&self) -> &MessageHeader {
        self.header()
    }
}
impl HasMessageHeader for OwnedMessage {
    fn header(&self) -> &MessageHeader {
        self.header()
    }
}

/// This can be written to a file to properly end the stream
pub fn end_of_stream() -> OwnedMessage {
    let header = MessageHeader::new(
        StreamKey::new(SEA_STREAMER_INTERNAL).unwrap(),
        ShardId::new(0),
        0,
        Timestamp::now_utc(),
    );
    OwnedMessage::new(header, END_OF_STREAM.into_bytes())
}

pub fn is_end_of_stream<M: HasMessageHeader>(mess: &M) -> bool {
    mess.header().stream_key().name() == SEA_STREAMER_INTERNAL
        && mess.message().as_bytes() == END_OF_STREAM.as_bytes()
}

/// This should never be written on file
pub(crate) fn pulse_message() -> OwnedMessage {
    let header = MessageHeader::new(
        StreamKey::new(SEA_STREAMER_INTERNAL).unwrap(),
        ShardId::new(0),
        0,
        Timestamp::now_utc(),
    );
    OwnedMessage::new(header, PULSE_MESSAGE.into_bytes())
}

pub(crate) fn is_pulse(mess: &SharedMessage) -> bool {
    mess.header().stream_key().name() == SEA_STREAMER_INTERNAL
        && mess.message().as_bytes() == PULSE_MESSAGE.as_bytes()
}

pub(crate) fn is_internal(mess: &SharedMessage) -> bool {
    mess.header().stream_key().name() == SEA_STREAMER_INTERNAL
}

pub(crate) fn is_wildcard(key: &StreamKey) -> bool {
    key.name() == SEA_STREAMER_WILDCARD
}