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

fix: supply historical fix #61

Merged
merged 1 commit into from
Jul 15, 2024
Merged

Conversation

yevhen-burkovskyi
Copy link
Contributor

No description provided.

@yevhen-burkovskyi yevhen-burkovskyi self-assigned this Jul 15, 2024
Copy link

coderabbitai bot commented Jul 15, 2024

Walkthrough

Overall, the changes revolve around removing the change field from the HistoricalSupply model and updating various data transfer objects (DTOs) and services to reflect this change. The modifications include schema updates, DTO adjustments, and service logic changes to align with the new data structure and calculation methodologies.

Changes

File Change Summary
prisma/migrations/.../migration.sql, prisma/schema.prisma Removed the change column from the historical_supply table in the schema.
src/modules/supply/dtos/current-supply.dto.ts Removed the change property from the CurrentSupplyDto interface.
src/modules/supply/dtos/supply-interval.dto.ts Introduced SupplyIntervalDto interface with change and time properties.
src/modules/supply/dtos/time-bucket.dto.ts Renamed sum_change to avg_supply and updated its type to string in the TimeBucketDto type.
src/modules/supply/services/supply.service.ts Updated various methods in SupplyService to align with new DTOs and calculation logic, including changing ChangeIntervalDto to SupplyIntervalDto and adjusting supply change calculation.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant SupplyService
    participant Database

    Client->>SupplyService: Request current supply
    SupplyService->>Database: Query current supply
    Database-->>SupplyService: Return supply data
    SupplyService->>Client: Return current supply (without `change`)

    Client->>SupplyService: Request supply intervals
    SupplyService->>Database: Query supply intervals
    Database-->>SupplyService: Return supply interval data
    SupplyService->>Client: Return `SupplyIntervalDto`
    
    Client->>SupplyService: Calculate supply growth
    SupplyService->>Database: Query past and current supply
    Database-->>SupplyService: Return past and current supply data
    SupplyService->>SupplyService: Calculate supply growth percentage
    SupplyService->>Client: Return supply growth result
Loading

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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c87044a and 07d6566.

Files selected for processing (6)
  • prisma/migrations/20240715092517_historical_supply_change_supply/migration.sql (1 hunks)
  • prisma/schema.prisma (1 hunks)
  • src/modules/supply/dtos/current-supply.dto.ts (1 hunks)
  • src/modules/supply/dtos/supply-interval.dto.ts (1 hunks)
  • src/modules/supply/dtos/time-bucket.dto.ts (1 hunks)
  • src/modules/supply/services/supply.service.ts (7 hunks)
Files skipped from review due to trivial changes (3)
  • prisma/migrations/20240715092517_historical_supply_change_supply/migration.sql
  • prisma/schema.prisma
  • src/modules/supply/dtos/supply-interval.dto.ts
Additional comments not posted (7)
src/modules/supply/dtos/current-supply.dto.ts (1)

1-4: LGTM! The interface is simplified.

The removal of the change property from CurrentSupplyDto is consistent with the overall refactor.

src/modules/supply/dtos/time-bucket.dto.ts (1)

2-4: LGTM! The property name and type change are appropriate.

The renaming of sum_change to avg_supply and the type change to string align with the overall refactor.

src/modules/supply/services/supply.service.ts (5)

Line range hint 67-71:
LGTM! The SQL query changes are correct.

The update to select avg_supply instead of sum_change is consistent with the new schema.


76-79: LGTM! The mapping is consistent.

The fromBucket method correctly maps avg_supply to change in the SupplyIntervalDto.


113-122: LGTM! The type change and logic adjustments are correct.

The method correctly handles newSupply and pastSupply as strings and calculates the supply change percentage.


192-205: LGTM! The logic for calculating supply growth is correct.

The method correctly calculates supply growth based on current and past supply values.


211-215: LGTM! The inclusion of growth is correct.

The method correctly includes growth in the returned object and calculates it using Big.

@yevhen-burkovskyi yevhen-burkovskyi merged commit 0909fa0 into main Jul 15, 2024
11 checks passed
@yevhen-burkovskyi yevhen-burkovskyi deleted the fix/supply-historical branch July 15, 2024 11:36
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