-
Notifications
You must be signed in to change notification settings - Fork 1.5k
feat(cli): add serve subcommand #2550
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| // Copyright 2026 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 serve | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "os" | ||
| "os/signal" | ||
| "syscall" | ||
| "time" | ||
|
|
||
| "github.com/googleapis/genai-toolbox/cmd/internal" | ||
| "github.com/googleapis/genai-toolbox/internal/server" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| func NewCommand(opts *internal.ToolboxOptions) *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "serve", | ||
| Short: "Deploy the toolbox server", | ||
| Long: "Deploy the toolbox server", | ||
| } | ||
| flags := cmd.Flags() | ||
| internal.ServeFlags(flags, opts) | ||
| cmd.RunE = func(*cobra.Command, []string) error { return runServe(cmd, opts) } | ||
| return cmd | ||
| } | ||
|
|
||
| func runServe(cmd *cobra.Command, opts *internal.ToolboxOptions) error { | ||
| ctx, cancel := context.WithCancel(cmd.Context()) | ||
| defer cancel() | ||
|
|
||
| // watch for sigterm / sigint signals | ||
| signals := make(chan os.Signal, 1) | ||
| signal.Notify(signals, syscall.SIGTERM, syscall.SIGINT) | ||
| go func(sCtx context.Context) { | ||
| var s os.Signal | ||
| select { | ||
| case <-sCtx.Done(): | ||
| // this should only happen when the context supplied when testing is canceled | ||
| return | ||
| case s = <-signals: | ||
| } | ||
| switch s { | ||
| case syscall.SIGINT: | ||
| opts.Logger.DebugContext(sCtx, "Received SIGINT signal to shutdown.") | ||
| case syscall.SIGTERM: | ||
| opts.Logger.DebugContext(sCtx, "Received SIGTERM signal to shutdown.") | ||
| } | ||
| cancel() | ||
| }(ctx) | ||
|
|
||
| ctx, shutdown, err := opts.Setup(ctx) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer func() { | ||
| _ = shutdown(ctx) | ||
| }() | ||
|
|
||
| // start server | ||
| s, err := server.NewServer(ctx, opts.Cfg) | ||
| if err != nil { | ||
| errMsg := fmt.Errorf("toolbox failed to initialize: %w", err) | ||
| opts.Logger.ErrorContext(ctx, errMsg.Error()) | ||
| return errMsg | ||
| } | ||
|
|
||
| // run server in background | ||
| srvErr := make(chan error, 1) | ||
| if opts.Cfg.Stdio { | ||
| go func() { | ||
| defer close(srvErr) | ||
| err = s.ServeStdio(ctx, opts.IOStreams.In, opts.IOStreams.Out) | ||
| if err != nil { | ||
| srvErr <- err | ||
| } | ||
| }() | ||
| } else { | ||
| err = s.Listen(ctx) | ||
| if err != nil { | ||
| errMsg := fmt.Errorf("toolbox failed to start listener: %w", err) | ||
| opts.Logger.ErrorContext(ctx, errMsg.Error()) | ||
| return errMsg | ||
| } | ||
| opts.Logger.InfoContext(ctx, "Server ready to serve!") | ||
| if opts.Cfg.UI { | ||
| opts.Logger.InfoContext(ctx, fmt.Sprintf("Toolbox UI is up and running at: http://%s:%d/ui", opts.Cfg.Address, opts.Cfg.Port)) | ||
| } | ||
|
|
||
| go func() { | ||
| defer close(srvErr) | ||
| err = s.Serve(ctx) | ||
| if err != nil { | ||
| srvErr <- err | ||
| } | ||
| }() | ||
| } | ||
|
|
||
| // wait for either the server to error out or the command's context to be canceled | ||
| select { | ||
| case err := <-srvErr: | ||
| if err != nil { | ||
| errMsg := fmt.Errorf("toolbox crashed with the following error: %w", err) | ||
| opts.Logger.ErrorContext(ctx, errMsg.Error()) | ||
| return errMsg | ||
| } | ||
| case <-ctx.Done(): | ||
| shutdownContext, cancel := context.WithTimeout(context.Background(), 10*time.Second) | ||
| defer cancel() | ||
| opts.Logger.WarnContext(shutdownContext, "Shutting down gracefully...") | ||
| err := s.Shutdown(shutdownContext) | ||
| if err == context.DeadlineExceeded { | ||
| return fmt.Errorf("graceful shutdown timed out... forcing exit") | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| // Copyright 2026 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 serve | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "strings" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/googleapis/genai-toolbox/cmd/internal" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| func serveCommand(ctx context.Context, args []string) (string, error) { | ||
| parentCmd := &cobra.Command{Use: "toolbox"} | ||
|
|
||
| buf := new(bytes.Buffer) | ||
| opts := internal.NewToolboxOptions(internal.WithIOStreams(buf, buf)) | ||
| internal.PersistentFlags(parentCmd, opts) | ||
|
|
||
| cmd := NewCommand(opts) | ||
| parentCmd.AddCommand(cmd) | ||
| parentCmd.SetArgs(args) | ||
| // Inject the context into the Cobra command | ||
| parentCmd.SetContext(ctx) | ||
|
|
||
| err := parentCmd.Execute() | ||
| return buf.String(), err | ||
| } | ||
|
|
||
| func TestServe(t *testing.T) { | ||
| // context will automatically shutdown in 1 second. | ||
| ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second) | ||
|
Yuan325 marked this conversation as resolved.
|
||
| defer cancel() | ||
|
|
||
| args := []string{"serve", "--port", "0"} | ||
| output, err := serveCommand(ctx, args) | ||
| if err != nil { | ||
| t.Fatalf("expected graceful shutdown without error, got: %v", err) | ||
| } | ||
|
|
||
| if !strings.Contains(output, "Server ready to serve!") { | ||
| t.Errorf("expected to find server ready message in output, got: %s", output) | ||
| } | ||
|
|
||
| if !strings.Contains(output, "Shutting down gracefully...") { | ||
| t.Errorf("expected to find graceful shutdown message in output, got: %s", output) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.