Skip to content

feat: make the SDK server workspace tool a global option #882

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.

Sign up for GitHub

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
merged 1 commit into from
Oct 20, 2024
Merged

feat: make the SDK server workspace tool a global option #882

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions pkg/cli/sdk_server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (

type SDKServer struct {
*GPTScript
WorkspaceTool string `usage:"Tool to use for workspace"`
}

func (c *SDKServer) Customize(cmd *cobra.Command) {
Expand All @@ -37,5 +38,6 @@ func (c *SDKServer) Run(cmd *cobra.Command, _ []string) error {
Options: opts,
ListenAddress: c.ListenAddress,
Debug: c.Debug,
WorkspaceTool: c.WorkspaceTool,
})
}
1 change: 1 addition & 0 deletions pkg/sdkserver/routes.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import (
type server struct {
gptscriptOpts gptscript.Options
address, token string
workspaceTool string
client *gptscript.GPTScript
events *broadcaster.Broadcaster[event]

Expand Down
7 changes: 7 additions & 0 deletions pkg/sdkserver/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ type Options struct {
gptscript.Options

ListenAddress string
WorkspaceTool string
Debug bool
DisableServerErrorLogging bool
}
Expand Down Expand Up @@ -107,6 +108,7 @@ func run(ctx context.Context, listener net.Listener, opts Options) error {
gptscriptOpts: opts.Options,
address: listener.Addr().String(),
token: token,
workspaceTool: opts.WorkspaceTool,
client: g,
events: events,
runtimeManager: runtimes.Default(opts.Options.Cache.CacheDir), // TODO - do we always want to use runtimes.Default here?
Expand Down Expand Up @@ -157,6 +159,7 @@ func complete(opts ...Options) Options {
for _, opt := range opts {
result.Options = gptscript.Complete(result.Options, opt.Options)
result.ListenAddress = types.FirstSet(opt.ListenAddress, result.ListenAddress)
result.WorkspaceTool = types.FirstSet(opt.WorkspaceTool, result.WorkspaceTool)
result.Debug = types.FirstSet(opt.Debug, result.Debug)
result.DisableServerErrorLogging = types.FirstSet(opt.DisableServerErrorLogging, result.DisableServerErrorLogging)
}
Expand All @@ -165,5 +168,9 @@ func complete(opts ...Options) Options {
result.ListenAddress = "127.0.0.1:0"
}

if result.WorkspaceTool == "" {
result.WorkspaceTool = "github.com/gptscript-ai/workspace-provider"
}

return result
}
29 changes: 15 additions & 14 deletions pkg/sdkserver/workspaces.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,20 @@ import (
"github.com/gptscript-ai/gptscript/pkg/loader"
)

func (s *server) getWorkspaceTool(req workspaceCommonRequest) string {
if req.WorkspaceTool != "" {
return req.WorkspaceTool
}

return s.workspaceTool
}

type workspaceCommonRequest struct {
ID string `json:"id"`
WorkspaceTool string `json:"workspaceTool"`
Env []string `json:"env"`
}

func (w workspaceCommonRequest) getToolRepo() string {
if w.WorkspaceTool != "" {
return w.WorkspaceTool
}
return "github.com/gptscript-ai/workspace-provider"
}

type createWorkspaceRequest struct {
workspaceCommonRequest `json:",inline"`
ProviderType string `json:"providerType"`
Expand All @@ -38,7 +39,7 @@ func (s *server) createWorkspace(w http.ResponseWriter, r *http.Request) {
return
}

prg, err := loader.Program(r.Context(), reqObject.getToolRepo(), "Create Workspace", loader.Options{Cache: s.client.Cache})
prg, err := loader.Program(r.Context(), s.getWorkspaceTool(reqObject.workspaceCommonRequest), "Create Workspace", loader.Options{Cache: s.client.Cache})
if err != nil {
writeError(logger, w, http.StatusInternalServerError, fmt.Errorf("failed to load program: %w", err))
return
Expand Down Expand Up @@ -77,7 +78,7 @@ func (s *server) deleteWorkspace(w http.ResponseWriter, r *http.Request) {
return
}

prg, err := loader.Program(r.Context(), reqObject.getToolRepo(), "Delete Workspace", loader.Options{Cache: s.client.Cache})
prg, err := loader.Program(r.Context(), s.getWorkspaceTool(reqObject.workspaceCommonRequest), "Delete Workspace", loader.Options{Cache: s.client.Cache})
if err != nil {
writeError(logger, w, http.StatusInternalServerError, fmt.Errorf("failed to load program: %w", err))
return
Expand Down Expand Up @@ -114,7 +115,7 @@ func (s *server) listWorkspaceContents(w http.ResponseWriter, r *http.Request) {
return
}

prg, err := loader.Program(r.Context(), reqObject.getToolRepo(), "List Workspace Contents", loader.Options{Cache: s.client.Cache})
prg, err := loader.Program(r.Context(), s.getWorkspaceTool(reqObject.workspaceCommonRequest), "List Workspace Contents", loader.Options{Cache: s.client.Cache})
if err != nil {
writeError(logger, w, http.StatusInternalServerError, fmt.Errorf("failed to load program: %w", err))
return
Expand Down Expand Up @@ -150,7 +151,7 @@ func (s *server) removeAllWithPrefixInWorkspace(w http.ResponseWriter, r *http.R
return
}

prg, err := loader.Program(r.Context(), reqObject.getToolRepo(), "Remove All With Prefix In Workspace", loader.Options{Cache: s.client.Cache})
prg, err := loader.Program(r.Context(), s.getWorkspaceTool(reqObject.workspaceCommonRequest), "Remove All With Prefix In Workspace", loader.Options{Cache: s.client.Cache})
if err != nil {
writeError(logger, w, http.StatusInternalServerError, fmt.Errorf("failed to load program: %w", err))
return
Expand Down Expand Up @@ -187,7 +188,7 @@ func (s *server) writeFileInWorkspace(w http.ResponseWriter, r *http.Request) {
return
}

prg, err := loader.Program(r.Context(), reqObject.getToolRepo(), "Write File In Workspace", loader.Options{Cache: s.client.Cache})
prg, err := loader.Program(r.Context(), s.getWorkspaceTool(reqObject.workspaceCommonRequest), "Write File In Workspace", loader.Options{Cache: s.client.Cache})
if err != nil {
writeError(logger, w, http.StatusInternalServerError, fmt.Errorf("failed to load program: %w", err))
return
Expand Down Expand Up @@ -223,7 +224,7 @@ func (s *server) removeFileInWorkspace(w http.ResponseWriter, r *http.Request) {
return
}

prg, err := loader.Program(r.Context(), reqObject.getToolRepo(), "Remove File In Workspace", loader.Options{Cache: s.client.Cache})
prg, err := loader.Program(r.Context(), s.getWorkspaceTool(reqObject.workspaceCommonRequest), "Remove File In Workspace", loader.Options{Cache: s.client.Cache})
if err != nil {
writeError(logger, w, http.StatusInternalServerError, fmt.Errorf("failed to load program: %w", err))
return
Expand Down Expand Up @@ -259,7 +260,7 @@ func (s *server) readFileInWorkspace(w http.ResponseWriter, r *http.Request) {
return
}

prg, err := loader.Program(r.Context(), reqObject.getToolRepo(), "Read File In Workspace", loader.Options{Cache: s.client.Cache})
prg, err := loader.Program(r.Context(), s.getWorkspaceTool(reqObject.workspaceCommonRequest), "Read File In Workspace", loader.Options{Cache: s.client.Cache})
if err != nil {
writeError(logger, w, http.StatusInternalServerError, fmt.Errorf("failed to load program: %w", err))
return
Expand Down