Arv/presence state #21
Merged
Conversation
This file contains 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
|
I got rid of the "singleton" case. Started enforcing correct clientID in write but needs more tests. Started writing tests for optional/empty id/clientID. Needs more work!!! |
arv
force-pushed
the
arv/presence-state
branch
from
bd904f9
to
716dbcc
Compare
This adds a function called `generatePresence` that generates a
collection of presence keys at `-/p/${clientID}/name/${id}`. The type of
these entities are called `PresenceEntity` and are defined as:
```ts
type PresenceEntity = {
clientID: string;
id: string;
};
```
When looking up a presence state value, if the `id` is omitted, the `id`
is set to `''` and if the `clientID` is omitted, the `clientID` is set
to the `clientID` of the current client.
When writing and mutating the value the `id` and the `clientID` are
added to the value if they are missing.
You can only mutate the presence state value for the current client. If
you try to mutate a value that has different `clientID` than the current
client a runtime error is thrown.
arv
force-pushed
the
arv/presence-state
branch
from
716dbcc
to
b2391e0
Compare
|
@aboodman This is |
For `get`, `mustGet`, `has` and `delete`. When undefined we treat it as
`{clientID: tx.clientID, id: ''}`.
aboodman
reviewed
Jan 15, 2024
| ```ts | ||
| type Cursor { | ||
| clientID: string; | ||
| id: '', |
There was a problem hiding this comment.
I think we could make id optional and default it to empty string, no?
There was a problem hiding this comment.
I played around with that.
It has some weirdness to only do this at the type level.
- If you use strict parse in zod (not default) or in valita (default) the extra field (
id) in the results causes errors. - The
idis always present in the result (get) and in the keys for the entries.
If we do this we should make the resulting types declare that it is always present at least.
| export type OptionalIDs<T extends PresenceEntity> = Partial<T> & | ||
| Omit<T, keyof PresenceEntity>; | ||
|
|
||
| export type LookupID = Partial<PresenceEntity>; |
There was a problem hiding this comment.
I might call this PresenceID just to make it a little more clear from name only, when using the type from outside the package.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.