cube-js/cube

Ability to monitor the websocket status & last message

Open

#4,015 opened on Feb 1, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Rust (1,965 forks)batch import
help wanted

Repository metrics

Stars
 (19,563 stars)
PR merge metrics
 (Avg merge 5d 16h) (138 merged PRs in 30d)

Description

Context: https://cube-js.slack.com/archives/CC0403RRR/p1642620249094800

When using the real-time websocket, there is no error handling available when the socket disconnects after the visual has been rendered. While the socket is disconnected, no new messages are published so rendered views will become stale without any error or update. Would like the ability to access the socket state (connected/connecting/error) as well as the last message to either handle errors in each visual, or render a general status component to show the health of the data on the screen.

Contributor guide

Research direction
Examine the existing WebSocket connection code in the Cube.js client SDK, particularly the `WebSocketTransport` class. Identify where the WebSocket is instantiated and how connection states (open, close, error) are handled. Implement a mechanism to expose the current connection status and the last received message, possibly through event emitters or a reactive state object. Ensure backward compatibility and add tests.
Tech stack
javascripttypescript
Domain
frontendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptWebSocket API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70