sync.go

package bundle

import (
	"context"
	"errors"
	"fmt"
	"io"
	"time"

	"github.com/databricks/cli/bundle"
	"github.com/databricks/cli/bundle/deploy/files"
	"github.com/databricks/cli/cmd/bundle/utils"
	"github.com/databricks/cli/cmd/root"
	"github.com/databricks/cli/libs/flags"
	"github.com/databricks/cli/libs/log"
	"github.com/databricks/cli/libs/sync"
	"github.com/spf13/cobra"
)

var errInvalidConcurrency = errors.New("--concurrency must be at least 1")

type syncFlags struct {
	interval    time.Duration
	full        bool
	watch       bool
	output      flags.Output
	dryRun      bool
	concurrency int
}

func (f *syncFlags) validate() error {
	if f.concurrency < 1 {
		return errInvalidConcurrency
	}
	return nil
}

func (f *syncFlags) syncOptionsFromBundle(cmd *cobra.Command, b *bundle.Bundle) (*sync.SyncOptions, error) {
	opts, err := files.GetSyncOptions(cmd.Context(), b)
	if err != nil {
		return nil, fmt.Errorf("cannot get sync options: %w", err)
	}

	if f.output != "" {
		var outputFunc func(context.Context, <-chan sync.Event, io.Writer)
		switch f.output {
		case flags.OutputText:
			outputFunc = sync.TextOutput
		case flags.OutputJSON:
			outputFunc = sync.JsonOutput
		}
		if outputFunc != nil {
			opts.OutputHandler = func(ctx context.Context, c <-chan sync.Event) {
				outputFunc(ctx, c, cmd.OutOrStdout())
			}
		}
	}

	opts.Full = f.full
	opts.PollInterval = f.interval
	opts.DryRun = f.dryRun
	opts.Concurrency = f.concurrency
	return opts, nil
}

func newSyncCommand() *cobra.Command {
	cmd := &cobra.Command{
		Use:   "sync [flags]",
		Short: "Synchronize bundle tree to the workspace",
		Long: `Synchronize bundle files to Databricks workspace for development.

Use sync during development to upload local changes without full deployment:
  databricks bundle sync              # One-time sync of all files
  databricks bundle sync --watch      # Continuously watch and sync changes
  databricks bundle sync --full       # Force full sync (vs incremental)
  databricks bundle sync --dry-run    # Preview what would be synced

Sync is faster than deploy for rapid development but doesn't update job/pipeline definitions.
Use 'databricks bundle deploy' for full resource deployment.`,
		Args: root.NoArgs,
	}

	var f syncFlags
	cmd.Flags().DurationVar(&f.interval, "interval", 1*time.Second, "file system polling interval (for --watch)")
	cmd.Flags().BoolVar(&f.full, "full", false, "perform full synchronization (default is incremental)")
	cmd.Flags().BoolVar(&f.watch, "watch", false, "watch local file system for changes")
	cmd.Flags().Var(&f.output, "output", "type of the output format")
	cmd.Flags().BoolVar(&f.dryRun, "dry-run", false, "simulate sync execution without making actual changes")
	cmd.Flags().IntVar(&f.concurrency, "concurrency", sync.MaxRequestsInFlight, "number of parallel requests to the workspace")

	cmd.RunE = func(cmd *cobra.Command, args []string) error {
		if err := f.validate(); err != nil {
			return err
		}

		b, err := utils.ProcessBundle(cmd, utils.ProcessOptions{})
		if err != nil {
			return err
		}
		ctx := cmd.Context()

		opts, err := f.syncOptionsFromBundle(cmd, b)
		if err != nil {
			return err
		}

		s, err := sync.New(ctx, *opts)
		if err != nil {
			return err
		}
		defer s.Close()

		log.Infof(ctx, "Remote file sync location: %v", opts.RemotePath)

		if opts.DryRun {
			log.Warnf(ctx, "Running in dry-run mode. No actual changes will be made.")
		}

		if f.watch {
			return s.RunContinuous(ctx)
		}

		_, err = s.RunOnce(ctx)
		return err
	}

	return cmd
}