share / share/sharedb

Inconsistent callback execution - sync vs async

Open
#206 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
6.5k
Forks
456
Avg merge
1d 5h
Merged PRs (30d)
5

Description

Callbacks in ShareDB are usually executed asynchronously but in some situations they are executed synchronously, especially when invoked with an error. This is inconsistent and may lead to unexpected behavior in client code. Could callbacks always be executed asynchronously?

See http://blog.izs.me/post/59142742143/designing-apis-for-asynchrony.

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

No files, tests, or entry points are identified in the issue. Start by tracing ShareDB's callback invocation paths and compare successful and error cases. Done means callbacks consistently run asynchronously, with regression coverage for both situations.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
backend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.