refactor(presence): Use branded JsonDeserialized type internally #24641
+365
−183
Conversation
This file contains hidden or 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
github-actions
bot
added
area: framework
tylerbutler
changed the title
jason-ha
reviewed
May 15, 2025
jason-ha
reviewed
May 15, 2025
jason-ha
reviewed
May 15, 2025
jason-ha
reviewed
May 15, 2025
github-actions
bot
added
area: examples
tylerbutler
force-pushed
the
presence-type-branding
branch
from
f6391fb to
1c54887
Compare
tylerbutler
changed the title
tylerbutler
commented
Jun 3, 2025
| @@ -172,12 +172,24 @@ export class PresenceDatastoreManagerImpl implements PresenceDatastoreManager { | |||
| if (updateProviders.length > 3) { | |||
| updateProviders.length = 3; | |||
| } | |||
| // TODO: #??? investigate and address `PresenceDatastore` incompatibility with `DatastoreMessageContent` | |||
There was a problem hiding this comment.
Open a tracking issue.
tylerbutler
commented
Jun 3, 2025
| @@ -146,12 +147,35 @@ export function prepareConnectedPresence( | |||
| quorumClientIds.length = 3; | |||
| } | |||
|
|
|||
| const expectedClientJoin: OutboundClientJoinMessage & | |||
| Partial<Pick<InboundClientJoinMessage, "clientId">> = generateBasicClientJoin(clock.now, { | |||
| // TODO: #??? investigate and address `InboundClientJoinMessage` incompatibility with `OutboundClientJoinMessage` | |||
tylerbutler
commented
Jun 3, 2025
| } | ||
|
|
||
| private broadcastAllKnownState(): void { | ||
| // TODO: #??? investigate and address `PresenceDatastore` incompatibility with `DatastoreMessageContent` |
jason-ha
reviewed
Jun 4, 2025
There was a problem hiding this comment.
Looks like all of these are incorrect. Likely you imported from the wrong path somewhere. See the note on lines 15-18.
…able Filtering the inner type when applying additional `JsonSerializable` filters broken the result down into `JsonTypeWith | Opaque` degenerate substitutes when `unknown` was sufficient already and would break the filter type checking. Now preserve the Opaque type's `T` as-is and rely on changes in `Controls` to dictate incompatibility.
This is required to allow `system:presence` workspace's datastore to deviated from the common general workspace datastore. This also removes test workarounds when specifying `clientToSessionId` records.
…able Filtering the inner type when applying additional `JsonSerializable` filters broken the result down into `JsonTypeWith | Opaque` degenerate substitutes when `unknown` was sufficient already and would break the filter type checking. Now preserve the Opaque type's `T` as-is and rely on changes in `Controls` to dictate incompatibility.
This is required to allow `system:presence` workspace's datastore to deviated from the common general workspace datastore. This also removes test workarounds when specifying `clientToSessionId` records.
…ral-datastore-typing' into presence-type-branding
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
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.
Updates the presence internals to use an opaque/branded internal type when passing around JSON objects. There are two functions to make JSON types opaque/not opaque, as well as a helper that casts from an opaque JSON type to a
DeeplyReadonly<JsonDeserialized<T>>object since that is what we often need.Externally, the API remains the same; the internal types and functions are marked
@systemand objects are converted between the types at the API boundaries.There were API level mismatches with the Notifications changes, so I marked
InternalUtilityTypesas alpha. Is there a better change? Similarly, the core-interfaces types needed to be beta since the presence APIs are marked as such.