💥 Comply with sharedb spec
#24
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alecgibson
force-pushed
the
setup-ci
branch
3 times, most recently
from
85d1a10 to
9240653
Compare
alecgibson
force-pushed
the
setup-ci
branch
8 times, most recently
from
48f1221 to
7e11116
Compare
Closed
alecgibson
force-pushed
the
setup-ci
branch
2 times, most recently
from
1f3774c to
6e3eb2d
Compare
This is a **BREAKING** change that: - adds tests against the [upstream `sharedb` DB test suite][1] - adds a CI build for the tests against current Node.js and Postgres versions - breaks the API to conform to the upstream tests, including adding metadata support The breaks are: - Dropping non-null constraints on `snapshots.doc_type` and `snapshots.data` (to allow `Doc`s to be deleted) - Adding a new `snapshots.metadata` `json` column - Respecting `options.metadata` and `fields.$submit`, which were previously ignored on `getOps()`, and useless on `getSnapshot()` (which didn't store metadata) - `snapshot.m` is now `undefined` if not present, or `null` if unrequested (inline with the spec) On top of this it also makes some bugfixes to conform to the spec: - Ignore unique key validations when committing, since this may happen during concurrent commits - `JSON.stringify()` JSON fields, which [break][2] if passed a raw array - Default `from = 0` if unset in `getOps()` [1]: https://github.com/share/sharedb/blob/7abe65049add9b58e1df638aa34e7ca2c0a1fcfa/test/db.js#L25 [2]: brianc/node-postgres#442
ericyhwang
approved these changes
Jun 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a BREAKING change that:
sharedbDB test suiteThe breaks are:
snapshots.doc_typeandsnapshots.data(to allowDocs to be deleted)snapshots.metadatajsoncolumnoptions.metadataandfields.$submit, which were previously ignored ongetOps(), and useless ongetSnapshot()(which didn't store metadata)snapshot.mis nowundefinedif not present, ornullif unrequested (inline with the spec)On top of this it also makes some bugfixes to conform to the spec:
JSON.stringify()JSON fields, which break if passed a raw arrayfrom = 0if unset ingetOps()