feat(zero): offline #4652

0xcadams · 2025-07-18T18:17:40Z

There was a usability issue with the online status with Zero. React doesn't rerender when Zero's online property updates. This proposes an API, onOnline, to make it easier to listen for updates to this. And an accompanying hook in React/SolidJS, useZeroOnline.

vercel · 2025-07-18T18:17:44Z

@0xcadams is attempting to deploy a commit to the Rocicorp Team on Vercel.

A member of the Team first needs to authorize it.

0xcadams · 2025-07-18T18:18:10Z

apps/zbugs/src/pages/issue/issue-composer.tsx

+
+    const raceResult = await promiseRace([sleep(5000), result.server]);
+    if (raceResult === 0) {
+      // TODO show toast


Do we want this to be a toast?

I think that we should rely on a new global onError handler that Matt is constantly wanting to add. It is half-implemented in the codebase right now, but we got distracted by API design questions and never finished it.

I don't want every mutator to have to do this kind of error handling manually.

This makes sense - agreed it would be much better to have this in onError. So I can add this toast later and only have this PR include online indicator, once the onError handler lands.

packages/zero-client/src/client/zero.ts

aboodman · 2025-07-18T18:29:57Z

I'm confused - we already have onOnlineChange. Why not use that at the basis for useOnline?

aboodman · 2025-07-18T18:32:57Z

@alexhking can you design an online indicator for zbugs? Note that people will probably copy whatever we do into their apps.

Here are my product thoughts:

I do not (cannot stress enough how much I do not want this) want it to animate or throb or do anything when syncing. This just becomes a spinner and destroys the feeling of instant.
I think when online, it should be invisible. Linear doesn't have an 'online' state. You assume it is online.
I am not sure where it should go visually.
As always I think it should be simple, minimal, tasteful.
Maybe we should consider animations and transitions when going offline and returning online.

0xcadams · 2025-07-18T18:34:37Z

I'm confused - we already have onOnlineChange. Why not use that at the basis for useOnline?

Yeah I can do that - it just means managing that state in two places and adds a new Context. Will change.

aboodman · 2025-07-18T18:37:05Z

I'm confused - we already have onOnlineChange. Why not use that at the basis for useOnline?

Yeah I can do that - it just means managing that state in two places and adds a new Context. Will change.

I am missing something.... it seems trivial to wrap a hook around the existing feature. I don't get why any change is needed in zero.ts.

aboodman · 2025-07-18T18:38:20Z

Oooh it is because there can be many hooks, but there can only be one onOnlineChange event. Yeah that was super ghetto, let's fix that. Good call. Will review PR with that frame.

aboodman

Nice, I like this.

aboodman · 2025-07-18T18:41:11Z

apps/zbugs/src/pages/issue/issue-composer.tsx

+
+    const raceResult = await promiseRace([sleep(5000), result.server]);
+    if (raceResult === 0) {
+      // TODO show toast


I think that we should rely on a new global onError handler that Matt is constantly wanting to add. It is half-implemented in the codebase right now, but we got distracted by API design questions and never finished it.

I don't want every mutator to have to do this kind of error handling manually.

apps/zbugs/src/zero-init.tsx

aboodman · 2025-07-18T18:45:03Z

packages/shared/src/subscribable.ts

@@ -0,0 +1,38 @@
+export class Subscribable<


I was going to suggest nanoevent but this is so simple maybe it makes sense to have it in our codebase in case we want to change it.

@arv @tantaman ?

Also @arv just confirming there's nothing like this already in Replicache so we don't duplicate code?

packages/zero-client/src/client/zero.ts

aboodman · 2025-07-18T19:00:20Z

packages/zero-client/src/client/zero.ts

+   * @param listener - The listener to subscribe to.
+   * @returns A function to unsubscribe the listener.
+   */
+  addOnlineChangeListener = (


How about onOnline and then we deprecate onOnlineChange.

aboodman · 2025-07-18T19:00:57Z

packages/zero-client/src/client/zero.ts

      );
    }

-    this.#onOnlineChange = onOnlineChange;


This is a breaking change but it is so simple to update I am supportive.

…s/offline

0xcadams · 2025-07-22T17:48:53Z

@alexhking I changed the design based on the above comments. Open to feedback. See the description for the current design. I can add tooltip, etc.

tantaman · 2025-07-28T13:58:43Z

@aboodman - should we just merge rather than having this open/blocked and fix forward? Seems annoying and unproductive to have to have PRs open for such a long time (having to rebase and resolve merge conflicts to revisit).

alexhking · 2025-07-28T20:50:45Z

@alexhking I changed the design based on the above comments. Open to feedback. See the description for the current design. I can add tooltip, etc.

Hey Chase, for some reason I didn't get notified when you sent this last week. Checking out now and will give feedback.

alexhking · 2025-07-28T21:01:34Z

@0xcadams @aboodman

Ok, after reviewing I have several questions and comments:

Do we want to completely remove the state of the visual representation of the user being logged in when offline?
If so, why are we still showing the log out control?
The “Offline” badge has a completely different style than the logged in user state, and I’m not sure why. Right now it seems to closely resemble what we use for labels, but with different padding.
It may be nice to add a tooltip to explain a bit more about what offline means and what limitations there are.

I would like to take a stab at redesigning this just a bit at least visually.

aboodman · 2025-07-29T18:18:31Z

@aboodman - should we just merge rather than having this open/blocked and fix forward? Seems annoying and unproductive to have to have PRs open for such a long time (having to rebase and resolve merge conflicts to revisit).

Typically we would but just because Chase was new to the team I suggested he block on reviews and start conservatively. Will re-evaluate.

aboodman · 2025-07-29T18:20:24Z

apps/zbugs/src/zero-init.tsx

        }
        return login.loginState?.encoded;
      },
