Skip to content

SY-2359 Make x/status package in all languages #1235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 16 commits into
base: rc
Choose a base branch
from

Conversation

pjdotson
Copy link
Contributor

Issue Pull Request

Key Information

Description

Abstract out all status packages to use the same four common statuses (info, success, warning, error) in all languages.
I was going to do this in the CDC PR but realized I should practice what I preach on splitting up PRs :).

Basic Readiness

  • I have performed a self-review of my code.
  • I have added relevant tests to cover the changes to CI.
  • I have added needed QA steps to the release candidate template that cover these changes.
  • I have updated in-code documentation to reflect the changes.
  • I have updated user-facing documentation to reflect the changes.

Backwards Compatibility

Data Structures

I have ensured that previous versions of stored data structures are properly migrated to new formats in the following projects:

  • Server
  • Console

API Changes

The following projects have backwards-compatible APIs:

  • Python Client
  • Server
  • TypeScript Client

Breaking Changes

@pjdotson pjdotson requested a review from emilbon99 April 17, 2025 22:17
@pjdotson pjdotson self-assigned this Apr 17, 2025

import { z } from "zod";

export const SUCCESS_VARIANT = "success";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assigning union value types to generic utilities like this in typescript isn't useful IMO. It's kind if like having direction="x" and direction={direction.X} inside of an Align.Space. The typescript compiler will already restrict the union types to a point where "x" is as type safe as {direction.X} and we don't introduce a whole new variable. Obv this is not the case in C++ or Go.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants