# Migrate to v2.0

This major version introduces several important changes. registerLogRocketInstrumentation now returns a client instance. The standalone createUserTraits function has been moved to the client, telemetry correlation ids are no longer implicitly added to session replays, and global variables for third-party integrations have been deprecated. To attach telemetry correlation ids to session replays, you must now provide a TelemetryContext instance. Third-party libraries such as Squide and the Platform widgets should also be explicitly provided with the returned client instance to integrate with Workleap's LogRocket instrumentation.

• Removed the createUserTraits standalone function, use the client createWorkleapPlatformDefaultUserTraits method instead.

• The window.__WLP_LOGROCKET_INSTRUMENTATION_IS_REGISTERED__ global variable have been deprecated. Instead, provide a client instance to the third-party libraries.
• The window.__WLP_LOGROCKET_INSTRUMENTATION_REGISTER_GET_SESSION_URL_LISTENER__ global variable have been deprecated. Instead, provide a client instance to the third-party libraries.

• The telemetryId and deviceId correlation ids are no longer implicitly attached to LogRocket session replays. To attach these ids, provide a TelemetryContext instance to the registerLogRocketInstrumentation function. You can create a TelemetryContext instance using the createTelemetryContext utility function.
• If your application is a React application, you must now import everything from @workleap/logrocket/react rather than @workleap/logrocket.

The registerLogRocketInstrumentation function now returns a client that must be forwarded to the LogRocketInstrumentationProvider. In addition, a TelemetryContext instance must be manually provided to the registration function to ensure correlation ids continue being attached to LogRocket session replays.

Before:

import { registerLogRocketInstrumentation } from "@workleap/logrocket";
import { StrictMode } from "react";
import { createRoot } from "react-dom/client";
import { App } from "./App.tsx";

registerLogRocketInstrumentation("my-app-id");

const root = createRoot(document.getElementById("root")!);

root.render(
    <StrictMode>
        <App />
    </StrictMode>
);

Now:

import { registerLogRocketInstrumentation, LogRocketInstrumentationProvider, createTelemetryContext } from "@workleap/logrocket/react";
import { StrictMode } from "react";
import { createRoot } from "react-dom/client";
import { App } from "./App.tsx";

const client = registerLogRocketInstrumentation("my-app-id", {
    telemetryContext: createTelemetryContext()
});

const root = createRoot(document.getElementById("root")!);

root.render(
    <StrictMode>
        <LogRocketInstrumentationProvider client={client}>
            <App />
        </LogRocketInstrumentationProvider>
    </StrictMode>
);

The createUserTraits standalone function is not exported anymore. Use the client createWorkleapPlatformDefaultUserTraits method instead.

Before:

import { createDefaultUserTraits } from "@workleap/logrocket";
import LogRocket from "logrocket";

const traits = createDefaultUserTraits({
    userId: "6a5e6b06-0cac-44ee-8d2b-00b9419e7da9",
    organizationId: "e6bb30f8-0a00-4928-8943-1630895a3f14",
    organizationName: "Acme",
    isMigratedToWorkleap: true,
    isOrganizationCreator: false,
    isAdmin: false
});

LogRocket.identify(traits.userId, traits);

Now:

import { useLogRocketInstrumentationClient } from "@workleap/logrocket/react";
import LogRocket from "logrocket";

const client = useLogRocketInstrumentationClient();

const traits = client.createWorkleapPlatformDefaultUserTraits({
    userId: "6a5e6b06-0cac-44ee-8d2b-00b9419e7da9",
    organizationId: "e6bb30f8-0a00-4928-8943-1630895a3f14",
    organizationName: "Acme",
    isMigratedToWorkleap: true,
    isOrganizationCreator: false,
    isAdmin: false
});

LogRocket.identify(traits.userId, traits);

• A new LogRocketInstrumentationProvider React context provider is available to forward a LogRocketInstrumentatonClient instance.
• A new useLogRocketInstrumentationClient hook is available to retrieve the provided LogRocketInstrumentatonClient instance.