-    };


I don't understand why this change is needed.

It's not - an artifact of other changes made and then kept because it added type safety. Can remove

What does it improve about type safety? Currently for me I do not see any type errors in my env w/o this.

The reason I'm asking is because zbugs is a testbed for how we expect Zero to be used and I wasn't expecting this to be required of users.

aboodman · 2025-07-29T18:21:59Z

packages/zero-client/src/client/options.ts

  /**
   * `onOnlineChange` is called when the Zero instance's online status changes.
+   *
+   * @deprecated Use `onOnline` on the Zero instance instead. e.g.


Nuts. @grgbkr had gone to a lot of trouble to pass in all the configuration to Zero. But I think didn't consider this problem/use-case. So maybe passing in all configuration cannot work.

We can support both here. The adding/removal of listeners doesn't need to be all up-front. And this doesn't need to be deprecated.

Or, if it's better, we can move this all to the React/Solid layers. And continue to use onOnlineChange and track the online state with React Context.

I think it will be very convoluted to track the listeners state in the React/Solid layers. I'm ok with this change.

The other to event listener type configs we currently have are onUpdateNeeded and onClientStateNotFound. Possibly these should move on to the Zero instance as well, and our general pattern would be event listeners on the Zero instance. I think these are unlikely to need multiple listeners like onOnline might, but it may just be more ergonomic to have them on Zero given React hooks. I think it would be good to build a UI for onUpdateNeeded to figure out what is most ergonomic.

0xcadams · 2025-07-29T20:32:04Z

Do we want to completely remove the state of the visual representation of the user being logged in when offline?

If so, why are we still showing the log out control?

The “Offline” badge has a completely different style than the logged in user state, and I’m not sure why. Right now it seems to closely resemble what we use for labels, but with different padding.

It may be nice to add a tooltip to explain a bit more about what offline means and what limitations there are.

I would like to take a stab at redesigning this just a bit at least visually.

On these - I am completely open to the design you want to go with. I am still getting used to what design styles the team likes, so I did not put a lot of time into the design (this was a very loose copy of how Linear does it). Please let me know if you want me to add tooltip, etc.

aboodman · 2025-07-29T20:45:40Z

@0xcadams @aboodman

Ok, after reviewing I have several questions and comments:

Do we want to completely remove the state of the visual representation of the user being logged in when offline?

I don't think so... is there some reason to do @0xcadams ? Prefer to keep login state looking the same while offline.

It may be nice to add a tooltip to explain a bit more about what offline means and what limitations there are.
I would like to take a stab at redesigning this just a bit at least visually.

Please! Sounds great!

aboodman

LGTM modulo type question.

vercel · 2025-07-30T17:52:15Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
replicache-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 30, 2025 6:02pm
zbugs	✅ Ready (Inspect)	Visit Preview		Jul 30, 2025 6:02pm

0xcadams · 2025-07-30T17:53:42Z

I have removed all changes to zbugs so we can update the styling/display of offline in a future PR.

aboodman · 2025-07-30T17:56:52Z

I think it is fine to land the zbugs changes and let Alex style them separately. It wasn’t bad enough to delay. And having the usage of the api somewhere is great for dogfooding purposes. a (phone)

…

On Wed, Jul 30, 2025 at 7:54 AM Chase Adams ***@***.***> wrote: *0xcadams* left a comment (rocicorp/mono#4652) <#4652 (comment)> I have removed all changes to zbugs so we can update the styling/display of offline in a future PR. — Reply to this email directly, view it on GitHub <#4652 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAATUBARDQBAAZTJHXZM6EL3LEBDXAVCNFSM6AAAAACB3KORL2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTCMZXGMYTQMRQHE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

This reverts commit dd11919.

0xcadams · 2025-07-30T18:01:52Z

Sounds good - added back and merging and will note to follow up w/ @alexhking to get better styling here.

0xcadams added 2 commits July 18, 2025 11:11

feat: added offline to zbugs and useZeroOffline

c0d5884

Merge remote-tracking branch 'origin/main' into 0xcadams/offline

fba0b98

0xcadams commented Jul 18, 2025

View reviewed changes

packages/zero-client/src/client/zero.ts Outdated Show resolved Hide resolved

aboodman reviewed Jul 18, 2025

View reviewed changes

0xcadams added 6 commits July 21, 2025 14:53

Merge branch 'main' into 0xcadams/offline

31ebf29

fix: updated with solidjs and feedback

6d5be78

chore: lint

096205b

Merge branch 'main' into 0xcadams/offline

1791569

fix: reworked design

cb1534f

Merge remote-tracking branch '0xcadams/0xcadams/offline' into 0xcadam…

7c1401b

…s/offline

0xcadams changed the title ~~[WIP] - Offline~~ Offline Jul 22, 2025

0xcadams changed the title ~~Offline~~ feat(zero): offline Jul 22, 2025

fix: format

f8f7fd3

0xcadams marked this pull request as ready for review July 22, 2025 17:47

aboodman reviewed Jul 29, 2025

View reviewed changes

Merge branch 'main' into 0xcadams/offline

a821ab2

aboodman approved these changes Jul 30, 2025

View reviewed changes

0xcadams added 3 commits July 30, 2025 10:39

Merge branch 'main' into 0xcadams/offline

06f1f5d

revert: revert changes to zbugs for follow-up

dd11919

test: added tests

5bce8c9

0xcadams enabled auto-merge (squash) July 30, 2025 17:52

vercel bot deployed to Preview – replicache-docs July 30, 2025 17:52 View deployment

vercel bot deployed to Preview – zbugs July 30, 2025 17:53 View deployment

0xcadams disabled auto-merge July 30, 2025 17:57

0xcadams added 2 commits July 30, 2025 10:59

Revert "revert: revert changes to zbugs for follow-up"

10404b6

This reverts commit dd11919.

revert: zero init changes

fb9fd9d

0xcadams enabled auto-merge (squash) July 30, 2025 18:00

vercel bot deployed to Preview – replicache-docs July 30, 2025 18:01 View deployment

vercel bot deployed to Preview – zbugs July 30, 2025 18:02 View deployment

0xcadams merged commit 5c91a63 into rocicorp:main Jul 30, 2025
11 checks passed

0xcadams deleted the 0xcadams/offline branch July 30, 2025 18:11

feat(zero): offline #4652

feat(zero): offline #4652

Uh oh!

Conversation

0xcadams commented Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Jul 18, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aboodman commented Jul 18, 2025

Uh oh!

aboodman commented Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

0xcadams commented Jul 18, 2025

Uh oh!

aboodman commented Jul 18, 2025

Uh oh!

aboodman commented Jul 18, 2025

Uh oh!

aboodman left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

0xcadams commented Jul 22, 2025

Uh oh!

tantaman commented Jul 28, 2025

Uh oh!

alexhking commented Jul 28, 2025

Uh oh!

alexhking commented Jul 28, 2025

Uh oh!

aboodman commented Jul 29, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

0xcadams commented Jul 29, 2025

Uh oh!

aboodman commented Jul 29, 2025

Uh oh!

aboodman left a comment

Choose a reason for hiding this comment

Uh oh!

vercel bot commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

0xcadams commented Jul 30, 2025

Uh oh!

aboodman commented Jul 30, 2025 via email

Uh oh!

0xcadams commented Jul 30, 2025

0xcadams commented Jul 18, 2025 •

edited

Loading

aboodman commented Jul 18, 2025 •

edited

Loading

vercel bot commented Jul 30, 2025 •

edited

Loading