Skip to content

Commit 98d4da1

Browse files
kerwin612kerwin612
committed
clean code
1 parent f4ea1a1 commit 98d4da1

File tree

8 files changed

+110
-110
lines changed

8 files changed

+110
-110
lines changed

‎models/webhook/webhook.go‎

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -24,33 +24,33 @@ import (
2424

2525
// MetaSettings represents the metadata settings for webhook
2626
type MetaSettings struct {
27-
PayloadOptimization PayloadOptimizationConfig `json:"payload_optimization"` // Payload optimization configuration
27+
PayloadConfig PayloadConfig `json:"payload_config"` // Payload configuration
2828
}
2929

30-
// PayloadOptimizationConfig represents the configuration for webhook payload optimization
31-
type PayloadOptimizationConfig struct {
32-
Files PayloadOptimizationItem `json:"files"` // Files optimization config
33-
Commits PayloadOptimizationItem `json:"commits"` // Commits optimization config
30+
// PayloadConfig represents the configuration for webhook payload
31+
type PayloadConfig struct {
32+
Files PayloadConfigItem `json:"files"` // Files configuration
33+
Commits PayloadConfigItem `json:"commits"` // Commits configuration
3434
}
3535

36-
// PayloadOptimizationItem represents a single optimization item configuration
37-
type PayloadOptimizationItem struct {
38-
Enable bool `json:"enable"` // Whether to enable optimization for this item
36+
// PayloadConfigItem represents a single payload configuration item
37+
type PayloadConfigItem struct {
38+
Enable bool `json:"enable"` // Whether to enable this configuration
3939
Limit int `json:"limit"` // 0: trim all (none kept), >0: keep N items (forward order), <0: keep N items (reverse order)
4040
}
4141

4242
// DefaultMetaSettings returns the default webhook meta settings
4343
func DefaultMetaSettings() MetaSettings {
4444
return MetaSettings{
45-
PayloadOptimization: DefaultPayloadOptimizationConfig(),
45+
PayloadConfig: DefaultPayloadConfig(),
4646
}
4747
}
4848

49-
// DefaultPayloadOptimizationConfig returns the default payload optimization configuration
50-
func DefaultPayloadOptimizationConfig() PayloadOptimizationConfig {
51-
return PayloadOptimizationConfig{
52-
Files: PayloadOptimizationItem{Enable: false, Limit: 0},
53-
Commits: PayloadOptimizationItem{Enable: false, Limit: 0},
49+
// DefaultPayloadConfig returns the default payload configuration
50+
func DefaultPayloadConfig() PayloadConfig {
51+
return PayloadConfig{
52+
Files: PayloadConfigItem{Enable: false, Limit: 0},
53+
Commits: PayloadConfigItem{Enable: false, Limit: 0},
5454
}
5555
}
5656

@@ -397,9 +397,9 @@ func (w *Webhook) GetMetaSettings() MetaSettings {
397397
return settings
398398
}
399399

400-
// GetPayloadOptimizationConfig returns the payload optimization configuration
401-
func (w *Webhook) GetPayloadOptimizationConfig() PayloadOptimizationConfig {
402-
return w.GetMetaSettings().PayloadOptimization
400+
// GetPayloadConfig returns the payload configuration
401+
func (w *Webhook) GetPayloadConfig() PayloadConfig {
402+
return w.GetMetaSettings().PayloadConfig
403403
}
404404

405405
// SetMetaSettings sets the webhook meta settings
@@ -413,22 +413,22 @@ func (w *Webhook) SetMetaSettings(settings MetaSettings) error {
413413
return nil
414414
}
415415

416-
// SetPayloadOptimizationConfig sets the payload optimization configuration
417-
func (w *Webhook) SetPayloadOptimizationConfig(config PayloadOptimizationConfig) error {
416+
// SetPayloadConfig sets the payload configuration
417+
func (w *Webhook) SetPayloadConfig(config PayloadConfig) error {
418418
settings := w.GetMetaSettings()
419-
settings.PayloadOptimization = config
419+
settings.PayloadConfig = config
420420
return w.SetMetaSettings(settings)
421421
}
422422

423-
// IsPayloadOptimizationEnabled returns whether payload optimization is enabled
424-
func (w *Webhook) IsPayloadOptimizationEnabled() bool {
425-
config := w.GetPayloadOptimizationConfig()
423+
// IsPayloadConfigEnabled returns whether payload configuration is enabled
424+
func (w *Webhook) IsPayloadConfigEnabled() bool {
425+
config := w.GetPayloadConfig()
426426
return config.Files.Enable || config.Commits.Enable
427427
}
428428

429-
// GetPayloadOptimizationLimit returns the payload optimization limit
430-
func (w *Webhook) GetPayloadOptimizationLimit() int {
431-
config := w.GetPayloadOptimizationConfig()
429+
// GetPayloadConfigLimit returns the payload configuration limit
430+
func (w *Webhook) GetPayloadConfigLimit() int {
431+
config := w.GetPayloadConfig()
432432
if config.Files.Enable {
433433
return config.Files.Limit
434434
}
@@ -438,26 +438,26 @@ func (w *Webhook) GetPayloadOptimizationLimit() int {
438438
return 0
439439
}
440440

441-
// IsFilesOptimizationEnabled returns whether files optimization is enabled
442-
func (w *Webhook) IsFilesOptimizationEnabled() bool {
443-
config := w.GetPayloadOptimizationConfig()
441+
// IsFilesConfigEnabled returns whether files configuration is enabled
442+
func (w *Webhook) IsFilesConfigEnabled() bool {
443+
config := w.GetPayloadConfig()
444444
return config.Files.Enable
445445
}
446446

447-
// GetFilesOptimizationLimit returns the files optimization limit
448-
func (w *Webhook) GetFilesOptimizationLimit() int {
449-
config := w.GetPayloadOptimizationConfig()
447+
// GetFilesConfigLimit returns the files configuration limit
448+
func (w *Webhook) GetFilesConfigLimit() int {
449+
config := w.GetPayloadConfig()
450450
return config.Files.Limit
451451
}
452452

453-
// IsCommitsOptimizationEnabled returns whether commits optimization is enabled
454-
func (w *Webhook) IsCommitsOptimizationEnabled() bool {
455-
config := w.GetPayloadOptimizationConfig()
453+
// IsCommitsConfigEnabled returns whether commits configuration is enabled
454+
func (w *Webhook) IsCommitsConfigEnabled() bool {
455+
config := w.GetPayloadConfig()
456456
return config.Commits.Enable
457457
}
458458

459-
// GetCommitsOptimizationLimit returns the commits optimization limit
460-
func (w *Webhook) GetCommitsOptimizationLimit() int {
461-
config := w.GetPayloadOptimizationConfig()
459+
// GetCommitsConfigLimit returns the commits configuration limit
460+
func (w *Webhook) GetCommitsConfigLimit() int {
461+
config := w.GetPayloadConfig()
462462
return config.Commits.Limit
463463
}

‎models/webhook/webhook_test.go‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -335,20 +335,20 @@ func TestWebhookPayloadOptimization(t *testing.T) {
335335
webhook := &Webhook{}
336336

337337
// Test default configuration
338-
config := webhook.GetPayloadOptimizationConfig()
338+
config := webhook.GetPayloadConfig()
339339
assert.False(t, config.Files.Enable)
340340
assert.Equal(t, 0, config.Files.Limit)
341341
assert.False(t, config.Commits.Enable)
342342
assert.Equal(t, 0, config.Commits.Limit)
343343

344344
// Test setting configuration via meta settings
345345
metaSettings := MetaSettings{
346-
PayloadOptimization: PayloadOptimizationConfig{
347-
Files: PayloadOptimizationItem{
346+
PayloadConfig: PayloadConfig{
347+
Files: PayloadConfigItem{
348348
Enable: true,
349349
Limit: 5,
350350
},
351-
Commits: PayloadOptimizationItem{
351+
Commits: PayloadConfigItem{
352352
Enable: true,
353353
Limit: -3,
354354
},
@@ -357,34 +357,34 @@ func TestWebhookPayloadOptimization(t *testing.T) {
357357
webhook.SetMetaSettings(metaSettings)
358358

359359
// Test getting configuration
360-
config = webhook.GetPayloadOptimizationConfig()
360+
config = webhook.GetPayloadConfig()
361361
assert.True(t, config.Files.Enable)
362362
assert.Equal(t, 5, config.Files.Limit)
363363
assert.True(t, config.Commits.Enable)
364364
assert.Equal(t, -3, config.Commits.Limit)
365365

366366
// Test individual methods
367-
assert.True(t, webhook.IsFilesOptimizationEnabled())
368-
assert.Equal(t, 5, webhook.GetFilesOptimizationLimit())
369-
assert.True(t, webhook.IsCommitsOptimizationEnabled())
370-
assert.Equal(t, -3, webhook.GetCommitsOptimizationLimit())
371-
assert.True(t, webhook.IsPayloadOptimizationEnabled())
372-
373-
// Test backward compatibility with direct payload optimization config setting
374-
newConfig := PayloadOptimizationConfig{
375-
Files: PayloadOptimizationItem{
367+
assert.True(t, webhook.IsFilesConfigEnabled())
368+
assert.Equal(t, 5, webhook.GetFilesConfigLimit())
369+
assert.True(t, webhook.IsCommitsConfigEnabled())
370+
assert.Equal(t, -3, webhook.GetCommitsConfigLimit())
371+
assert.True(t, webhook.IsPayloadConfigEnabled())
372+
373+
// Test backward compatibility with direct payload config setting
374+
newConfig := PayloadConfig{
375+
Files: PayloadConfigItem{
376376
Enable: false,
377377
Limit: 10,
378378
},
379-
Commits: PayloadOptimizationItem{
379+
Commits: PayloadConfigItem{
380380
Enable: false,
381381
Limit: 20,
382382
},
383383
}
384-
webhook.SetPayloadOptimizationConfig(newConfig)
384+
webhook.SetPayloadConfig(newConfig)
385385

386386
// Verify the config is properly set through meta settings
387-
config = webhook.GetPayloadOptimizationConfig()
387+
config = webhook.GetPayloadConfig()
388388
assert.False(t, config.Files.Enable)
389389
assert.Equal(t, 10, config.Files.Limit)
390390
assert.False(t, config.Commits.Enable)

‎routers/api/v1/utils/hook.go‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ import (
2121
webhook_service "code.gitea.io/gitea/services/webhook"
2222
)
2323

24-
// getPayloadOptimizationEnable extracts the "enable" boolean value from a payload optimization config map
25-
func getPayloadOptimizationEnable(m map[string]any) bool {
24+
// getPayloadConfigEnable extracts the "enable" boolean value from a payload config map
25+
func getPayloadConfigEnable(m map[string]any) bool {
2626
if val, ok := m["enable"]; ok {
2727
if boolVal, ok := val.(bool); ok {
2828
return boolVal
@@ -31,8 +31,8 @@ func getPayloadOptimizationEnable(m map[string]any) bool {
3131
return false
3232
}
3333

34-
// getPayloadOptimizationLimit extracts the "limit" integer value from a payload optimization config map
35-
func getPayloadOptimizationLimit(m map[string]any) int {
34+
// getPayloadConfigLimit extracts the "limit" integer value from a payload config map
35+
func getPayloadConfigLimit(m map[string]any) int {
3636
if val, ok := m["limit"]; ok {
3737
switch v := val.(type) {
3838
case int:
@@ -259,31 +259,31 @@ func addHook(ctx *context.APIContext, form *api.CreateHookOption, ownerID, repoI
259259
if form.MetaSettings != nil {
260260
metaSettings := webhook.MetaSettings{}
261261

262-
// Parse payload optimization config
263-
if payloadOptMap, ok := form.MetaSettings["payload_optimization"].(map[string]any); ok {
264-
payloadOptConfig := webhook.PayloadOptimizationConfig{}
262+
// Parse payload config
263+
if payloadOptMap, ok := form.MetaSettings["payload_config"].(map[string]any); ok {
264+
payloadOptConfig := webhook.PayloadConfig{}
265265

266266
// Parse files config
267267
if filesConfig, ok := payloadOptMap["files"].(map[string]any); ok {
268-
payloadOptConfig.Files = webhook.PayloadOptimizationItem{
269-
Enable: getPayloadOptimizationEnable(filesConfig),
270-
Limit: getPayloadOptimizationLimit(filesConfig),
268+
payloadOptConfig.Files = webhook.PayloadConfigItem{
269+
Enable: getPayloadConfigEnable(filesConfig),
270+
Limit: getPayloadConfigLimit(filesConfig),
271271
}
272272
} else {
273-
payloadOptConfig.Files = webhook.PayloadOptimizationItem{Enable: false, Limit: 0}
273+
payloadOptConfig.Files = webhook.PayloadConfigItem{Enable: false, Limit: 0}
274274
}
275275

276276
// Parse commits config
277277
if commitsConfig, ok := payloadOptMap["commits"].(map[string]any); ok {
278-
payloadOptConfig.Commits = webhook.PayloadOptimizationItem{
279-
Enable: getPayloadOptimizationEnable(commitsConfig),
280-
Limit: getPayloadOptimizationLimit(commitsConfig),
278+
payloadOptConfig.Commits = webhook.PayloadConfigItem{
279+
Enable: getPayloadConfigEnable(commitsConfig),
280+
Limit: getPayloadConfigLimit(commitsConfig),
281281
}
282282
} else {
283-
payloadOptConfig.Commits = webhook.PayloadOptimizationItem{Enable: false, Limit: 0}
283+
payloadOptConfig.Commits = webhook.PayloadConfigItem{Enable: false, Limit: 0}
284284
}
285285

286-
metaSettings.PayloadOptimization = payloadOptConfig
286+
metaSettings.PayloadConfig = payloadOptConfig
287287
}
288288

289289
if err := w.SetMetaSettings(metaSettings); err != nil {
@@ -460,31 +460,31 @@ func editHook(ctx *context.APIContext, form *api.EditHookOption, w *webhook.Webh
460460
if form.MetaSettings != nil {
461461
metaSettings := webhook.MetaSettings{}
462462

463-
// Parse payload optimization config
464-
if payloadOptMap, ok := (*form.MetaSettings)["payload_optimization"].(map[string]any); ok {
465-
payloadOptConfig := webhook.PayloadOptimizationConfig{}
463+
// Parse payload config
464+
if payloadOptMap, ok := (*form.MetaSettings)["payload_config"].(map[string]any); ok {
465+
payloadOptConfig := webhook.PayloadConfig{}
466466

467467
// Parse files config
468468
if filesConfig, ok := payloadOptMap["files"].(map[string]any); ok {
469-
payloadOptConfig.Files = webhook.PayloadOptimizationItem{
470-
Enable: getPayloadOptimizationEnable(filesConfig),
471-
Limit: getPayloadOptimizationLimit(filesConfig),
469+
payloadOptConfig.Files = webhook.PayloadConfigItem{
470+
Enable: getPayloadConfigEnable(filesConfig),
471+
Limit: getPayloadConfigLimit(filesConfig),
472472
}
473473
} else {
474-
payloadOptConfig.Files = webhook.PayloadOptimizationItem{Enable: false, Limit: 0}
474+
payloadOptConfig.Files = webhook.PayloadConfigItem{Enable: false, Limit: 0}
475475
}
476476

477477
// Parse commits config
478478
if commitsConfig, ok := payloadOptMap["commits"].(map[string]any); ok {
479-
payloadOptConfig.Commits = webhook.PayloadOptimizationItem{
480-
Enable: getPayloadOptimizationEnable(commitsConfig),
481-
Limit: getPayloadOptimizationLimit(commitsConfig),
479+
payloadOptConfig.Commits = webhook.PayloadConfigItem{
480+
Enable: getPayloadConfigEnable(commitsConfig),
481+
Limit: getPayloadConfigLimit(commitsConfig),
482482
}
483483
} else {
484-
payloadOptConfig.Commits = webhook.PayloadOptimizationItem{Enable: false, Limit: 0}
484+
payloadOptConfig.Commits = webhook.PayloadConfigItem{Enable: false, Limit: 0}
485485
}
486486

487-
metaSettings.PayloadOptimization = payloadOptConfig
487+
metaSettings.PayloadConfig = payloadOptConfig
488488
}
489489

490490
if err := w.SetMetaSettings(metaSettings); err != nil {

‎routers/web/repo/setting/webhook.go‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -260,14 +260,14 @@ func createWebhook(ctx *context.Context, params webhookParams) {
260260
IsSystemWebhook: orCtx.IsSystemWebhook,
261261
}
262262

263-
// Set webhook meta settings with payload optimization config
263+
// Set webhook meta settings with payload config
264264
metaSettings := webhook.MetaSettings{
265-
PayloadOptimization: webhook.PayloadOptimizationConfig{
266-
Files: webhook.PayloadOptimizationItem{
265+
PayloadConfig: webhook.PayloadConfig{
266+
Files: webhook.PayloadConfigItem{
267267
Enable: params.WebhookForm.PayloadOptimizationFilesEnable,
268268
Limit: params.WebhookForm.PayloadOptimizationFilesLimit,
269269
},
270-
Commits: webhook.PayloadOptimizationItem{
270+
Commits: webhook.PayloadConfigItem{
271271
Enable: params.WebhookForm.PayloadOptimizationCommitsEnable,
272272
Limit: params.WebhookForm.PayloadOptimizationCommitsLimit,
273273
},
@@ -329,14 +329,14 @@ func editWebhook(ctx *context.Context, params webhookParams) {
329329
w.HTTPMethod = params.HTTPMethod
330330
w.Meta = string(meta)
331331

332-
// Set webhook meta settings with payload optimization config
332+
// Set webhook meta settings with payload config
333333
metaSettings := webhook.MetaSettings{
334-
PayloadOptimization: webhook.PayloadOptimizationConfig{
335-
Files: webhook.PayloadOptimizationItem{
334+
PayloadConfig: webhook.PayloadConfig{
335+
Files: webhook.PayloadConfigItem{
336336
Enable: params.WebhookForm.PayloadOptimizationFilesEnable,
337337
Limit: params.WebhookForm.PayloadOptimizationFilesLimit,
338338
},
339-
Commits: webhook.PayloadOptimizationItem{
339+
Commits: webhook.PayloadConfigItem{
340340
Enable: params.WebhookForm.PayloadOptimizationCommitsEnable,
341341
Limit: params.WebhookForm.PayloadOptimizationCommitsLimit,
342342
},

‎services/webhook/general.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -412,14 +412,14 @@ func ToHook(repoLink string, w *webhook_model.Webhook) (*api.Hook, error) {
412412
// Convert meta settings to map
413413
metaSettings := w.GetMetaSettings()
414414
metaSettingsMap := map[string]any{
415-
"payload_optimization": map[string]any{
415+
"payload_config": map[string]any{
416416
"files": map[string]any{
417-
"enable": metaSettings.PayloadOptimization.Files.Enable,
418-
"limit": metaSettings.PayloadOptimization.Files.Limit,
417+
"enable": metaSettings.PayloadConfig.Files.Enable,
418+
"limit": metaSettings.PayloadConfig.Files.Limit,
419419
},
420420
"commits": map[string]any{
421-
"enable": metaSettings.PayloadOptimization.Commits.Enable,
422-
"limit": metaSettings.PayloadOptimization.Commits.Limit,
421+
"enable": metaSettings.PayloadConfig.Commits.Enable,
422+
"limit": metaSettings.PayloadConfig.Commits.Limit,
423423
},
424424
},
425425
}

‎services/webhook/notifier.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -665,7 +665,7 @@ func (m *webhookNotifier) applyWebhookPayloadOptimizations(ctx context.Context,
665665

666666
for _, webhook := range webhooks {
667667
if webhook.HasEvent(webhook_module.HookEventPush) {
668-
config := webhook.GetPayloadOptimizationConfig()
668+
config := webhook.GetPayloadConfig()
669669

670670
// Check files optimization
671671
if config.Files.Enable {

0 commit comments

Comments
 (0)