improvement(client-container-loader): tighten Signal expectations #25522
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
jason-ha
force-pushed
the
loader/signal-typing
branch
from
d123305 to
06c211d
Compare
jason-ha
force-pushed
the
core/JsonString
branch
from
53f528a to
28ca32f
Compare
jason-ha
force-pushed
the
core/JsonString
branch
from
532fec0 to
4da8ea2
Compare
jason-ha
force-pushed
the
loader/signal-typing
branch
from
06c211d to
bc4e818
Compare
Signals specify `type` within message `content` next to inner content that is stringified JSON. Assert that internally (to avoid legacy API change) and leverage. Additionally, clean up system signal typing and type guard to reduce casts.
jason-ha
force-pushed
the
loader/signal-typing
branch
from
bc4e818 to
385b86a
Compare
github-actions
bot
added
area: loader
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR tightens Signal expectations in the client-container-loader package by ensuring signal messages conform to expected typing and structure. The changes improve type safety by asserting that signal content is properly formatted JSON and reducing type casting throughout the codebase.
Key changes:
- Converts SignalType from enum to const object and adds comprehensive type definitions for system signals
- Introduces runtime assertions to validate signal message structure and content format
- Replaces generic IProtocolHandler with more specific ProtocolHandlerInternal interface
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| protocol.ts | Adds system signal type definitions and creates ProtocolHandlerInternal interface with narrower signal constraints |
| deltaManager.ts | Updates signal handling to use JsonParse and adds JsonString type constraints |
| contracts.ts | Adds JsonString type constraint to signalHandler interface |
| container.ts | Updates to use InternalProtocolHandlerBuilder and ProtocolHandlerInternal types |
| connectionManager.ts | Adds assertExpectedSignals validation function and uses JsonStringify for signal creation |
Comment on lines
+118
to
+129
| function assertExpectedSignals( | ||
| signals: ISignalMessage[], | ||
| ): asserts signals is ISignalMessage<{ type: never; content: JsonString<unknown> }>[] { | ||
| for (const signal of signals) { | ||
| if ("type" in signal) { | ||
| throw new Error("Unexpected type in ISignalMessage"); | ||
| } | ||
| if (typeof signal.content !== "string") { | ||
| throw new TypeError("Non-string content in ISignalMessage"); | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Use string literals for assert error messages instead of generic descriptions. Replace 'Unexpected type in ISignalMessage' and 'Non-string content in ISignalMessage' with more descriptive string literals.
WillieHabi
reviewed
Oct 6, 2025
| export interface ProtocolHandlerInternal extends IProtocolHandler { | ||
| /** | ||
| * Process the audience related signal. | ||
| * @privateRemarks Internally only AudienceSignal messages need handled |
Contributor
There was a problem hiding this comment.
typo: need to be handled* or need handling*
WillieHabi
approved these changes
Oct 6, 2025
+ TSDoc link additions
WillieHabi
approved these changes
Oct 6, 2025
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.
Signals specify
typewithin messagecontentnext to inner content that is stringified JSON.Assert that internally (to avoid legacy API change) and leverage. Additionally, clean up system signal typing and type guard to reduce casts.
AB#49979