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

Rename best to latest #664

Closed
wants to merge 1 commit into from

Conversation

MakisChristou
Copy link
Member

Description

Renaming of block label best to latest.

Fixes #91

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Test Configuration:

  • Go Version:
  • Hardware:
  • Docker Version:

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • New and existing E2E tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have not added any vulnerable dependencies to my code

@MakisChristou MakisChristou requested a review from a team as a code owner January 31, 2024 07:45
@codecov-commenter
Copy link

Codecov Report

Attention: 3 lines in your changes are missing coverage. Please review.

Comparison is base (39ecf84) 57.40% compared to head (0e065b6) 57.42%.

Files Patch % Lines
chain/repository.go 0.00% 1 Missing ⚠️
cmd/thor/node/packer_loop.go 0.00% 1 Missing ⚠️
comm/communicator.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #664      +/-   ##
==========================================
+ Coverage   57.40%   57.42%   +0.01%     
==========================================
  Files         179      179              
  Lines       20678    20678              
==========================================
+ Hits        11870    11874       +4     
+ Misses       7922     7918       -4     
  Partials      886      886              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@darrenvechain darrenvechain left a comment

Choose a reason for hiding this comment

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

This PR introduces a breaking change. As a best practice, it's crucial to ensure that existing endpoints remain backward compatible.

The discussion around naming conventions on blocks is still ongoing I believe.

@claytonneal
Copy link
Member

claytonneal commented Jan 31, 2024

heya, think the idea is to support latest and best!
so if the user passed "latest" just map it to "best"
also there is function "handleRevision" in api/accounts/accounts.go that also parses the revision, that needs updating too!

@darrenvechain
Copy link
Member

darrenvechain commented Jan 31, 2024

heya, think the idea is to support latest and best! so if the user passed "latest" just map it to "best" also there is function "handleRevision" in accounts.go that also parses the revision, that needs updating too!

Something to watch out for around handleRevision is finalized. I think this field is currently only used in /blocks and not other endpoints

@MakisChristou
Copy link
Member Author

est practice, it's crucial t

So would that entail just modifying the parseRevision function to include latest as well? That seems to do the trick in practice. Both best and latest are work on the swagger API.

@claytonneal
Copy link
Member

Is this PR dead now? Should it be closed? cheers

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.

4 participants