global/reference_config.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 global

import (
	"maps"
	"strconv"
)

// ReferenceConfig is the configuration of service consumer
type ReferenceConfig struct {
	InterfaceName    string            `yaml:"interface"  json:"interface,omitempty" property:"interface"`
	Check            *bool             `yaml:"check"  json:"check,omitempty" property:"check"`
	URL              string            `yaml:"url"  json:"url,omitempty" property:"url"`
	Filter           string            `yaml:"filter" json:"filter,omitempty" property:"filter"`
	Protocol         string            `yaml:"protocol"  json:"protocol,omitempty" property:"protocol"`
	RegistryIDs      []string          `yaml:"registry-ids"  json:"registry-ids,omitempty"  property:"registry-ids"`
	Cluster          string            `yaml:"cluster"  json:"cluster,omitempty" property:"cluster"`
	Loadbalance      string            `yaml:"loadbalance"  json:"loadbalance,omitempty" property:"loadbalance"`
	Retries          string            `yaml:"retries"  json:"retries,omitempty" property:"retries"`
	Group            string            `yaml:"group"  json:"group,omitempty" property:"group"`
	Version          string            `yaml:"version"  json:"version,omitempty" property:"version"`
	Serialization    string            `yaml:"serialization" json:"serialization" property:"serialization"`
	ProvidedBy       string            `yaml:"provided_by"  json:"provided_by,omitempty" property:"provided_by"`
	Async            bool              `yaml:"async"  json:"async,omitempty" property:"async"`
	Params           map[string]string `yaml:"params"  json:"params,omitempty" property:"params"`
	Generic          string            `yaml:"generic"  json:"generic,omitempty" property:"generic"`
	Sticky           bool              `yaml:"sticky"   json:"sticky,omitempty" property:"sticky"`
	RequestTimeout   string            `yaml:"timeout"  json:"timeout,omitempty" property:"timeout"`
	ForceTag         bool              `yaml:"force.tag"  json:"force.tag,omitempty" property:"force.tag"`
	TracingKey       string            `yaml:"tracing-key" json:"tracing-key,omitempty" property:"tracing-key"`
	MeshProviderPort int               `yaml:"mesh-provider-port" json:"mesh-provider-port,omitempty" property:"mesh-provider-port"`

	// config
	MethodsConfig []*MethodConfig `yaml:"methods"  json:"methods,omitempty" property:"methods"`
	// TODO: rename protocol_config to protocol when publish 4.0.0.
	ProtocolClientConfig *ClientProtocolConfig `yaml:"protocol_config" json:"protocol_config,omitempty" property:"protocol_config"`

	// TODO: remove KeepAliveInterval and KeepAliveTimeout in version 4.0.0.
	//
	// Deprecated: use ClientProtocolConfig.TripleConfig.KeepAliveInterval or the
	// "protocol_config/triple/keep-alive-interval" configuration key instead.
	KeepAliveInterval string `yaml:"keep-alive-interval" json:"keep-alive-interval,omitempty" property:"keep-alive-interval"`
	// Deprecated: use ClientProtocolConfig.TripleConfig.KeepAliveTimeout or the
	// "protocol_config/triple/keep-alive-timeout" configuration key instead.
	KeepAliveTimeout string `yaml:"keep-alive-timeout" json:"keep-alive-timeout,omitempty" property:"keep-alive-timeout"`

	// just for new triple non-IDL mode
	// TODO: remove IDLMode when config package is removed
	//
	// Deprecated: this field will be removed in the next version. The IDL mode
	// switch is no longer supported by dubbo-go.
	IDLMode string
}

func DefaultReferenceConfig() *ReferenceConfig {
	return &ReferenceConfig{
		// use Triple protocol by default
		//Protocol: "tri",
		MethodsConfig:        make([]*MethodConfig, 0, 8),
		ProtocolClientConfig: DefaultClientProtocolConfig(),
		//Params:   make(map[string]string, 8),
	}
}

// TODO: check if ProtocolClientConfig need get options
func (c *ReferenceConfig) GetOptions() []ReferenceOption {
	var refOpts []ReferenceOption
	if c.InterfaceName != "" {
		refOpts = append(refOpts, WithReference_InterfaceName(c.InterfaceName))
	}
	if c.Check != nil {
		refOpts = append(refOpts, WithReference_Check(*c.Check))
	}
	if c.URL != "" {
		refOpts = append(refOpts, WithReference_URL(c.URL))
	}
	if c.Filter != "" {
		refOpts = append(refOpts, WithReference_Filter(c.Filter))
	}
	if c.Protocol != "" {
		refOpts = append(refOpts, WithReference_Protocol(c.Protocol))
	}
	if len(c.RegistryIDs) > 0 {
		refOpts = append(refOpts, WithReference_RegistryIDs(c.RegistryIDs))
	}
	if c.Cluster != "" {
		refOpts = append(refOpts, WithReference_Cluster(c.Cluster))
	}
	if c.Loadbalance != "" {
		refOpts = append(refOpts, WithReference_LoadBalance(c.Loadbalance))
	}
	if c.Retries != "" {
		if rInt, err := strconv.Atoi(c.Retries); err == nil {
			refOpts = append(refOpts, WithReference_Retries(rInt))
		}
	}
	if c.Group != "" {
		refOpts = append(refOpts, WithReference_Group(c.Group))
	}
	if c.Version != "" {
		refOpts = append(refOpts, WithReference_Version(c.Version))
	}
	if c.Serialization != "" {
		refOpts = append(refOpts, WithReference_Serialization(c.Serialization))
	}
	if c.ProvidedBy != "" {
		refOpts = append(refOpts, WithReference_ProviderBy(c.ProvidedBy))
	}
	if len(c.Params) > 0 {
		newParams := make(map[string]string, len(c.Params))
		maps.Copy(newParams, c.Params)
		refOpts = append(refOpts, WithReference_Params(newParams))
	}
	if c.Generic != "" {
		refOpts = append(refOpts, WithReference_Generic(c.Generic))
	}
	if c.Sticky {
		refOpts = append(refOpts, WithReference_Sticky(c.Sticky))
	}
	if c.RequestTimeout != "" {
		refOpts = append(refOpts, WithReference_RequestTimeout(c.RequestTimeout))
	}
	if c.TracingKey != "" {
		refOpts = append(refOpts, WithReference_TracingKey(c.TracingKey))
	}
	if c.MeshProviderPort != 0 {
		refOpts = append(refOpts, WithReference_MeshProviderPort(c.MeshProviderPort))
	}
	if c.KeepAliveInterval != "" {
		refOpts = append(refOpts, WithReference_KeepAliveInterval(c.KeepAliveInterval))
	}
	if c.KeepAliveTimeout != "" {
		refOpts = append(refOpts, WithReference_KeepAliveTimeout(c.KeepAliveTimeout))
	}
	if c.ProtocolClientConfig != nil {
		refOpts = append(refOpts, WithReference_ProtocolClientConfig(c.ProtocolClientConfig))
	}
	return refOpts
}

