serde_v8's Introduction

serde_v8

Author: Aaron O'Mullan [email protected]

Serde support for encoding/decoding (rusty_)v8 values.

Broadly serde_v8 aims to provide an expressive but ~maximally efficient encoding layer to biject rust & v8/js values. It's a core component of deno's op-layer and is used to encode/decode all non-buffer values.

Original issue: denoland/deno#9540

Quickstart

serde_v8 fits naturally into the serde ecosystem, so if you've already used serde or serde_json, serde_v8's API should be very familiar.

serde_v8 exposes two key-functions:

to_v8: maps rust->v8, similar to serde_json::to_string, ...
from_v8: maps v8->rust, similar to serde_json::from_str, ...

Best practices

Whilst serde_v8 is compatible with serde_json::Value it's important to keep in mind that serde_json::Value is essentially a loosely-typed value (think nested HashMaps), so when writing ops we recommend directly using rust structs/tuples or primitives, since mapping to serde_json::Value will add extra overhead and result in slower ops.

I also recommend avoiding unecessary "wrappers", if your op takes a single-keyed struct, consider unwrapping that as a plain value unless you plan to add fields in the near-future.

Instead of returning "nothing" via Ok(json!({})), change your return type to rust's unit type () and returning Ok(()), serde_v8 will efficiently encode that as a JS null.

Advanced features

If you need to mix rust & v8 values in structs/tuples, you can use the special serde_v8::Value type, which will passthrough the original v8 value untouched when encoding/decoding.

TODO

Experiment with KeyCache to optimize struct keys
Experiment with external v8 strings
Explore using json-stringifier.cc's fast-paths for arrays
Improve tests to test parity with serde_json (should be mostly interchangeable)
Consider a Payload type that's deserializable by itself (holds scope & value)
Ensure we return errors instead of panicking on .unwrap()s

serde_v8's People

Contributors

Stargazers

Watchers

serde_v8's Issues

Add `ByteString` magic type

This would losslessly store a string as a byte vector internally.

Ref denoland/deno#10991

Panic when deserializing a primitive value into a struct

E.g 123 being deserialized into a struct { foo: String }.

serde_v8 is vulnerable to prototype pollution

use rusty_v8 as v8;
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize)]
struct TestStruct {
    a: String,
    b: String,
}

fn run_script(scope: &mut v8::HandleScope, code: &str) {
    let code_string = v8::String::new(scope, code).unwrap();
    let script = v8::Script::compile(scope, code_string, None).unwrap();
    script.run(scope).unwrap();
}

fn main() {
    let platform = v8::new_default_platform(0, false).make_shared();
    v8::V8::initialize_platform(platform);
    v8::V8::initialize();

    let isolate = &mut v8::Isolate::new(Default::default());
    let scope = &mut v8::HandleScope::new(isolate);
    let context = v8::Context::new(scope);
    let scope = &mut v8::ContextScope::new(scope, context);

    run_script(
        scope,
        r#"
            Object.defineProperty(Object.prototype, "a", {
                set: (v) => {
                    throw new Error("WTF");
                }
            });
        "#,
    );

    let test = TestStruct {
        a: "a".into(),
        b: "b".into(),
    };
    let try_catch = &mut v8::TryCatch::new(scope);
    let _result = serde_v8::to_v8(try_catch, test);

    match try_catch.message() {
        Some(message) => println!(
            "Thrown exception: {}",
            message.get(try_catch).to_rust_string_lossy(try_catch)
        ),
        None => println!("No exception thrown."),
    }
}

Thrown exception: Uncaught Error: WTF

Recommend Projects

denoland / serde_v8 Goto Github PK

serde_v8's Introduction

serde_v8

Quickstart

Best practices

Advanced features

TODO

serde_v8's People

Contributors

Stargazers

Watchers

Forkers

serde_v8's Issues

Add `ByteString` magic type

Panic when deserializing a primitive value into a struct

serde_v8 is vulnerable to prototype pollution

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent