platform/dbops/binaries/weaviate-src/usecases/schema/executor.go

//                           _       _
// __      _____  __ ___   ___  __ _| |_ ___
// \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
//  \ V  V /  __/ (_| |\ V /| | (_| | ||  __/
//   \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
//
//  Copyright © 2016 - 2025 Weaviate B.V. All rights reserved.
//
//  CONTACT: hello@weaviate.io
//

package schema

import (
	"context"
	"errors"
	"fmt"
	"runtime"
	"sync"

	"github.com/sirupsen/logrus"
	schemaConfig "github.com/weaviate/weaviate/entities/schema/config"
	"golang.org/x/exp/slices"

	"github.com/weaviate/weaviate/cluster/proto/api"
	enterrors "github.com/weaviate/weaviate/entities/errors"
	"github.com/weaviate/weaviate/entities/models"
	"github.com/weaviate/weaviate/entities/schema"
)

var _NUMCPU = runtime.GOMAXPROCS(0)

type executor struct {
	schemaReader SchemaReader
	migrator     Migrator

	callbacksLock sync.RWMutex
	callbacks     []func(updatedSchema schema.SchemaWithAliases)

	logger          logrus.FieldLogger
	restoreClassDir func(string) error
}

// NewManager creates a new manager
func NewExecutor(migrator Migrator, sr SchemaReader,
	logger logrus.FieldLogger, classBackupDir func(string) error,
) *executor {
	return &executor{
		migrator:        migrator,
		logger:          logger,
		schemaReader:    sr,
		restoreClassDir: classBackupDir,
	}
}

func (e *executor) Open(ctx context.Context) error {
	return e.migrator.WaitForStartup(ctx)
}

// ReloadLocalDB reloads the local database using the latest schema.
func (e *executor) ReloadLocalDB(ctx context.Context, all []api.UpdateClassRequest) error {
	cs := make([]*models.Class, len(all))

	g, ctx := enterrors.NewErrorGroupWithContextWrapper(e.logger, ctx)
	g.SetLimit(_NUMCPU * 2)

	var errList error
	var errMutex sync.Mutex

	for i, u := range all {
		i, u := i, u

		g.Go(func() error {
			e.logger.WithField("index", u.Class.Class).Info("reload local index")
			cs[i] = u.Class

			if err := e.migrator.UpdateIndex(ctx, u.Class, u.State); err != nil {
				e.logger.WithField("index", u.Class.Class).WithError(err).Error("failed to reload local index")
				err := fmt.Errorf("failed to reload local index %q: %w", i, err)

				errMutex.Lock()
				errList = errors.Join(errList, err)
				errMutex.Unlock()
			}
			return nil
		})
	}

	if err := g.Wait(); err != nil {
		return err
	}
	return errList
}

func (e *executor) Close(ctx context.Context) error {
	return e.migrator.Shutdown(ctx)
}

func (e *executor) AddClass(pl api.AddClassRequest) error {
	ctx := context.Background()
	if err := e.migrator.AddClass(ctx, pl.Class); err != nil {
		return fmt.Errorf("apply add class: %w", err)
	}
	return nil
}

func (e *executor) AddReplicaToShard(class string, shard string, targetNode string) error {
	ctx := context.Background()
	if replicas, err := e.schemaReader.ShardReplicas(class, shard); err != nil {
		return fmt.Errorf("error reading replicas for collection %s shard %s: %w", class, shard, err)
	} else if !slices.Contains(replicas, targetNode) {
		return fmt.Errorf("replica %s does not exists for collection %s shard %s", targetNode, class, shard)
	}
	return e.migrator.LoadShard(ctx, class, shard)
}

func (e *executor) DeleteReplicaFromShard(class string, shard string, targetNode string) error {
	ctx := context.Background()
	if replicas, err := e.schemaReader.ShardReplicas(class, shard); err != nil {
		return fmt.Errorf("error reading replicas for collection %s shard %s: %w", class, shard, err)
	} else if slices.Contains(replicas, targetNode) {
		return fmt.Errorf("replica %s exists for collection %s shard %s", targetNode, class, shard)
	}
	return e.migrator.DropShard(ctx, class, shard)
}

