feat: reduce tool entrypoints in synopsis for text editor, bash, process manager by salman1993 · Pull Request #191 · block/goose

salman1993 · 2024-10-24T15:36:28Z

builds on top of the changes in #186

we collect similar tools into a collection:

bash (params for source_path, working_dir)
process manager (commands and optional params)
text editor (commands and optional params)

…rypoint-refactor * origin/main: feat: support optional params jsonschema conversion in exchange (#188) fix: correct context loading from session new/overwrite and resume (#180) feat: trying a license checker (#184) docs: getting index.md in sync with readme (#183)

src/goose/synopsis/bash.py

lamchau · 2024-10-24T22:17:46Z

src/goose/synopsis/process_manager.py

+        self.notifier.log(Rule(RULEPREFIX + "processes", style=RULESTYLE, align="left"))
+        self.notifier.log(Markdown(f"```\nreading {process_id}\n```"))
+        self.notifier.log("")
+        output = system.view_process_output(process_id)


out of scope for this PR but we should test failures. i believe in the event a process failed we don't catch stderr so that would be important to capture (which may aid in system recovery).

goose/src/goose/synopsis/system.py

Lines 62 to 71 in 300c4b6

def view_process_output(self, process_id: int) -> str:

"""View the output of a running background process."""

if not (process := self._processes.get(process_id)):

raise ValueError(f"No process found with ID: {process_id}")

output = []

while line := process.stdout.readline():

output.append(line)

return "".join(output)

lamchau · 2024-10-24T22:19:15Z

src/goose/synopsis/process_manager.py

+        if command not in self.command_dispatch:
+            raise ValueError(f"Unknown command '{command}'.")
+
+        # Call the corresponding method from the command dispatch


not necessary comment, delete?

lamchau

lgtm! much cleaner, nice work 🥳 !

lamchau · 2024-10-24T22:39:06Z

also out of scope we but in a follow up i think we should pick a different command for testing the process management 65% of the testing time is taken up by these

2.02s call     tests/synopsis/test_process_management.py::test_start_process
2.01s call     tests/synopsis/test_process_management.py::test_cancel_process
1.03s call     tests/toolkit/test_developer.py::test_write_file_prevent_write_if_changed

michaelneale · 2024-10-24T23:56:03Z

to save confusion should the other PR be closed and we just try this one out?

baxen

LGTM!

src/goose/synopsis/bash.py

baxen · 2024-10-29T17:34:21Z

src/goose/synopsis/process_manager.py

+            "cancel": self._cancel_process,
+        }
+
+    def logshell(self, command: str, title: str = "shell") -> None:


nit: should we make a top level util out of this?

baxen · 2024-10-29T17:36:02Z

src/goose/synopsis/text_editor.py

+            content = content[start_line - 1 : (end_line if end_line != -1 else len(content))]
+
+        system.remember_file(str(patho))
+        self._log_file_operation(str(patho), "".join(content), get_language(str(patho)))


nit: imo, this is too verbose to show every read - it is consistent, but i'd consider only showing this on writes?

…ontent

