fix(hooks): Use project_dir for hook execution working directory#2105
Draft
fix(hooks): Use project_dir for hook execution working directory#2105
Conversation
When hooks are loaded from a repository subdirectory (e.g., /workspace/project/repo-name), the hook executor needs to run commands from that directory, not the base workspace working_dir. This fixes the issue where relative paths in hook commands like .openhands/hooks/on_stop.sh would fail because they were being resolved against /workspace/project instead of /workspace/project/repo-name. Changes: - Add project_dir field to HookConfig - Set project_dir in hooks_service when loading hooks from workspace - Use project_dir (when set) as working_dir in LocalConversation's hook setup Co-authored-by: openhands <openhands@all-hands.dev>
Contributor
Coverage Report •
|
||||||||||||||||||||||||||||||
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Fixes an issue where hook commands with relative paths fail when hooks are loaded from a repository subdirectory.
Problem
When a user selects a repository (e.g.,
OpenHands/software-agent-sdk), hooks are loaded from/workspace/project/software-agent-sdk/.openhands/hooks.json. However, when the hook executor runs commands like.openhands/hooks/on_stop.sh, it uses the base workspace working_dir (/workspace/project) instead of the project directory where hooks were loaded from.This causes hook commands to fail with "file not found" because the relative path doesn't resolve correctly.
Solution
project_dirfield toHookConfig: Stores the directory where hooks were loaded fromproject_dirinhooks_service.py: When loading hooks, store the project directoryproject_dirinLocalConversation: When setting up the hook executor, useproject_dir(if set) instead ofworkspace.working_dirTesting
This fix was identified through Datadog log analysis showing:
hook_configinStartConversationRequestThe fix ensures relative paths in hook commands resolve against the correct project directory.
Related
@xingyaoww can click here to continue refining the PR
Agent Server images for this PR
• GHCR package: https://github.com/OpenHands/agent-sdk/pkgs/container/agent-server
Variants & Base Images
eclipse-temurin:17-jdknikolaik/python-nodejs:python3.12-nodejs22golang:1.21-bookwormPull (multi-arch manifest)
# Each variant is a multi-arch manifest supporting both amd64 and arm64 docker pull ghcr.io/openhands/agent-server:5df57e1-pythonRun
All tags pushed for this build
About Multi-Architecture Support
5df57e1-python) is a multi-arch manifest supporting both amd64 and arm645df57e1-python-amd64) are also available if needed