green_copper_runtime/modules/io/fs/
mod.rs

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
//! #FS Module
//!
//! ```javascript
//! async function test() {
//!     let fs_mod = await import('greco://fs');
//!     await fs_mod.write('./test.txt', 'hello from greco fs');
//! }
//! ```
//! # example
//!
//! ```rust
//! use quickjs_runtime::builder::QuickJsRuntimeBuilder;
//! use futures::executor::block_on;
//! use quickjs_runtime::jsutils::Script;
//! use quickjs_runtime::values::JsValueFacade;
//! let rtb = QuickJsRuntimeBuilder::new();
//! let rtb = green_copper_runtime::init_greco_rt(rtb);
//! let rt = rtb.build();
//! rt.eval_sync(None, Script::new("init_fs.es", "async function test_write() {\
//!     let fs_mod = await import('greco://fs');\
//!     await fs_mod.write('./test.txt', 'hello from greco fs');
//! }\n")).expect("script failed");
//! let prom_jsvf = rt.invoke_function_sync(None, &[], "test_write", vec![]).ok().expect("write function invocation failed");
//! // wait for promise to be done
//!
//! if let JsValueFacade::JsPromise { cached_promise } = prom_jsvf {
//!     let done = block_on(cached_promise.get_promise_result());
//!     assert!(done.is_ok());
//! } else {
//!     panic!("not a promise");
//! }
//!
//! // do read test
//! let eval_fut = rt.eval(None, Script::new("init_fs.es", "async function test_read() {\
//!     let fs_mod = await import('greco://fs');\
//!     return await fs_mod.readString('./test.txt');
//! }\n"));
//! let _ = block_on(eval_fut);
//! let prom_jsvf = rt.invoke_function_sync(None, &[], "test_read", vec![]).ok().expect("read invocation failed");
//! // wait for promise to be done
//! if let JsValueFacade::JsPromise { cached_promise } = prom_jsvf {
//!     let done = block_on(cached_promise.get_promise_result()).ok().expect("prom failed");
//!     match done {
//!        Ok(done_jsvf) => {
//!           let s = done_jsvf.stringify();
//!           assert_eq!(s, "String: hello from greco fs");
//!        }
//!        Err(val) => {
//!           panic!("promise was rejected: {}", val.stringify());
//!        }
//!     }
//!     
//! } else {
//!     panic!("not  promise")
//! }
//! ```
//!
//! # Methods
//!
//! ##append
//! ##copy
//! ##createSymlink
//! ##createDirs
//! ##getMetadata
//! ##getSymlinkMetadata
//! ##list
//! ##readString
//! ##removeDir
//! ##removeFile
//! ##rename
//! ##touch
//! ##write
//!

use quickjs_runtime::builder::QuickJsRuntimeBuilder;
use quickjs_runtime::jsutils::modules::NativeModuleLoader;
use quickjs_runtime::jsutils::JsError;
use quickjs_runtime::quickjsrealmadapter::QuickJsRealmAdapter;
use quickjs_runtime::quickjsvalueadapter::QuickJsValueAdapter;
use quickjs_runtime::values::JsValueFacade;
use std::fs;

pub(crate) fn read_string(args: &[JsValueFacade]) -> Result<JsValueFacade, JsError> {
    if args.len() != 1 || !args[0].is_string() {
        Err(JsError::new_str(
            "readString requires one argument: (String)",
        ))
    } else {
        let path = args[0].get_str();

        match fs::read_to_string(path) {
            Ok(s) => Ok(JsValueFacade::new_string(s)),
            Err(e) => Err(JsError::new_string(format!("{e}"))),
        }
    }
}

pub(crate) fn remove_file(args: &[JsValueFacade]) -> Result<JsValueFacade, JsError> {
    if args.len() != 1 || !args[0].is_string() {
        Err(JsError::new_str(
            "removeFile requires one argument: (String)",
        ))
    } else {
        let path = args[0].get_str();

        match fs::remove_file(path) {
            Ok(_) => Ok(JsValueFacade::Null),
            Err(e) => Err(JsError::new_string(format!("{e}"))),
        }
    }
}