* main: chore: housekeeping (#202) feat: reduce tool entrypoints in synopsis for text editor, bash, process manager (#191) feat: list moderators (#204) chore: Minor changes in providers envs logic (#161) chore: add `.vscode` workspace settings and suggested extensions (#200) feat: license checker (#201) feat: include new anthropic model in docs and recommended config (#198) feat: tiny change so you know what processing is doing (#196) docs: correct intellij link (#197) docs: remove small duplication (#194) chore: add tracing option to run and group traces under session name (#187) docs: fix mkdocs, update to new references (#193)

…ess manager (#191)

…ess manager (block#191)

salman1993 added 10 commits October 23, 2024 12:44

Parse optional params in tools from docstring

1b1b8f9

Add docstring support for Literal -> jsonschema enum

da4f54c

Create a text editor tool collection, with multiple commands

adff4a6

Fix ruff checks - docstring lines were too long

8e22654

Use text_editor toolkit for tests

adaaf16

Merge changes for jsonschema conversion

128d097

Refactor to texteditor class

c6ddf14

Refactor to Bash and ProcessManager class

2d778f7

Fix synopsis tests

5a8b9ea

salman1993 mentioned this pull request Oct 24, 2024

feat: create a text editor tool with multiple commands #186

Closed

salman1993 changed the title ~~feat: reduce tool entrypoints in synopsis for bash, process manager~~ feat: reduce tool entrypoints in synopsis for text editor, bash, process manager Oct 24, 2024

salman1993 requested review from baxen, lamchau and michaelneale October 24, 2024 15:40

lamchau reviewed Oct 24, 2024

View reviewed changes

src/goose/synopsis/bash.py Outdated Show resolved Hide resolved

lamchau reviewed Oct 24, 2024

View reviewed changes

lamchau approved these changes Oct 24, 2024

View reviewed changes

michaelneale approved these changes Oct 25, 2024

View reviewed changes

baxen approved these changes Oct 29, 2024

View reviewed changes

salman1993 added 2 commits October 29, 2024 18:09

Address PR comments

3d8d022

Don't log output for 'view' command, fix view directory to show dir c…

92302c3

…ontent

salman1993 merged commit 40da95b into main Oct 29, 2024

ahau-square pushed a commit that referenced this pull request Nov 6, 2024

feat: reduce tool entrypoints in synopsis for text editor, bash, proc…

107e2bc

…ess manager (#191)

ahau-square pushed a commit that referenced this pull request Nov 6, 2024

feat: reduce tool entrypoints in synopsis for text editor, bash, proc…

dddb4d1

…ess manager (#191)

yingjiehe-xyz deleted the sm/synopsis-tools-entrypoint-refactor branch February 5, 2025 21:12

ahau-square pushed a commit that referenced this pull request May 2, 2025

feat: reduce tool entrypoints in synopsis for text editor, bash, proc…

db2666d

…ess manager (#191)

cbruyndoncx pushed a commit to cbruyndoncx/goose that referenced this pull request Jul 20, 2025

feat: reduce tool entrypoints in synopsis for text editor, bash, proc…

95c1f57

…ess manager (block#191)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

feat: reduce tool entrypoints in synopsis for text editor, bash, process manager#191

feat: reduce tool entrypoints in synopsis for text editor, bash, process manager#191
salman1993 merged 12 commits intomainfrom
sm/synopsis-tools-entrypoint-refactor

salman1993 commented Oct 24, 2024 •

edited

Loading

Uh oh!

Uh oh!

lamchau Oct 24, 2024 •

edited

Loading

Uh oh!

lamchau Oct 24, 2024

Uh oh!

lamchau left a comment •

edited

Loading

Uh oh!

lamchau commented Oct 24, 2024

Uh oh!

michaelneale commented Oct 24, 2024

Uh oh!

baxen left a comment

Uh oh!

Uh oh!

baxen Oct 29, 2024

Uh oh!

baxen Oct 29, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	def view_process_output(self, process_id: int) -> str:
	"""View the output of a running background process."""
	if not (process := self._processes.get(process_id)):
	raise ValueError(f"No process found with ID: {process_id}")

	output = []
	while line := process.stdout.readline():
	output.append(line)

	return "".join(output)

Comments

Conversation

salman1993 commented Oct 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

lamchau Oct 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lamchau Oct 24, 2024

Choose a reason for hiding this comment

Uh oh!

lamchau left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lamchau commented Oct 24, 2024

Uh oh!

michaelneale commented Oct 24, 2024

Uh oh!

baxen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

baxen Oct 29, 2024

Choose a reason for hiding this comment

Uh oh!

baxen Oct 29, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

salman1993 commented Oct 24, 2024 •

edited

Loading

lamchau Oct 24, 2024 •

edited

Loading

lamchau left a comment •

edited

Loading