mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-05 20:54:56 -05:00
1c9ad5ea24
This commit refactors the source configuration and loading mechanism to use a dynamic registration pattern. Each source package now registers itself with a central registry via its init() function. The server configuration code uses this registry to decode and initialize sources, decoupling it from specific source implementations and simplifying the addition of new sources. Key changes: - Introduced `sources.Register()` and `newConfig()` constructor in each source package. - Moved source package imports to `cmd/root.go` as blank imports to trigger `init()` functions for self-registration. - Removed direct imports of specific source packages from `internal/server/config.go`. - Renamed `SourceKind` constants to `Kind` within each source package. - Updated tests to use the new `Kind` constants and reflect registration changes. --------- Co-authored-by: Yuan Teoh <yuanteoh@google.com>
124 lines
3.5 KiB
Go
124 lines
3.5 KiB
Go
// Copyright 2024 Google LLC
|
|
//
|
|
// 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,
|
|
// 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 spanner
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
"cloud.google.com/go/spanner"
|
|
"github.com/goccy/go-yaml"
|
|
"github.com/googleapis/genai-toolbox/internal/sources"
|
|
"github.com/googleapis/genai-toolbox/internal/util"
|
|
"go.opentelemetry.io/otel/trace"
|
|
)
|
|
|
|
const SourceKind string = "spanner"
|
|
|
|
// validate interface
|
|
var _ sources.SourceConfig = Config{}
|
|
|
|
func init() {
|
|
if !sources.Register(SourceKind, newConfig) {
|
|
panic(fmt.Sprintf("source kind %q already registered", SourceKind))
|
|
}
|
|
}
|
|
|
|
func newConfig(ctx context.Context, name string, decoder *yaml.Decoder) (sources.SourceConfig, error) {
|
|
actual := Config{Name: name, Dialect: "googlesql"} // Default dialect
|
|
if err := decoder.DecodeContext(ctx, &actual); err != nil {
|
|
return nil, err
|
|
}
|
|
return actual, nil
|
|
}
|
|
|
|
type Config struct {
|
|
Name string `yaml:"name" validate:"required"`
|
|
Kind string `yaml:"kind" validate:"required"`
|
|
Project string `yaml:"project" validate:"required"`
|
|
Instance string `yaml:"instance" validate:"required"`
|
|
Dialect sources.Dialect `yaml:"dialect" validate:"required"`
|
|
Database string `yaml:"database" validate:"required"`
|
|
}
|
|
|
|
func (r Config) SourceConfigKind() string {
|
|
return SourceKind
|
|
}
|
|
|
|
func (r Config) Initialize(ctx context.Context, tracer trace.Tracer) (sources.Source, error) {
|
|
client, err := initSpannerClient(ctx, tracer, r.Name, r.Project, r.Instance, r.Database)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to create client: %w", err)
|
|
}
|
|
|
|
s := &Source{
|
|
Name: r.Name,
|
|
Kind: SourceKind,
|
|
Client: client,
|
|
Dialect: r.Dialect.String(),
|
|
}
|
|
return s, nil
|
|
}
|
|
|
|
var _ sources.Source = &Source{}
|
|
|
|
type Source struct {
|
|
Name string `yaml:"name"`
|
|
Kind string `yaml:"kind"`
|
|
Client *spanner.Client
|
|
Dialect string
|
|
}
|
|
|
|
func (s *Source) SourceKind() string {
|
|
return SourceKind
|
|
}
|
|
|
|
func (s *Source) SpannerClient() *spanner.Client {
|
|
return s.Client
|
|
}
|
|
|
|
func (s *Source) DatabaseDialect() string {
|
|
return s.Dialect
|
|
}
|
|
|
|
func initSpannerClient(ctx context.Context, tracer trace.Tracer, name, project, instance, dbname string) (*spanner.Client, error) {
|
|
//nolint:all // Reassigned ctx
|
|
ctx, span := sources.InitConnectionSpan(ctx, tracer, SourceKind, name)
|
|
defer span.End()
|
|
|
|
// Configure the connection to the database
|
|
db := fmt.Sprintf("projects/%s/instances/%s/databases/%s", project, instance, dbname)
|
|
|
|
// Configure session pool to automatically clean inactive transactions
|
|
sessionPoolConfig := spanner.SessionPoolConfig{
|
|
TrackSessionHandles: true,
|
|
InactiveTransactionRemovalOptions: spanner.InactiveTransactionRemovalOptions{
|
|
ActionOnInactiveTransaction: spanner.WarnAndClose,
|
|
},
|
|
}
|
|
|
|
// Create spanner client
|
|
userAgent, err := util.UserAgentFromContext(ctx)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
client, err := spanner.NewClientWithConfig(ctx, db, spanner.ClientConfig{SessionPoolConfig: sessionPoolConfig, UserAgent: userAgent})
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to create new client: %w", err)
|
|
}
|
|
|
|
return client, nil
|
|
}
|