Zero 0.24

Copy markdown

Join Flipping, Cookie Auth, Previews # Zero 0.24 ## Installation ```bash npm install @rocicorp/zero@0.24 ``` ## Features * [**Join Flipping:**](https://zero.rocicorp.dev/docs/reading-data#join-flipping) Dramatically improves the performance of `whereExists()` in many common cases. Join flipping is a form of manual query planning that tells Zero the order to evaluate joins. An automatic planner will follow in a future release. * [**Simplified Auth:**](https://zero.rocicorp.dev/docs/auth#opaque-auth-tokens) If you are using custom mutators and synced queries, you no longer need to use JWT auth. You can use opaque tokens or even better, plain old cookies. This even means you can use HTTP-only cookies. In our demo apps this eliminated hundreds of lines of code. It's a big improvement. * [**Full Preview Support:**](https://zero.rocicorp.dev/docs/custom-mutators#custom-mutate-url) We tried to get this out in 0.23 but it didn't quite make it. You can now dynamically configure Zero with the location of your mutator and [query](https://zero.rocicorp.dev/docs/synced-queries#custom-get-queries-url) endpoints. This allows easily using preview URLs on platforms like Vercel. * [**Analyze Query from Inspector:**](https://zero.rocicorp.dev/docs/debug/inspector#analyzing-queries) No more `npx zero-analyze-query` or ssh'ing into production. You can analyze any query right from the dev tools of your browser. On by default in every Zero app. * [**Simplified Metrics Output in Inspector:**](https://zero.rocicorp.dev/docs/debug/inspector#queries) No more `.metrics["long-name-i-cant-remember"].quantile(0.99)`. The most important metrics – hydration and update time – are right on the query object. Also, you don't have to `(await __zero.inspect()).client.queries` anymore. It's just `__zero.inspector.client.queries()`. * [**New Type helpers:**](https://zero.rocicorp.dev/docs/reading-data#type-helpers) `QueryResultType` and `QueryRowType` are handy ways to get the type of a query result or one of its rows. * [**Faster storage for React Native via op-sqlite:**](https://zero.rocicorp.dev/docs/react-native#op-sqlite) The op-sqlite bindings are faster than the expo built-in ones. We now provide this built-in to Zero. * [**Brand New Cloudflare Sample:**](https://zero.rocicorp.dev/docs/samples#hello-zero-cf) Turned the old hello-zero-do sample into a complete Cloudflare sample using workers for everything. * [**Improved ZQL server-side APIs:**](https://zero.rocicorp.dev/docs/server-zql) More convenient setup, and added `node-postgres` and Drizzle support. ## Fixes * [Expose server errors from `get-queries` endpoint to client](https://zero.rocicorp.dev/docs/synced-queries#handling-errors) * [Correctly map primary keys to server names in some edge cases](https://github.com/rocicorp/mono/pull/4857) * [Reduce some OTEL error logging to `warn`](https://github.com/rocicorp/mono/pull/4867) * [Fix a case of deadlock related to CVR cleanup](https://github.com/rocicorp/mono/pull/4877) * [Fix hang on shutdown under Bun CLI](https://github.com/rocicorp/mono/pull/4854) (thanks [David](https://github.com/dpeek)!) * [Fix "View already exists" error](https://github.com/rocicorp/mono/pull/4888), [Discord](https://discord.com/channels/830183651022471199/1415395645203812424/1415395649205305434) * [Fix rows sometimes missing from `startAt` queries](https://github.com/rocicorp/mono/pull/4926) * [Improve performance of CVR cleanup](https://github.com/rocicorp/mono/pull/4930) * [Disable statement-level timeouts that were preventing CVR cleanup](https://github.com/rocicorp/mono/pull/4933) * [Fix WAL growth when no connected clients](https://github.com/rocicorp/mono/pull/4954) * [Fix exception with local-only queries and `enableLegacyQueries:false`](https://github.com/rocicorp/mono/pull/4967) * [Fix inability to use `--flags` with `zero-cache-dev`](https://github.com/rocicorp/mono/pull/4966) (thanks [Alizain](https://github.com/alizain)!). * [Reduce ping timeouts during slow queries with better time-slicing](https://github.com/rocicorp/mono/pull/4989) * [Improve handling of ownership changes in the change-streamer](https://github.com/rocicorp/mono/pull/4994) ## Breaking Changes 1. If you are using the `push.url` param to the `Zero` constructor, rename it to `mutateURL` ([more info](https://zero.rocicorp.dev/docs/custom-mutators#custom-mutate-url)). 2. If you are using the `ZERO_PUSH_URL` config param, rename it to `ZERO_MUTATE_URL` ([more info](https://zero.rocicorp.dev/docs/custom-mutators#custom-mutate-url)). 3. If you are awaiting queries directly without calling `run()`, like `await z.query.foo.where(...)`, or `await tx.query.foo.where(...)`, add `.run()` to the end, like `await z.query.foo.where(...).run()` or `await tx.query.foo.where(...).run()`.. This is most common in custom mutator implementations ([more info](https://zero.rocicorp.dev/docs/reading-data#default-run)) 4. If you are building for React Native, change your import path from `@rocicorp/zero/react-native` to `@rocicorp/zero/expo-sqlite` ([more info](https://zero.rocicorp.dev/docs/react-native)) 5. Add a `ZERO_ADMIN_PASSWORD` env var to your production config. This is now required ([more info](https://zero.rocicorp.dev/docs/zero-cache-config#admin-password)) ## Example Upgrades * [ztunes](https://github.com/rocicorp/ztunes/pull/23) * [zslack](https://github.com/rocicorp/zslack/pull/12) * [hello-zero-solid](https://github.com/rocicorp/hello-zero-solid/pull/27) * [hello-zero](https://github.com/rocicorp/hello-zero/pull/50) – Note that we are keeping `hello-zero` on the legacy query and mutator APIs until they are deprecated, for testing reasons. So this PR doesn't include custom mutator, synced query, or auth-related changes.

