Importing in jest errors on missing TextEncoder

[nbrustein]

Select which package(s) are affected

@livekit/components-core

Describe the bug

What is happening

I have a jest spec that imports a LiveKit component that has this code:

import {
    type AgentState,
    LiveKitRoom,
    useVoiceAssistant,
    BarVisualizer,
    RoomAudioRenderer,
    VoiceAssistantControlBar,
    DisconnectButton,
} from '@livekit/components-react';

I'm not actually using that LiveKit component in this spec at all. It just happens to be getting imported.

The test run fails on ReferenceError: TextEncoder is not defined

I can fix this by adding this to my setup:

global.TextEncoder = require('util').TextEncoder;
global.TextDecoder = require('util').TextDecoder;

What I expect

Just importing some livekit components should not break my test setup.

How to resolve

In places like this where you're using TextEncoder or TextDecoder, do not instantiate the encoder at the top level of the file. Wait until the function is called that needs the encoder, and initialize it then.

Reproduction

Add the following import to a jest spec and run it:

import {
    type AgentState,
    LiveKitRoom,
    useVoiceAssistant,
    BarVisualizer,
    RoomAudioRenderer,
    VoiceAssistantControlBar,
    DisconnectButton,
} from '@livekit/components-react';

Logs

No response

System Info

System:
    OS: macOS 14.6.1
    CPU: (10) arm64 Apple M1 Max
    Memory: 11.13 GB / 64.00 GB
    Shell: 3.2.57 - /bin/bash
  Binaries:
    Node: 22.11.0 - ~/.asdf/installs/nodejs/22.11.0/bin/node
    Yarn: 4.5.3 - ~/.asdf/installs/nodejs/22.11.0/bin/yarn
    npm: 10.9.0 - ~/.asdf/plugins/nodejs/shims/npm
  Browsers:
    Chrome: 131.0.6778.205
    Safari: 18.1

Severity

annoyance

Additional Information

No response

[lukasIO]

I get your point, but I think this is an issue of the jest environment not defining TextEncoder which is a globally available constructor on all supported browers.