matthewmueller/x-ray

Better Stream Support

Open

#160 opened on Mar 26, 2016

View on GitHub
 (0 comments) (2 reactions) (0 assignees)JavaScript (5,804 stars) (415 forks)batch import
enhancementepichelp wanted

Description

Currently stream support is poor.

I'm doing experiments on my computer and under stream error nothing happens and this is totally dangerous.

Also I've noticed that code is dirty because first, need to handle callback of the requests, and later, handle the stream interaction (that could be a noop method, lol)

It could be more simple just handling the data as stream (Before my experienced creating fetch-timeline, I think that from2 is the right way, maybe JSONStream too) and, if a callback is provided, convert the stream into a callback interaction (for example, using read-all-stream).

This feature/refactor is very important to support filter/transform data with perfomance.

Contributor guide

Tech stack
javascriptnodejs
Domain
backendperformance
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.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
Node.js streamsx ray library internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
First, examine the current stream handling in x ray's source code, particularly how it processes data via callbacks. Then, evaluate integrating libraries like from2 or JSONStream to create a streaming interface. Ensure backward compatibility by converting streams to callbacks when a callback is provided. Look for any existing discussions or PRs on this topic.