func (e *executor) LoadShard(class string, shard string) {
	ctx := context.Background()
	if err := e.migrator.LoadShard(ctx, class, shard); err != nil {
		e.logger.WithFields(logrus.Fields{
			"action": "load_shard",
			"class":  class,
			"shard":  shard,
		}).WithError(err).Warn("migrator")
	}
}

func (e *executor) ShutdownShard(class string, shard string) {
	ctx := context.Background()
	if err := e.migrator.ShutdownShard(ctx, class, shard); err != nil {
		e.logger.WithFields(logrus.Fields{
			"action": "shutdown_shard",
			"class":  class,
			"shard":  shard,
		}).WithError(err).Warn("migrator")
	}
}

func (e *executor) DropShard(class string, shard string) {
	ctx := context.Background()
	if err := e.migrator.DropShard(ctx, class, shard); err != nil {
		e.logger.WithFields(logrus.Fields{
			"action": "drop_shard",
			"class":  class,
			"shard":  shard,
		}).WithError(err).Warn("migrator")
	}
}

// RestoreClassDir restores classes on the filesystem directly from the temporary class backup stored on disk.
// This function is invoked by the Raft store when a restoration request is sent by the backup coordinator.
func (e *executor) RestoreClassDir(class string) error {
	return e.restoreClassDir(class)
}

func (e *executor) UpdateClass(req api.UpdateClassRequest) error {
	className := req.Class.Class
	ctx := context.Background()

	if cfg, ok := req.Class.VectorIndexConfig.(schemaConfig.VectorIndexConfig); ok {
		if err := e.migrator.UpdateVectorIndexConfig(ctx, className, cfg); err != nil {
			return fmt.Errorf("vector index config update: %w", err)
		}
	}

	if cfgs := asVectorIndexConfigs(req.Class); cfgs != nil {
		if err := e.migrator.UpdateVectorIndexConfigs(ctx, className, cfgs); err != nil {
			return fmt.Errorf("vector index configs update: %w", err)
		}
	}

	if err := e.migrator.UpdateInvertedIndexConfig(ctx, className,
		req.Class.InvertedIndexConfig); err != nil {
		return fmt.Errorf("inverted index config: %w", err)
	}

	if err := e.migrator.UpdateReplicationConfig(ctx, className, req.Class.ReplicationConfig); err != nil {
		return fmt.Errorf("update replication config: %w", err)
	}

	return nil
}

func (e *executor) UpdateIndex(req api.UpdateClassRequest) error {
	ctx := context.Background()
	if err := e.migrator.UpdateIndex(ctx, req.Class, req.State); err != nil {
		return err
	}
	return nil
}

func (e *executor) DeleteClass(cls string, hasFrozen bool) error {
	ctx := context.Background()
	if err := e.migrator.DropClass(ctx, cls, hasFrozen); err != nil {
		e.logger.WithFields(logrus.Fields{
			"action": "delete_class",
			"class":  cls,
		}).WithError(err).Errorf("migrator")
	}

	e.logger.WithFields(logrus.Fields{
		"action": "delete_class",
		"class":  cls,
	}).Debug("deleting class")

	return nil
}

func (e *executor) AddProperty(className string, req api.AddPropertyRequest) error {
	ctx := context.Background()
	if err := e.migrator.AddProperty(ctx, className, req.Properties...); err != nil {
		return err
	}

	e.logger.WithFields(logrus.Fields{
		"action": "add_property",
		"class":  className,
	}).Debug("adding property")
	return nil
}

func (e *executor) AddTenants(class string, req *api.AddTenantsRequest) error {
	if len(req.Tenants) == 0 {
		return nil
	}
	updates := make([]*CreateTenantPayload, len(req.Tenants))
	for i, p := range req.Tenants {
		updates[i] = &CreateTenantPayload{
			Name:   p.Name,
			Status: p.Status,
		}
	}
	cls := e.schemaReader.ReadOnlyClass(class)
	if cls == nil {
		return fmt.Errorf("class %q: %w", class, ErrNotFound)
	}
	ctx := context.Background()
	if err := e.migrator.NewTenants(ctx, cls, updates); err != nil {
		return fmt.Errorf("migrator.new_tenants: %w", err)
	}
	return nil
}

