mirror of
				https://codeberg.org/forgejo/forgejo.git
				synced 2025-10-31 14:31:02 +00:00 
			
		
		
		
	# ⚠️ Breaking Many deprecated queue config options are removed (actually, they should have been removed in 1.18/1.19). If you see the fatal message when starting Gitea: "Please update your app.ini to remove deprecated config options", please follow the error messages to remove these options from your app.ini. Example: ``` 2023/05/06 19:39:22 [E] Removed queue option: `[indexer].ISSUE_INDEXER_QUEUE_TYPE`. Use new options in `[queue.issue_indexer]` 2023/05/06 19:39:22 [E] Removed queue option: `[indexer].UPDATE_BUFFER_LEN`. Use new options in `[queue.issue_indexer]` 2023/05/06 19:39:22 [F] Please update your app.ini to remove deprecated config options ``` Many options in `[queue]` are are dropped, including: `WRAP_IF_NECESSARY`, `MAX_ATTEMPTS`, `TIMEOUT`, `WORKERS`, `BLOCK_TIMEOUT`, `BOOST_TIMEOUT`, `BOOST_WORKERS`, they can be removed from app.ini. # The problem The old queue package has some legacy problems: * complexity: I doubt few people could tell how it works. * maintainability: Too many channels and mutex/cond are mixed together, too many different structs/interfaces depends each other. * stability: due to the complexity & maintainability, sometimes there are strange bugs and difficult to debug, and some code doesn't have test (indeed some code is difficult to test because a lot of things are mixed together). * general applicability: although it is called "queue", its behavior is not a well-known queue. * scalability: it doesn't seem easy to make it work with a cluster without breaking its behaviors. It came from some very old code to "avoid breaking", however, its technical debt is too heavy now. It's a good time to introduce a better "queue" package. # The new queue package It keeps using old config and concept as much as possible. * It only contains two major kinds of concepts: * The "base queue": channel, levelqueue, redis * They have the same abstraction, the same interface, and they are tested by the same testing code. * The "WokerPoolQueue", it uses the "base queue" to provide "worker pool" function, calls the "handler" to process the data in the base queue. * The new code doesn't do "PushBack" * Think about a queue with many workers, the "PushBack" can't guarantee the order for re-queued unhandled items, so in new code it just does "normal push" * The new code doesn't do "pause/resume" * The "pause/resume" was designed to handle some handler's failure: eg: document indexer (elasticsearch) is down * If a queue is paused for long time, either the producers blocks or the new items are dropped. * The new code doesn't do such "pause/resume" trick, it's not a common queue's behavior and it doesn't help much. * If there are unhandled items, the "push" function just blocks for a few seconds and then re-queue them and retry. * The new code doesn't do "worker booster" * Gitea's queue's handlers are light functions, the cost is only the go-routine, so it doesn't make sense to "boost" them. * The new code only use "max worker number" to limit the concurrent workers. * The new "Push" never blocks forever * Instead of creating more and more blocking goroutines, return an error is more friendly to the server and to the end user. There are more details in code comments: eg: the "Flush" problem, the strange "code.index" hanging problem, the "immediate" queue problem. Almost ready for review. TODO: * [x] add some necessary comments during review * [x] add some more tests if necessary * [x] update documents and config options * [x] test max worker / active worker * [x] re-run the CI tasks to see whether any test is flaky * [x] improve the `handleOldLengthConfiguration` to provide more friendly messages * [x] fine tune default config values (eg: length?) ## Code coverage: 
		
			
				
	
	
		
			133 lines
		
	
	
	
		
			3.5 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			133 lines
		
	
	
	
		
			3.5 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
| // Copyright 2019 The Gitea Authors. All rights reserved.
 | |
| // SPDX-License-Identifier: MIT
 | |
| 
 | |
| package mirror
 | |
| 
 | |
| import (
 | |
| 	"context"
 | |
| 	"fmt"
 | |
| 
 | |
| 	repo_model "code.gitea.io/gitea/models/repo"
 | |
| 	"code.gitea.io/gitea/modules/graceful"
 | |
| 	"code.gitea.io/gitea/modules/log"
 | |
| 	mirror_module "code.gitea.io/gitea/modules/mirror"
 | |
| 	"code.gitea.io/gitea/modules/queue"
 | |
| 	"code.gitea.io/gitea/modules/setting"
 | |
| )
 | |
| 
 | |
| // doMirrorSync causes this request to mirror itself
 | |
| func doMirrorSync(ctx context.Context, req *mirror_module.SyncRequest) {
 | |
| 	if req.ReferenceID == 0 {
 | |
| 		log.Warn("Skipping mirror sync request, no mirror ID was specified")
 | |
| 		return
 | |
| 	}
 | |
| 	switch req.Type {
 | |
| 	case mirror_module.PushMirrorType:
 | |
| 		_ = SyncPushMirror(ctx, req.ReferenceID)
 | |
| 	case mirror_module.PullMirrorType:
 | |
| 		_ = SyncPullMirror(ctx, req.ReferenceID)
 | |
| 	default:
 | |
| 		log.Error("Unknown Request type in queue: %v for MirrorID[%d]", req.Type, req.ReferenceID)
 | |
| 	}
 | |
| }
 | |
