pkg/core/engine/component.go

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package engine

import (
	"fmt"
	"math"
	"reflect"

	"k8s.io/client-go/tools/cache"

	"github.com/apache/dubbo-admin/pkg/common/bizerror"
	enginecfg "github.com/apache/dubbo-admin/pkg/config/engine"
	"github.com/apache/dubbo-admin/pkg/core/controller"
	"github.com/apache/dubbo-admin/pkg/core/engine/subscriber"
	"github.com/apache/dubbo-admin/pkg/core/events"
	"github.com/apache/dubbo-admin/pkg/core/logger"
	meshresource "github.com/apache/dubbo-admin/pkg/core/resource/apis/mesh/v1alpha1"
	"github.com/apache/dubbo-admin/pkg/core/runtime"
	"github.com/apache/dubbo-admin/pkg/core/store"
)

func init() {
	runtime.RegisterComponent(newEngineComponent())
}

type Component interface {
	runtime.Component
	ResourceEngine
}

var _ Component = &engineComponent{}

type engineComponent struct {
	name                string
	storeRouter         store.Router
	informers           []controller.Informer
	subscriptionManager events.SubscriptionManager
	subscribers         []events.Subscriber
}

func newEngineComponent() Component {
	return &engineComponent{
		informers:   make([]controller.Informer, 0),
		subscribers: make([]events.Subscriber, 0),
	}
}

func (e *engineComponent) RequiredDependencies() []runtime.ComponentType {
	return []runtime.ComponentType{
		runtime.EventBus,
		runtime.ResourceStore,
	}
}

func (e *engineComponent) Type() runtime.ComponentType {
	return runtime.ResourceEngine
}

func (e *engineComponent) Order() int {
	return math.MaxInt - 3
}

func (e *engineComponent) Init(ctx runtime.BuilderContext) error {
	cfg := ctx.Config().Engine
	e.name = cfg.ID
	eventBusComponent, err := ctx.GetActivatedComponent(runtime.EventBus)
	if err != nil {
		return fmt.Errorf("can not retrieve event bus from runtime in engine %s, %w", e.name, err)
	}
	eventBus, ok := eventBusComponent.(events.EventBus)
	if !ok {
		return bizerror.NewAssertionError("EventBus", reflect.TypeOf(eventBusComponent).Name())
	}
	e.subscriptionManager = eventBus
	storeComponent, err := ctx.GetActivatedComponent(runtime.ResourceStore)
	if err != nil {
		return fmt.Errorf("can not retrieve store from runtime in engine %s, %w", e.name, err)
	}
	storeRouter, ok := storeComponent.(store.Router)
	if !ok {
		return bizerror.NewAssertionError("store.Router", reflect.TypeOf(storeComponent).Name())
	}
	e.storeRouter = storeRouter
	if err = e.initInformers(cfg, eventBus); err != nil {
		return fmt.Errorf("init informer failed, %w", err)
	}
	if err = e.initSubscribers(eventBus); err != nil {
		return fmt.Errorf("init subscribers failed, %w", err)
	}
	logger.Infof("resource engine %s has been inited successfully", e.name)
	return nil
}

func (e *engineComponent) initInformers(cfg *enginecfg.Config, emitter events.Emitter) error {
	factory, err := FactoryRegistry().GetListWatcherFactory(cfg.Type)
	if err != nil {
		return err
	}
	lwList, err := factory.NewListWatchers(cfg)
	if err != nil {
		return err
	}
	for _, lw := range lwList {
		rk := lw.ResourceKind()
		rs, err := e.storeRouter.ResourceKindRoute(rk)
		if err != nil {
			return fmt.Errorf("can not find store for resource kind %s, %w", rk, err)
		}
		informer := controller.NewInformerWithOptions(lw, emitter, rs, cache.MetaNamespaceKeyFunc, controller.Options{ResyncPeriod: 0})
		if lw.TransformFunc() != nil {
			err = informer.SetTransform(lw.TransformFunc())
			if err != nil {
				return fmt.Errorf("can not set transform for informer of resource kind %s, %w", rk, err)
			}
		}
		e.informers = append(e.informers, informer)
		logger.Infof("resource engine %s has added informer for resource kind %s", e.name, rk)
	}
	return nil
}

func (e *engineComponent) initSubscribers(eventbus events.EventBus) error {
	rs, err := e.storeRouter.ResourceKindRoute(meshresource.InstanceKind)
	if err != nil {
		return fmt.Errorf("can not find store for resource kind %s, %w", meshresource.InstanceKind, err)
	}
	runtimeInstanceSub := subscriber.NewRuntimeInstanceEventSubscriber(rs, eventbus)
	e.subscribers = append(e.subscribers, runtimeInstanceSub)
	return nil
}

func (e *engineComponent) Start(_ runtime.Runtime, ch <-chan struct{}) error {
	// 1. subscribe resource changed events
	for _, sub := range e.subscribers {
		if err := e.subscriptionManager.Subscribe(sub); err != nil {
			return fmt.Errorf("could not subscribe %s to eventbus, %w", sub.Name(), err)
		}
	}
	// 2. start informers
	for _, informer := range e.informers {
		go informer.Run(ch)
	}
	logger.Infof("resource engine %s has started successfully", e.name)
	return nil
}