1591556 - Consider a Nice Rust API for the Glean SDK General Control Surface

Status: RESOLVED FIXED

(Data Platform and Tools :: Glean: SDK, enhancement, P1)

Description

[Chris H-C :chutten]

The FOGotype is our first Rust customer, so we should try out a nice Rust API.

It could be that the existing General API is nice enough, but it could also be a good opportunity to try something new if there's an opportunity to be nicer.

"nice" here might mean things like

• maybe not having to do singleton and threading things in-product
• dealing with higher-level abstractions (objects, not handles)
• friendly names

Comment 1

[Chris H-C :chutten]

This might end up being a subset of the work needed for bug 1579146, depending on whether the control API in the prototype ends up being nice enough to keep. (or whether we burn it to the ground after the FOGotype is done)

Comment 2

[Jan-Erik Rediger [:janerik]]

Taking this bug as part of the API preview.

Comment 3

[Jan-Erik Rediger [:janerik]]

Attachment: GitHub Pull Request

The linked PR provides the API preview based on the FFI (that is: it works without any changes to the internals of Glean right now)

let cfg = Configuration {
    data_path,
    application_id: "org.mozilla.glean_core.example".into(),
    upload_enabled: true,
    max_events: None,
};
glean::initialize(cfg)?;
glean::register_ping_type(&PrototypePing);

if glean::send_ping_by_name("prototype") {
    log::info!("Successfully collected a prototype ping");
} else {
    log::info!("Prototype ping failed");
}

Comment 4

[Jan-Erik Rediger [:janerik]]

the preview landed and is about to land in m-c.