Skip to content
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

refactor(schema)!: rename IntegerStringKind and DecimalStringKind #21694

Merged
merged 3 commits into from
Sep 14, 2024

Conversation

aaronc
Copy link
Member

@aaronc aaronc commented Sep 12, 2024

Description

This PR renames reverts a previous renaming of schema.IntegerStringKind and schema.DecimalStringKind and changes them back to IntegerKind and DecimalKind respectively.

Previously, I was thinking to have distinct larger precision IntN and UIntN types in #21244. But I realize that it's not ideal to have two types with overlapping semantic meanings because we want to add size limits to integer and decimal strings too, so the fact they are encoded as strings in protobuf should be irrelevant.

The code comments now indicate that size limits will be added and that golang representation may change (thinking of *big.Int instead of string).


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features

    • Updated naming conventions for integer and decimal types to enhance clarity and consistency.
    • Improved type handling by transitioning from string representations to native numeric types.
  • Bug Fixes

    • Enhanced validation logic for integer and decimal types, ensuring more accurate data handling.
  • Tests

    • Updated test cases to reflect the new naming conventions and improved validation logic for integers and decimals.

Copy link
Contributor

coderabbitai bot commented Sep 12, 2024

Walkthrough

Walkthrough

The pull request introduces a series of changes focused on renaming schema kinds from string-based representations to their respective numeric types. Specifically, IntegerStringKind and DecimalStringKind have been renamed to IntegerKind and DecimalKind, respectively, across multiple files. This modification affects type handling, validation logic, and test cases, enhancing the clarity and consistency of the codebase.

Changes

Files Change Summary
indexer/postgres/column.go Renamed IntegerStringKind to IntegerKind and DecimalStringKind to DecimalKind. Functionality remains unchanged.
indexer/postgres/select.go Updated readCol function to handle IntegerKind and DecimalKind instead of their string counterparts, improving type safety.
schema/kind.go Renamed constants and updated methods to reflect new names. Enhanced validation logic for integers and decimals.
schema/kind_test.go Updated test cases to use IntegerKind and DecimalKind, ensuring validation logic aligns with new naming conventions.
schema/testing/diff.go Modified CompareKindValues function to compare numeric types directly instead of string representations.
schema/testing/diff_test.go Adjusted test cases in TestCompareKindValues to compare IntegerKind and DecimalKind.
schema/testing/field.go Renamed field kinds from string-based to numeric types, updating associated generator functions accordingly.
schema/testing/fmt.go Updated fmtValue function to handle IntegerKind and DecimalKind, improving type handling.
schema/testing/fmt_test.go Changed field types in KeyFields from string representations to their respective numeric types.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Application
    participant Database

    User->>Application: Request to process data
    Application->>Database: Read data with IntegerKind/DecimalKind
    Database-->>Application: Return numeric data
    Application->>User: Return processed result
Loading

Assessment against linked issues

Objective Addressed Explanation
Rename schema kinds for clarity and consistency (undefined)
Improve type handling in validation logic (undefined)

Possibly related issues

  • None

Possibly related PRs

Suggested labels

C:orm, C:collections, C:server/v2, C:server/v2 cometbft


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@aaronc aaronc changed the title refactor(schema)!: rename IntegerStringKind, DecimalStringKind, add SizeLimit placeholder refactor(schema)!: rename IntegerStringKind and DecimalStringKind Sep 12, 2024
@aaronc aaronc marked this pull request as ready for review September 12, 2024 21:07
@aaronc aaronc added this pull request to the merge queue Sep 14, 2024
Merged via the queue into main with commit 47561a9 Sep 14, 2024
74 checks passed
@aaronc aaronc deleted the aaronc/schema-int-dec-refactor branch September 14, 2024 01:52
alpe added a commit that referenced this pull request Sep 16, 2024
* main:
  test: fix sims (#21735)
  build: bump proto-builder (#21730)
  refactor(schema)!: rename IntegerStringKind and DecimalStringKind (#21694)
  feat(types/collections): add `LegacyDec` collection value (#21693)
  refactor(server): alias AppOptions to coreserver.DynamicConfig (#21711)
  refactor(simapp): simplify simapp di (#21718)
  feat: replace the cosmos-db usecases in the tests with `core/testing` (#21525)
  feat(runtime/v2): store loader on simappv2 (#21704)
  docs(x/auth): vesting (#21715)
  build(deps): Bump google.golang.org/grpc from 1.66.1 to 1.66.2 (#21670)
  refactor(systemtest): Add cli.RunAndWait for common operations (#21689)
  fix(runtime/v2): provide default factory options if unset in app builder (#21690)
  chore: remove duplicate proto files for the same proto file (#21648)
  feat(x/genutil): add better error messages for genesis validation (#21701)
  build(deps): Bump cosmossdk.io/core from 1.0.0-alpha.1 to 1.0.0-alpha.2 (#21698)
  test: migrate e2e/bank to system tests (#21607)
  chore: fix the gci lint issue in testutil (#21695)
  docs(x/authz): update grant docs (#21677)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants