Merge pull request #688 from Extra-Chill/fix/issue-687-local-workspace-precedence

Fix local workspace path precedence

Author: chubes4

inc/Abilities/WorkspaceAbilities.php

@@ -2493,14 +2493,21 @@ public static function getCapabilities( array $input ): array {   // phpcs:ignor
 	 * @return array Result.
 	 */
 	public static function showRepo( array $input ): array|\WP_Error {
+		$workspace = new Workspace();
+		if ( RemoteWorkspaceBackend::should_handle() ) {
+			$local_result = self::showLocalWorkspaceHandleIfPresent($workspace, (string) ( $input['name'] ?? '' ));
+			if ( null !== $local_result ) {
+				return $local_result;
+			}
+		}
+
 		if ( RemoteWorkspaceBackend::should_handle() ) {
 			$result = ( new RemoteWorkspaceBackend() )->show($input['name'] ?? '');
 			if ( ! self::shouldFallbackToLocalWorkspace($result) ) {
 				return $result;
 			}
 		}
 
-		$workspace = new Workspace();
 		return $workspace->show_repo($input['name'] ?? '');
 	}
 
@@ -3461,17 +3468,34 @@ public static function worktreeAdd( array $input ): array|\WP_Error {
 	 * Whether a repo argument resolves to an editable local primary checkout.
 	 */
 	private static function hasLocalPrimaryCheckout( Workspace $workspace, string $repo ): bool {
-		if ( '' === trim($repo) ) {
+		$result = self::showLocalWorkspaceHandleIfPresent($workspace, $repo);
+		if ( null === $result ) {
 			return false;
 		}
 
-		$result = $workspace->show_repo($repo);
+		$path = (string) ( $result['path'] ?? '' );
+		return ! str_contains(basename($path), '@');
+	}
+
+	/**
+	 * Return local workspace details for an existing local handle, if present.
+	 */
+	private static function showLocalWorkspaceHandleIfPresent( Workspace $workspace, string $handle ): ?array {
+		if ( '' === trim($handle) ) {
+			return null;
+		}
+
+		$result = $workspace->show_repo($handle);
 		if ( is_wp_error($result) ) {
-			return false;
+			return null;
 		}
 
 		$path = (string) ( $result['path'] ?? '' );
-		return '' !== $path && ! str_starts_with($path, 'github://') && ! str_contains(basename($path), '@');
+		if ( '' === $path || str_starts_with($path, 'github://') ) {
+			return null;
+		}
+
+		return $result;
 	}
 
 	/**

tests/smoke-workspace-local-fallback.php

@@ -22,16 +22,27 @@ class RemoteWorkspaceBackend
 	{
 		public static array $show_input = array();
 		public static array $worktree_input = array();
+		public static bool $show_returns_remote_success = false;
 		public static bool $worktree_returns_remote_success = false;
 
 		public static function should_handle(): bool
 		{
 			return true;
 		}
 
-		public function show( string $handle ): \WP_Error
+		public function show( string $handle ): array|\WP_Error
 		{
 			self::$show_input = compact('handle');
+			if ( self::$show_returns_remote_success ) {
+				return array(
+					'success'     => true,
+					'name'        => $handle,
+					'repo'        => $handle,
+					'is_worktree' => str_contains($handle, '@'),
+					'path'        => 'github://Automattic/' . str_replace('@', '#', $handle),
+				);
+			}
+
 			return new \WP_Error(
 				'remote_workspace_repo_not_found',
 				'Remote workspace repository "wpcom-codebox" is not registered. Call workspace_clone first.'
@@ -64,13 +75,17 @@ class Workspace
 		public function show_repo( string $handle ): array
 		{
 			self::$show_input = compact('handle');
+			$parsed = explode('@', $handle, 2);
+			$repo   = $parsed[0];
+			$slug   = $parsed[1] ?? '';
+			$path   = '/Users/chubes/Developer/' . $handle;
 			return array(
 				'success'     => true,
 				'name'        => $handle,
-				'repo'        => $handle,
-				'is_worktree' => false,
-				'path'        => '/Users/chubes/Developer/' . $handle,
-				'branch'      => 'main',
+				'repo'        => $repo,
+				'is_worktree' => '' !== $slug,
+				'path'        => $path,
+				'branch'      => '' !== $slug ? str_replace('-', '/', $slug) : 'main',
 				'remote'      => 'git@github.a8c.com:Automattic/wpcom-codebox.git',
 				'commit'      => 'abc123 listed primary',
 				'dirty'       => 0,
@@ -161,10 +176,31 @@ function is_wp_error( $value ): bool
 		)
 	);
 
-	$assert('remote show attempted first', 'wpcom-codebox' === ( \DataMachineCode\Workspace\RemoteWorkspaceBackend::$show_input['handle'] ?? '' ));
-	$assert('local show fallback attempted', 'wpcom-codebox' === ( \DataMachineCode\Workspace\Workspace::$show_input['handle'] ?? '' ));
+	$assert('remote show is not consulted when local primary exists', array() === \DataMachineCode\Workspace\RemoteWorkspaceBackend::$show_input);
+	$assert('local show attempted first', 'wpcom-codebox' === ( \DataMachineCode\Workspace\Workspace::$show_input['handle'] ?? '' ));
 	$assert('show returns local listed primary', is_array($show) && '/Users/chubes/Developer/wpcom-codebox' === ( $show['path'] ?? '' ));
 
+	\DataMachineCode\Workspace\RemoteWorkspaceBackend::$show_returns_remote_success = true;
+	\DataMachineCode\Workspace\RemoteWorkspaceBackend::$show_input = array();
+	\DataMachineCode\Workspace\Workspace::$show_input = array();
+	$duplicate_show = \DataMachineCode\Abilities\WorkspaceAbilities::showRepo(
+		array(
+			'name' => 'wpcom-codebox',
+		)
+	);
+
+	$assert('duplicate remote show is not consulted when local primary exists', array() === \DataMachineCode\Workspace\RemoteWorkspaceBackend::$show_input);
+	$assert('duplicate local primary wins show path', is_array($duplicate_show) && '/Users/chubes/Developer/wpcom-codebox' === ( $duplicate_show['path'] ?? '' ));
+
+	$duplicate_path = \DataMachineCode\Abilities\WorkspaceAbilities::getPath(
+		array(
+			'name' => 'wpcom-codebox@fix-listed-primary-resolution',
+		)
+	);
+
+	$assert('workspace path returns local worktree when duplicate remote exists', is_array($duplicate_path) && '/Users/chubes/Developer/wpcom-codebox@fix-listed-primary-resolution' === ( $duplicate_path['path'] ?? '' ));
+	$assert('workspace path marks local worktree handle as existing', is_array($duplicate_path) && true === ( $duplicate_path['exists'] ?? null ));
+
 	\DataMachineCode\Workspace\RemoteWorkspaceBackend::$worktree_returns_remote_success = true;
 	\DataMachineCode\Workspace\RemoteWorkspaceBackend::$worktree_input = array();
 	$worktree = \DataMachineCode\Abilities\WorkspaceAbilities::worktreeAdd(