// Copyright 2024 PingCAP, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.

package server

import (
	"context"

	"github.com/pingcap/ticdc/pkg/common"
	"github.com/pingcap/ticdc/pkg/config"
)

// Coordinator is the master of the ticdc cluster,
// 1. schedules changefeed maintainer to ticdc node
// 2. save changefeed checkpoint ts to meta store backend
// 3. send checkpoint to downstream
// 4. manager gc safe point
// 5. response for open API call
type Coordinator interface {
	Stop()
	// Run handles messages
	Run(ctx context.Context) error
	// ListChangefeeds returns all changefeeds of keyspace
	ListChangefeeds(ctx context.Context, keyspace string) ([]*config.ChangeFeedInfo, []*config.ChangeFeedStatus, error)
	// GetChangefeed returns a changefeed
	GetChangefeed(ctx context.Context, changefeedDisplayName common.ChangeFeedDisplayName) (*config.ChangeFeedInfo, *config.ChangeFeedStatus, error)
	// CreateChangefeed creates a new changefeed
	CreateChangefeed(ctx context.Context, info *config.ChangeFeedInfo) error
	// RemoveChangefeed gets a changefeed
	RemoveChangefeed(ctx context.Context, id common.ChangeFeedID) (uint64, error)
	// PauseChangefeed pauses a changefeed
	PauseChangefeed(ctx context.Context, id common.ChangeFeedID) error
	// ResumeChangefeed resumes a changefeed
	ResumeChangefeed(ctx context.Context, id common.ChangeFeedID, newCheckpointTs uint64, overwriteCheckpointTs bool) error
	// UpdateChangefeed updates a changefeed
	UpdateChangefeed(ctx context.Context, change *config.ChangeFeedInfo) error
	// RequestResolvedTsFromLogCoordinator requests the log coordinator to report the resolved ts of the changefeed,
	// and coordinator will update the changefeed status after receiving the resolved ts from log coordinator.
	RequestResolvedTsFromLogCoordinator(ctx context.Context, changefeedDisplayName common.ChangeFeedDisplayName)

	Initialized() bool
}