func (e *executor) UpdateTenants(class string, req *api.UpdateTenantsRequest) error {
	ctx := context.Background()
	cls := e.schemaReader.ReadOnlyClass(class)
	if cls == nil {
		return fmt.Errorf("class %q: %w", class, ErrNotFound)
	}

	updates := make([]*UpdateTenantPayload, 0, len(req.Tenants))
	for _, tu := range req.Tenants {
		updates = append(updates, &UpdateTenantPayload{
			Name:   tu.Name,
			Status: tu.Status,
		})
	}

	if err := e.migrator.UpdateTenants(ctx, cls, updates, req.ImplicitUpdateRequest); err != nil {
		e.logger.WithFields(logrus.Fields{
			"action": "update_tenants",
			"class":  class,
		}).WithError(err).Error("error updating tenants")
		return err
	}
	return nil
}

func (e *executor) UpdateTenantsProcess(class string, req *api.TenantProcessRequest) error {
	ctx := context.Background()
	cls := e.schemaReader.ReadOnlyClass(class)
	if cls == nil {
		return fmt.Errorf("class %q: %w", class, ErrNotFound)
	}
	// no error here because that means the process shouldn't be applied to db
	if req.TenantsProcesses == nil {
		return nil
	}

	updates := []*UpdateTenantPayload{}
	for idx := range req.TenantsProcesses {
		if req.TenantsProcesses[idx] == nil || req.TenantsProcesses[idx].Tenant == nil {
			continue
		}
		updates = append(updates, &UpdateTenantPayload{
			Name:   req.TenantsProcesses[idx].Tenant.Name,
			Status: req.TenantsProcesses[idx].Tenant.Status,
		})
	}

	if err := e.migrator.UpdateTenants(ctx, cls, updates, false); err != nil {
		e.logger.WithFields(logrus.Fields{
			"action":     "update_tenants_process",
			"sub-action": "update_tenants",
			"class":      class,
		}).WithError(err).Error("error updating tenants")
		return err
	}
	return nil
}

func (e *executor) DeleteTenants(class string, tenants []*models.Tenant) error {
	ctx := context.Background()
	if err := e.migrator.DeleteTenants(ctx, class, tenants); err != nil {
		e.logger.WithFields(logrus.Fields{
			"action": "delete_tenants",
			"class":  class,
		}).WithError(err).Error("error deleting tenants")
	}

	return nil
}

func (e *executor) UpdateShardStatus(req *api.UpdateShardStatusRequest) error {
	ctx := context.Background()
	return e.migrator.UpdateShardStatus(ctx, req.Class, req.Shard, req.Status, req.SchemaVersion)
}

func (e *executor) GetShardsStatus(class, tenant string) (models.ShardStatusList, error) {
	ctx := context.Background()
	shardsStatus, err := e.migrator.GetShardsStatus(ctx, class, tenant)
	if err != nil {
		return nil, err
	}

	resp := models.ShardStatusList{}

	for name, status := range shardsStatus {
		resp = append(resp, &models.ShardStatusGetResponse{
			Name:   name,
			Status: status,
		})
	}

	return resp, nil
}

func (e *executor) TriggerSchemaUpdateCallbacks() {
	e.callbacksLock.RLock()
	defer e.callbacksLock.RUnlock()

	s := e.schemaReader.ReadOnlySchema()
	body := schema.SchemaWithAliases{
		Schema:  schema.Schema{Objects: &s},
		Aliases: e.schemaReader.Aliases(),
	}
	for _, cb := range e.callbacks {
		cb(body)
	}
}

// RegisterSchemaUpdateCallback allows other usecases to register a primitive
// type update callback. The callbacks will be called any time we persist a
// schema update
func (e *executor) RegisterSchemaUpdateCallback(callback func(updatedSchema schema.SchemaWithAliases)) {
	e.callbacksLock.Lock()
	defer e.callbacksLock.Unlock()

	e.callbacks = append(e.callbacks, callback)
}