CR: config renaming/comment fix

algorand · Nov 8, 2023 · eb977e2 · eb977e2
1 parent 8c4c28b
commit eb977e2
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 12 deletions.
diff --git a/config/localTemplate.go b/config/localTemplate.go
@@ -238,11 +238,12 @@ type Local struct {
 	// TxBacklogAppTxPerSecondRate determines a target app per second rate for the app tx rate limiter
 	TxBacklogAppTxPerSecondRate int `version[32]:"100"`
 
-	// TxBacklogRateLimitingCongestionRatio determines the backlog filling threashold in percents at which app limiter kicks in
+	// TxBacklogRateLimitingCongestionRatio determines the backlog filling threshold percentage at which the app limiter kicks in
+	// or the tx backlog rate limiter kicks off.
 	TxBacklogRateLimitingCongestionPct int `version[32]:"50"`
 
-	// EnableAppTxBacklogRateLimiting controls if an app rate limiter should be attached to the tx backlog enqueue process
-	EnableAppTxBacklogRateLimiting bool `version[32]:"true"`
+	// EnableTxBacklogAppRateLimiting controls if an app rate limiter should be attached to the tx backlog enqueue process
+	EnableTxBacklogAppRateLimiting bool `version[32]:"true"`
 
 	// EnableTxBacklogRateLimiting controls if a rate limiter and congestion manager should be attached to the tx backlog enqueue process
 	// if enabled, the over-all TXBacklog Size will be larger by MAX_PEERS*TxBacklogReservedCapacityPerPeer

diff --git a/config/local_defaults.go b/config/local_defaults.go
@@ -62,7 +62,6 @@ var defaultLocal = Local{
 	EnableAccountUpdatesStats:                  false,
 	EnableAgreementReporting:                   false,
 	EnableAgreementTimeMetrics:                 false,
-	EnableAppTxBacklogRateLimiting:             true,
 	EnableAssembleStats:                        false,
 	EnableBlockService:                         false,
 	EnableBlockServiceFallbackToArchiver:       false,
@@ -82,6 +81,7 @@ var defaultLocal = Local{
 	EnableRequestLogger:                        false,
 	EnableRuntimeMetrics:                       false,
 	EnableTopAccountsReporting:                 false,
+	EnableTxBacklogAppRateLimiting:             true,
 	EnableTxBacklogRateLimiting:                true,
 	EnableTxnEvalTracer:                        false,
 	EnableUsageLog:                             false,

diff --git a/data/txHandler.go b/data/txHandler.go
@@ -181,11 +181,11 @@ func MakeTxHandler(opts TxHandlerOpts) (*TxHandler, error) {
 		handler.txCanonicalCache = makeDigestCache(int(opts.Config.TxIncomingFilterMaxSize))
 	}
 
-	if opts.Config.EnableTxBacklogRateLimiting || opts.Config.EnableAppTxBacklogRateLimiting {
+	if opts.Config.EnableTxBacklogRateLimiting || opts.Config.EnableTxBacklogAppRateLimiting {
 		if opts.Config.TxBacklogRateLimitingCongestionPct > 100 || opts.Config.TxBacklogRateLimitingCongestionPct < 0 {
 			return nil, fmt.Errorf("invalid value for TxBacklogRateLimitingCongestionPct: %d", opts.Config.TxBacklogRateLimitingCongestionPct)
 		}
-		if opts.Config.EnableAppTxBacklogRateLimiting && opts.Config.TxBacklogAppTxRateLimiterMaxSize == 0 {
+		if opts.Config.EnableTxBacklogAppRateLimiting && opts.Config.TxBacklogAppTxRateLimiterMaxSize == 0 {
 			return nil, fmt.Errorf("invalid value for TxBacklogAppTxRateLimiterMaxSize: %d. App rate limiter enabled with zero size", opts.Config.TxBacklogAppTxRateLimiterMaxSize)
 		}
 		handler.backlogCongestionThreshold = float64(opts.Config.TxBacklogRateLimitingCongestionPct) / 100
@@ -197,7 +197,7 @@ func MakeTxHandler(opts TxHandlerOpts) (*TxHandler, error) {
 				txBacklogDroppedCongestionManagement,
 			)
 		}
-		if opts.Config.EnableAppTxBacklogRateLimiting {
+		if opts.Config.EnableTxBacklogAppRateLimiting {
 			handler.appLimiter = makeAppRateLimiter(
 				opts.Config.TxBacklogAppTxRateLimiterMaxSize,
 				uint64(opts.Config.TxBacklogAppTxPerSecondRate),

diff --git a/data/txHandler_test.go b/data/txHandler_test.go
@@ -2533,7 +2533,7 @@ func TestTxHandlerAppRateLimiterERLEnabled(t *testing.T) {
 
 	func() {
 		cfg.EnableTxBacklogRateLimiting = false
-		cfg.EnableAppTxBacklogRateLimiting = false
+		cfg.EnableTxBacklogAppRateLimiting = false
 		handler, err := makeTestTxHandler(l, cfg)
 		require.NoError(t, err)
 		defer handler.txVerificationPool.Shutdown()
@@ -2545,7 +2545,7 @@ func TestTxHandlerAppRateLimiterERLEnabled(t *testing.T) {
 
 	func() {
 		cfg.EnableTxBacklogRateLimiting = true
-		cfg.EnableAppTxBacklogRateLimiting = false
+		cfg.EnableTxBacklogAppRateLimiting = false
 		handler, err := makeTestTxHandler(l, cfg)
 		require.NoError(t, err)
 		defer handler.txVerificationPool.Shutdown()
@@ -2556,7 +2556,7 @@ func TestTxHandlerAppRateLimiterERLEnabled(t *testing.T) {
 	}()
 
 	cfg.EnableTxBacklogRateLimiting = true
-	cfg.EnableAppTxBacklogRateLimiting = true
+	cfg.EnableTxBacklogAppRateLimiting = true
 	handler, err := makeTestTxHandler(l, cfg)
 	require.NoError(t, err)
 	defer handler.txVerificationPool.Shutdown()

diff --git a/installer/config.json.example b/installer/config.json.example
@@ -41,7 +41,6 @@
     "EnableAccountUpdatesStats": false,
     "EnableAgreementReporting": false,
     "EnableAgreementTimeMetrics": false,
-    "EnableAppTxBacklogRateLimiting": true,
     "EnableAssembleStats": false,
     "EnableBlockService": false,
     "EnableBlockServiceFallbackToArchiver": false,
@@ -61,6 +60,7 @@
     "EnableRequestLogger": false,
     "EnableRuntimeMetrics": false,
     "EnableTopAccountsReporting": false,
+    "EnableTxBacklogAppRateLimiting": true,
     "EnableTxBacklogRateLimiting": true,
     "EnableTxnEvalTracer": false,
     "EnableUsageLog": false,

diff --git a/test/testdata/configs/config-v32.json b/test/testdata/configs/config-v32.json
@@ -41,7 +41,6 @@
     "EnableAccountUpdatesStats": false,
     "EnableAgreementReporting": false,
     "EnableAgreementTimeMetrics": false,
-    "EnableAppTxBacklogRateLimiting": true,
     "EnableAssembleStats": false,
     "EnableBlockService": false,
     "EnableBlockServiceFallbackToArchiver": false,
@@ -61,6 +60,7 @@
     "EnableRequestLogger": false,
     "EnableRuntimeMetrics": false,
     "EnableTopAccountsReporting": false,
+    "EnableTxBacklogAppRateLimiting": true,
     "EnableTxBacklogRateLimiting": true,
     "EnableTxnEvalTracer": false,
     "EnableUsageLog": false,