summaryrefslogtreecommitdiff
path: root/systems/sheet/src/index_source/alias.rs
blob: d50c183285bba07848d95e7145772b87af84543f (plain)
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
use std::path::Path;
use std::path::PathBuf;
use tokio::fs;
use tokio::fs::OpenOptions;
use tokio::io::{AsyncReadExt, AsyncSeekExt, AsyncWriteExt};

use crate::index_source::IndexSource;
use crate::index_source::error::IDAliasError;

const MAX_ENTRIES_PER_FILE: u32 = 65536;
const ENTRY_SIZE: usize = 4;
const FILE_SIZE: u64 = (MAX_ENTRIES_PER_FILE as u64) * (ENTRY_SIZE as u64);

impl IndexSource {
    /// Convert local index source to remote index source
    ///
    /// This method converts the local index source's ID to the corresponding remote ID,
    /// and updates the index source's state to remote.
    /// If the index source is already in remote state, it returns directly.
    ///
    /// - `alias_dir` - Directory path where alias files are stored
    /// - `Result<IndexSource, (IndexSource, aliasError)>` - Returns the converted index source on success,
    ///   or returns the original index source along with the error if conversion fails
    pub async fn to_remote_namespace(
        mut self,
        alias_dir: PathBuf,
    ) -> Result<IndexSource, (IndexSource, IDAliasError)> {
        if self.remote {
            return Ok(self);
        }

        let new_id = match convert_to_remote(alias_dir, self.id).await {
            Ok(id) => id,
            Err(e) => return Err((self, e)),
        };
        self.id = new_id;
        self.set_is_remote(true);
        Ok(self)
    }
}

pub struct IndexSourceAliasesManager;
impl IndexSourceAliasesManager {
    /// Write a alias between local and remote IDs
    pub async fn write_alias(
        aliases_dir: impl Into<PathBuf>,
        local_id: u32,
        remote_id: u32,
    ) -> Result<(), IDAliasError> {
        write_alias(aliases_dir.into(), local_id, remote_id).await
    }

    /// Delete a alias between local and remote IDs
    pub async fn delete_alias(
        aliases_dir: impl Into<PathBuf>,
        local_id: u32,
    ) -> Result<(), IDAliasError> {
        delete_alias(aliases_dir.into(), local_id).await
    }

    /// Check if a alias exists between local and remote IDs
    pub async fn alias_exists(
        aliases_dir: impl Into<PathBuf>,
        local_id: u32,
    ) -> Result<bool, IDAliasError> {
        alias_exists(aliases_dir.into(), local_id).await
    }
}

async fn write_alias(
    aliases_dir: PathBuf,
    local_id: u32,
    remote_id: u32,
) -> Result<(), IDAliasError> {
    ensure_aliases_dir(&aliases_dir).await?;

    let (file_index, offset) = get_file_path_and_offset(local_id);
    let file = get_or_create_alias_file(&aliases_dir, file_index).await?;
    write_entry_to_file(file, offset, remote_id).await?;

    Ok(())
}

async fn delete_alias(aliases_dir: PathBuf, local_id: u32) -> Result<(), IDAliasError> {
    ensure_aliases_dir(&aliases_dir).await?;

    let (file_index, offset) = get_file_path_and_offset(local_id);
    let file = get_or_create_alias_file(&aliases_dir, file_index).await?;
    write_entry_to_file(file, offset, 0).await?;

    Ok(())
}

async fn alias_exists(aliases_dir: PathBuf, local_id: u32) -> Result<bool, IDAliasError> {
    ensure_aliases_dir(&aliases_dir).await?;

    let (file_index, offset) = get_file_path_and_offset(local_id);
    let file = get_or_create_alias_file(&aliases_dir, file_index).await?;
    let remote_id = read_entry_from_file(file, offset).await?;

    Ok(remote_id != 0)
}

pub async fn convert_to_remote(aliases_dir: PathBuf, local_id: u32) -> Result<u32, IDAliasError> {
    ensure_aliases_dir(&aliases_dir).await?;

    let (file_index, offset) = get_file_path_and_offset(local_id);
    let file = get_or_create_alias_file(&aliases_dir, file_index).await?;
    let remote_id = read_entry_from_file(file, offset).await?;

    if remote_id == 0 {
        return Err(IDAliasError::AliasNotFound(local_id));
    }

    Ok(remote_id)
}

