feat: add file stat to workspace API

Signed-off-by: Donnie Adams <[email protected]>

Author: thedadams

workspace.go

@@ -7,6 +7,7 @@ import (
 	"fmt"
 	"os"
 	"strings"
+	"time"
 )
 
 type NotFoundInWorkspaceError struct {
@@ -207,3 +208,48 @@ func (g *GPTScript) ReadFileInWorkspace(ctx context.Context, filePath string, op
 
 	return base64.StdEncoding.DecodeString(out)
 }
+
+type StatFileInWorkspaceOptions struct {
+	WorkspaceID string
+}
+
+func (g *GPTScript) StatFileInWorkspace(ctx context.Context, filePath string, opts ...StatFileInWorkspaceOptions) (FileInfo, error) {
+	var opt StatFileInWorkspaceOptions
+	for _, o := range opts {
+		if o.WorkspaceID != "" {
+			opt.WorkspaceID = o.WorkspaceID
+		}
+	}
+
+	if opt.WorkspaceID == "" {
+		opt.WorkspaceID = os.Getenv("GPTSCRIPT_WORKSPACE_ID")
+	}
+
+	out, err := g.runBasicCommand(ctx, "workspaces/stat-file", map[string]any{
+		"id":            opt.WorkspaceID,
+		"filePath":      filePath,
+		"workspaceTool": g.globalOpts.WorkspaceTool,
+		"env":           g.globalOpts.Env,
+	})
+	if err != nil {
+		if strings.HasSuffix(err.Error(), fmt.Sprintf("not found: %s/%s", opt.WorkspaceID, filePath)) {
+			return FileInfo{}, newNotFoundInWorkspaceError(opt.WorkspaceID, filePath)
+		}
+		return FileInfo{}, err
+	}
+
+	var info FileInfo
+	err = json.Unmarshal([]byte(out), &info)
+	if err != nil {
+		return FileInfo{}, err
+	}
+
+	return info, nil
+}
+
+type FileInfo struct {
+	WorkspaceID string
+	Name        string
+	Size        int64
+	ModTime     time.Time
+}

workspace_test.go

@@ -53,6 +53,28 @@ func TestWriteReadAndDeleteFileFromWorkspace(t *testing.T) {
 		t.Errorf("Unexpected content: %s", content)
 	}
 
+	// Stat the file to ensure it exists
+	fileInfo, err := g.StatFileInWorkspace(context.Background(), "test.txt", StatFileInWorkspaceOptions{WorkspaceID: id})
+	if err != nil {
+		t.Errorf("Error statting file: %v", err)
+	}
+
+	if fileInfo.WorkspaceID != id {
+		t.Errorf("Unexpected file workspace ID: %v", fileInfo.WorkspaceID)
+	}
+
+	if fileInfo.Name != "test.txt" {
+		t.Errorf("Unexpected file name: %s", fileInfo.Name)
+	}
+
+	if fileInfo.Size != 4 {
+		t.Errorf("Unexpected file size: %d", fileInfo.Size)
+	}
+
+	if fileInfo.ModTime.IsZero() {
+		t.Errorf("Unexpected file mod time: %v", fileInfo.ModTime)
+	}
+
 	// Ensure we get the error we expect when trying to read a non-existent file
 	_, err = g.ReadFileInWorkspace(context.Background(), "test1.txt", ReadFileInWorkspaceOptions{WorkspaceID: id})
 	if nf := (*NotFoundInWorkspaceError)(nil); !errors.As(err, &nf) {
@@ -182,6 +204,28 @@ func TestWriteReadAndDeleteFileFromWorkspaceS3(t *testing.T) {
 		t.Errorf("Unexpected content: %s", content)
 	}
 
+	// Stat the file to ensure it exists
+	fileInfo, err := g.StatFileInWorkspace(context.Background(), "test.txt", StatFileInWorkspaceOptions{WorkspaceID: id})
+	if err != nil {
+		t.Errorf("Error statting file: %v", err)
+	}
+
+	if fileInfo.WorkspaceID != id {
+		t.Errorf("Unexpected file workspace ID: %v", fileInfo.WorkspaceID)
+	}
+
+	if fileInfo.Name != "test.txt" {
+		t.Errorf("Unexpected file name: %s", fileInfo.Name)
+	}
+
+	if fileInfo.Size != 4 {
+		t.Errorf("Unexpected file size: %d", fileInfo.Size)
+	}
+
+	if fileInfo.ModTime.IsZero() {
+		t.Errorf("Unexpected file mod time: %v", fileInfo.ModTime)
+	}
+
 	// Ensure we get the error we expect when trying to read a non-existent file
 	_, err = g.ReadFileInWorkspace(context.Background(), "test1.txt", ReadFileInWorkspaceOptions{WorkspaceID: id})
 	if nf := (*NotFoundInWorkspaceError)(nil); !errors.As(err, &nf) {