// Clone a new ReferenceConfig
func (c *ReferenceConfig) Clone() *ReferenceConfig {
	if c == nil {
		return nil
	}

	var newCheck *bool
	if c.Check != nil {
		check := *c.Check
		newCheck = &check
	}

	newRegistryIDs := make([]string, len(c.RegistryIDs))
	copy(newRegistryIDs, c.RegistryIDs)

	var newMethods []*MethodConfig
	if c.MethodsConfig != nil {
		newMethods = make([]*MethodConfig, 0, len(c.MethodsConfig))
		for _, method := range c.MethodsConfig {
			newMethods = append(newMethods, method.Clone())
		}
	}

	newParams := make(map[string]string, len(c.Params))
	maps.Copy(newParams, c.Params)

	return &ReferenceConfig{
		InterfaceName:        c.InterfaceName,
		Check:                newCheck,
		URL:                  c.URL,
		Filter:               c.Filter,
		Protocol:             c.Protocol,
		RegistryIDs:          newRegistryIDs,
		Cluster:              c.Cluster,
		Loadbalance:          c.Loadbalance,
		Retries:              c.Retries,
		Group:                c.Group,
		Version:              c.Version,
		Serialization:        c.Serialization,
		ProvidedBy:           c.ProvidedBy,
		MethodsConfig:        newMethods,
		ProtocolClientConfig: c.ProtocolClientConfig.Clone(),
		Async:                c.Async,
		Params:               newParams,
		Generic:              c.Generic,
		Sticky:               c.Sticky,
		RequestTimeout:       c.RequestTimeout,
		ForceTag:             c.ForceTag,
		TracingKey:           c.TracingKey,
		MeshProviderPort:     c.MeshProviderPort,
		KeepAliveInterval:    c.KeepAliveInterval,
		KeepAliveTimeout:     c.KeepAliveTimeout,
		IDLMode:              c.IDLMode,
	}
}

type ReferenceOption func(*ReferenceConfig)

func WithReference_InterfaceName(name string) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.InterfaceName = name
	}
}

func WithReference_Check(check bool) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.Check = &check
	}
}

func WithReference_URL(url string) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.URL = url
	}
}

func WithReference_Filter(filter string) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.Filter = filter
	}
}

func WithReference_Protocol(protocol string) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.Protocol = protocol
	}
}

func WithReference_RegistryIDs(registryIDs []string) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		if len(registryIDs) >= 0 {
			cfg.RegistryIDs = registryIDs
		}
	}
}

func WithReference_Cluster(cluster string) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.Cluster = cluster
	}
}

func WithReference_LoadBalance(loadBalance string) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.Loadbalance = loadBalance
	}
}

func WithReference_Retries(retries int) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.Retries = strconv.Itoa(retries)
	}
}

func WithReference_Group(group string) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.Group = group
	}
}

func WithReference_Version(version string) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.Version = version
	}
}

func WithReference_Serialization(serialization string) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.Serialization = serialization
	}
}

func WithReference_ProviderBy(providedBy string) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.ProvidedBy = providedBy
	}
}

func WithReference_Async(async bool) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.Async = async
	}
}

func WithReference_Params(params map[string]string) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.Params = params
	}
}

func WithReference_Generic(generic string) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.Generic = generic
	}
}

func WithReference_Sticky(sticky bool) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.Sticky = sticky
	}
}

func WithReference_RequestTimeout(timeout string) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.RequestTimeout = timeout
	}
}

func WithReference_Force(force bool) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.ForceTag = force
	}
}

func WithReference_TracingKey(tracingKey string) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.TracingKey = tracingKey
	}
}

func WithReference_MeshProviderPort(port int) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.MeshProviderPort = port
	}
}

// WithReference_KeepAliveInterval configures the legacy keepalive interval.
//
// Deprecated: configure ClientProtocolConfig.TripleConfig.KeepAliveInterval instead.
func WithReference_KeepAliveInterval(interval string) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.KeepAliveInterval = interval
	}
}

// WithReference_KeepAliveTimeout configures the legacy keepalive timeout.
//
// Deprecated: configure ClientProtocolConfig.TripleConfig.KeepAliveTimeout instead.
func WithReference_KeepAliveTimeout(timeout string) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.KeepAliveTimeout = timeout
	}
}

func WithReference_ProtocolClientConfig(protocolClientConfig *ClientProtocolConfig) ReferenceOption {
	return func(cfg *ReferenceConfig) {
		cfg.ProtocolClientConfig = protocolClientConfig.Clone()
	}
}