Skip to content
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

add support for git repos #5

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

add support for git repos #5

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b0b1240
add support for git repos
jmcclelland Jan 23, 2023
ed47064
more sensible way to get the URL.
jmcclelland Jan 23, 2023
c339ff8
fix deprecation warnings.
jmcclelland Jan 24, 2023
12abc9f
always purge download directory.
jmcclelland Jan 24, 2023
e8aab4f
update documentation.
jmcclelland Jan 24, 2023
3cfb161
add test for git type.
jmcclelland Jan 24, 2023
6f94fa2
use composer functions when available.
jmcclelland Jan 24, 2023
8ae9f60
specifying depth limits the commits we can checkout
jmcclelland Jan 24, 2023
a943cd0
remove extra argument to sprintf
jmcclelland Jan 24, 2023
1a2da1b
we have to get all the branches
jmcclelland Jan 24, 2023
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
2 changes: 2 additions & 0 deletions src/DownloadsParser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
use LastCall\DownloadsPlugin\Handler\BaseHandler;
use LastCall\DownloadsPlugin\Handler\FileHandler;
use LastCall\DownloadsPlugin\Handler\PharHandler;
use LastCall\DownloadsPlugin\Handler\GitHandler;

class DownloadsParser
{
Expand Down Expand Up @@ -62,6 +63,7 @@ public function pickClass($extraFile)
'archive' => ArchiveHandler::CLASS,
'file' => FileHandler::CLASS,
'phar' => PharHandler::CLASS,
'git' => GitHandler::CLASS,
];
if (isset($extraFile['type'], $types[$extraFile['type']])) {
return $types[$extraFile['type']];
Expand Down
77 changes: 77 additions & 0 deletions src/Handler/GitHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
<?php

namespace LastCall\DownloadsPlugin\Handler;

use Composer\Composer;
use Composer\Config;
use Composer\IO\IOInterface;
use Composer\Util\Git;
use Composer\Util\ProcessExecutor;
use Composer\Util\Filesystem;
use React\Promise\PromiseInterface;

class GitHandler extends BaseHandler
{
const TMP_PREFIX = '.composer-extra-tmp-';

public function createSubpackage()
{
$pkg = parent::createSubpackage();
$pkg->setDistType('git');
return $pkg;
}

public function getTrackingFile()
{
$file = basename($this->extraFile['id']) . '-' . md5($this->extraFile['id']) . '.json';
return
dirname($this->getTargetPath()) .
DIRECTORY_SEPARATOR . self::DOT_DIR .
DIRECTORY_SEPARATOR . $file;
}

/**
* @param Composer $composer
* @param IOInterface $io
*/
public function download(Composer $composer, IOInterface $io) {
$urlAndVersion = $this->getSubpackage()->getDistUrl();
$config = $composer->getConfig();
$wd = $this->getTargetPath();
$process = new ProcessExecutor($io);
$cfs = new Filesystem();
$git = new Git($io, $config, $process, $cfs);
if (file_exists($wd)) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't tested, but I see these two code-paths (based on file_exists()), and it makes me imagine the following use-case:

  1. In top-level composer.json, add extra.downloads definition with a git URL.
  2. Run composer install.
  3. In top-level composer.json, edit extra.downloads and change the git commit/tag.
  4. Run composer install.

I guess the idea is that step 2 makes a new folder, and step 4 updates that same folder.

But what if that folder doesn't have any .git data? For example:

  1. In top-level composer.json, add extra.downloads definition with a zip URL.
  2. Run composer install.
  3. In top-level composer.json, edit extra.downloads definition to a git URL.
  4. Run composer install.

At step 4, shouldn't we clear out the folder before doing any git operations?

(IIRC, this only matters for extra.downloads in the top-level folder. In other contexts, there's a higher level rm -rf.)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the feedback! And yes, I agree, I think adding git support here is a better way forward than adding the alternative.

I can work on extending the test coverage.

Regarding the file_exists code paths - I added it without much thought in the interest of speed and efficiency (if we already have the directory in place and it's checked out to the same commit, we move on very quickly). However, it does sacrifice correctness in the use case you provide (and perhaps others we haven't even thought of).

I think, in the context of this extension, the .composer-downloads/<id>-<hash>.json is kinda like the composer.lock file. So, on composer install we could test for the existance of that file. If it doesn't exist and we have a folder, than rm -rf the folder and install from scratch. If it does exist, we could assume the contents properly describe the folder and run git fetch (if someone mucked with the folder git will return an error and that seems reasonable).

On composer update we would need to compare composer.json with .composer-downloads/<id>-<hash>.json. If we are moving from zip to git, then rm -rf the folder and start from scratch. If the repo URL changes, rm -rf and start from scratch, and otherwise git fetch.

Having spelled all this out, I'm leaning towards your initial suggestion of just rm -rf. I'm not sure all the added complexity is worth the small efficiency gain. Open to writing the more complex approach though if you prefer.

$gitCallable = static function ($urlAndVersion): string {
$parts = explode('@', $urlAndVersion);
$url = $parts[0];
if (count($parts) > 1) {
$version = $parts[1];
}
else {
$version = 'master';
}
return sprintf('git remote update --prune origin && git checkout %s', ProcessExecutor::escape($version));
};
}
else {
if (!file_exists($wd)) {
mkdir($wd);
}
$gitCallable = static function ($urlAndVersion): string {
print_r($urlAndVersion);
$parts = explode('@', $urlAndVersion);
$url = $parts[0];
if (count($parts) > 1) {
$version = $parts[1];
}
else {
$version = 'master';
}
return sprintf('git init && git remote add origin %s && git remote update --prune origin && git checkout %s', ProcessExecutor::escape($url), ProcessExecutor::escape($version));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For both L71 and L54 -- I think git remote update is a newer command? We don't have a good way to control the git version here. It might be safer to use something like:

  • git fetch <remote> <refspec>
  • git fetch --depth 1 <remote> <refspec>

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup - makes sense.

};
}
$git->runCommand($gitCallable, $urlAndVersion, $wd);
}

}