Skip to content

Add read-only context repositories #618

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

Merged
chubes4 merged 2 commits into from
Jun 10, 2026
Merged

Add read-only context repositories #618

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09eca91
fix: add read-only context repositories
chubes4 Jun 10, 2026
b2ce746
fix: satisfy context repository lint
chubes4 Jun 10, 2026
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
4 changes: 2 additions & 2 deletions inc/Abilities/WorkspaceAbilities.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,8 @@ private function registerAbilities(): void {
),
'type' => array(
'type' => 'string',
'enum' => array( 'primary', 'worktree' ),
'description' => 'Optional checkout type filter. Use "primary" for base checkouts or "worktree" for branch worktrees.',
'enum' => array( 'primary', 'worktree', 'context' ),
'description' => 'Optional checkout type filter. Use "primary" for base checkouts, "worktree" for branch worktrees, or "context" for read-only context repositories.',
),
),
),
Expand Down
4 changes: 2 additions & 2 deletions inc/Tools/WorkspaceTools.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1035,8 +1035,8 @@ public function getListDefinition(): array
),
'type' => array(
'type' => 'string',
'enum' => array( 'primary', 'worktree' ),
'description' => 'Optional checkout type filter. Use "primary" for base checkouts or "worktree" for branch worktrees.',
'enum' => array( 'primary', 'worktree', 'context' ),
'description' => 'Optional checkout type filter. Use "primary" for base checkouts, "worktree" for branch worktrees, or "context" for read-only context repositories.',
),
),
'required' => array(),
Expand Down
117 changes: 107 additions & 10 deletions inc/Workspace/RemoteWorkspaceBackend.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,11 @@ public function worktree_prune(): array {
* @return array<string,mixed>|\WP_Error
*/
public function read_file( string $handle, string $path, int $max_size, ?int $offset = null, ?int $limit = null ): array|\WP_Error {
$policy_error = WorkspaceAliasResolver::read_error_if_disallowed($handle, $path);
if ( null !== $policy_error ) {
return $policy_error;
}

$context = $this->resolve_handle($handle);
if ( is_wp_error($context) ) {
return $context;
Expand Down Expand Up @@ -234,13 +239,18 @@ public function read_file( string $handle, string $path, int $max_size, ?int $of
$result_content = implode("\n", $lines);
}

return array(
$result = array(
'success' => true,
'backend' => 'github_api',
'content' => $result_content,
'path' => $path,
'size' => $size,
);
if ( WorkspaceAliasResolver::is_context_repository($handle) ) {
$result['workspace_policy'] = WorkspaceAliasResolver::policy_attestation($handle);
}

return $result;
}

/**
Expand All @@ -249,6 +259,11 @@ public function read_file( string $handle, string $path, int $max_size, ?int $of
* @return array<string,mixed>|\WP_Error
*/
public function list_directory( string $handle, ?string $path = null ): array|\WP_Error {
$policy_error = WorkspaceAliasResolver::read_error_if_disallowed($handle, $path ?? '');
if ( null !== $policy_error ) {
return $policy_error;
}

$context = $this->resolve_handle($handle);
if ( is_wp_error($context) ) {
return $context;
Expand Down Expand Up @@ -287,13 +302,20 @@ public function list_directory( string $handle, ?string $path = null ): array|\W
);
}

return array(
$entries = WorkspaceAliasResolver::filter_context_entries($handle, '' === $prefix ? '/' : $prefix, $entries);

$result = array(
'success' => true,
'backend' => 'github_api',
'repo' => $handle,
'path' => '' === $prefix ? '/' : $prefix,
'entries' => $entries,
);
if ( WorkspaceAliasResolver::is_context_repository($handle) ) {
$result['workspace_policy'] = WorkspaceAliasResolver::policy_attestation($handle);
}

return $result;
}

/**
Expand All @@ -302,6 +324,11 @@ public function list_directory( string $handle, ?string $path = null ): array|\W
* @return array<string,mixed>|\WP_Error
*/
public function grep( string $handle, string $pattern, ?string $path = null, ?string $include_pattern = null, int $max_results = 100, int $context_lines = 0 ): array|\WP_Error {
$policy_error = WorkspaceAliasResolver::read_error_if_disallowed($handle, $path ?? '');
if ( null !== $policy_error ) {
return $policy_error;
}

$context = $this->resolve_handle($handle);
if ( is_wp_error($context) ) {
return $context;
Expand Down Expand Up @@ -353,7 +380,11 @@ public function grep( string $handle, string $pattern, ?string $path = null, ?st
}

foreach ( $files as $file ) {
$file_path = (string) ( $file['path'] ?? '' );
$file_path = (string) ( $file['path'] ?? '' );
$context_policy = WorkspaceAliasResolver::context_policy_for($handle);
if ( null !== $context_policy && ! WorkspaceAliasResolver::path_allowed_by_policy($file_path, $context_policy) ) {
continue;
}
if ( '' === $file_path || isset($seen[ $file_path ]) || ! $this->path_matches_include($file_path, $include_pattern) ) {
continue;
}
Expand All @@ -380,7 +411,7 @@ public function grep( string $handle, string $pattern, ?string $path = null, ?st
}
}

return array(
$result = array(
'success' => true,
'backend' => 'github_api',
'repo' => $handle,
Expand All @@ -390,6 +421,11 @@ public function grep( string $handle, string $pattern, ?string $path = null, ?st
'count' => count($matches),
'truncated' => count($matches) >= $max_results,
);
if ( WorkspaceAliasResolver::is_context_repository($handle) ) {
$result['workspace_policy'] = WorkspaceAliasResolver::policy_attestation($handle);
}

return $result;
}

/**
Expand All @@ -398,6 +434,10 @@ public function grep( string $handle, string $pattern, ?string $path = null, ?st
* @return array<string,mixed>|\WP_Error
*/
public function write_file( string $handle, string $path, string $content ): array|\WP_Error {
if ( WorkspaceAliasResolver::is_context_repository($handle) ) {
return WorkspaceAliasResolver::mutation_error($handle, 'write');
}

$context = $this->resolve_handle($handle);
if ( is_wp_error($context) ) {
return $context;
Expand Down Expand Up @@ -428,6 +468,10 @@ public function write_file( string $handle, string $path, string $content ): arr
* @return array<string,mixed>|\WP_Error
*/
public function edit_file( string $handle, string $path, string $old_string, string $new_string, bool $replace_all = false ): array|\WP_Error {
if ( WorkspaceAliasResolver::is_context_repository($handle) ) {
return WorkspaceAliasResolver::mutation_error($handle, 'edit');
}

$context = $this->resolve_handle($handle);
if ( is_wp_error($context) ) {
return $context;
Expand Down Expand Up @@ -490,12 +534,13 @@ public function show( string $handle ): array|\WP_Error {

$files = array_values(array_unique(array_values( (array) $context['changed_files'])));

return array(
$result = array(
'success' => true,
'backend' => 'github_api',
'name' => $handle,
'repo' => $context['repo_name'],
'is_worktree' => isset($context['branch']) && '' !== (string) $context['branch'],
'is_worktree' => empty($context['read_only_context']) && isset($context['branch']) && '' !== (string) $context['branch'],
'is_context' => ! empty($context['read_only_context']),
'path' => 'github://' . $context['repo'] . ( '' !== (string) $context['branch']
? '#' . $context['branch']
: '' ),
Expand All @@ -505,6 +550,11 @@ public function show( string $handle ): array|\WP_Error {
'dirty' => count($files),
'files' => $files,
);
if ( WorkspaceAliasResolver::is_context_repository($handle) ) {
$result['workspace_policy'] = WorkspaceAliasResolver::policy_attestation($handle);
}

return $result;
}

/**
Expand All @@ -514,6 +564,10 @@ public function show( string $handle ): array|\WP_Error {
*/
public function git_diff( string $handle, ?string $from = null, ?string $to = null, bool $staged = false, ?string $path = null ): array|\WP_Error {
unset($staged);
$policy_error = WorkspaceAliasResolver::read_error_if_disallowed($handle, $path ?? '');
if ( null !== $policy_error ) {
return $policy_error;
}

$context = $this->resolve_handle($handle);
if ( is_wp_error($context) ) {
Expand Down Expand Up @@ -549,13 +603,18 @@ public function git_diff( string $handle, ?string $from = null, ?string $to = nu
$diff .= $this->build_unified_file_diff($changed_path, $old_content, (string) $new_content);
}

return array(
$result = array(
'success' => true,
'backend' => 'github_api',
'name' => $handle,
'repo' => $context['repo_name'],
'diff' => $diff,
);
if ( WorkspaceAliasResolver::is_context_repository($handle) ) {
$result['workspace_policy'] = WorkspaceAliasResolver::policy_attestation($handle);
}

return $result;
}

/**
Expand All @@ -569,20 +628,26 @@ public function git_status( string $handle ): array|\WP_Error {
return $context;
}

$files = array_values(array_unique(array_values( (array) $context['changed_files'])));
return array(
$files = array_values(array_unique(array_values( (array) $context['changed_files'])));
$result = array(
'success' => true,
'backend' => 'github_api',
'name' => $handle,
'repo' => $context['repo_name'],
'is_worktree' => true,
'is_worktree' => empty($context['read_only_context']),
'is_context' => ! empty($context['read_only_context']),
'path' => 'github://' . $context['repo'] . '#' . $context['branch'],
'branch' => $context['branch'],
'remote' => 'https://github.com/' . $context['repo'] . '.git',
'commit' => '' !== $context['last_commit_sha'] ? $context['last_commit_sha'] : null,
'dirty' => count($files),
'files' => $files,
);
if ( WorkspaceAliasResolver::is_context_repository($handle) ) {
$result['workspace_policy'] = WorkspaceAliasResolver::policy_attestation($handle);
}

return $result;
}

/**
Expand All @@ -591,6 +656,10 @@ public function git_status( string $handle ): array|\WP_Error {
* @return array<string,mixed>|\WP_Error
*/
public function git_add( string $handle, array $paths ): array|\WP_Error {
if ( WorkspaceAliasResolver::is_context_repository($handle) ) {
return WorkspaceAliasResolver::mutation_error($handle, 'git add');
}

$context = $this->resolve_handle($handle);
if ( is_wp_error($context) ) {
return $context;
Expand All @@ -611,6 +680,10 @@ public function git_add( string $handle, array $paths ): array|\WP_Error {
* @return array<string,mixed>|\WP_Error
*/
public function git_commit( string $handle, string $message ): array|\WP_Error {
if ( WorkspaceAliasResolver::is_context_repository($handle) ) {
return WorkspaceAliasResolver::mutation_error($handle, 'git commit');
}

$context = $this->resolve_handle($handle);
if ( is_wp_error($context) ) {
return $context;
Expand Down Expand Up @@ -1103,6 +1176,10 @@ private function group_diff_hunks( array $ops, int $context_lines ): array {
* @return array<string,mixed>|\WP_Error
*/
public function git_push( string $handle, string $remote = 'origin', ?string $branch = null ): array|\WP_Error {
if ( WorkspaceAliasResolver::is_context_repository($handle) ) {
return WorkspaceAliasResolver::mutation_error($handle, 'git push');
}

$context = $this->resolve_handle($handle);
if ( is_wp_error($context) ) {
return $context;
Expand Down Expand Up @@ -1131,6 +1208,26 @@ public function git_push( string $handle, string $remote = 'origin', ?string $br
* @return array<string,mixed>
*/
private function resolve_handle( string $handle ): array|\WP_Error {
$context_policy = WorkspaceAliasResolver::context_policy_for($handle);
if ( null !== $context_policy ) {
$repo = (string) ( $context_policy['repo'] ?? '' );
if ( '' === $repo ) {
$repo = (string) ( $context_policy['target'] ?? $handle );
}

return array(
'handle' => (string) $context_policy['alias'],
'repo_name' => (string) $context_policy['alias'],
'repo' => $repo,
'branch' => (string) ( $context_policy['ref'] ?? '' ),
'read_ref' => (string) ( $context_policy['ref'] ?? '' ),
'pending_files' => array(),
'changed_files' => array(),
'last_commit_sha' => '',
'read_only_context' => true,
);
}

$handle = $this->resolve_alias($handle);
$state = $this->state();
if ( isset($state['worktrees'][ $handle ]) ) {
Expand Down
Loading
Loading