Dedupe Reload/NoSyncReload, prefer empty instead of nil init #804
+6
−24
Conversation
This file contains 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
ahrtr
reviewed
Aug 5, 2024
internal/freelist/freelist.go
Outdated
| @@ -65,7 +66,7 @@ type Interface interface { | |||
| // NoSyncReload reads the freelist from Pgids and filters out pending items. | |||
| NoSyncReload(pgIds common.Pgids) | |||
|
|
|||
| // freePageIds returns the IDs of all free pages. | |||
| // freePageIds returns the IDs of all free pages. No free pages returns an empty slice. | |||
There was a problem hiding this comment.
Suggested change
| // freePageIds returns the IDs of all free pages. No free pages returns an empty slice. | |
| // freePageIds returns the IDs of all free pages. Returns an empty slice if no free pages are available. |
internal/freelist/freelist.go
Outdated
| Free(txId common.Txid, p *common.Page) | ||
|
|
||
| // Freed returns whether a given page is in the free list. | ||
| Freed(pgId common.Pgid) bool | ||
|
|
||
| // Rollback removes the pages from a given pending tx. | ||
| // Should always be followed by Reload or NoSyncReload from last freelist state. |
There was a problem hiding this comment.
Such restriction isn't friendly to users. We should consider to get rid of such restriction in following PRs. We can discuss this separately.
Suggested change
| // Should always be followed by Reload or NoSyncReload from last freelist state. |
Reload and NoSyncReload have duplicated code, this unifies both for later refactoring. This PR is split from etcd-io#786, where the tests found differences on reloading and nil/empty initializations. Added some more clarifications in godocs for certain panic behavior and expected returns on the interface. Signed-off-by: Thomas Jungblut <[email protected]>
tjungblu
force-pushed
the
duplicated_code
branch
from
4061583
to
33b71a5
Compare
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ahrtr, tjungblu The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
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.
Reload and NoSyncReload have duplicated code, this unifies both for later refactoring.
This PR is split from #786, where the tests found differences on reloading and nil/empty initializations. Added some more clarifications in godocs for certain panic behavior and expected returns on the interface.