Add a way to configure plan-preview handling

[Warashi]

What would you like to be added:

The way to configure plan-preview handling behavior.

Why is this needed:

We have some options in the planpreview package, but they are not used or are only used in the tests.

pipecd/pkg/app/piped/planpreview/handler.go

Lines 52 to 74 in d667a1c

	func WithWorkerNum(n int) Option {
	return func(opts *options) {
	opts.workerNum = n
	}
	}
	func WithCommandQueueBufferSize(s int) Option {
	return func(opts *options) {
	opts.commandQueueBufferSize = s
	}
	}
	func WithCommandCheckInterval(i time.Duration) Option {
	return func(opts *options) {
	opts.commandCheckInterval = i
	}
	}
	func WithCommandHandleTimeout(t time.Duration) Option {
	return func(opts *options) {
	opts.commandHandleTimeout = t
	}
	}

[kadai0308]

I can help!

[khanhtc1202]

Thanks, assigned to @kadai0308 👍

[kadai0308]

@Warashi Hi, not sure do I understand correct or not? Do you mean to remove all these function

pipecd/pkg/app/piped/planpreview/handler.go

Lines 52 to 74 in d667a1c

	func WithWorkerNum(n int) Option {
	return func(opts *options) {
	opts.workerNum = n
	}
	}
	func WithCommandQueueBufferSize(s int) Option {
	return func(opts *options) {
	opts.commandQueueBufferSize = s
	}
	}
	func WithCommandCheckInterval(i time.Duration) Option {
	return func(opts *options) {
	opts.commandCheckInterval = i
	}
	}
	func WithCommandHandleTimeout(t time.Duration) Option {
	return func(opts *options) {
	opts.commandHandleTimeout = t
	}
	}

and pass parameter directly in NewHandler?
something like:

func NewHandler(
	gc gitClient,
	ac apiClient,
	cl commandLister,
	al applicationLister,
	cg lastTriggeredCommitGetter,
	sd secretDecrypter,
	appManifestsCache cache.Cache,
	cfg *config.PipedSpec,
	workerNum int,
	commandQueueBufferSize int,
	commandCheckInterval time.Duration,
	commandHandleTimeout time.Duration,
	opts ...Option,
) *Handler {
	if workerNum < 1 {
		workerNum = defaultWorkerNum
	}
	if commandQueueBufferSize < 1 {
		commandQueueBufferSize = defaultCommandQueueBufferSize
	}
	if commandCheckInterval <= 0 {
		commandCheckInterval = defaultCommandCheckInterval
	}
	if commandHandleTimeout <= 0 {
		commandHandleTimeout = defaultCommandHandleTimeout
	}

	opt := &options{
		workerNum:              workerNum,
		commandQueueBufferSize: commandQueueBufferSize,
		commandCheckInterval:   commandCheckInterval,
		commandHandleTimeout:   commandHandleTimeout,
		logger:                 zap.NewNop(),
	}
	for _, o := range opts {
		o(opt)
	}
...

[Warashi]

@kadai0308
No, I meant adding a way to configure these values via piped's config.

I think that we have to add types/fields to the below struct and pass the values to NewHandler with optional functions.

pipecd/pkg/config/piped.go

Lines 38 to 83 in 275a1e1

	// PipedSpec contains configurable data used to while running Piped.
	type PipedSpec struct {
	// The identifier of the PipeCD project where this piped belongs to.
	ProjectID string `json:"projectID"`
	// The unique identifier generated for this piped.
	PipedID string `json:"pipedID"`
	// The path to the file containing the generated Key string for this piped.
	PipedKeyFile string `json:"pipedKeyFile,omitempty"`
	// Base64 encoded string of Piped key.
	PipedKeyData string `json:"pipedKeyData,omitempty"`
	// The name of this piped.
	Name string `json:"name,omitempty"`
	// The address used to connect to the control-plane's API.
	APIAddress string `json:"apiAddress"`
	// The address to the control-plane's Web.
	WebAddress string `json:"webAddress,omitempty"`
	// How often to check whether an application should be synced.
	// Default is 1m.
	SyncInterval Duration `json:"syncInterval,omitempty" default:"1m"`
	// How often to check whether an application configuration file should be synced.
	// Default is 1m.
	AppConfigSyncInterval Duration `json:"appConfigSyncInterval,omitempty" default:"1m"`
	// Git configuration needed for git commands.
	Git PipedGit `json:"git,omitempty"`
	// List of git repositories this piped will handle.
	Repositories []PipedRepository `json:"repositories,omitempty"`
	// List of helm chart repositories that should be added while starting up.
	ChartRepositories []HelmChartRepository `json:"chartRepositories,omitempty"`
	// List of helm chart registries that should be logged in while starting up.
	ChartRegistries []HelmChartRegistry `json:"chartRegistries,omitempty"`
	// List of cloud providers can be used by this piped.
	// Deprecated: use PlatformProvider instead.
	CloudProviders []PipedPlatformProvider `json:"cloudProviders,omitempty"`
	// List of platform providers can be used by this piped.
	PlatformProviders []PipedPlatformProvider `json:"platformProviders,omitempty"`
	// List of analysis providers can be used by this piped.
	AnalysisProviders []PipedAnalysisProvider `json:"analysisProviders,omitempty"`
	// Sending notification to Slack, Webhook…
	Notifications Notifications `json:"notifications"`
	// What secret management method should be used.
	SecretManagement *SecretManagement `json:"secretManagement,omitempty"`
	// Optional settings for event watcher.
	EventWatcher PipedEventWatcher `json:"eventWatcher"`
	// List of labels to filter all applications this piped will handle.
	AppSelector map[string]string `json:"appSelector,omitempty"`
	}

[anshikavashistha]

Hi @Warashi ,I’m interested in working on this issue (configurable plan-preview handling). I noticed it was previously assigned and PR #5947 was mentioned — is this still actively being worked on?
If it’s available, I’d love to help implement the configuration support via PipedSpec. Happy to align on the expected approach before starting

[rawadhossain]

Hi @Warashi & @t-kikuc,
I’ve opened a PR addressing this issue.
I added a configurable planPreview section in piped config and wired it to the existing handler options with validation and tests.

Would appreciate your review when you have time. Thanks.