feat(yjs): collaborative editing framework - #2785
Open
JammingBen wants to merge 36 commits into
Open
Conversation
JammingBen
force-pushed
the
feat/realtime-collaboration
branch
4 times, most recently
from
July 2, 2026 13:12
035fead to
e1fbb9f
Compare
JammingBen
changed the title
JammingBen
force-pushed
the
feat/realtime-collaboration
branch
from
August 6, 2026 07:59
e1fbb9f to
17f3f90
Compare
JammingBen
force-pushed
the
feat/realtime-collaboration
branch
6 times, most recently
from
August 7, 2026 13:49
1608ce6 to
faf7cfd
Compare
7 tasks
JammingBen
force-pushed
the
feat/realtime-collaboration
branch
2 times, most recently
from
August 10, 2026 11:11
7604e60 to
f129eb8
Compare
JammingBen
marked this pull request as ready for review
August 10, 2026 12:43
…p apps Brings the realtime-collaboration PoC from opencloud-eu/web-extensions into the canonical web repo: - New `@opencloud-eu/web-pkg` component family at `src/components/Collaborative/`: `CollaborativeWrapper.vue` + `CollaborativeAdapter` type contract. Reads `useAuthStore` / `useConfigStore` via the existing composables barrel. - web-pkg deps gain `@hocuspocus/provider`, `yjs`, `y-protocols`, `semver` (+ `@types/semver` devDep). Editor-binding deps (`y-codemirror.next`, `@tiptap/y-tiptap`, `@tiptap/markdown`, `@tiptap/extension-collaboration`, `@codemirror/*`) stay with the consuming apps — web-pkg only ships the editor-agnostic plumbing. - `realtimeUrl` prop is now three-state on the wrapper: `string` for an explicit URL, `null` for forced local-only mode, `undefined` (default) to derive from `configStore.serverUrl` plus the `/realtime` convention. Means collab is on out-of-the-box once the sidecar runs on the OC host. A first-class `options.realtimeUrl` field in OC's web config schema is a separate follow-up. - Tiptap StarterKit uses the v3 `undoRedo: false` option name (was `history: false` in v2) — clears the lingering `Partial<StarterKitOptions>` type error and keeps yUndoPlugin from `@tiptap/y-tiptap` as the collab-aware undo manager.
Removes the CollaborativeWrapper component in favor of a new composable useCollaborativeDocument, making the entire yjs & collaboration architecture a bit simpler.
JammingBen
force-pushed
the
feat/realtime-collaboration
branch
from
August 11, 2026 09:23
ccffa57 to
775e1ca
Compare
dschmidt
reviewed
Aug 11, 2026
dschmidt
left a comment
dschmidt
left a comment
Contributor
There was a problem hiding this comment.
basically: LGTM :)
Just a bunch of nit picks here and there
| currentContent: Ref<string> | ||
| currentFileContext: FileContext | ||
| /** Fetching this costs a WebDAV GET of the whole file. */ | ||
| currentContent: string |
Contributor
There was a problem hiding this comment.
Is this correct? Cant we have different types depending on what the app defines how it wants content to be injected? Or is this just urls not content?
Member
Author
There was a problem hiding this comment.
Yes, setting currentContent results in a WebDAV GET because of if (unref(hasProp('currentContent'))) in the AppWrapper.
| ] | ||
| } | ||
| }) | ||
| } |
Contributor
There was a problem hiding this comment.
It's only a few lines of code, so it's not too important - but is this something we should upstream somewhere? in @tiptap/extension-collaboration maybe?
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Subset of #2755 without the example apps we don't want to have in our monorepo, but with some architectual changes, improvements and bug fixes.
This is quite a lot, I recommend reading
dev/docs/yjs.mdto get more information about the implementation.Huge thanks to @dschmidt for the heavy lifting groundwork in the original PR!
Setup
Pull the latest OpenCloud image and run a fresh
docker compose up -d.How has this been tested
dev/docs/yjs-manual-tests.md)This of obviously far from being battle tested. It will be especially interesting to see how it performs under load and with more than 2-3 concurrent peers.
What next?
#3033 lists all the follow-ups and categorizes them into priorities.