Method pull

lib/model/folder_sendrecv.go:164–236

pull returns true if it manages to get all needed items from peers, i.e. get the device in sync with the global state.

(ctx context.Context)

// pull returns true if it manages to get all needed items from peers, i.e. get
// the device in sync with the global state.
func (f *sendReceiveFolder) pull(ctx context.Context) (bool, error) {
	f.sl.DebugContext(ctx, "Pulling")

	scanChan := make(chan string)
	go f.pullScannerRoutine(ctx, scanChan)
	defer func() {
		close(scanChan)
		f.setState(FolderIdle)
	}()

	metricFolderPulls.WithLabelValues(f.ID).Inc()
	pullCtx, cancel := context.WithCancel(ctx)
	defer cancel()
	go addTimeUntilCancelled(pullCtx, metricFolderPullSeconds.WithLabelValues(f.ID))

	changed := 0

	f.errorsMut.Lock()
	f.pullErrors = nil
	f.errorsMut.Unlock()

	var err error
	for tries := range maxPullerIterations {
		select {
		case <-ctx.Done():
			return false, ctx.Err()
		default:
		}

		// Needs to be set on every loop, as the puller might have set
		// it to FolderSyncing during the last iteration.
		f.setState(FolderSyncPreparing)

		changed, err = f.pullerIteration(ctx, scanChan)
		if err != nil {
			return false, err
		}

		f.sl.DebugContext(ctx, "Pull iteration completed", "changed", changed, "try", tries+1)

		if changed == 0 {
			// No files were changed by the puller, so we are in sync, or we
			// are unable to make further progress for the moment.
			break
		}
	}

	f.errorsMut.Lock()
	pullErrNum := len(f.tempPullErrors)
	if pullErrNum > 0 {
		f.pullErrors = make([]FileError, 0, len(f.tempPullErrors))
		for path, err := range f.tempPullErrors {
			f.sl.WarnContext(ctx, "Failed to sync", slogutil.FilePath(path), slogutil.Error(err))
			f.pullErrors = append(f.pullErrors, FileError{
				Err:  err,
				Path: path,
			})
		}