Support diffing against a non-existing composer.lock file #46
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -25,6 +25,9 @@ | |
| /** @var UrlGenerator */ | ||
| protected $urlGenerator; | ||
|
|
||
| /** @var bool */ | ||
| protected $skipIoErrors = false; | ||
|
|
||
| public function __construct() | ||
| { | ||
| $this->urlGenerator = new GeneratorContainer(); | ||
|
|
@@ -38,6 +41,16 @@ | |
| $this->urlGenerator = $urlGenerator; | ||
| } | ||
|
|
||
| /** | ||
| * @param bool $skipIoErrors | ||
| * | ||
| * @return void | ||
| */ | ||
| public function setSkipIoErrors($skipIoErrors) | ||
| { | ||
| $this->skipIoErrors = (bool) $skipIoErrors; | ||
|
Check warning on line 51 in src/PackageDiff.php
|
||
| } | ||
|
|
||
| /** | ||
| * @param string[] $directPackages | ||
| * @param bool $onlyDirect | ||
|
|
@@ -65,7 +78,7 @@ | |
| /** | ||
| * @return array<InstallOperation|UpdateOperation|UninstallOperation> | ||
| */ | ||
| public function getOperations(RepositoryInterface $oldPackages, RepositoryInterface $targetPackages) | ||
|
Check warning on line 81 in src/PackageDiff.php
|
||
| { | ||
| $operations = array(); | ||
|
|
||
|
|
@@ -213,28 +226,71 @@ | |
| return file_get_contents($localPath); | ||
| } | ||
|
|
||
| $attemptedSpecs = array(); | ||
| $lastError = ''; | ||
|
|
||
| foreach ($this->getGitCandidates($path, $lockFile) as $gitPath) { | ||
| $attemptedSpecs[] = $gitPath; | ||
| $output = array(); | ||
| @exec(sprintf('git show %s 2>&1', escapeshellarg($gitPath)), $output, $exit); | ||
| $outputString = implode("\n", $output); | ||
|
|
||
| if (0 !== $exit) { | ||
| $lastError = $outputString; | ||
|
|
||
| continue; | ||
| } | ||
|
|
||
| if (!$this->looksLikeJsonDocument($outputString)) { | ||
| $lastError = sprintf('Unexpected non-JSON output for git spec %s', $gitPath); | ||
|
|
||
| continue; | ||
| } | ||
|
|
||
| return $outputString; | ||
| } | ||
|
|
||
| if ($lockFile && !$this->skipIoErrors) { | ||
| throw new \RuntimeException(sprintf('Could not open file %s or find it in git as %s: %s', $originalPath, implode(', ', $attemptedSpecs), $lastError)); | ||
| } | ||
|
|
||
| /* @infection-ignore-all False-positive */ | ||
| // Do not throw exception for composer.json as it might not exist and that's fine. | ||
| // For composer.lock this fallback is optional and controlled by setSkipIoErrors(). | ||
| return '{}'; | ||
| } | ||
|
|
||
| /** | ||
| * @param string $path | ||
| * @param bool $lockFile | ||
| * | ||
| * @return string[] | ||
| */ | ||
| private function getGitCandidates($path, $lockFile = true) | ||
| { | ||
| $candidates = array(); | ||
|
|
||
| if ($lockFile) { | ||
| $candidates[] = $path; | ||
| $candidates[] = $path.self::GIT_SEPARATOR.self::COMPOSER.self::EXTENSION_LOCK; | ||
|
Owner
There was a problem hiding this comment. Previously there was a |
||
| } else { | ||
| $candidates[] = $this->getJsonPath($path); | ||
| $candidates[] = $this->getJsonPath($path.self::GIT_SEPARATOR.self::COMPOSER.self::EXTENSION_LOCK); | ||
| } | ||
|
|
||
| return array_values(array_unique($candidates)); | ||
| } | ||
|
|
||
| /** | ||
| * @param string $contents | ||
| * | ||
| * @return bool | ||
| */ | ||
| private function looksLikeJsonDocument($contents) | ||
| { | ||
| $data = json_decode($contents, true); | ||
|
|
||
| return JSON_ERROR_NONE === json_last_error() && is_array($data); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -248,6 +304,6 @@ | |
| return substr($path, 0, -strlen(self::EXTENSION_LOCK)).self::EXTENSION_JSON; | ||
| } | ||
|
|
||
| return $path; | ||
|
Check warning on line 307 in src/PackageDiff.php
|
||
| } | ||
| } | ||
This file contains hidden or 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 hidden or 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
Oops, something went wrong.
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.
This will cause decoding the json twice. Also, if the file exists but is not a well-formed JSON, I wouldn't consider it a skippable IO error and throw exception here. Let me know what you think.