-
-
Notifications
You must be signed in to change notification settings - Fork 4.5k
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.
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
Plugin helpers for v2 #9278
Merged
Merged
Plugin helpers for v2 #9278
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
<?php | ||
|
||
namespace Composer\Util; | ||
|
||
use Composer\Downloader\DownloaderInterface; | ||
use Composer\Package\PackageInterface; | ||
use React\Promise\PromiseInterface; | ||
|
||
class SyncHelper | ||
{ | ||
/** | ||
* Helps you download + install a single package in a synchronous way | ||
* | ||
* This executes all the required steps and waits for promises to complete | ||
* | ||
* @param Loop $loop Loop instance which you can get from $composer->getLoop() | ||
* @param DownloaderInterface $downloader Downloader instance you can get from $composer->getDownloadManager()->getDownloader('zip') for example | ||
* @param string $path the installation path for the package | ||
* @param PackageInterface $package the package to install | ||
* @param PackageInterface|null $prevPackage the previous package if this is an update and not an initial installation | ||
*/ | ||
public static function downloadAndInstallPackageSync(Loop $loop, DownloaderInterface $downloader, $path, PackageInterface $package, PackageInterface $prevPackage = null) | ||
{ | ||
$type = $prevPackage ? 'update' : 'install'; | ||
|
||
try { | ||
self::await($loop, $downloader->download($package, $path, $prevPackage)); | ||
|
||
self::await($loop, $downloader->prepare($type, $package, $path, $prevPackage)); | ||
|
||
if ($type === 'update') { | ||
self::await($loop, $downloader->update($package, $path, $prevPackage)); | ||
} else { | ||
self::await($loop, $downloader->install($package, $path, $prevPackage)); | ||
} | ||
} catch (\Exception $e) { | ||
self::await($loop, $downloader->cleanup($type, $package, $path, $prevPackage)); | ||
throw $e; | ||
} | ||
|
||
self::await($loop, $downloader->cleanup($type, $package, $path, $prevPackage)); | ||
} | ||
|
||
/** | ||
* Waits for a promise to resolve | ||
* | ||
* @param Loop $loop Loop instance which you can get from $composer->getLoop() | ||
* @param PromiseInterface|null $promise | ||
*/ | ||
public static function await(Loop $loop, PromiseInterface $promise = null) | ||
{ | ||
if ($promise) { | ||
$loop->wait(array($promise)); | ||
} | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know this is not an issue with this PR, but it seems odd that we mutate the client here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah it's not ideal, but it lets people create and use a sync client without shooting themselves in the foot.