socketio / socketio/socket.io

Can't enable debug messages when using client in a web worker

Open
#5,104 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement package:socket.io-client
Dominant language
TypeScript
Stars
63.2k
Forks
10.3k
Avg merge
11d 20h
Merged PRs (30d)
2

Description

You want to:

  • report a bug
  • request a feature
Current behavior

The documentation says to set localStorage.debug = '' in order to turn on debug messages, but when using socket.io-client from inside of a web worker we don't have access to localStorage. We tried explicitly calling debug.enable('') from the worker, but that doesn't seem to work either.

As doing more work in terms of I/O and processing (we are loading large datasets into the client) is moving to worker threads this is likely to become a more common issue. I'm not familiar enough with the setup to know whether this needs to be handled by socket-io.client or the debug library that it uses.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the socket.io-client documentation for the localStorage.debug guidance and the worker-side debug.enable('*') attempt. Reproduce the behavior inside a web worker and trace how debug messages are initialized there. Done means debug messages can be enabled from a worker without localStorage, with the behavior documented or covered by an appropriate test.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
frontend, web-dev
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.