refactor(presence-tracker): Use presence package #23020
Conversation
github-actions
bot
added
area: examples
|
For reference here is branch where I updated Presence to have legacy support and then migrated example's MouseTracker. (I left FocusTracker alone just so there were parallel examples of Signals versus Presence.) |
| @@ -2,9 +2,17 @@ | |||
|
|
|||
| **_This demo is a work-in-progress_** | |||
|
|
|||
| **Presence Tracker** is an example that demonstrates how transient state of audience members can be tracked among other audience members using signals. It does so using fluid-framework's `FluidContainer`, `IServiceAudience`, and `Signaler`. | |||
| **Presence Tracker** is an example that demonstrates how the @fluidframework/presence package can be used to share data | |||
There was a problem hiding this comment.
Nit: I always recommend line-breaking along sentence boundaries for ease of reviewing future content changes.
| // Define the schema of our Container. | ||
| // This includes the DataObjects we support and any initial DataObjects we want created | ||
| // when the Container is first created. |
There was a problem hiding this comment.
Nit: any reason this shouldn't be a TSDoc comment?
| /** | ||
| * A states workspace that the FocusTracker will use to share focus states with other session clients. | ||
| */ | ||
| readonly statesWorkspace: PresenceStates<any>, |
There was a problem hiding this comment.
any? {} with a lint disable is better than any.
At one point I think I had a type for empty states (PresenceStates<{}>) because we get {} complaints. Then most cases disappeared and I removed it as likely hard to discover and easy enough for any users to declare themselves.
There was a problem hiding this comment.
This confuses me a bit. What does PresenceStates<{}> represent? I thought it was "an empty workspace," but the trackers accept a workspace that already has a state key defined. Does PresenceStates<{}> instead represent "a workspace with unknown states?"
There was a problem hiding this comment.
I tried unknown but that wasn't permitted type-wise.
There was a problem hiding this comment.
{} is the correct type. It is a workspace with no defined entries. In this case it is a lint rule that is overzealous. (There are special treatments for {} in TypeScript, but in this case, I think we know what we are doing.)
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
Summary of changes
The presence-tracker example has been updated to use the presence package. It now uses LatestValueManagers for mouse and focus tracking.
Each client also has a slider that controls the allowable latency of the mouse updates. This enables quick demos of the differences in behavior with higher latencies as well as demonstrating runtime adjustments of the allowable latency.
Known issues: