Struct JavaScriptBuilderElement 

pub struct JavaScriptBuilderElement { /* private fields */ }

Generates a JavaScript include to be run on the client device.

The element renders the bundled Mustache template with the JSON payload produced by the JSON builder, the request’s session and sequence evidence, a callback URL and the request parameters, then optionally minifies the result. The generated JavaScript is stored on the flow data under the crate::JAVASCRIPT_BUILDER_ELEMENT_DATA_KEY element data key. It implements the javascript-builder specification.

Derivation rules

• protocol: the configured protocol if set, else the header.protocol evidence, else https.
• host: the configured host if set, else the header.host evidence.
• object name: the query.fod-js-object-name evidence if present, else the configured object name (default fod).
• enable cookies: the query.fod-js-enable-cookies evidence parsed as a boolean if present, else the configured default (true).
• callback URL: built only when protocol, host and endpoint are all present, normalizing the single slash between host and endpoint. When a URL is built the background-update mechanism is enabled.
• parameters: every query.* evidence entry except the session id and sequence, with the prefix stripped and the key and value URL-encoded, serialized as a JSON object.
• has delayed properties: true when the JSON payload contains the delayexecution marker.
• supports promises: true when the device-detection Promise property is Full. The check is latched off once the property proves unavailable.
• supports fetch: true when the device-detection Fetch property is true. The check is latched off once the property proves unavailable.

Example

use std::sync::Arc;
use fiftyone_pipeline_core::{Evidence, Pipeline};
use fiftyone_json_builder::JsonBuilderElement;
use fiftyone_javascript_builder::{JavaScriptBuilderElement, JAVASCRIPT_BUILDER_DATA_KEY};

let pipeline = Pipeline::builder()
    .add_element(Arc::new(JsonBuilderElement::new()))
    .add_element(Arc::new(JavaScriptBuilderElement::new()))
    .build()
    .unwrap();

let mut data = pipeline.create_flow_data_with(
    Evidence::builder()
        .add("header.host", "localhost")
        .add("query.sequence", "1")
        .build(),
);
data.process().unwrap();

let js = data.get(JAVASCRIPT_BUILDER_DATA_KEY).unwrap().javascript().to_owned();
assert!(js.contains("fiftyoneDegreesManager"));

Implementations

impl JavaScriptBuilderElement

pub fn new() -> Self

Create a JavaScript builder with the default configuration.

pub fn builder() -> JavaScriptBuilderElementBuilder

Start configuring a JavaScript builder.

Trait Implementations

impl Default for JavaScriptBuilderElement

fn default() -> Self

Returns the “default value” for a type.

impl FlowElement for JavaScriptBuilderElement

fn process(&self, data: &mut FlowData) -> Result<()>

Process the supplied flow data with this element.

fn data_key(&self) -> &str

The string data key used to store and retrieve this element’s data in a flow data. This is a specification MUST.

fn evidence_key_filter(&self) -> &dyn EvidenceKeyFilter

A filter describing the evidence keys this element can make use of.

fn properties(&self) -> &[PropertyMetaData]

Metadata for the properties this element can populate.

fn is_concurrent(&self) -> bool

True if this element starts multiple threads internally. Defaults to false. A pipeline reports itself concurrent if any element does, which influences whether thread-safe flow data is needed.