| 
 | |
| var errLimit = fmt.Errorf("reached limit")
 | |
| 
 | |
| // Update checks and updates mirror repositories.
 | |
| func Update(ctx context.Context, pullLimit, pushLimit int) error {
 | |
| 	if !setting.Mirror.Enabled {
 | |
| 		log.Warn("Mirror feature disabled, but cron job enabled: skip update")
 | |
| 		return nil
 | |
| 	}
 | |
| 	log.Trace("Doing: Update")
 | |
| 
 | |
| 	handler := func(idx int, bean interface{}) error {
 | |
| 		var repo *repo_model.Repository
 | |
| 		var mirrorType mirror_module.SyncType
 | |
| 		var referenceID int64
 | |
| 
 | |
| 		if m, ok := bean.(*repo_model.Mirror); ok {
 | |
| 			if m.GetRepository() == nil {
 | |
| 				log.Error("Disconnected mirror found: %d", m.ID)
 | |
| 				return nil
 | |
| 			}
 | |
| 			repo = m.Repo
 | |
| 			mirrorType = mirror_module.PullMirrorType
 | |
| 			referenceID = m.RepoID
 | |
| 		} else if m, ok := bean.(*repo_model.PushMirror); ok {
 | |
| 			if m.GetRepository() == nil {
 | |
| 				log.Error("Disconnected push-mirror found: %d", m.ID)
 | |
| 				return nil
 | |
| 			}
 | |
| 			repo = m.Repo
 | |
| 			mirrorType = mirror_module.PushMirrorType
 | |
| 			referenceID = m.ID
 | |
| 		} else {
 | |
| 			log.Error("Unknown bean: %v", bean)
 | |
| 			return nil
 | |
| 		}
 | |
| 
 | |
| 		// Check we've not been cancelled
 | |
| 		select {
 | |
| 		case <-ctx.Done():
 | |
| 			return fmt.Errorf("aborted")
 | |
| 		default:
 | |
| 		}
 | |
| 
 | |
| 		// Push to the Queue
 | |
| 		if err := mirror_module.PushToQueue(mirrorType, referenceID); err != nil {
 | |
| 			if err == queue.ErrAlreadyInQueue {
 | |
| 				if mirrorType == mirror_module.PushMirrorType {
 | |
| 					log.Trace("PushMirrors for %-v already queued for sync", repo)
 | |
| 				} else {
 | |
| 					log.Trace("PullMirrors for %-v already queued for sync", repo)
 | |
| 				}
 | |
| 				return nil
 | |
| 			}
 | |
| 			return err
 | |
| 		}
 | |
| 		return nil
 | |
| 	}
 | |
| 
 | |
| 	pullMirrorsRequested := 0
 | |
| 	if pullLimit != 0 {
 | |
| 		if err := repo_model.MirrorsIterate(pullLimit, func(idx int, bean interface{}) error {
 | |
| 			if err := handler(idx, bean); err != nil {
 | |
| 				return err
 | |
| 			}
 | |
| 			pullMirrorsRequested++
 | |
| 			return nil
 | |
| 		}); err != nil && err != errLimit {
 | |
| 			log.Error("MirrorsIterate: %v", err)
 | |
| 			return err
 | |
| 		}
 | |
| 	}
 | |
| 
 | |
| 	pushMirrorsRequested := 0
 | |
| 	if pushLimit != 0 {
 | |
| 		if err := repo_model.PushMirrorsIterate(ctx, pushLimit, func(idx int, bean interface{}) error {
 | |
| 			if err := handler(idx, bean); err != nil {
 | |
| 				return err
 | |
| 			}
 | |
| 			pushMirrorsRequested++
 | |
| 			return nil
 | |
| 		}); err != nil && err != errLimit {
 | |
| 			log.Error("PushMirrorsIterate: %v", err)
 | |
| 			return err
 | |
| 		}
 | |
| 	}
 | |
| 	log.Trace("Finished: Update: %d pull mirrors and %d push mirrors queued", pullMirrorsRequested, pushMirrorsRequested)
 | |
| 	return nil
 | |
| }
 | |
| 
 | |
| func queueHandler(items ...*mirror_module.SyncRequest) []*mirror_module.SyncRequest {
 | |
| 	for _, req := range items {
 | |
| 		doMirrorSync(graceful.GetManager().ShutdownContext(), req)
 | |
| 	}
 | |
| 	return nil
 | |
| }
 | |
| 
 | |
| // InitSyncMirrors initializes a go routine to sync the mirrors
 | |
| func InitSyncMirrors() {
 | |
| 	mirror_module.StartSyncMirrors(queueHandler)
 | |
| }
 |