Skip to content

fix: bake the resolved homeboy path into AGENTS.md guidance #577

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

Open
chubes4 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: bake the resolved homeboy path into AGENTS.md guidance #577

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
72 changes: 51 additions & 21 deletions guidance/homeboy.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,34 +74,64 @@ guidance_register() {
fi
}

# _guidance_homeboy_php_quote <value>
#
# Escape a filesystem path for embedding in a PHP single-quoted string
# literal. Only backslash and single-quote are special inside '...'.
_guidance_homeboy_php_quote() {
local value="$1"
value="${value//\\/\\\\}"
value="${value//\'/\\\'}"
printf '%s' "$value"
}

# Emit the live PHP block with the resolved homeboy path baked in.
#
# The binary is resolved ONCE here, at sync time, using the same `type -P`
# lookup as guidance_applies(). The emitted PHP checks that one absolute
# path instead of walking getenv('PATH') at compose time.
#
# This matters because AGENTS.md is recomposed by whatever process happens
# to trigger it — PHP-FPM, cron, a plugin upgrade, a WP-CLI call with a
# trimmed environment. Those do not inherit an interactive PATH, so a
# PATH-based probe reported "homeboy absent" on a host where homeboy was
# installed and executable, and the section silently deleted itself (#575).
#
# The #254 live gate is preserved: the emitted code still re-checks
# is_executable() at every compose, so a host that loses the binary stops
# emitting the section with no wp-coding-agents sync.
#
# Quoted heredoc ('PHP_BLOCK') so PHP $variables, backticks, and ${...} are
# emitted verbatim — bash never touches them.
# emitted verbatim — bash never touches them. The single baked value is
# substituted afterward via a placeholder, preserving that property.
_guidance_homeboy_live_block() {
cat <<'PHP_BLOCK'
local homeboy_path
homeboy_path="$(type -P homeboy 2>/dev/null || true)"
if [ -z "$homeboy_path" ]; then
return 1
fi

local quoted_path
quoted_path="$(_guidance_homeboy_php_quote "$homeboy_path")"

cat <<'PHP_BLOCK' | sed "s|__WP_CODING_AGENTS_HOMEBOY_BIN__|${quoted_path//|/\\|}|g"
// BEGIN agents-md-guidance:homeboy-cli
if ( ! function_exists( 'wp_coding_agents_homeboy_binary' ) ) {
function wp_coding_agents_homeboy_binary() {
$homeboy = null;
$path_env = ( is_callable( 'getenv' ) ) ? getenv( 'PATH' ) : false;
if ( is_string( $path_env ) && $path_env !== '' ) {
foreach ( explode( PATH_SEPARATOR, $path_env ) as $dir ) {
if ( $dir === '' ) {
continue;
}
$candidate = rtrim( $dir, '/' ) . '/homeboy';
if ( @is_executable( $candidate ) ) {
$homeboy = $candidate;
break;
}
}
}
return $homeboy;
// Absolute path resolved by wp-coding-agents at sync time. Checked live
// at every compose so losing the binary drops the section (#254), but
// never re-derived from the composing process's PATH (#575).
if ( ! defined( 'WP_CODING_AGENTS_HOMEBOY_BIN' ) ) {
define( 'WP_CODING_AGENTS_HOMEBOY_BIN', '__WP_CODING_AGENTS_HOMEBOY_BIN__' );
}

if ( ! function_exists( 'wp_coding_agents_homeboy_available' ) ) {
function wp_coding_agents_homeboy_available() {
return @is_executable( WP_CODING_AGENTS_HOMEBOY_BIN );
}
}

if ( ! function_exists( 'wp_coding_agents_render_homeboy_cli_section' ) ) {
function wp_coding_agents_render_homeboy_cli_section() {
if ( wp_coding_agents_homeboy_binary() === null ) {
if ( ! wp_coding_agents_homeboy_available() ) {
return '';
}

Expand Down Expand Up @@ -138,7 +168,7 @@ MD;
}

// Gate registration itself at composition time.
if ( wp_coding_agents_homeboy_binary() !== null ) {
if ( wp_coding_agents_homeboy_available() ) {
\DataMachine\Engine\AI\SectionRegistry::register(
'AGENTS.md',
'homeboy-cli',
Expand Down
47 changes: 47 additions & 0 deletions tests/agents-md-guidance.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,6 +416,53 @@ HOMEBOY_HASH_BEFORE=$(file_hash "$MU_FILE")
guidance_sync_unit homeboy
HOMEBOY_HASH_AFTER=$(file_hash "$MU_FILE")
assert_eq "$HOMEBOY_HASH_AFTER" "$HOMEBOY_HASH_BEFORE" "Homeboy guidance generation is idempotent"
echo "==> Homeboy guidance survives a compose with a minimal PATH (#575)"
# The composing process is not always an interactive shell. PHP-FPM, cron, a
# plugin upgrade, or a WP-CLI call with a trimmed environment all recompose
# AGENTS.md without an interactive PATH. Resolving the binary from
# getenv('PATH') at compose time therefore deleted the section on hosts where
# Homeboy was installed and executable.
assert_contains "$MU_FILE" "$TMP/homeboy-bin/homeboy" "Homeboy guidance bakes the absolute binary path"
if grep -Fq "getenv( 'PATH' )" "$MU_FILE"; then
echo " FAIL Homeboy guidance still resolves the binary from the ambient PATH"
FAILED=$((FAILED + 1))
else
echo " ok Homeboy guidance does not read the ambient PATH"
fi

# Execute the generated block with a deliberately empty PATH. This is the
# exact condition that silently dropped the section before the fix.
MINIMAL_PATH_SHIM="$TMP/minimal-path-shim.php"
cat > "$MINIMAL_PATH_SHIM" <<PHP
<?php
define( 'ABSPATH', '/' );
\$GLOBALS['actions'] = [];
\$GLOBALS['filters'] = [];
\$GLOBALS['sections'] = [];
class MinimalPathSectionRegistry {
public static function register( \$file, \$section, \$priority, \$callback, \$metadata = [] ): void {
\$GLOBALS['sections'][ \$section ] = \$callback;
}
}
class_alias( 'MinimalPathSectionRegistry', 'DataMachine\\\\Engine\\\\AI\\\\SectionRegistry' );
function add_action( \$tag, \$callback, \$priority = 10 ) { \$GLOBALS['actions'][\$tag][\$priority][] = \$callback; }
function add_filter( \$tag, \$callback, \$priority = 10 ) { \$GLOBALS['filters'][\$tag][\$priority][] = \$callback; }
function apply_filters( \$tag, \$value ) { return \$value; }
function datamachine_agents_md_enabled(): bool { return true; }
// The composing process has no usable PATH — the #575 condition.
putenv( 'PATH=' );
require '$MU_FILE';
ksort( \$GLOBALS['actions']['datamachine_sections'] );
foreach ( \$GLOBALS['actions']['datamachine_sections'] as \$callbacks ) { foreach ( \$callbacks as \$callback ) { \$callback(); } }
\$rendered = isset( \$GLOBALS['sections']['homeboy-cli'] ) ? (string) \$GLOBALS['sections']['homeboy-cli']() : '';
echo json_encode([
'registered' => isset( \$GLOBALS['sections']['homeboy-cli'] ),
'renders' => str_contains( \$rendered, '## Homeboy' ),
]);
PHP
RESULT=$(php "$MINIMAL_PATH_SHIM")
assert_eq "$RESULT" '{"registered":true,"renders":true}' "Homeboy guidance still composes with an empty PATH"

rm "$TMP/homeboy-bin/homeboy"
PATH="$TMP/homeboy-bin:/usr/bin:/bin"
export PATH
Expand Down
Loading