mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-05-02 03:00:36 -04:00
This PR introduces a significant update to the Toolbox configuration file format, which is one of the primary **breaking changes** required for the implementation of the Advanced Control Plane. # Summary of Changes The configuration schema has been updated to enforce resource isolation and facilitate atomic, incremental updates. * Resource Isolation: Resource definitions are now separated into individual blocks, using a distinct structure for each resource type (Source, Tool, Toolset, etc.). This improves readability, management, and auditing of configuration files. * Field Name Modification: Internal field names have been modified to align with declarative methodologies. Specifically, the configuration now separates kind (general resource type, e.g., Source) from type (specific implementation, e.g., Postgres). # User Impact Existing tools.yaml configuration files are now in an outdated format. Users must eventually update their files to the new YAML format. # Mitigation & Compatibility Backward compatibility is maintained during this transition to ensure no immediate user action is required for existing files. * Immediate Backward Compatibility: The source code includes a pre-processing layer that automatically detects outdated configuration files (v1 format) and converts them to the new v2 format under the hood. * [COMING SOON] Migration Support: The new toolbox migrate subcommand will be introduced to allow users to automatically convert their old configuration files to the latest format. # Example Example for config file v2: ``` kind: sources name: my-pg-instance type: cloud-sql-postgres project: my-project region: my-region instance: my-instance database: my_db user: my_user password: my_pass --- kind: authServices name: my-google-auth type: google clientId: testing-id --- kind: tools name: example_tool type: postgres-sql source: my-pg-instance description: some description statement: SELECT * FROM SQL_STATEMENT; parameters: - name: country type: string description: some description --- kind: tools name: example_tool_2 type: postgres-sql source: my-pg-instance description: returning the number one statement: SELECT 1; --- kind: toolsets name: example_toolset tools: - example_tool ``` --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com>
162 lines
4.1 KiB
Go
162 lines
4.1 KiB
Go
// Copyright 2025 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 valkey
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"log"
|
|
|
|
"github.com/goccy/go-yaml"
|
|
"github.com/googleapis/genai-toolbox/internal/sources"
|
|
"github.com/valkey-io/valkey-go"
|
|
"go.opentelemetry.io/otel/trace"
|
|
)
|
|
|
|
const SourceType string = "valkey"
|
|
|
|
// validate interface
|
|
var _ sources.SourceConfig = Config{}
|
|
|
|
func init() {
|
|
if !sources.Register(SourceType, newConfig) {
|
|
panic(fmt.Sprintf("source type %q already registered", SourceType))
|
|
}
|
|
}
|
|
|
|
func newConfig(ctx context.Context, name string, decoder *yaml.Decoder) (sources.SourceConfig, error) {
|
|
actual := Config{Name: name}
|
|
if err := decoder.DecodeContext(ctx, &actual); err != nil {
|
|
return nil, err
|
|
}
|
|
return actual, nil
|
|
}
|
|
|
|
type Config struct {
|
|
Name string `yaml:"name" validate:"required"`
|
|
Type string `yaml:"type" validate:"required"`
|
|
Address []string `yaml:"address" validate:"required"`
|
|
Username string `yaml:"username"`
|
|
Password string `yaml:"password"`
|
|
Database int `yaml:"database"`
|
|
UseGCPIAM bool `yaml:"useGCPIAM"`
|
|
DisableCache bool `yaml:"disableCache"`
|
|
}
|
|
|
|
func (r Config) SourceConfigType() string {
|
|
return SourceType
|
|
}
|
|
|
|
func (r Config) Initialize(ctx context.Context, tracer trace.Tracer) (sources.Source, error) {
|
|
|
|
client, err := initValkeyClient(ctx, r)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error initializing Valkey client: %s", err)
|
|
}
|
|
s := &Source{
|
|
Config: r,
|
|
Client: client,
|
|
}
|
|
return s, nil
|
|
}
|
|
|
|
func initValkeyClient(ctx context.Context, r Config) (valkey.Client, error) {
|
|
var authFn func(valkey.AuthCredentialsContext) (valkey.AuthCredentials, error)
|
|
if r.UseGCPIAM {
|
|
// Pass in an access token getter fn for IAM auth
|
|
authFn = func(valkey.AuthCredentialsContext) (valkey.AuthCredentials, error) {
|
|
token, err := sources.GetIAMAccessToken(ctx)
|
|
creds := valkey.AuthCredentials{Username: "default", Password: token}
|
|
if err != nil {
|
|
return creds, err
|
|
}
|
|
return creds, nil
|
|
}
|
|
}
|
|
|
|
client, err := valkey.NewClient(valkey.ClientOption{
|
|
InitAddress: r.Address,
|
|
SelectDB: r.Database,
|
|
Username: r.Username,
|
|
Password: r.Password,
|
|
AuthCredentialsFn: authFn,
|
|
DisableCache: r.DisableCache,
|
|
})
|
|
|
|
if err != nil {
|
|
log.Fatalf("error creating Valkey client: %v", err)
|
|
}
|
|
|
|
// Ping the server to check connectivity
|
|
pingCmd := client.B().Ping().Build()
|
|
_, err = client.Do(ctx, pingCmd).ToString()
|
|
if err != nil {
|
|
log.Fatalf("Failed to execute PING command: %v", err)
|
|
}
|
|
return client, nil
|
|
}
|
|
|
|
var _ sources.Source = &Source{}
|
|
|
|
type Source struct {
|
|
Config
|
|
Client valkey.Client
|
|
}
|
|
|
|
func (s *Source) SourceType() string {
|
|
return SourceType
|
|
}
|
|
|
|
func (s *Source) ToConfig() sources.SourceConfig {
|
|
return s.Config
|
|
}
|
|
|
|
func (s *Source) ValkeyClient() valkey.Client {
|
|
return s.Client
|
|
}
|
|
|
|
func (s *Source) RunCommand(ctx context.Context, cmds [][]string) (any, error) {
|
|
// Build commands
|
|
builtCmds := make(valkey.Commands, len(cmds))
|
|
|
|
for i, cmd := range cmds {
|
|
builtCmds[i] = s.ValkeyClient().B().Arbitrary(cmd...).Build()
|
|
}
|
|
|
|
if len(builtCmds) == 0 {
|
|
return nil, fmt.Errorf("no valid commands were built to execute")
|
|
}
|
|
|
|
// Execute commands
|
|
responses := s.ValkeyClient().DoMulti(ctx, builtCmds...)
|
|
|
|
// Parse responses
|
|
out := make([]any, len(cmds))
|
|
for i, resp := range responses {
|
|
if err := resp.Error(); err != nil {
|
|
// Store error message in the output for this command
|
|
out[i] = fmt.Sprintf("error from executing command at index %d: %s", i, err)
|
|
continue
|
|
}
|
|
val, err := resp.ToAny()
|
|
if err != nil {
|
|
out[i] = fmt.Sprintf("error parsing response: %s", err)
|
|
continue
|
|
}
|
|
out[i] = val
|
|
}
|
|
|
|
return out, nil
|
|
}
|