Skip to content

This PR is to add comment to WithTieredStore in fluid/pkg/ddc/base/runtime.go #5728

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.

Sign up for GitHub

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

Closed
0x001cdf2c wants to merge 1 commit into from
Closed

This PR is to add comment to WithTieredStore in fluid/pkg/ddc/base/runtime.go #5728

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions pkg/ddc/base/runtime.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,18 @@ func (info *RuntimeInfo) GetFuseMetricsScrapeTarget() mountModeSelector {
return info.fuse.MetricsScrapeTarget
}

// WithTieredStore converts datav1alpha1.TieredStore to TieredStoreInfo and sets it to RuntimeInfo
// The conversion is needed because datav1alpha1.TieredStore contains some fields in string type which are not convenient to use, such as Quota and QuotaList, and we want to convert them to more structured type in RuntimeInfo.
// The conversion logic is as follows:
// 1. If the length of Levels in datav1alpha1.TieredStore is 0, return an empty TieredStoreInfo.
// 2. For each level in datav1alpha1.TieredStore, split the Path by comma to get multiple paths.
// 3. If QuotaList is not set, divide Quota equally to multiple paths and set the quota for each path.
// 4. If QuotaList is set, split the QuotaList by comma to get multiple quotas, and set the corresponding quota for each path. The value in QuotaList will overwrite the value in Quota if both of them are set.
// 5. Set other fields in TieredStoreInfo according to the values in datav1alpha1.TieredStore.
// If there is any error during the conversion, return the error.
// For example, if the length of quotas in QuotaList is not consistent with the length of paths, return an error. If the quota in Quota or QuotaList can't be parsed to a quantity type, return an error.
// The reason why we want to convert datav1alpha1.TieredStore to TieredStoreInfo instead of using datav1alpha1.TieredStore directly in RuntimeInfo is that datav1alpha1.TieredStore is designed for users to input the tiered store configuration in a flexible way, while TieredStoreInfo is designed for us to use the tiered store configuration in a more structured way in the code. By converting datav1alpha1.TieredStore to TieredStoreInfo, we can make it easier for us to use the tiered store configuration in the code, and also make it easier for us to validate the tiered store configuration when we convert it.
// The conversion logic is implemented in the convertToTieredstoreInfo function, and WithTieredStore is a wrapper of it to set the converted TieredStoreInfo to RuntimeInfo.
Comment on lines +249 to +260
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Mar 26, 2026

Choose a reason for hiding this comment

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

medium

While adding comments is great for code clarity, this comment block is quite verbose for a wrapper function and includes implementation details of convertToTieredstoreInfo. According to Go's style guide, comments should be concise and located with the code they describe.

It would be better to move the detailed conversion logic to a comment block for the convertToTieredstoreInfo function. For WithTieredStore, a more concise summary is preferable.

Here is a suggested replacement that is more idiomatic for Go documentation:

Suggested change
// WithTieredStore converts datav1alpha1.TieredStore to TieredStoreInfo and sets it to RuntimeInfo
// The conversion is needed because datav1alpha1.TieredStore contains some fields in string type which are not convenient to use, such as Quota and QuotaList, and we want to convert them to more structured type in RuntimeInfo.
// The conversion logic is as follows:
// 1. If the length of Levels in datav1alpha1.TieredStore is 0, return an empty TieredStoreInfo.
// 2. For each level in datav1alpha1.TieredStore, split the Path by comma to get multiple paths.
// 3. If QuotaList is not set, divide Quota equally to multiple paths and set the quota for each path.
// 4. If QuotaList is set, split the QuotaList by comma to get multiple quotas, and set the corresponding quota for each path. The value in QuotaList will overwrite the value in Quota if both of them are set.
// 5. Set other fields in TieredStoreInfo according to the values in datav1alpha1.TieredStore.
// If there is any error during the conversion, return the error.
// For example, if the length of quotas in QuotaList is not consistent with the length of paths, return an error. If the quota in Quota or QuotaList can't be parsed to a quantity type, return an error.
// The reason why we want to convert datav1alpha1.TieredStore to TieredStoreInfo instead of using datav1alpha1.TieredStore directly in RuntimeInfo is that datav1alpha1.TieredStore is designed for users to input the tiered store configuration in a flexible way, while TieredStoreInfo is designed for us to use the tiered store configuration in a more structured way in the code. By converting datav1alpha1.TieredStore to TieredStoreInfo, we can make it easier for us to use the tiered store configuration in the code, and also make it easier for us to validate the tiered store configuration when we convert it.
// The conversion logic is implemented in the convertToTieredstoreInfo function, and WithTieredStore is a wrapper of it to set the converted TieredStoreInfo to RuntimeInfo.
// WithTieredStore is a RuntimeInfoOption that converts a datav1alpha1.TieredStore to a TieredStoreInfo
// and sets it on the RuntimeInfo.
//
// The datav1alpha1.TieredStore is a user-facing API object that uses strings for flexibility (e.g., QuotaList).
// The internal TieredStoreInfo uses structured types for easier processing and validation.
// This function is a wrapper around convertToTieredstoreInfo, which performs the actual conversion.
References
  1. Go's 'Effective Go' guide recommends that comments should be concise and document the code they are placed with. Long, detailed comments about a wrapped function's implementation are better placed with the function itself to improve code readability and maintainability. (link)

func WithTieredStore(tieredStore datav1alpha1.TieredStore) RuntimeInfoOption {
return func(info *RuntimeInfo) error {
tieredStoreInfo, err := convertToTieredstoreInfo(tieredStore)
Expand Down
Loading