Skip to content

feat: add locally-tracked guard to install and update methods in Inst… #17

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
roble merged 1 commit into from
Jun 6, 2026
Merged

feat: add locally-tracked guard to install and update methods in Inst… #17

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
24 changes: 24 additions & 0 deletions src/Installer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,16 @@ public function install(InstalledRepositoryInterface $repo, PackageInterface $pa
return \React\Promise\resolve(null);
}

if ($this->isLocallyTracked($this->getInstallPath($package))) {
$this->io->write(" - <info>Skipping install for locally tracked module:</info> {$package->getPrettyName()}");

if (! $repo->hasPackage($package)) {
$repo->addPackage(clone $package);
}

return \React\Promise\resolve(null);
}

$promise = $this->parentInstall($repo, $package);

return $promise->then(function () use ($package) {
Expand Down Expand Up @@ -540,6 +550,20 @@ public function update(InstalledRepositoryInterface $repo, PackageInterface $ini
}

$installPath = $this->getInstallPath($target);

if ($this->isLocallyTracked($installPath)) {
$this->io->write(" - <info>Skipping update for locally tracked module:</info> {$target->getPrettyName()}");

if ($repo->hasPackage($initial)) {
$repo->removePackage($initial);
}

if (! $repo->hasPackage($target)) {
$repo->addPackage(clone $target);
}

return \React\Promise\resolve(null);
}
$stashPath = null;
$basePath = null;

Expand Down
70 changes: 70 additions & 0 deletions tests/ModuleInstallerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -674,6 +674,40 @@ public function test_install_does_not_register_package_in_repo_when_already_pres
$installer->install($repo, $pkg);
}

// -------------------------------------------------------------------------
// install() locally-tracked guard (distType='zip', physical .git check)
// -------------------------------------------------------------------------

public function test_install_skips_when_install_path_is_locally_tracked(): void
{
$baseDir = sys_get_temp_dir().'/install-tracked-'.uniqid('', true);
mkdir($baseDir.'/test-module/.git', 0755, true);

$io = $this->createMock(IOInterface::class);
$io->expects($this->once())
->method('write')
->with($this->stringContains('Skipping install for locally tracked'));

$composer = $this->createStub(Composer::class);
$root = new RootPackage('root/app', '1.0.0.0', '1.0.0');
$root->setExtra(['module-dir' => $baseDir]);
$composer->method('getPackage')->willReturn($root);

$pkg = new Package('saucebase/test-module', '1.0.0.0', '1.0.0');
$pkg->setDistType('zip');

$repo = $this->createMock(InstalledRepositoryInterface::class);
$repo->method('hasPackage')->willReturn(false);
$repo->expects($this->once())->method('addPackage');

$installer = new TestableInstaller($io, $composer);
$promise = $installer->install($repo, $pkg);

$this->assertNotNull($promise);

(new Filesystem)->remove($baseDir);
}

// -------------------------------------------------------------------------
// update() path-repository guard
// -------------------------------------------------------------------------
Expand Down Expand Up @@ -797,6 +831,42 @@ public function test_uninstall_skips_remove_package_when_package_not_in_repo():
$installer->uninstall($repo, $pkg);
}

// -------------------------------------------------------------------------
// update() locally-tracked guard (distType='zip', physical .git check)
// -------------------------------------------------------------------------

public function test_update_skips_when_install_path_is_locally_tracked(): void
{
$baseDir = sys_get_temp_dir().'/update-tracked-'.uniqid('', true);
mkdir($baseDir.'/test-module/.git', 0755, true);

$io = $this->createMock(IOInterface::class);
$io->expects($this->once())
->method('write')
->with($this->stringContains('Skipping update for locally tracked'));

$composer = $this->createStub(Composer::class);
$root = new RootPackage('root/app', '1.0.0.0', '1.0.0');
$root->setExtra(['module-dir' => $baseDir]);
$composer->method('getPackage')->willReturn($root);

$initial = new Package('saucebase/test-module', '1.0.0.0', '1.0.0');
$target = new Package('saucebase/test-module', '2.0.0.0', '2.0.0');
$target->setDistType('zip');

$repo = $this->createMock(InstalledRepositoryInterface::class);
$repo->method('hasPackage')->willReturnOnConsecutiveCalls(true, false);
$repo->expects($this->once())->method('removePackage');
$repo->expects($this->once())->method('addPackage');

$installer = new TestableInstaller($io, $composer);
$promise = $installer->update($repo, $initial, $target);

$this->assertNotNull($promise);

(new Filesystem)->remove($baseDir);
}

// -------------------------------------------------------------------------
// updateCode() skip flag
// -------------------------------------------------------------------------
Expand Down