share / share/sharedb

Proposal Redis DB Adapter

Open
#312 1 comment 1 reaction 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

Hello community!

As discussed with @ericyhwang in the issue https://github.com/share/sharedb/issues/266, we took the time to isolate and build an open source Redis Adapter for ShareDB 🎉

Github repository: https://github.com/Wisembly/sharedb-redis
NPM Package: https://www.npmjs.com/package/sharedb-redis-adapter

This package uses the atomic Redis EVAL method to both:

  • Check and reject the commit if the version (score) already exists in the ops collection
  • Persist the op into the ops collection using ZADD

This usage was born from the reflexions and the discussions around the issue #266. We faced a multi-user collaboration issue when people interact on the same document at very high pace (typing pace ~150-200ms per action). We are using this adapter in production for several months now and we’re pretty happy and confident about it.

What do you think about the package ? Let me know what we have to do to be fully integrated into your environment

Are at Wisembly Jam, we love Sharedb. We are proud of our meeting editor and everything was possible because of your work. We're willing to invest time and passion into this adapter to help your community and improve the experience of using sharedb.

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

Read issue #266 and the linked sharedb-redis repository and NPM package first; this issue names no files or tests. Done would be a maintainer decision on whether and how the Redis adapter should be integrated into ShareDB, with the required integration scope identified.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, redis
Domain
backend, database
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.