Or, for AI assistants

ALWAYS readllms.txtfor curated documentation pages and examples.

Join Flipping, Cookie Auth, Previews

Installation

Copynpm install @rocicorp/zero@0.24

Features

• Join Flipping: Dramatically improves the performance of whereExists() in many common cases. Join flipping is a form of manual query planning that tells Zero the order to evaluate joins. An automatic planner will follow in a future release.
• Simplified Auth: If you are using custom mutators and synced queries, you no longer need to use JWT auth. You can use opaque tokens or even better, plain old cookies. This even means you can use HTTP-only cookies. In our demo apps this eliminated hundreds of lines of code. It's a big improvement.
• Full Preview Support: We tried to get this out in 0.23 but it didn't quite make it. You can now dynamically configure Zero with the location of your mutator and query endpoints. This allows easily using preview URLs on platforms like Vercel.
• Analyze Query from Inspector: No more npx zero-analyze-query or ssh'ing into production. You can analyze any query right from the dev tools of your browser. On by default in every Zero app.
• Simplified Metrics Output in Inspector: No more .metrics["long-name-i-cant-remember"].quantile(0.99). The most important metrics – hydration and update time – are right on the query object. Also, you don't have to (await __zero.inspect()).client.queries anymore. It's just __zero.inspector.client.queries().
• New Type helpers: QueryResultType and QueryRowType are handy ways to get the type of a query result or one of its rows.
• Faster storage for React Native via op-sqlite: The op-sqlite bindings are faster than the expo built-in ones. We now provide this built-in to Zero.
• Brand New Cloudflare Sample: Turned the old hello-zero-do sample into a complete Cloudflare sample using workers for everything.
• Improved ZQL server-side APIs: More convenient setup, and added node-postgres and Drizzle support.

Fixes

• Expose server errors from get-queries endpoint to client
• Correctly map primary keys to server names in some edge cases
• Reduce some OTEL error logging to warn
• Fix a case of deadlock related to CVR cleanup
• Fix hang on shutdown under Bun CLI (thanks David!)
• Fix "View already exists" error, Discord
• Fix rows sometimes missing from startAt queries
• Improve performance of CVR cleanup
• Disable statement-level timeouts that were preventing CVR cleanup
• Fix WAL growth when no connected clients
• Fix exception with local-only queries and enableLegacyQueries:false
• Fix inability to use --flags with zero-cache-dev (thanks Alizain!).
• Reduce ping timeouts during slow queries with better time-slicing
• Improve handling of ownership changes in the change-streamer

Breaking Changes

1. If you are using the push.url param to the Zero constructor, rename it to mutateURL (more info).
2. If you are using the ZERO_PUSH_URL config param, rename it to ZERO_MUTATE_URL (more info).
3. If you are awaiting queries directly without calling run(), like await z.query.foo.where(...), or await tx.query.foo.where(...), add .run() to the end, like await z.query.foo.where(...).run() or await tx.query.foo.where(...).run().. This is most common in custom mutator implementations (more info)
4. If you are building for React Native, change your import path from @rocicorp/zero/react-native to @rocicorp/zero/expo-sqlite (more info)
5. Add a ZERO_ADMIN_PASSWORD env var to your production config. This is now required (more info)

Example Upgrades

• ztunes
• zslack
• hello-zero-solid
• hello-zero – Note that we are keeping hello-zero on the legacy query and mutator APIs until they are deprecated, for testing reasons. So this PR doesn't include custom mutator, synced query, or auth-related changes.