pinojs / pinojs/thread-stream

flush semantics are unclear

Open
#56 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
261
Forks
31
Avg merge
2d 9h
Merged PRs (30d)
4

Description

The semantics of flush is a little unclear to me, i.e. when I call flush(cb) I'd expect that all data that I have write(chunk) would be flushed when cb is invoked. However, unlike flushSync this is not the case. flush doesn't actually flush the buffer to the worker, it just waits for whatever already has been flushed to worker is done.

Contributor guide

No contributing guide indexed for this repository

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 tracing the flush(cb), flushSync, and write(chunk) entry points in the thread-stream implementation and compare when data is sent to the worker. Clarify the intended callback contract, then update the implementation and relevant tests so flush(cb) has a defined relationship to all preceding writes. The issue does not name specific files or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
backend
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.