feat: Define metric schema and TypeScript types#2
Open
charliewwdev wants to merge 2 commits intomainfrom
Open
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
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.
Create shared types for MetricEvent, MetricSeries, and AggregatedMetric. Types must be shared between the server WebSocket emitter and the client consumer to prevent payload drift.
Generated by OpenDev AI
All types are derived from Zod schemas using
z.infer<>, consistent with the existingprd-decompose.ts/task-codegen.tspattern. This gives both compile-time safety and runtime validation on WebSocket frames — preventing payload drift because the same schema object is the single source of truth for both sides. Key decisions: (1)MetricEventis the atomic unit;MetricSeriesbatches historical points on subscribe;AggregatedMetriccarries pre-computed stats so clients stay thin. (2) All three are wrapped in aServerMetricMessagediscriminated union so client switch statements are exhaustive. (3)ClientMetricMessagemirrors the pattern for subscription control messages. (4) Refinements enforce invariants (window_end >= window_start,min <= max) at the schema level so invalid shapes are rejected at the boundary. (5) Three parse helpers are exported: strictparse*for startup-time validation, andsafeParse*for high-throughput loops where a bad frame should be skipped rather than crashing.