feat: implement analytics schema registry - #1075
Open
onyekachi66 wants to merge 1 commit into
Open
onyekachi66 wants to merge 1 commit into
onyekachi66 wants to merge 1 commit into
Conversation
|
@onyekachi66 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
Contributor
|
Kindly fix the failed workflow |
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.
Closes #822
Description:
This PR introduces a central schema registry for analytics events to prevent dashboards from silently breaking when fields are modified.
Changes:
analytics-registry: Created a dedicated, standalone package at@quickex/analytics-registry.payment_initiated,payment_completed, etc.) using Zod. Each schema explicitly includes aversionfield.app/frontend/src/app/pay/PaymentPageClient.tsx) to validate payloads against the registry on emit. Invalid payloads are rejected and an invalid event counter is incremented.scripts/check-schema.mjsand integrated it into ourci.ymlpipeline. This asserts that any changes adding required fields or removing existing fields will fail the CI build unless the corresponding schema'sversionis incremented.exportRegistrymethod that exposes the schemas (along with their property typings and required fields) into a readable JSON object, which can be extracted directly into dashboards or external consumers. Aschemas.snapshot.jsonfile is additionally maintained to track historical breaking changes across versions.Acceptance Criteria Verified: