Feature Request: Pluggable persistence provider

[dhmw]

Hi,

Is there any chance that the existing LevelDB integration could be refactored as a plugin interface?

I'm very interested in using this library, but not so much with LevelDB and I would like to bring my own persistence layer. (Probably either AWS S3 or DynamoDB).

Regards,
Doug

[dhmw]

I've made these changes myself in my fork here: main...dhmw:y-socket.io:generic-persistence-interface

It removes y-leveldb as a dependency from this library, but should allow you to plug it in directly yourself.
My fork also includes an adaptor so that you can provide your own storage implementation.

To use level db with these changes, you can just instantiate it in your code:

import { YSocketIO } from 'y-socket.io/dist/server'
import { LeveldbPersistence } from 'y-leveldb'

const ysocketio = new YSocketIO(
  io,
  {
    persistenceProvider: new LeveldbPersistence()
  }
)
ysocketio.initialize()

Or, any other provider which implements the PersistenceProvider interface:

import { YSocketIO, PersistenceProvider } from 'y-socket.io/dist/server'

class MyStorage implements PersistenceProvider {
 // implement the methods getYDoc, storeUpdate, flushDocument
}

const ysocketio = new YSocketIO(
  io,
  {
    persistenceProvider: new MyStorage()
  }
)
ysocketio.initialize()

My fork also includes an intermediate adaptor GenericPersistenceAdaptor which manages some Y.Doc operations before it hits the storage, you need to feed this an implementation of GenericPersistence interface:

import { YSocketIO, GenericPersistenceAdaptor, GenericPersistence } from 'y-socket.io/dist/server'

class MyPersistence implements GenericPersistence {
 // implement the methods getYDoc, storeUpdate, flushDocument
}

const ysocketio = new YSocketIO(
  io,
  {
    persistenceProvider: new GenericPersistenceAdaptor(new MyPersistence())
  }
)
ysocketio.initialize()

[cherfaoui-syphax]

This should get merged into main