typesense / typesense/typesense-go

WithClientConfig overrides default ClientConfig values with zero values.

Open
#220 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
319
Forks
73
PR merge metrics
No merged PRs in 30d

Description

While using the Go Typesense client (v3.2.0), I noticed a potential configuration issue related to the functional options pattern and default configuration handling.

In NewClient, a default ClientConfig is initialized with sensible default values:

c := &Client{apiConfig: &ClientConfig{
    RetryInterval:             defaultRetryInterval,
    HealthcheckInterval:       defaultHealthcheckInterval,
    ConnectionTimeout:         defaultConnectionTimeout,
    CircuitBreakerName:        defaultCircuitBreakerName,
    CircuitBreakerMaxRequests: circuit.DefaultGoBreakerMaxRequests,
    CircuitBreakerInterval:    circuit.DefaultGoBreakerInterval,
    CircuitBreakerTimeout:     circuit.DefaultGoBreakerTimeout,
    CircuitBreakerReadyToTrip: circuit.DefaultReadyToTrip,
}}

However, when using the WithClientConfig option:

client := typesense.NewClient(
    typesense.WithClientConfig(&typesense.ClientConfig{
        ServerURL: cfg.ServerURL,
        APIKey:    cfg.APIKey,
    }),
)

The implementation of WithClientConfig assigns all fields from the provided config directly:

func WithClientConfig(config *ClientConfig) ClientOption {
    return func(c *Client) {
        c.apiConfig.ServerURL = config.ServerURL
        c.apiConfig.NearestNode = config.NearestNode
        c.apiConfig.Nodes = config.Nodes
        c.apiConfig.NumRetries = config.NumRetries
        c.apiConfig.RetryInterval = config.RetryInterval
        c.apiConfig.HealthcheckInterval = config.HealthcheckInterval
        c.apiConfig.APIKey = config.APIKey
        c.apiConfig.ConnectionTimeout = config.ConnectionTimeout
        c.apiConfig.CircuitBreakerName = config.CircuitBreakerName
        c.apiConfig.CircuitBreakerMaxRequests = config.CircuitBreakerMaxRequests
        c.apiConfig.CircuitBreakerInterval = config.CircuitBreakerInterval
        c.apiConfig.CircuitBreakerTimeout = config.CircuitBreakerTimeout
        c.apiConfig.CircuitBreakerReadyToTrip = config.CircuitBreakerReadyToTrip
        c.apiConfig.CircuitBreakerOnStateChange = config.CircuitBreakerOnStateChange
    }
}

If only a subset of fields is provided (e.g., only ServerURL and APIKey), the remaining fields are Go zero values and overwrite the defaults set in NewClient.

// implement option pattern
	for _, opt := range opts {
		opt(c)
	}
Question / Clarification

1. Is it the intended behavior that WithClientConfig fully overrides all defaults?
2. Specifically, should NumRetries (and other retry-related fields) have a non-zero default if not explicitly provided?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with NewClient and WithClientConfig, focusing on how the option copies ClientConfig fields into the defaults. Determine and document the intended behavior for omitted fields, especially retry and circuit-breaker settings, then add coverage showing the selected behavior for a partial configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.