mirror of
https://github.com/seaweedfs/seaweedfs.git
synced 2026-05-13 21:31:32 +00:00
* refactor(worker): co-locate plugin handlers with their task packages
Move every per-task plugin handler from weed/plugin/worker/ into the
matching weed/worker/tasks/<name>/ package, so each task owns its
detection, scheduling, execution, and plugin handler in one place.
Step 0 (within pluginworker, no behavior change): extract shared helpers
that previously lived inside individual handler files into dedicated
files and export the ones now consumed across packages.
- activity.go: BuildExecutorActivity, BuildDetectorActivity
- config.go: ReadStringConfig/Double/Int64/Bytes/StringList, MapTaskPriority
- interval.go: ShouldSkipDetectionByInterval
- volume_state.go: VolumeState + consts, FilterMetricsByVolumeState/Location
- collection_filter.go: CollectionFilterMode + consts
- volume_metrics.go: export CollectVolumeMetricsFromMasters,
MasterAddressCandidates, FetchVolumeList
- testing_senders_test.go: shared test stubs
Phase 1: move the per-task plugin handlers (and the iceberg subpackage)
into their task packages.
weed/plugin/worker/vacuum_handler.go -> weed/worker/tasks/vacuum/plugin_handler.go
weed/plugin/worker/ec_balance_handler.go -> weed/worker/tasks/ec_balance/plugin_handler.go
weed/plugin/worker/erasure_coding_handler.go -> weed/worker/tasks/erasure_coding/plugin_handler.go
weed/plugin/worker/volume_balance_handler.go -> weed/worker/tasks/balance/plugin_handler.go
weed/plugin/worker/iceberg/ -> weed/worker/tasks/iceberg/
weed/plugin/worker/handlers/handlers.go now blank-imports all five
task subpackages so their init() registrations fire.
weed/command/mini.go and the worker tests construct the handler with
vacuum.DefaultMaxExecutionConcurrency (the constant moved with the
vacuum handler).
admin_script remains in weed/plugin/worker/ because there is no
underlying weed/worker/tasks/admin_script/ package to merge with.
* refactor(worker): update test/plugin_workers imports for moved handlers
Three handler constructors moved out of pluginworker into their task
packages — update the integration test files in test/plugin_workers/
to import from the new locations:
pluginworker.NewVacuumHandler -> vacuum.NewVacuumHandler
pluginworker.NewVolumeBalanceHandler -> balance.NewVolumeBalanceHandler
pluginworker.NewErasureCodingHandler -> erasure_coding.NewErasureCodingHandler
The pluginworker import is kept where the file still uses
pluginworker.WorkerOptions / pluginworker.JobHandler.
* refactor(worker): update test/s3tables iceberg import path
The iceberg subpackage moved from weed/plugin/worker/iceberg/ to
weed/worker/tasks/iceberg/. test/s3tables/maintenance/maintenance_integration_test.go
still imported the old path, breaking S3 Tables / RisingWave / Trino /
Spark / Iceberg-catalog / STS integration test builds.
Mirrors the OSS-side fix needed by every job in the run that
transitively imports test/s3tables/maintenance.
* chore: gofmt PR-touched files
The S3 Tables Format Check job runs `gofmt -l` over weed/s3api/s3tables
and test/s3tables, then fails if anything is unformatted. Files this
PR moved or modified had import-grouping and trailing-spacing issues
introduced by perl-based renames; reformat them with gofmt -w.
Touched files:
test/plugin_workers/erasure_coding/{detection,execution}_test.go
test/s3tables/maintenance/maintenance_integration_test.go
weed/plugin/worker/handlers/handlers.go
weed/worker/tasks/{balance,ec_balance,erasure_coding,vacuum}/plugin_handler*.go
* refactor(worker): bounds-checked int conversions for plugin config values
CodeQL flagged 18 go/incorrect-integer-conversion warnings on the moved
plugin handler files: results of pluginworker.ReadInt64Config (which
ultimately calls strconv.ParseInt with bit size 64) were being narrowed
to int32/uint32/int without an upper-bound check, so a malicious or
malformed admin/worker config value could overflow the target type.
Add three helpers in weed/plugin/worker/config.go that wrap
ReadInt64Config and clamp out-of-range values back to the caller's
fallback:
ReadInt32Config (math.MinInt32 .. math.MaxInt32)
ReadUint32Config (0 .. math.MaxUint32)
ReadIntConfig (math.MinInt32 .. math.MaxInt32, platform-portable)
Update each flagged call site in the four moved task packages to use
the bounds-checked helper. For protobuf uint32 fields (volume IDs)
the variable type also becomes uint32, removing the trailing
uint32(volumeID) casts and changing the "missing volume_id" check
from `<= 0` to `== 0`.
Touched files:
weed/plugin/worker/config.go
weed/worker/tasks/balance/plugin_handler.go
weed/worker/tasks/erasure_coding/plugin_handler.go
weed/worker/tasks/vacuum/plugin_handler.go
* refactor(worker): use ReadIntConfig for clamped derive-worker-config helpers
CodeQL still flagged three call sites where ReadInt64Config was being
narrowed to int after a value-range clamp (max_concurrent_moves <= 50,
batch_size <= 100, min_server_count >= 2). The clamp is correct but
CodeQL's flow analysis didn't recognize the bound, so it flagged them
as unbounded narrowing.
Switch to ReadIntConfig (already int32-bounded by the helper) for
those three sites, drop the now-redundant int64 intermediate variables.
Also drops the now-unused `> math.MaxInt32` clamp in
ec_balance.deriveECBalanceWorkerConfig (the helper covers it).
228 lines
6.6 KiB
Go
228 lines
6.6 KiB
Go
package pluginworker
|
|
|
|
import (
|
|
"fmt"
|
|
"math"
|
|
"strconv"
|
|
"strings"
|
|
|
|
"github.com/seaweedfs/seaweedfs/weed/pb/plugin_pb"
|
|
workertypes "github.com/seaweedfs/seaweedfs/weed/worker/types"
|
|
)
|
|
|
|
// ReadStringConfig reads a string-valued plugin config field, returning fallback
|
|
// when the value is missing or of an unsupported kind.
|
|
func ReadStringConfig(values map[string]*plugin_pb.ConfigValue, field string, fallback string) string {
|
|
if values == nil {
|
|
return fallback
|
|
}
|
|
value := values[field]
|
|
if value == nil {
|
|
return fallback
|
|
}
|
|
switch kind := value.Kind.(type) {
|
|
case *plugin_pb.ConfigValue_StringValue:
|
|
return kind.StringValue
|
|
case *plugin_pb.ConfigValue_Int64Value:
|
|
return strconv.FormatInt(kind.Int64Value, 10)
|
|
case *plugin_pb.ConfigValue_DoubleValue:
|
|
return strconv.FormatFloat(kind.DoubleValue, 'f', -1, 64)
|
|
case *plugin_pb.ConfigValue_BoolValue:
|
|
return strconv.FormatBool(kind.BoolValue)
|
|
}
|
|
return fallback
|
|
}
|
|
|
|
// ReadDoubleConfig reads a double-valued plugin config field, returning
|
|
// fallback when the value is missing or unparseable.
|
|
func ReadDoubleConfig(values map[string]*plugin_pb.ConfigValue, field string, fallback float64) float64 {
|
|
if values == nil {
|
|
return fallback
|
|
}
|
|
value := values[field]
|
|
if value == nil {
|
|
return fallback
|
|
}
|
|
switch kind := value.Kind.(type) {
|
|
case *plugin_pb.ConfigValue_DoubleValue:
|
|
return kind.DoubleValue
|
|
case *plugin_pb.ConfigValue_Int64Value:
|
|
return float64(kind.Int64Value)
|
|
case *plugin_pb.ConfigValue_StringValue:
|
|
parsed, err := strconv.ParseFloat(strings.TrimSpace(kind.StringValue), 64)
|
|
if err == nil {
|
|
return parsed
|
|
}
|
|
case *plugin_pb.ConfigValue_BoolValue:
|
|
if kind.BoolValue {
|
|
return 1
|
|
}
|
|
return 0
|
|
}
|
|
return fallback
|
|
}
|
|
|
|
// ReadInt64Config reads an int64-valued plugin config field, returning fallback
|
|
// when the value is missing or unparseable.
|
|
func ReadInt64Config(values map[string]*plugin_pb.ConfigValue, field string, fallback int64) int64 {
|
|
if values == nil {
|
|
return fallback
|
|
}
|
|
value := values[field]
|
|
if value == nil {
|
|
return fallback
|
|
}
|
|
switch kind := value.Kind.(type) {
|
|
case *plugin_pb.ConfigValue_Int64Value:
|
|
return kind.Int64Value
|
|
case *plugin_pb.ConfigValue_DoubleValue:
|
|
return int64(kind.DoubleValue)
|
|
case *plugin_pb.ConfigValue_StringValue:
|
|
parsed, err := strconv.ParseInt(strings.TrimSpace(kind.StringValue), 10, 64)
|
|
if err == nil {
|
|
return parsed
|
|
}
|
|
case *plugin_pb.ConfigValue_BoolValue:
|
|
if kind.BoolValue {
|
|
return 1
|
|
}
|
|
return 0
|
|
}
|
|
return fallback
|
|
}
|
|
|
|
// ReadInt32Config reads an int32-valued plugin config field, returning fallback
|
|
// when the value is missing or out of int32 range. Used for protobuf int32
|
|
// fields whose admin/worker config values arrive as int64.
|
|
func ReadInt32Config(values map[string]*plugin_pb.ConfigValue, field string, fallback int32) int32 {
|
|
v := ReadInt64Config(values, field, int64(fallback))
|
|
if v < int64(math.MinInt32) || v > int64(math.MaxInt32) {
|
|
return fallback
|
|
}
|
|
return int32(v)
|
|
}
|
|
|
|
// ReadUint32Config reads a uint32-valued plugin config field, returning
|
|
// fallback when the value is missing, negative, or exceeds math.MaxUint32.
|
|
// Used for protobuf uint32 fields (volume IDs, shard counts, …).
|
|
func ReadUint32Config(values map[string]*plugin_pb.ConfigValue, field string, fallback uint32) uint32 {
|
|
v := ReadInt64Config(values, field, int64(fallback))
|
|
if v < 0 || v > int64(math.MaxUint32) {
|
|
return fallback
|
|
}
|
|
return uint32(v)
|
|
}
|
|
|
|
// ReadIntConfig reads an int-valued plugin config field, returning fallback
|
|
// when the value is missing or outside the int32 range. The int32 range is
|
|
// used as the platform-portable safe range so that the same value parses
|
|
// identically on 32-bit and 64-bit builds.
|
|
func ReadIntConfig(values map[string]*plugin_pb.ConfigValue, field string, fallback int) int {
|
|
v := ReadInt64Config(values, field, int64(fallback))
|
|
if v < int64(math.MinInt32) || v > int64(math.MaxInt32) {
|
|
return fallback
|
|
}
|
|
return int(v)
|
|
}
|
|
|
|
// ReadBytesConfig reads a bytes-valued plugin config field, returning nil when
|
|
// the value is missing or of a different kind.
|
|
func ReadBytesConfig(values map[string]*plugin_pb.ConfigValue, field string) []byte {
|
|
if values == nil {
|
|
return nil
|
|
}
|
|
value := values[field]
|
|
if value == nil {
|
|
return nil
|
|
}
|
|
if kind, ok := value.Kind.(*plugin_pb.ConfigValue_BytesValue); ok {
|
|
return kind.BytesValue
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// ReadStringListConfig reads a list-of-strings plugin config field, returning
|
|
// nil when the value is missing. Accepts ConfigValue_StringList,
|
|
// ConfigValue_ListValue, or a comma-separated ConfigValue_StringValue.
|
|
func ReadStringListConfig(values map[string]*plugin_pb.ConfigValue, field string) []string {
|
|
if values == nil {
|
|
return nil
|
|
}
|
|
value := values[field]
|
|
if value == nil {
|
|
return nil
|
|
}
|
|
|
|
switch kind := value.Kind.(type) {
|
|
case *plugin_pb.ConfigValue_StringList:
|
|
return normalizeStringList(kind.StringList.GetValues())
|
|
case *plugin_pb.ConfigValue_ListValue:
|
|
out := make([]string, 0, len(kind.ListValue.GetValues()))
|
|
for _, item := range kind.ListValue.GetValues() {
|
|
itemText := readStringFromConfigValue(item)
|
|
if itemText != "" {
|
|
out = append(out, itemText)
|
|
}
|
|
}
|
|
return normalizeStringList(out)
|
|
case *plugin_pb.ConfigValue_StringValue:
|
|
return normalizeStringList(strings.Split(kind.StringValue, ","))
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func readStringFromConfigValue(value *plugin_pb.ConfigValue) string {
|
|
if value == nil {
|
|
return ""
|
|
}
|
|
switch kind := value.Kind.(type) {
|
|
case *plugin_pb.ConfigValue_StringValue:
|
|
return strings.TrimSpace(kind.StringValue)
|
|
case *plugin_pb.ConfigValue_Int64Value:
|
|
return fmt.Sprintf("%d", kind.Int64Value)
|
|
case *plugin_pb.ConfigValue_DoubleValue:
|
|
return fmt.Sprintf("%g", kind.DoubleValue)
|
|
case *plugin_pb.ConfigValue_BoolValue:
|
|
if kind.BoolValue {
|
|
return "true"
|
|
}
|
|
return "false"
|
|
}
|
|
return ""
|
|
}
|
|
|
|
func normalizeStringList(values []string) []string {
|
|
normalized := make([]string, 0, len(values))
|
|
seen := make(map[string]struct{}, len(values))
|
|
for _, value := range values {
|
|
item := strings.TrimSpace(value)
|
|
if item == "" {
|
|
continue
|
|
}
|
|
if _, found := seen[item]; found {
|
|
continue
|
|
}
|
|
seen[item] = struct{}{}
|
|
normalized = append(normalized, item)
|
|
}
|
|
return normalized
|
|
}
|
|
|
|
// MapTaskPriority converts a worker-task priority into the plugin protocol's
|
|
// JobPriority enum.
|
|
func MapTaskPriority(priority workertypes.TaskPriority) plugin_pb.JobPriority {
|
|
switch strings.ToLower(string(priority)) {
|
|
case "low":
|
|
return plugin_pb.JobPriority_JOB_PRIORITY_LOW
|
|
case "medium", "normal":
|
|
return plugin_pb.JobPriority_JOB_PRIORITY_NORMAL
|
|
case "high":
|
|
return plugin_pb.JobPriority_JOB_PRIORITY_HIGH
|
|
case "critical":
|
|
return plugin_pb.JobPriority_JOB_PRIORITY_CRITICAL
|
|
default:
|
|
return plugin_pb.JobPriority_JOB_PRIORITY_NORMAL
|
|
}
|
|
}
|