Merge pull request #24 from thedadams/restart-error-runs

fix: allow retrying of failed runs

Author: thedadams

README.md

@@ -34,6 +34,7 @@ None of the options is required, and the defaults will reduce the number of call
 - `chatState`: The chat state to continue, or null to start a new chat and return the state
 - `confirm`: Prompt before running potentially dangerous commands
 - `prompt`: Allow prompting of the user
+- `env`: Extra environment variables to pass to the script in the form `KEY=VAL`
 
 ## Functions
 

client.go

@@ -119,7 +119,6 @@ func (c *client) Evaluate(ctx context.Context, opts Options, tools ...fmt.String
 		state:       Creating,
 		opts:        opts,
 		content:     concatTools(tools),
-		chatState:   opts.ChatState,
 	}).NextChat(ctx, opts.Input)
 }
 
@@ -130,7 +129,6 @@ func (c *client) Run(ctx context.Context, toolPath string, opts Options) (*Run,
 		state:       Creating,
 		opts:        opts,
 		toolPath:    toolPath,
-		chatState:   opts.ChatState,
 	}).NextChat(ctx, opts.Input)
 }
 

opts.go

@@ -2,13 +2,14 @@ package gptscript
 
 // Options represents options for the gptscript tool or file.
 type Options struct {
-	Confirm       bool   `json:"confirm"`
-	Input         string `json:"input"`
-	DisableCache  bool   `json:"disableCache"`
-	CacheDir      string `json:"cacheDir"`
-	SubTool       string `json:"subTool"`
-	Workspace     string `json:"workspace"`
-	ChatState     string `json:"chatState"`
-	IncludeEvents bool   `json:"includeEvents"`
-	Prompt        bool   `json:"prompt"`
+	Confirm       bool     `json:"confirm"`
+	Input         string   `json:"input"`
+	DisableCache  bool     `json:"disableCache"`
+	CacheDir      string   `json:"cacheDir"`
+	SubTool       string   `json:"subTool"`
+	Workspace     string   `json:"workspace"`
+	ChatState     string   `json:"chatState"`
+	IncludeEvents bool     `json:"includeEvents"`
+	Prompt        bool     `json:"prompt"`
+	Env           []string `json:"env"`
 }

run.go

@@ -154,22 +154,24 @@ func (r *Run) ChatState() string {
 // NextChat will pass input and create the next run in a chat.
 // The new Run will be returned.
 func (r *Run) NextChat(ctx context.Context, input string) (*Run, error) {
-	if r.state != Creating && r.state != Continue {
-		return nil, fmt.Errorf("run must be in creating or continue state not %q", r.state)
+	if r.state != Creating && r.state != Continue && r.state != Error {
+		return nil, fmt.Errorf("run must be in creating, continue, or error state not %q", r.state)
 	}
 
 	run := &Run{
 		url:         r.url,
 		requestPath: r.requestPath,
 		state:       Creating,
-		chatState:   r.chatState,
 		toolPath:    r.toolPath,
 		content:     r.content,
 		opts:        r.opts,
 	}
+
 	run.opts.Input = input
-	if run.chatState != "" {
-		run.opts.ChatState = run.chatState
+	if r.chatState != "" && r.state != Error {
+		// If the previous run errored, then don't update the chat state.
+		// opts.ChatState will be the last chat state where an error did not occur.
+		run.opts.ChatState = r.chatState
 	}
 
 	var payload any
@@ -350,10 +352,15 @@ func (r *Run) request(ctx context.Context, payload any) (err error) {
 							r.parentCallFrameID = event.Call.ID
 						}
 						r.callsLock.Unlock()
-					} else if event.Run != nil && event.Run.Type == EventTypeRunStart {
-						r.callsLock.Lock()
-						r.program = &event.Run.Program
-						r.callsLock.Unlock()
+					} else if event.Run != nil {
+						if event.Run.Type == EventTypeRunStart {
+							r.callsLock.Lock()
+							r.program = &event.Run.Program
+							r.callsLock.Unlock()
+						} else if event.Run.Type == EventTypeRunFinish && event.Run.Error != "" {
+							r.state = Error
+							r.err = fmt.Errorf(event.Run.Error)
+						}
 					}
 
 					if r.opts.IncludeEvents {

run_test.go

@@ -0,0 +1,44 @@
+package gptscript
+
+import (
+	"context"
+	"runtime"
+	"testing"
+)
+
+func TestRestartingErrorRun(t *testing.T) {
+	instructions := "#!/bin/bash\nexit ${EXIT_CODE}"
+	if runtime.GOOS == "windows" {
+		instructions = "#!/usr/bin/env powershell.exe\n\n$e = $env:EXIT_CODE;\nif ($e) { Exit 1; }"
+	}
+	tool := &ToolDef{
+		Context:      []string{"my-context"},
+		Instructions: "Say hello",
+	}
+	contextTool := &ToolDef{
+		Name:         "my-context",
+		Instructions: instructions,
+	}
+
+	run, err := c.Evaluate(context.Background(), Options{Env: []string{"EXIT_CODE=1"}, IncludeEvents: true}, tool, contextTool)
+	if err != nil {
+		t.Errorf("Error executing tool: %v", err)
+	}
+
+	// Wait for the run to complete
+	_, err = run.Text()
+	if err == nil {
+		t.Fatalf("no error returned from run")
+	}
+
+	run.opts.Env = nil
+	run, err = run.NextChat(context.Background(), "")
+	if err != nil {
+		t.Errorf("Error executing next run: %v", err)
+	}
+
+	_, err = run.Text()
+	if err != nil {
+		t.Errorf("executing run with input of 0 should not fail: %v", err)
+	}
+}