MTS/yjs-backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Keep persistence object signature

Browse Source 
- consolidate getYDoc, findOrCreateDoc
- rename findOrCreateDoc to getOrInitDoc
- rename persistence.getYDoc to getOrCreateDoc
This commit is contained in:
Duane Johnson 2020-10-10 12:55:41 -06:00
parent 576db4267e
commit 70905bc7a0
1 changed files with 36 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
bin/utils.js
View File

@ -23,6 +23,16 @@ const wsReadyStateClosed = 3 // eslint-disable-line
// disable gc when using snapshots!
const gcEnabled = process.env.GC !== 'false' && process.env.GC !== '0'
const persistenceDir = process.env.YPERSISTENCE
/**
* If persistence is enabled, performs two-way sync between memory and disk stores.
* If persistence is not enabled, does nothing.
*
* @param {string} docName the Y.Doc's name in disk store
* @param {WSSharedDoc} ydoc the in-memory Y.Doc
*/
let mutualSync = async (docName, ydoc) => {}
/**
* @type {{bindState: function(string,WSSharedDoc):void, writeState:function(string,WSSharedDoc):Promise<any>}|null}
*/
@ -32,34 +42,26 @@ if (typeof persistenceDir === 'string') {
// @ts-ignore
const LeveldbPersistence = require('y-leveldb').LeveldbPersistence
const ldb = new LeveldbPersistence(persistenceDir)
persistence = {
// Sync in-memory and ldb state
mutualSync: async (docName, ydoc) => {
const persistedYdoc = await ldb.getYDoc(docName)
const newUpdates = Y.encodeStateAsUpdate(ydoc)
ldb.storeUpdate(docName, newUpdates)
Y.applyUpdate(ydoc, Y.encodeStateAsUpdate(persistedYdoc))
},
// Sync in-memory and ldb state
mutualSync = async (docName, ydoc) => {
const persistedYdoc = await ldb.getYDoc(docName)
const newUpdates = Y.encodeStateAsUpdate(ydoc)
ldb.storeUpdate(docName, newUpdates)
Y.applyUpdate(ydoc, Y.encodeStateAsUpdate(persistedYdoc))
}
persistence = {
bindState: async (docName, ydoc) => {
await persistence.mutualSync(docName, ydoc)
await mutualSync(docName, ydoc)
ydoc.on('update', (update) => {
ldb.storeUpdate(docName, update)
})
},
writeState: async (docName, ydoc) => {},
// Gets a Y.Doc by name, whether in memory or on disk
getYDoc: async (docName) => {
const ydoc = findOrCreateDoc(docName)
await persistence.mutualSync(docName, ydoc)
return ydoc
},
}
}
// If enabled, provide access to persistence functions
exports.persistence = persistence
/**
* @param {{bindState: function(string,WSSharedDoc):void,
@ -146,10 +148,10 @@ class WSSharedDoc extends Y.Doc {
}
/**
* @param {string} docName - the name of the Y.Doc to find or create
* @param {string} docName - the name of the Y.Doc to find or initialize
* @param {boolean} gc - whether to allow gc on the doc (applies only when created)
*/
function findOrCreateDoc(docName, gc = true) {
function getOrInitDoc(docName, gc = true) {
// get doc, create if it does not exist yet
return map.setIfUndefined(docs, docName, () => {
const doc = new WSSharedDoc(docName)
@ -161,7 +163,18 @@ function findOrCreateDoc(docName, gc = true) {
return doc
})
}
exports.findOrCreateDoc = findOrCreateDoc
/**
* Gets a Y.Doc by name, whether in memory or on disk
*
* @param {string} docName - the name of the Y.Doc to find or create
*/
async function getOrCreateDoc(docName, gc = true) {
const ydoc = getOrInitDoc(docName, gc)
await mutualSync(docName, ydoc)
return ydoc
}
exports.getOrCreateDoc = getOrCreateDoc
/**
* @param {any} conn
@ -237,8 +250,8 @@ const pingTimeout = 30000
*/
exports.setupWSConnection = (conn, req, { docName = req.url.slice(1).split('?')[0], gc = true } = {}) => {
conn.binaryType = 'arraybuffer'
// get doc, create if it does not exist yet
const doc = findOrCreateDoc(docName, gc)
// get doc, initialize if it does not exist yet
const doc = getOrInitDoc(docName, gc)
doc.conns.set(conn, new Set())
// listen and reply to events
conn.on('message', /** @param {ArrayBuffer} message */ message => messageListener(conn, doc, new Uint8Array(message)))