Breaking Idea: Separate LockedDocument and SharedDocument classes

[anthony0br]

Currently, Document is used to represent two things which are mostly distinct, but have some functionality in common.

You would never use OpenAndUpdate on a session-locked document, because you could just open it and use cache, for example, but you can't use the cache methods on non-session-locked documents.

Document would represent session-locked documents. Update would be removed.

LockedDocument & SharedDocument would inherit some methods from a Document class. LockedDocument would implement caching and not expose protected methods from Document like Update, whereas SharedDocument would essentially be an UpdateAsync wrapper with migrations.

This would be a breaking changes.

[anthony0br]

Further ideas

LockedDocumentStore
Returns LockedDocuments

Methods include: Open, Set, Get, Save, Close, Erase, Read
Potentially allow mutable editing.

SharedDocumentStore
Returns SharedDocuments
Methods include: Update, Read, Erase

Common behaviour includes migrations, retries, erase, Read, signals, GPDR methods

Schema would be backwards compatible

[anthony0br]

I’d get rid of Lune and sync with Roblox studio.

I’d split up DocumentStore into SharedStore & LockedStore classes. This would be very similar to the existing Store but would take a DataStoreService and a key instead of a DataStore.

SharedStore:Get() would return a SharedDocument. A SharedDocument has one main method: Update. This is, pretty much just an UpdateAsync wrapper (with migrations).

LockedStore:Get() would return something similar to what we’re used to, but it would just have a save (no update)