pub(crate) fn append(_args: &[JsValueFacade]) -> Result<JsValueFacade, JsError> {
    unimplemented!()
}

pub(crate) fn copy(_args: &[JsValueFacade]) -> Result<JsValueFacade, JsError> {
    unimplemented!()
}

pub(crate) fn create_symlink(_args: &[JsValueFacade]) -> Result<JsValueFacade, JsError> {
    unimplemented!()
}

pub(crate) fn create_dirs(_args: &[JsValueFacade]) -> Result<JsValueFacade, JsError> {
    unimplemented!()
}

pub(crate) fn get_metadata(_args: &[JsValueFacade]) -> Result<JsValueFacade, JsError> {
    unimplemented!()
}

pub(crate) fn get_symlink_metadata(_args: &[JsValueFacade]) -> Result<JsValueFacade, JsError> {
    unimplemented!()
}

pub(crate) fn list(_args: &[JsValueFacade]) -> Result<JsValueFacade, JsError> {
    unimplemented!()
}

pub(crate) fn remove_dir(_args: &[JsValueFacade]) -> Result<JsValueFacade, JsError> {
    unimplemented!()
}

pub(crate) fn rename(_args: &[JsValueFacade]) -> Result<JsValueFacade, JsError> {
    unimplemented!()
}

pub(crate) fn touch(_args: &[JsValueFacade]) -> Result<JsValueFacade, JsError> {
    unimplemented!()
}

/// write
/// write to a file
/// # Example
/// ```javascript
/// async function write_example() {
///    let fs = await import('greco://fs');
///    await fs.write('./test.txt', 'hello world');
/// }
/// ```
pub(crate) fn write(args: &[JsValueFacade]) -> Result<JsValueFacade, JsError> {
    if args.len() != 2 || !args[0].is_string() {
        Err(JsError::new_str(
            "write requires two arguments: (String, obj)",
        ))
    } else {
        let path = args[0].get_str();
        let content = if args[1].is_string() {
            args[1].get_str().to_string()
        } else {
            args[1].stringify()
        };

        match fs::write(path, content) {
            Ok(_) => Ok(JsValueFacade::Null),
            Err(e) => Err(JsError::new_string(format!("{e}"))),
        }
    }
}

pub struct FsModuleLoader {}

impl NativeModuleLoader for FsModuleLoader {
    fn has_module(&self, _realm: &QuickJsRealmAdapter, module_name: &str) -> bool {
        module_name.eq("greco://fs")
    }

    fn get_module_export_names(
        &self,
        _realm: &QuickJsRealmAdapter,
        _module_name: &str,
    ) -> Vec<&str> {
        vec![
            "append",
            "copy",
            "createSymlink",
            "createDirs",
            "getMetadata",
            "getSymlinkMetadata",
            "list",
            "readString",
            "removeDir",
            "removeFile",
            "rename",
            "touch",
            "write",
        ]
    }

    fn get_module_exports(
        &self,
        realm: &QuickJsRealmAdapter,
        _module_name: &str,
    ) -> Vec<(&str, QuickJsValueAdapter)> {
        init_exports(realm).expect("init fs exports failed")
    }
}

pub(crate) fn init(builder: QuickJsRuntimeBuilder) -> QuickJsRuntimeBuilder {
    builder.native_module_loader(FsModuleLoader {})
}

