Skip to content

[rust] Publish Selenium Manager as native shared library #15368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 9 commits into
base: trunk
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion rust/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
load("@crates//:defs.bzl", "all_crate_deps")
load("//rust:defs.bzl", "rust_binary", "rust_library", "rust_test", "rustfmt_config")
load("//rust:defs.bzl", "rust_binary", "rust_library", "rust_shared_library", "rust_test", "rustfmt_config")

rustfmt_config(
name = "enable-rustfmt",
Expand Down Expand Up @@ -96,6 +96,18 @@ rust_library(
deps = all_crate_deps(normal = True),
)

rust_shared_library(
# The name here is used as the crate name
name = "selenium_manager_shared",
srcs = glob(
["src/**/*.rs"],
exclude = ["main.rs"],
),
edition = "2021",
visibility = ["//rust:__subpackages__"],
deps = all_crate_deps(normal = True),
)

filegroup(
name = "selenium_manager_srcs",
srcs = [
Expand Down
2 changes: 1 addition & 1 deletion rust/Cargo.Bazel.lock
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"checksum": "e68bc8d92875cfa0a3769e6e31b05c99d2669f20fda466dd415ef9dcbd361b7d",
"checksum": "04c2f1c8b7c0ac539b226b5da83b0b41311961e3c8b2fed1a3dfae76721fec9c",
"crates": {
"addr2line 0.21.0": {
"name": "addr2line",
Expand Down
7 changes: 7 additions & 0 deletions rust/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@ description = """
Selenium Manager is a CLI tool that automatically manages the browser/driver infrastructure required by Selenium.
"""

[[bin]]
name = "selenium-manager"

[lib]
name = "selenium_manager"
crate-type = ["cdylib", "rlib"]

[dependencies]
clap = { version = "4.5.23", features = ["derive", "cargo"] }
log = "0.4.22"
Expand Down
2 changes: 2 additions & 0 deletions rust/defs.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@ load(
"//rust/private:rustfmt_wrapper.bzl",
_rust_binary = "rust_binary",
_rust_library = "rust_library",
_rust_shared_library = "rust_shared_library",
_rust_test = "rust_test",
_rust_test_suite = "rust_test_suite",
)

rust_binary = _rust_binary
rust_library = _rust_library
rust_shared_library = _rust_shared_library
rust_test = _rust_test
rust_test_suite = _rust_test_suite
rustfmt_config = _rustfmt_config
5 changes: 5 additions & 0 deletions rust/private/rustfmt_wrapper.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ load(
"rustfmt_test",
_rust_binary = "rust_binary",
_rust_library = "rust_library",
_rust_shared_library = "rust_shared_library",
_rust_test = "rust_test",
_rust_test_suite = "rust_test_suite",
)
Expand All @@ -27,6 +28,10 @@ def rust_library(name, **kwargs):
_rust_library(name = name, **kwargs)
_wrap_with_fmt_test(name, kwargs.get("tags", []))

def rust_shared_library(name, **kwargs):
_rust_shared_library(name = name, **kwargs)
_wrap_with_fmt_test(name, kwargs.get("tags", []))

def rust_binary(name, **kwargs):
_rust_binary(name = name, **kwargs)
_wrap_with_fmt_test(name, kwargs.get("tags", []))
Expand Down
91 changes: 91 additions & 0 deletions rust/src/ffi.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The SFC licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

use std::{ffi::{c_char, c_int, CStr, CString}, ptr::null_mut};

// this is callback function to be called each time when rust wants to send log data
type LogCallback = extern "C" fn(level: c_int, message: *const std::os::raw::c_char);

#[repr(C)]
pub struct WebDriverPathResult {
success: bool,
driver_path: *mut c_char,
error: *mut c_char,
}

// this is just an example how to expose function for external usage
#[no_mangle]
pub extern "C" fn get_dummy_webdriver_path(driver_name: *const c_char, log: LogCallback) -> WebDriverPathResult {
let result = std::panic::catch_unwind(|| {

for i in 1..6 {
let message = CString::new("Hello, I am logging message").unwrap();
//let message = CString::new(String::from("A").repeat(10_000_000)).unwrap();
log(i, message.as_ptr());
}

//panic!("Intentional panic for testing");
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bonigarcia can you help me here? We want to handle all panics in this block and propagate it in returning result. Seems I do it incorrectly.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I don't have bandwidth for the following weeks. In any case, this deserves to be discussed in the following Selenium Dev Summit in Valencia (24-25 March).


let driver = unsafe { CStr::from_ptr(driver_name).to_str().unwrap() };

return CString::new("This is dummy driver path for ".to_owned() + driver).unwrap().into_raw();
//return CString::new(String::from("A").repeat(10_000_000)).unwrap().into_raw();
});

match result {
Ok(driver_path) => WebDriverPathResult {
success: true,
driver_path,
error: null_mut(),
},
Err(panic) => WebDriverPathResult {
success: false,
driver_path: null_mut(),
error: CString::new(extract_panic_message(panic)).unwrap().into_raw(),
}
}
}

#[no_mangle]
pub extern "C" fn free_webdriver_path_result(result: *mut WebDriverPathResult) {
if result.is_null() {
return;
}
unsafe {
let ffi_result = &mut *result;
if !ffi_result.driver_path.is_null() {
// Reconstruct CString to drop it and free memory
let _ = CString::from_raw(ffi_result.driver_path);
}
if !ffi_result.error.is_null() {
// Reconstruct CString to drop it and free memory
let _ = CString::from_raw(ffi_result.error);
}
}
}

/// Extract panic message from `Box<dyn Any>`
fn extract_panic_message(panic: Box<dyn std::any::Any + Send>) -> String {
// Try to downcast to common panic types
if let Some(s) = panic.downcast_ref::<String>() {
s.clone()
} else if let Some(s) = panic.downcast_ref::<&str>() {
s.to_string()
} else {
"Unknown panic (non-string payload)".to_string()
}
}
2 changes: 2 additions & 0 deletions rust/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ pub mod safaritp;
pub mod shell;
pub mod stats;

mod ffi;

pub const REQUEST_TIMEOUT_SEC: u64 = 300; // The timeout is applied from when the request starts connecting until the response body has finished
pub const STABLE: &str = "stable";
pub const BETA: &str = "beta";
Expand Down