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
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright The Lance Authors

use std::sync::Arc;

use arrow_array::{
    cast::AsArray, types::UInt8Type, Array, ArrayRef, ListArray, StringArray, UInt8Array,
};

use arrow_buffer::ScalarBuffer;
use arrow_schema::{DataType, Field};
use futures::{future::BoxFuture, FutureExt};
use lance_core::Result;
use log::trace;

use crate::{
    decoder::{DecodeArrayTask, LogicalPageDecoder, LogicalPageScheduler, NextDecodeTask},
    encoder::{EncodedPage, FieldEncoder},
    encodings::physical::basic::BasicEncoder,
};

use super::{list::ListFieldEncoder, primitive::PrimitiveFieldEncoder};

// TODO: Support large string, binary, large binary

/// A logical scheduler for utf8 pages which assumes the data are encoded as List<u8>
#[derive(Debug)]
pub struct Utf8PageScheduler {
    varbin_scheduler: Box<dyn LogicalPageScheduler>,
}

impl Utf8PageScheduler {
    // Create a new ListPageScheduler
    pub fn new(varbin_scheduler: Box<dyn LogicalPageScheduler>) -> Self {
        Self { varbin_scheduler }
    }
}

impl LogicalPageScheduler for Utf8PageScheduler {
    fn schedule_ranges(
        &self,
        ranges: &[std::ops::Range<u32>],
        scheduler: &Arc<dyn crate::EncodingsIo>,
        sink: &tokio::sync::mpsc::UnboundedSender<Box<dyn crate::decoder::LogicalPageDecoder>>,
    ) -> Result<()> {
        trace!("Scheduling utf8 for {} ranges", ranges.len());
        let (tx, mut rx) = tokio::sync::mpsc::unbounded_channel();
        self.varbin_scheduler
            .schedule_ranges(ranges, scheduler, &tx)?;

        while let Some(decoder) = rx.recv().now_or_never() {
            let wrapped = Utf8PageDecoder {
                inner: decoder.unwrap(),
            };
            sink.send(Box::new(wrapped)).unwrap();
        }

        Ok(())
    }

    fn schedule_take(
        &self,
        indices: &[u32],
        scheduler: &Arc<dyn crate::EncodingsIo>,
        sink: &tokio::sync::mpsc::UnboundedSender<Box<dyn crate::decoder::LogicalPageDecoder>>,
    ) -> Result<()> {
        trace!("Scheduling utf8 for {} indices", indices.len());
        self.schedule_ranges(
            &indices
                .iter()
                .map(|&idx| idx..(idx + 1))
                .collect::<Vec<_>>(),
            scheduler,
            sink,
        )
    }

    fn num_rows(&self) -> u32 {
        self.varbin_scheduler.num_rows()
    }
}

pub struct Utf8PageDecoder {
    inner: Box<dyn LogicalPageDecoder>,
}

impl LogicalPageDecoder for Utf8PageDecoder {
    fn wait<'a>(
        &'a mut self,
        num_rows: u32,
        source: &'a mut tokio::sync::mpsc::UnboundedReceiver<Box<dyn LogicalPageDecoder>>,
    ) -> BoxFuture<'a, Result<()>> {
        self.inner.wait(num_rows, source)
    }

    fn drain(&mut self, num_rows: u32) -> Result<NextDecodeTask> {
        let inner_task = self.inner.drain(num_rows)?;
        Ok(NextDecodeTask {
            has_more: inner_task.has_more,
            num_rows: inner_task.num_rows,
            task: Box::new(Utf8ArrayDecoder {
                inner: inner_task.task,
            }),
        })
    }

    fn unawaited(&self) -> u32 {
        self.inner.unawaited()
    }

    fn avail(&self) -> u32 {
        self.inner.avail()
    }
}

pub struct Utf8ArrayDecoder {
    inner: Box<dyn DecodeArrayTask>,
}

impl DecodeArrayTask for Utf8ArrayDecoder {
    fn decode(self: Box<Self>) -> Result<ArrayRef> {
        let arr = self.inner.decode()?;
        let list_arr = arr.as_list::<i32>();
        let values = list_arr
            .values()
            .as_primitive::<UInt8Type>()
            .values()
            .inner()
            .clone();
        Ok(Arc::new(StringArray::new(
            list_arr.offsets().clone(),
            values,
            list_arr.nulls().cloned(),
        )))
    }
}

/// An encoder which encodes string arrays as List<u8>
pub struct Utf8FieldEncoder {
    varbin_encoder: Box<dyn FieldEncoder>,
}

impl Utf8FieldEncoder {
    pub fn new(cache_bytes_per_column: u64, column_index: u32) -> Self {
        let bytes_encoder = Arc::new(BasicEncoder::new(column_index + 1));
        let items_encoder = Box::new(PrimitiveFieldEncoder::new(
            cache_bytes_per_column,
            bytes_encoder,
        ));
        Self {
            varbin_encoder: Box::new(ListFieldEncoder::new(
                items_encoder,
                cache_bytes_per_column,
                column_index,
            )),
        }
    }
}

impl FieldEncoder for Utf8FieldEncoder {
    fn maybe_encode(
        &mut self,
        array: ArrayRef,
    ) -> Result<Vec<BoxFuture<'static, Result<EncodedPage>>>> {
        let utf8_array = array.as_string::<i32>();
        let values = UInt8Array::new(
            ScalarBuffer::<u8>::new(utf8_array.values().clone(), 0, utf8_array.values().len()),
            None,
        );
        let list_field = Field::new("item", DataType::UInt8, true);
        let list_array = ListArray::new(
            Arc::new(list_field),
            utf8_array.offsets().clone(),
            Arc::new(values),
            utf8_array.nulls().cloned(),
        );
        self.varbin_encoder.maybe_encode(Arc::new(list_array))
    }

    fn flush(&mut self) -> Result<Vec<BoxFuture<'static, Result<EncodedPage>>>> {
        self.varbin_encoder.flush()
    }

    fn num_columns(&self) -> u32 {
        2
    }
}

#[cfg(test)]
mod tests {
    use arrow_schema::{DataType, Field};

    use crate::{
        encodings::logical::utf8::Utf8FieldEncoder, testing::check_round_trip_field_encoding,
    };

    #[test_log::test(tokio::test)]
    async fn test_utf8() {
        let encoder = Utf8FieldEncoder::new(4096, 0);
        let field = Field::new("", DataType::Utf8, false);

        check_round_trip_field_encoding(encoder, field).await;
    }
}