mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-11 07:35:05 -05: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>
173 lines
4.3 KiB
Go
173 lines
4.3 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 http
|
|
|
|
import (
|
|
"context"
|
|
"crypto/tls"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"net/url"
|
|
"time"
|
|
|
|
"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 SourceType string = "http"
|
|
|
|
// 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, Timeout: "30s"} // Default timeout
|
|
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"`
|
|
BaseURL string `yaml:"baseUrl"`
|
|
Timeout string `yaml:"timeout"`
|
|
DefaultHeaders map[string]string `yaml:"headers"`
|
|
QueryParams map[string]string `yaml:"queryParams"`
|
|
DisableSslVerification bool `yaml:"disableSslVerification"`
|
|
}
|
|
|
|
func (r Config) SourceConfigType() string {
|
|
return SourceType
|
|
}
|
|
|
|
// Initialize initializes an HTTP Source instance.
|
|
func (r Config) Initialize(ctx context.Context, tracer trace.Tracer) (sources.Source, error) {
|
|
duration, err := time.ParseDuration(r.Timeout)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to parse Timeout string as time.Duration: %s", err)
|
|
}
|
|
|
|
tr := &http.Transport{}
|
|
|
|
logger, err := util.LoggerFromContext(ctx)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to get logger from ctx: %s", err)
|
|
}
|
|
|
|
if r.DisableSslVerification {
|
|
tr.TLSClientConfig = &tls.Config{
|
|
InsecureSkipVerify: true,
|
|
}
|
|
|
|
logger.WarnContext(ctx, "Insecure HTTP is enabled for HTTP source %s. TLS certificate verification is skipped.\n", r.Name)
|
|
}
|
|
|
|
client := http.Client{
|
|
Timeout: duration,
|
|
Transport: tr,
|
|
}
|
|
|
|
// Validate BaseURL
|
|
_, err = url.ParseRequestURI(r.BaseURL)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("failed to parse BaseUrl %v", err)
|
|
}
|
|
|
|
ua, err := util.UserAgentFromContext(ctx)
|
|
if err != nil {
|
|
fmt.Printf("Error in User Agent retrieval: %s", err)
|
|
}
|
|
if r.DefaultHeaders == nil {
|
|
r.DefaultHeaders = make(map[string]string)
|
|
}
|
|
if existingUA, ok := r.DefaultHeaders["User-Agent"]; ok {
|
|
ua = ua + " " + existingUA
|
|
}
|
|
r.DefaultHeaders["User-Agent"] = ua
|
|
|
|
s := &Source{
|
|
Config: r,
|
|
client: &client,
|
|
}
|
|
return s, nil
|
|
|
|
}
|
|
|
|
var _ sources.Source = &Source{}
|
|
|
|
type Source struct {
|
|
Config
|
|
client *http.Client
|
|
}
|
|
|
|
func (s *Source) SourceType() string {
|
|
return SourceType
|
|
}
|
|
|
|
func (s *Source) ToConfig() sources.SourceConfig {
|
|
return s.Config
|
|
}
|
|
|
|
func (s *Source) HttpDefaultHeaders() map[string]string {
|
|
return s.DefaultHeaders
|
|
}
|
|
|
|
func (s *Source) HttpBaseURL() string {
|
|
return s.BaseURL
|
|
}
|
|
|
|
func (s *Source) HttpQueryParams() map[string]string {
|
|
return s.QueryParams
|
|
}
|
|
|
|
func (s *Source) Client() *http.Client {
|
|
return s.client
|
|
}
|
|
|
|
func (s *Source) RunRequest(req *http.Request) (any, error) {
|
|
// Make request and fetch response
|
|
resp, err := s.Client().Do(req)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error making HTTP request: %s", err)
|
|
}
|
|
defer resp.Body.Close()
|
|
|
|
var body []byte
|
|
body, err = io.ReadAll(resp.Body)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if resp.StatusCode < 200 || resp.StatusCode > 299 {
|
|
return nil, fmt.Errorf("unexpected status code: %d, response body: %s", resp.StatusCode, string(body))
|
|
}
|
|
|
|
var data any
|
|
if err = json.Unmarshal(body, &data); err != nil {
|
|
// if unable to unmarshal data, return result as string.
|
|
return string(body), nil
|
|
}
|
|
return data, nil
|
|
}
|