History

David Sheldrick 4a3d9d407d [bemo bae] Spike on tlsync public API improvement (#4002 ) This PR replaces the extendable TLServer class with an instantiatable wrapper for the TLSyncRoom called TLSocketRoom. The goal is to provide an API where you pretty much just 1. create a room from some (optional) snapshot 2. pass websockets into it when they connect And then lifecycle stuff and persistence stuff is left to the consumer, since that all seems to be much more context dependent. One thing remaining here is to work on observability. We had a slightly messy situation regarding logging and error handling and analytics and I want to clean that all up. ### Change Type <!-- ❗ Please select a 'Scope' label ❗️ --> - [ ] `sdk` — Changes the tldraw SDK - [ ] `dotcom` — Changes the tldraw.com web app - [ ] `docs` — Changes to the documentation, examples, or templates. - [ ] `vs code` — Changes to the vscode plugin - [x] `internal` — Does not affect user-facing stuff <!-- ❗ Please select a 'Type' label ❗️ --> - [ ] `bugfix` — Bug fix - [ ] `feature` — New feature - [ ] `improvement` — Improving existing features - [ ] `chore` — Updating dependencies, other boring stuff - [x] `galaxy brain` — Architectural changes - [ ] `tests` — Changes to any test code - [ ] `tools` — Changes to infrastructure, CI, internal scripts, debugging tools, etc. - [ ] `dunno` — I don't know ### Test Plan 1. Add a step-by-step description of how to test your PR here. 4. - [ ] Unit Tests - [ ] End to end tests ### Release Notes - Add a brief release note for your PR here.		2024-06-26 14:07:36 +00:00
..
scripts	unbrivate, dot com in (#2475 )	2024-01-16 14:38:05 +00:00
src/lib	[bemo bae] Spike on tlsync public API improvement (#4002 )	2024-06-26 14:07:36 +00:00
.gitignore	unbrivate, dot com in (#2475 )	2024-01-16 14:38:05 +00:00
CHANGELOG.md	unbrivate, dot com in (#2475 )	2024-01-16 14:38:05 +00:00
package.json	[bemo bae] Spike on tlsync public API improvement (#4002 )	2024-06-26 14:07:36 +00:00
README.md	unbrivate, dot com in (#2475 )	2024-01-16 14:38:05 +00:00
tsconfig.json	Readonly / room creation omnibus (#3192 )	2024-04-25 14:10:40 +00:00
wrangler.toml	[bemo bae] Spike on tlsync public API improvement (#4002 )	2024-06-26 14:07:36 +00:00

README.md

@tldraw/tlsync-worker

Enable database persistence for local dev

The values for env.SUPABASE_KEY and env.SUPABASE_URL are stored in the Cloudflare Workers dashboard for this worker. However we use --local mode for local development, which doesn't read these values from the dashboard.

To workaround this, create a file called .dev.vars under merge-server with the required values (which you can currently find at https://app.supabase.com/project/bfcjbbjqflgfzxhskwct/settings/api). This will be read by wrangler dev --local and used to populate the environment variables.

SUPABASE_URL=<url>
SUPABASE_KEY=<key>