# Migrate to umbrella v3.0

This major version remove the global variables deprecated in the previous versions of the standalone libraries and introduce a productFamily argument.

• The window.__WLP_HONEYCOMB_INSTRUMENTATION_IS_REGISTERED__ global variable have been removed. Instead, provide a client instance to the third-party libraries.
• The window.__WLP_HONEYCOMB_REGISTER_DYNAMIC_FETCH_REQUEST_HOOK__ global variable have been removed. Instead, provide a client instance to the third-party libraries.
• The window.__WLP_HONEYCOMB_REGISTER_DYNAMIC_FETCH_REQUEST_HOOK_AT_START__ global variable have been removed. Instead, provide a client instance to the third-party libraries.
• The window.__WLP_LOGROCKET_INSTRUMENTATION_IS_REGISTERED__ global variable have been removed. Instead, provide a client instance to the third-party libraries.
• The window.__WLP_LOGROCKET_INSTRUMENTATION_REGISTER_GET_SESSION_URL_LISTENER__ global variable have been removed. Instead, provide a client instance to the third-party libraries.
• The window.__WLP_MIXPANEL_IS_INITIALIZED__ global variable have been removed. Instead, provide a client instance to the third-party libraries.
• The createTrackingFunction has been removed, use the client createTrackingFunction method instead.

With the addition of ShareGate to this library, a way to distinguish whether the consumer is a Workleap Platform or a ShareGate application is now required. This is the purpose of the new productFamily argument of the initializeTelemetry function:

initializeTelemetry("sg", {
    ...
});

The initializeTelemetry function mixpanel.productId has been moved as an option.

Previously, it made sense for productId to be a required argument because all WLP products were single-product applications, and the product identifier was known at initialization time. This is not the case for all ShareGate applications.

Before:

initializeTelemetry("wlp", {
    mixpanel: {
        productId: "wlp",
        envOrTrackingApiBaseUrl: "development"
    }
});

Now:

const telemetryClient = initializeTelemetry("wlp", {
    mixpanel: {
        envOrTrackingApiBaseUrl: "development",
        options: {
            productId: "wlp"
        }
    }
});

The createTelemetryContext function signature has been updated to introduce a productFamily argument as the first parameter.

Before:

const context = createTelemetryContext();

Now:

const context = createTelemetryContext("sg");

A Mixpanel client createTrackingFunction instance now accept a productId as an option:

const telemetryClient = initializeTelemetry("wlp", {
    mixpanel: {
        envOrTrackingApiBaseUrl: "development"
    }
});

const track = telemetryClient.mixpanelClient.createTrackingFunction({
    productId: "wlp"
});

If a productId is provided both during initialization and as an option to createTrackingFunction, the value passed to createTrackingFunction takes precedence.

The useMixpanelTrackingFunction hook now accept a productId as an option:

const track = useMixpanelTrackingFunction({
    productId: "wlp"
});

The LogRocket instrumentation client have a new createShareGateDefaultUserTraits method:

const traits = client.createShareGateDefaultUserTraits({
    shareGateAccountId: "cd7fb5ca-f13d-420f-9a87-637b3419d242",
    microsoftUserId: "e9bb1688-a68b-4235-b514-95a59a7bf8bc",
    microsoftTenantId: "86bea6e5-5dbb-43c9-93a4-b10bf91cc6db",
    workspaceId: "225e6494-c008-4086-ac80-3770aa47085b"
});

A new MixpanelPropertiesProvider is available to define scoped Mixpanel properties. These properties are automatically attached to every event tracked by components nested within the provider.

const MixpanelProperties = {
    section: "User Form"
};

function App() {
    return (
        <MixpanelPropertiesProvider value={MixpanelProperties}>
            <NestedComponent />
        </MixpanelPropertiesProvider>
    )
}

When the product family is sg, the domain of the identity cookie is now .sharegate.com instead of .workleap.com.