fn init_exports(
    realm: &QuickJsRealmAdapter,
) -> Result<Vec<(&'static str, QuickJsValueAdapter)>, JsError> {
    let copy_func = JsValueFacade::new_function("copy", copy, 1);
    let write_func = JsValueFacade::new_function("write", write, 1);
    let append_func = JsValueFacade::new_function("append", append, 1);
    let create_symlink_func = JsValueFacade::new_function("createSymlink", create_symlink, 1);
    let create_dirs_func = JsValueFacade::new_function("createDirs", create_dirs, 1);
    let get_metadata_func = JsValueFacade::new_function("getMetadata", get_metadata, 1);
    let get_symlink_metadata_func =
        JsValueFacade::new_function("getSymlinkMetadata", get_symlink_metadata, 1);
    let list_func = JsValueFacade::new_function("list", list, 1);
    let remove_dir_func = JsValueFacade::new_function("removeDir", remove_dir, 1);
    let rename_func = JsValueFacade::new_function("rename", rename, 1);
    let touch_func = JsValueFacade::new_function("touch", touch, 1);
    let remove_file_func = JsValueFacade::new_function("removeFile", remove_file, 1);
    let read_string_func = JsValueFacade::new_function("readString", read_string, 1);

    Ok(vec![
        ("write", realm.from_js_value_facade(write_func)?),
        (
            "getSymlinkMetadata",
            realm.from_js_value_facade(get_symlink_metadata_func)?,
        ),
        ("copy", realm.from_js_value_facade(copy_func)?),
        ("append", realm.from_js_value_facade(append_func)?),
        (
            "createSymlink",
            realm.from_js_value_facade(create_symlink_func)?,
        ),
        ("createDirs", realm.from_js_value_facade(create_dirs_func)?),
        (
            "getMetadata",
            realm.from_js_value_facade(get_metadata_func)?,
        ),
        ("list", realm.from_js_value_facade(list_func)?),
        ("removeDir", realm.from_js_value_facade(remove_dir_func)?),
        ("rename", realm.from_js_value_facade(rename_func)?),
        ("touch", realm.from_js_value_facade(touch_func)?),
        ("removeFile", realm.from_js_value_facade(remove_file_func)?),
        ("readString", realm.from_js_value_facade(read_string_func)?),
    ])
}

#[cfg(test)]
pub mod tests {
    use crate::init_greco_rt;
    use backtrace::Backtrace;
    use log::LevelFilter;
    use quickjs_runtime::builder::QuickJsRuntimeBuilder;
    use quickjs_runtime::jsutils::Script;
    use quickjs_runtime::values::JsValueFacade;
    use std::panic;

    #[test]
    fn test_fs() {
        panic::set_hook(Box::new(|panic_info| {
            let backtrace = Backtrace::new();
            log::error!(
                "thread panic occurred: {}\nbacktrace: {:?}",
                panic_info,
                backtrace
            );
        }));

        simple_logging::log_to_file("grecort.log", LevelFilter::max())
            .ok()
            .expect("could not init logger");

        let mut rtb = QuickJsRuntimeBuilder::new();
        rtb = init_greco_rt(rtb);
        let rt = rtb.build();
        rt.eval_sync(
            None,
            Script::new(
                "init_fs.es",
                "async function test_write() {\
     let fs_mod = await import('greco://fs');\
     await fs_mod.write('./test.txt', 'hello from greco fs');
 }\n",
            ),
        )
        .ok()
        .expect("init write script failed");
        let prom_esvf = rt
            .invoke_function_sync(None, &[], "test_write", vec![])
            .ok()
            .expect("write function invocation failed");
        // wait for promise to be done

        assert!(prom_esvf.is_js_promise());

        if let JsValueFacade::JsPromise { cached_promise } = prom_esvf {
            let done = cached_promise
                .get_promise_result_sync()
                .expect("promise timed out");
            assert!(done.is_ok());
        }

        // do read test
        rt.eval_sync(
            None,
            Script::new(
                "init_fs.es",
                "async function test_read() {\
     let fs_mod = await import('greco://fs');\
     return await fs_mod.readString('./test.txt');
 }\n",
            ),
        )
        .ok()
        .expect("init write script failed");
        let prom_esvf = rt
            .invoke_function_sync(None, &[], "test_read", vec![])
            .ok()
            .expect("read invocation failed");
        // wait for promise to be done

        assert!(prom_esvf.is_js_promise());
        if let JsValueFacade::JsPromise { cached_promise } = prom_esvf {
            let done = cached_promise
                .get_promise_result_sync()
                .expect("promise timed out");
            assert!(done.is_ok());
            let done_esvf = done.ok().unwrap();
            let s = done_esvf.get_str();
            assert_eq!(s, "hello from greco fs");
        }
    }
}