Point collaboration provider at self-hosted docs-collab-server#409
Draft
jhodapp wants to merge 2 commits into
Draft
Point collaboration provider at self-hosted docs-collab-server#409jhodapp wants to merge 2 commits into
jhodapp wants to merge 2 commits into
Conversation
jhodapp
changed the title
Provider init now gates on siteConfig.env.docsCollabUrl instead of tiptapAppId, but the editor-cache-context and connection-status test mocks still only defined tiptapAppId. With docsCollabUrl undefined, initializeProvider early-returned, no TiptapCollabProvider was created, and the test helpers threw on the missing provider instance.
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
1 participant
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
Repoints the collaborative coaching-notes provider from TipTap Cloud to the self-hosted docs-collab-server. This is a config-only change:
TiptapCollabProvidernow connects viabaseUrl(the newNEXT_PUBLIC_DOCS_COLLAB_URL) instead ofappId. Editor behavior, awareness/presence, theY.Doc, and the JWT/token flow are unchanged.Coordinated with the backend PR refactor-group/refactor-platform-rs#342 (the new server).
tiptapAppIdis left in place so reverting to TipTap Cloud stays a one-line change.GitHub Issue: link if applicable
Changes
editor-cache-context.tsx: provider construction usesbaseUrl: siteConfig.env.docsCollabUrlinstead ofappId, and the connect guard keys ondocsCollabUrl.site.config.ts: surfacedocsCollabUrlfromNEXT_PUBLIC_DOCS_COLLAB_URL.Screenshots / Videos Showing UI Changes (if applicable)
No visual change; the editor is identical. The useful verification artifact is a short screen recording of two browser windows on the same coaching session syncing text and presence/cursors in real time against a running docs-collab-server.
Testing Strategy
npm run lint,npx tsc --noEmit, andnpm run buildare clean. No type changes were needed (the base-classbaseUrloverride type-checks).docs/test-plans/docs-collab-server-local-e2e.md): real-time two-window text sync, presence, persistence across a server restart, and CRDT offline merge.Concerns
NEXT_PUBLIC_DOCS_COLLAB_URL, and its JWT signing key must match the app backend'stiptap_jwt_signing_key. Merge/deploy must be coordinated with Add a self-hosted Hocuspocus collaboration server (docs-collab-server) refactor-platform-rs#342.NEXT_PUBLIC_DOCS_COLLAB_URLmust be provisioned per environment (.env*is gitignored in this repo).