Update Rust bindings integration

This is a large commit with a grab-bag of changes needed (or nice to have) to get this PR to work on top of #255.

The bindings are still pretty rough, but the result passes the test suite, so at least nothing existing is broken by it.

I'd like to get this landed soon-ish and iterate on things from here.

Signed-off-by: Till Schneidereit <till@tillschneidereit.net>

Author: tschneidereit

builtins/web/fetch/fetch-api.cpp

@@ -18,8 +18,6 @@ using blob::Blob;
 using fetch::Headers;
 using host_api::HostString;
 
-static api::Engine *ENGINE;
-
 enum class FetchScheme {
   About,
   Blob,

builtins/web/fetch/request-response.cpp

@@ -537,7 +537,7 @@ bool RequestOrResponse::append_body(JSContext *cx, JS::HandleObject self, JS::Ha
   api::TaskCompletionCallback callback, HandleObject callback_receiver) {
   MOZ_ASSERT(!body_used(source));
   MOZ_ASSERT(self != source);
-  auto engine = api::Engine::from_context(cx);
+  auto& engine = api::Engine::from_context(cx);
   host_api::HttpIncomingBody *source_body = incoming_body_handle(source);
   host_api::HttpOutgoingBody *dest_body = outgoing_body_handle(self);
   auto res = dest_body->append(&engine, source_body, callback, callback_receiver);
@@ -1160,7 +1160,7 @@ bool reader_for_outgoing_body_then_handler(JSContext *cx, JS::HandleObject body_
     bytes = host_api::HostBytes(unique_ptr<uint8_t[]>(ptr), length);
   }
 
-  auto res = body->write_all(ENGINE, std::move(bytes),
+  auto res = body->write_all(&api::Engine::from_context(cx), std::move(bytes),
     write_all_finish_callback, then_handler);
   if (auto *err = res.to_err()) {
     HANDLE_ERROR(cx, *err);
@@ -1198,7 +1198,7 @@ bool RequestOrResponse::maybe_stream_body(JSContext *cx, JS::HandleObject body_o
   if (is_incoming(body_owner)) {
     auto *source_body = incoming_body_handle(body_owner);
     auto *dest_body = destination->body().unwrap();
-    auto engine = api::Engine::from_context(cx);
+    auto& engine = api::Engine::from_context(cx);
     auto res = dest_body->append(&engine, source_body, finish_outgoing_body_streaming, nullptr);
     if (auto *err = res.to_err()) {
       HANDLE_ERROR(cx, *err);

builtins/web/streams/buf-reader.cpp

@@ -20,7 +20,7 @@ class StreamTask final : public api::AsyncTask {
 
 public:
   explicit StreamTask(const HandleObject reader) : reader_(reader) {
-    handle_ = IMMEDIATE_TASK_HANDLE;
+    handle_ = api::IMMEDIATE_TASK_HANDLE;
   }
 
   [[nodiscard]] bool run(api::Engine *engine) override {
@@ -78,7 +78,7 @@ class StreamTask final : public api::AsyncTask {
   }
 
   [[nodiscard]] bool cancel(api::Engine *engine) override {
-    handle_ = INVALID_POLLABLE_HANDLE;
+    handle_ = api::INVALID_POLLABLE_HANDLE;
     return true;
   }
 

cmake/build-crates.cmake

@@ -47,6 +47,7 @@ add_dependencies("cargo-prebuild_rust_staticlib" cargo-build_generate_bindings)
 add_library(rust-glue STATIC ${CMAKE_CURRENT_SOURCE_DIR}/runtime/crates/jsapi-rs/cpp/jsglue.cpp)
 target_include_directories(rust-glue PRIVATE ${SM_INCLUDE_DIR})
 add_dependencies(rust_staticlib rust-glue)
+target_link_libraries(rust-glue PRIVATE spidermonkey)
 
 # Add a Rust library to the staticlib bundle.
 function(add_rust_lib name path)
@@ -61,7 +62,7 @@ endfunction()
 add_library(rust-hooks-wrappers STATIC "${CMAKE_CURRENT_SOURCE_DIR}/crates/rust-hooks/src/wrappers.cpp")
 target_link_libraries(rust-hooks-wrappers PRIVATE spidermonkey)
 add_library(rust-crates STATIC ${CMAKE_CURRENT_BINARY_DIR}/null.cpp)
-target_link_libraries(rust-crates PRIVATE rust_staticlib rust-hooks-wrappers)
+target_link_libraries(rust-crates PRIVATE rust_staticlib rust-glue rust-hooks-wrappers)
 
 # Add crates as needed here:
 add_rust_lib(rust-url "${CMAKE_CURRENT_SOURCE_DIR}/crates/rust-url")

host-apis/wasi-0.2.0/handles.h

@@ -217,7 +217,7 @@ class IncomingBodyHandle final : public WASIHandle<host_api::HttpIncomingBody> {
 
 public:
   explicit IncomingBodyHandle(HandleOps<host_api::HttpIncomingBody>::owned handle)
-      : WASIHandle(handle), pollable_handle_(INVALID_POLLABLE_HANDLE) {
+      : WASIHandle(handle), pollable_handle_(api::INVALID_POLLABLE_HANDLE) {
     HandleOps<InputStream>::owned stream{};
     if (!wasi_http_types_method_incoming_body_stream(borrow(), &stream)) {
       MOZ_ASSERT_UNREACHABLE("Getting a body's stream should never fail");
@@ -238,7 +238,7 @@ class OutgoingBodyHandle final : public WASIHandle<host_api::HttpOutgoingBody> {
 
 public:
   explicit OutgoingBodyHandle(HandleOps<host_api::HttpOutgoingBody>::owned handle)
-      : WASIHandle(handle), pollable_handle_(INVALID_POLLABLE_HANDLE) {
+      : WASIHandle(handle), pollable_handle_(api::INVALID_POLLABLE_HANDLE) {
     HandleOps<OutputStream>::owned stream{};
     if (!wasi_http_types_method_outgoing_body_write(borrow(), &stream)) {
       MOZ_ASSERT_UNREACHABLE("Getting a body's stream should never fail");

host-apis/wasi-0.2.3/sockets.cpp

@@ -17,7 +17,7 @@ class TCPSocketHandle final : public WASIHandle<host_api::TCPSocket> {
 
 public:
   explicit TCPSocketHandle(HandleOps<host_api::TCPSocket>::owned handle)
-      : WASIHandle(handle), pollable_handle_(INVALID_POLLABLE_HANDLE) {
+      : WASIHandle(handle), pollable_handle_(api::INVALID_POLLABLE_HANDLE) {
     network_ = wasi_sockets_instance_network_instance_network();
   }
 
@@ -29,7 +29,7 @@ class TCPSocketHandle final : public WASIHandle<host_api::TCPSocket> {
     return wasi_sockets_tcp_borrow_network_t(network_.__handle);
   }
   PollableHandle pollable_handle() {
-    if (pollable_handle_ == INVALID_POLLABLE_HANDLE) {
+    if (pollable_handle_ == api::INVALID_POLLABLE_HANDLE) {
       pollable_handle_ = wasi_sockets_tcp_method_tcp_socket_subscribe(borrow()).__handle;
     }
     return pollable_handle_;
@@ -95,7 +95,7 @@ void TCPSocket::close() {
     WASI_SOCKETS_TCP_SHUTDOWN_TYPE_BOTH, &err);
   wasi_io_streams_output_stream_drop_own(state->output_);
   wasi_io_streams_input_stream_drop_own(state->input_);
-  if (state->pollable_handle_ != INVALID_POLLABLE_HANDLE) {
+  if (state->pollable_handle_ != api::INVALID_POLLABLE_HANDLE) {
     wasi_io_poll_pollable_drop_own(own_pollable_t{state->pollable_handle_});
   }
   wasi_sockets_tcp_tcp_socket_drop_own(state->take());

include/config-parser.h

@@ -13,7 +13,7 @@ class ConfigParser {
 
 public:
   ConfigParser() : config_(std::make_unique<api::EngineConfig>()) {
-    config_->content_script_path = mozilla::Some(DEFAULT_SCRIPT_PATH);
+    config_->content_script_path = DEFAULT_SCRIPT_PATH;
   }
 
   /**
@@ -73,13 +73,13 @@ class ConfigParser {
     for (size_t i = 1; i < args.size(); i++) {
       if (args[i] == "-e" || args[i] == "--eval") {
         if (i + 1 < args.size()) {
-          config_->content_script = mozilla::Some(args[i + 1]);
-          config_->content_script_path.reset();
+          config_->content_script = args[i + 1];
+          config_->content_script_path = nullptr;
           i++;
         }
       } else if (args[i] == "-i" || args[i] == "--initializer-script-path") {
         if (i + 1 < args.size()) {
-          config_->initializer_script_path = mozilla::Some(args[i + 1]);
+          config_->initializer_script_path = args[i + 1];
           i++;
         }
       } else if (args[i] == "-v" || args[i] == "--verbose") {
@@ -88,13 +88,13 @@ class ConfigParser {
         config_->debugging = true;
       } else if (args[i] == "--strip-path-prefix") {
         if (i + 1 < args.size()) {
-          config_->path_prefix = mozilla::Some(args[i + 1]);
+          config_->path_prefix = args[i + 1];
           i++;
         }
       } else if (args[i] == "--legacy-script") {
         config_->module_mode = false;
         if (i + 1 < args.size()) {
-          config_->content_script_path = mozilla::Some(args[i + 1]);
+          config_->content_script_path = args[i + 1];
           i++;
         }
       } else if (args[i] == "--wpt-mode") {
@@ -103,7 +103,7 @@ class ConfigParser {
         std::cerr << "Unknown option: " << args[i] << std::endl;
         exit(1);
       } else {
-        config_->content_script_path = mozilla::Some(args[i]);
+        config_->content_script_path = args[i];
       }
     }
 

include/extension-api.h

@@ -35,9 +35,9 @@ constexpr PollableHandle IMMEDIATE_TASK_HANDLE = -2;
 class AsyncTask;
 
 struct EngineConfig {
-  mozilla::Maybe<std::string> content_script_path = mozilla::Nothing();
-  mozilla::Maybe<std::string> content_script = mozilla::Nothing();
-  mozilla::Maybe<std::string> path_prefix = mozilla::Nothing();
+  std::string content_script_path;
+  std::string content_script;
+  std::string path_prefix;
   bool module_mode = true;
 
   /**
@@ -47,7 +47,7 @@ struct EngineConfig {
    * available to content. It can be used to set up the environment for the content
    * script, e.g. by registering builtin modules or adding global properties.
    */
-  mozilla::Maybe<std::string> initializer_script_path = mozilla::Nothing();
+  std::string initializer_script_path;
 
   /**
    * Whether to evaluate the top-level script in pre-initialization mode or not.
@@ -95,6 +95,10 @@ class Engine {
   // TODO: change to static Engine& from_context(JSContext *cx);
   static Engine *get(JSContext *cx);
 
+  static Engine& from_context(JSContext *cx) {
+    return *get(cx);
+  }
+
   /**
    * Returns the `JSContext` associated with the `Engine` instance.
    *
@@ -237,4 +241,36 @@ class AsyncTask {
 
 } // namespace api
 
+namespace rust_bindgen_details {
+
+/**
+ * <div rustbindgen="true" replaces="std::optional">
+ */
+template<typename T> class simple_optional {
+  T* ptr;
+};
+
+/**
+ * <div rustbindgen="true" replaces="std::unique_ptr">
+ */
+template<typename T> class simple_unique_ptr {
+  T* ptr;
+};
+
+/**
+ * <div rustbindgen="true" replaces="std::vector">
+ */
+template<typename T> class simple_vector {
+  T* ptr;
+};
+
+/**
+ * <div rustbindgen="true" replaces="mozilla::Maybe">
+ */
+template<typename T> class simple_maybe {
+  T* ptr;
+};
+
+}
+
 #endif // EXTENSION_API_H

include/host_api.h

@@ -20,27 +20,6 @@
 #include "jsapi.h"
 #pragma clang diagnostic pop
 
-/**
- * <div rustbindgen="true" replaces="std::optional">
- */
-template<typename T> class simple_optional {
-  T* ptr;
-};
-
-/**
- * <div rustbindgen="true" replaces="std::unique_ptr">
- */
-template<typename T> class simple_unique_ptr {
-  T* ptr;
-};
-
-/**
- * <div rustbindgen="true" replaces="std::vector">
- */
-template<typename T> class simple_vector {
-  T* ptr;
-};
-
 using api::PollableHandle;
 using std::optional;
 using std::string_view;