fn get_file_path_and_offset(id: u32) -> (u32, u64) {
    let file_index = id / MAX_ENTRIES_PER_FILE;
    let offset_within_file = id % MAX_ENTRIES_PER_FILE;
    let byte_offset = (offset_within_file as u64) * (ENTRY_SIZE as u64);
    (file_index, byte_offset)
}

async fn ensure_aliases_dir(aliases_dir: &Path) -> Result<(), IDAliasError> {
    if !aliases_dir.exists() {
        fs::create_dir_all(aliases_dir).await?;
    }
    Ok(())
}

async fn get_or_create_alias_file(
    aliases_dir: &Path,
    file_index: u32,
) -> Result<fs::File, IDAliasError> {
    let file_path = aliases_dir.join(file_index.to_string());

    let file = OpenOptions::new()
        .read(true)
        .write(true)
        .create(true)
        .open(&file_path)
        .await
        .map_err(|e| IDAliasError::Io(e))?;

    let metadata = file.metadata().await.map_err(|e| IDAliasError::Io(e))?;
    if metadata.len() != FILE_SIZE {
        drop(file);
        let file = OpenOptions::new()
            .write(true)
            .create(true)
            .truncate(true)
            .open(&file_path)
            .await
            .map_err(|e| IDAliasError::Io(e))?;

        file.set_len(FILE_SIZE)
            .await
            .map_err(|e| IDAliasError::Io(e))?;

        let file = OpenOptions::new()
            .read(true)
            .write(true)
            .open(&file_path)
            .await
            .map_err(|e| IDAliasError::Io(e))?;

        Ok(file)
    } else {
        Ok(file)
    }
}

async fn write_entry_to_file(
    mut file: fs::File,
    offset: u64,
    remote_id: u32,
) -> Result<(), IDAliasError> {
    file.seek(std::io::SeekFrom::Start(offset)).await?;
    file.write_all(&remote_id.to_le_bytes()).await?;

    Ok(())
}

async fn read_entry_from_file(mut file: fs::File, offset: u64) -> Result<u32, IDAliasError> {
    file.seek(std::io::SeekFrom::Start(offset)).await?;

    let mut remote_buf = [0u8; 4];
    file.read_exact(&mut remote_buf).await?;

    let remote_id = u32::from_le_bytes(remote_buf);
    Ok(remote_id)
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::env;

    fn get_test_dir(test_name: &str) -> PathBuf {
        let current_dir = env::current_dir().expect("Failed to get current directory");
        let test_dir = current_dir
            .join(".temp")
            .join("index_source")
            .join(test_name);
        test_dir
    }

    async fn cleanup_test_dir(test_name: &str) {
        let test_dir = get_test_dir(test_name);
        if test_dir.exists() {
            tokio::fs::remove_dir_all(&test_dir)
                .await
                .expect("Failed to cleanup test directory");
        }
    }

    async fn setup_test(test_name: &str) -> PathBuf {
        cleanup_test_dir(test_name).await;
        let test_dir = get_test_dir(test_name);
        tokio::fs::create_dir_all(&test_dir)
            .await
            .expect("Failed to create test directory");
        test_dir
    }

    #[test]
    fn test_get_file_path_and_offset() {
        assert_eq!(get_file_path_and_offset(0), (0, 0));
        assert_eq!(get_file_path_and_offset(1), (0, 4));
        assert_eq!(get_file_path_and_offset(65535), (0, 262140)); // 65535 * 4
        assert_eq!(get_file_path_and_offset(65536), (1, 0));
        assert_eq!(get_file_path_and_offset(65537), (1, 4));
        assert_eq!(get_file_path_and_offset(131071), (1, 262140)); // (131071-65536) * 4
        assert_eq!(get_file_path_and_offset(131072), (2, 0));
    }

    #[tokio::test]
    async fn test_write_and_read_alias() {
        let test_dir = setup_test("test_write_and_read_alias").await;

        write_alias(test_dir.clone(), 100, 200)
            .await
            .expect("Failed to write alias");

        let exists = alias_exists(test_dir.clone(), 100)
            .await
            .expect("Failed to check alias");
        assert!(exists, "alias should exist");

        let remote_id = convert_to_remote(test_dir.clone(), 100)
            .await
            .expect("Failed to convert to remote");
        assert_eq!(remote_id, 200, "Remote ID should be 200");

        let result = convert_to_remote(test_dir.clone(), 999).await;
        assert!(
            result.is_err(),
            "Should return error for non-existent alias"
        );

        cleanup_test_dir("test_write_and_read_alias").await;
    }

    #[tokio::test]
    async fn test_delete_alias() {
        let test_dir = setup_test("test_delete_alias").await;

        write_alias(test_dir.clone(), 300, 400)
            .await
            .expect("Failed to write alias");

        let exists = alias_exists(test_dir.clone(), 300)
            .await
            .expect("Failed to check alias");
        assert!(exists, "alias should exist before deletion");

        delete_alias(test_dir.clone(), 300)
            .await
            .expect("Failed to delete alias");

        let exists = alias_exists(test_dir.clone(), 300)
            .await
            .expect("Failed to check alias");
        assert!(!exists, "alias should not exist after deletion");

        let result = convert_to_remote(test_dir.clone(), 300).await;
        assert!(result.is_err(), "Should return error after deletion");

        cleanup_test_dir("test_delete_alias").await;
    }

    #[tokio::test]
    async fn test_large_id_alias() {
        let test_dir = setup_test("test_large_id_alias").await;

        let large_local_id = 70000;
        let large_remote_id = 80000;

        write_alias(test_dir.clone(), large_local_id, large_remote_id)
            .await
            .expect("Failed to write large alias");

        let exists = alias_exists(test_dir.clone(), large_local_id)
            .await
            .expect("Failed to check alias");
        assert!(exists, "Large alias should exist");

        let remote_id = convert_to_remote(test_dir.clone(), large_local_id)
            .await
            .expect("Failed to convert large to remote");
        assert_eq!(remote_id, large_remote_id, "Remote ID should match");

        cleanup_test_dir("test_large_id_alias").await;
    }

    #[tokio::test]
    async fn test_multiple_aliass() {
        let test_dir = setup_test("test_multiple_aliass").await;

        let aliass = vec![(10, 20), (30, 40), (50, 60), (1000, 2000), (70000, 80000)];

        for (local, remote) in &aliass {
            write_alias(test_dir.clone(), *local, *remote)
                .await
                .expect("Failed to write alias");
        }

        for (local, remote) in &aliass {
            let exists = alias_exists(test_dir.clone(), *local)
                .await
                .expect("Failed to check alias");
            assert!(exists, "alias for local {} should exist", local);

            let converted_remote = convert_to_remote(test_dir.clone(), *local)
                .await
                .expect("Failed to convert to remote");
            assert_eq!(
                converted_remote, *remote,
                "Remote ID should match for local {}",
                local
            );
        }

        let result = alias_exists(test_dir.clone(), 9999)
            .await
            .expect("Failed to check non-existent alias");
        assert!(!result, "Non-existent alias should return false");

        cleanup_test_dir("test_multiple_aliass").await;
    }

    #[tokio::test]
    async fn test_file_creation_and_size() {
        let test_dir = setup_test("test_file_creation_and_size").await;

        write_alias(test_dir.clone(), 500, 600)
            .await
            .expect("Failed to write alias");

        let file_path = test_dir.join("0");
        assert!(file_path.exists(), "File should exist");

        let metadata = tokio::fs::metadata(&file_path)
            .await
            .expect("Failed to get file metadata");
        assert_eq!(
            metadata.len(),
            FILE_SIZE,
            "File size should be {}",
            FILE_SIZE
        );

        write_alias(test_dir.clone(), 70000, 80000)
            .await
            .expect("Failed to write alias");

        let file_path_1 = test_dir.join("1");
        assert!(file_path_1.exists(), "File 1 should exist");

        let metadata_1 = tokio::fs::metadata(&file_path_1)
            .await
            .expect("Failed to get file metadata");
        assert_eq!(
            metadata_1.len(),
            FILE_SIZE,
            "File 1 size should be {}",
            FILE_SIZE
        );

        cleanup_test_dir("test_file_creation_and_size").await;
    }

    #[tokio::test]
    async fn test_error_handling() {
        let test_dir = setup_test("test_error_handling").await;

        let result = convert_to_remote(test_dir.clone(), 100).await;
        assert!(
            matches!(result, Err(IDAliasError::AliasNotFound(100))),
            "Should return aliasNotFound error"
        );

        write_alias(test_dir.clone(), 200, 300)
            .await
            .expect("Failed to write alias");
        delete_alias(test_dir.clone(), 200)
            .await
            .expect("Failed to delete alias");

        let result = convert_to_remote(test_dir.clone(), 200).await;
        assert!(
            matches!(result, Err(IDAliasError::AliasNotFound(200))),
            "Should return aliasNotFound after deletion"
        );

        cleanup_test_dir("test_error_handling").await;
    }
}