This repository was archived by the owner on Apr 2, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Adds pull command #21
Open
gcavanunez
wants to merge
10
commits into
tighten:main
Choose a base branch
from
gcavanunez:gc/pull-recipe
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
470ae76
kickstarts pull cmd
gcavanunez afaf3ea
fix composer config
gcavanunez a45338d
tweaks pull cmd
gcavanunez c1fbd88
remove recipe stubs
gcavanunez 318b09c
recurse over local recipes
gcavanunez e4bfc66
add checks to the pull command
gcavanunez ccc092f
adds the baseline LocalRecipeService
gcavanunez 49a69b7
working state
gcavanunez 39d1f67
adds local service
gcavanunez cc41e2f
adds names to the confirm
gcavanunez File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,177 @@ | ||
| <?php | ||
|
|
||
| namespace App\Commands; | ||
|
|
||
| use App\Services\LocalRecipesService; | ||
| use App\Services\MiseService; | ||
| use Illuminate\Support\Collection; | ||
| use Illuminate\Support\Facades\Process; | ||
| use LaravelZero\Framework\Commands\Command; | ||
|
|
||
| use function Laravel\Prompts\confirm; | ||
| use function Laravel\Prompts\error; | ||
| use function Laravel\Prompts\info; | ||
| use function Laravel\Prompts\multisearch; | ||
| use function Laravel\Prompts\note; | ||
| use function Laravel\Prompts\select; | ||
| use function Laravel\Prompts\table; | ||
|
|
||
| class PullCommand extends Command | ||
| { | ||
| protected $signature = | ||
| 'pull {recipe?*}' . | ||
| '{--no-process : prevent processes from executing}'; | ||
|
|
||
| protected $description = 'Pull a recipe from mise.dev'; | ||
|
|
||
| public function handle(): void | ||
| { | ||
| if ($this->option('no-process')) { | ||
| info('Dry run enabled'); | ||
| Process::fake(); | ||
| } | ||
|
|
||
| $remoteRecipes = $this->selectRemoteRecipes(); | ||
|
|
||
| $recipeDiff = $this->diffRecipes($remoteRecipes); | ||
|
|
||
| $recipesToInstall = $this->handleConflicts($recipeDiff); | ||
|
|
||
| if (empty($recipesToInstall)) { | ||
| info('No recipes to install.'); | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| foreach ($recipesToInstall as $recipe) { | ||
| $this->install($recipe); | ||
| } | ||
|
|
||
| if (confirm(sprintf('Should I apply %s?', implode(', ', $recipesToInstall)))) { | ||
| $this->call('apply', [ | ||
| 'recipe' => $recipesToInstall, | ||
| '--no-process' => $this->option('no-process'), | ||
| ]); | ||
| } | ||
| } | ||
|
|
||
| private function selectRemoteRecipes(): array | ||
| { | ||
| $selectedRemoteRecipes = $this->argument('recipe'); | ||
|
|
||
| if (empty($selectedRemoteRecipes)) { | ||
| $options = app(MiseService::class)->allForSelect(); | ||
|
|
||
| return multisearch( | ||
| 'Which recipe(s) should I pull?', | ||
| fn (string $value) => strlen($value) > 0 | ||
| ? $options->filter(fn ($option) => str_contains($option, $value))->all() | ||
| : $options->all(), | ||
| ); | ||
| } | ||
|
|
||
| if (count($missingRecipes = array_diff($selectedRemoteRecipes, app(MiseService::class)->keys()->toArray())) > 0) { | ||
| error('The following keys were not found and will be skipped'); | ||
| note(collect($missingRecipes)->map(fn ($key) => " {$key}")->implode("\n")); | ||
| } | ||
|
|
||
| return app(MiseService::class)->keys()->filter( | ||
| fn (string $key) => in_array($key, $selectedRemoteRecipes) | ||
| )->toArray(); | ||
| } | ||
|
|
||
| private function diffRecipes(array $recipeKeys): Collection | ||
| { | ||
| $miseService = app(MiseService::class)->all(); | ||
|
|
||
| return collect($recipeKeys)->map(function ($key) use ($miseService) { | ||
| $remoteRecipe = $miseService->first(fn ($recipe) => $recipe['key'] === $key); | ||
|
|
||
| $status = 'new'; | ||
|
|
||
| if (app(LocalRecipesService::class)->exists($key)) { | ||
| $localRecipe = app(LocalRecipesService::class)->findByKey($key); | ||
|
|
||
| $status = $localRecipe['integrity'] === $remoteRecipe['integrity'] && $localRecipe['version'] === $remoteRecipe['version'] | ||
| ? 'unchanged' | ||
| : 'updated'; | ||
| } | ||
|
|
||
| return [ | ||
| 'key' => $key, | ||
| 'status' => $status, | ||
| ]; | ||
| }); | ||
| } | ||
|
|
||
| private function handleConflicts(Collection $recipeAnalysis): array | ||
| { | ||
| $this->showConflictSummary($recipeAnalysis); | ||
|
|
||
| $existingRecipes = $recipeAnalysis->whereIn('status', ['unchanged', 'updated']); | ||
|
|
||
| if ($existingRecipes->isEmpty()) { | ||
| return $recipeAnalysis->pluck('key')->toArray(); | ||
| } | ||
|
|
||
| return $this->resolveConflictsInteractively($recipeAnalysis); | ||
| } | ||
|
|
||
| private function showConflictSummary(Collection $recipeAnalysis): void | ||
| { | ||
| if ($recipeAnalysis->isEmpty()) { | ||
| return; | ||
| } | ||
|
|
||
| info('Checking for conflicts...'); | ||
|
|
||
| $tableData = $recipeAnalysis->map(function ($recipe) { | ||
| $actionText = match ($recipe['status']) { | ||
| 'new' => 'Will install', | ||
| 'unchanged' => 'No changes', | ||
| 'updated' => 'Updated available', | ||
| }; | ||
|
|
||
| return [ | ||
| $recipe['key'], | ||
| ucfirst($recipe['status']), | ||
| $actionText, | ||
| ]; | ||
| })->toArray(); | ||
|
|
||
| table(['Recipe', 'Status', 'Action'], $tableData); | ||
| } | ||
|
|
||
| private function resolveConflictsInteractively(Collection $recipeAnalysis): array | ||
| { | ||
| $choice = select( | ||
| label: 'How should I handle existing recipes?', | ||
| options: [ | ||
| 'skip-unchanged' => 'Skip unchanged recipes (recommended)', | ||
| 'overwrite-all' => 'Overwrite all existing recipes', | ||
| ], | ||
| default: 'skip-unchanged' | ||
| ); | ||
|
|
||
| return match ($choice) { | ||
| 'skip-unchanged' => $recipeAnalysis->whereIn('status', ['new', 'updated'])->pluck('key')->toArray(), | ||
| 'overwrite-all' => $recipeAnalysis->pluck('key')->toArray(), | ||
| }; | ||
| } | ||
|
|
||
| private function install($key) | ||
| { | ||
| info('Installing recipe: ' . $key); | ||
|
|
||
| $data = app(MiseService::class)->findByKey($key); | ||
|
|
||
| app(LocalRecipesService::class)->install([ | ||
| 'key' => $key, | ||
| 'name' => $data->get('name'), | ||
| 'namespace' => $data->get('namespace'), | ||
| 'version' => $data->get('version'), | ||
| 'url' => $data->get('download_url'), | ||
| 'integrity' => $data->get('integrity'), | ||
| ]); | ||
| } | ||
| } | ||
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 |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| <?php | ||
|
|
||
| namespace App\Services; | ||
|
|
||
| use Exception; | ||
| use Illuminate\Support\Collection; | ||
| use Illuminate\Support\Facades\Http; | ||
| use Illuminate\Support\Facades\Storage; | ||
| use ZipArchive; | ||
|
|
||
| class LocalRecipesService | ||
| { | ||
| const Lock = 'mise-lock.json'; | ||
| const Disk = 'local-recipes'; | ||
|
|
||
| public function install($package): void | ||
| { | ||
| $response = Http::get($package['url'])->throw(); | ||
| $zipContent = $response->body(); | ||
|
|
||
| if ($this->validateIntegrity($zipContent) !== $package['integrity']) { | ||
| throw new Exception('Integrity verification failed. Downloaded file integrity check failed.'); | ||
| } | ||
|
|
||
| $this->extractRecipe($zipContent, $package['namespace']); | ||
|
|
||
| $this->updateLock($package['key'], [ | ||
| 'name' => $package['name'], | ||
| 'version' => $package['version'], | ||
| 'integrity' => $package['integrity'], | ||
| 'source' => ['url' => $package['url']], | ||
| ]); | ||
| } | ||
|
|
||
| public function all(): Collection | ||
| { | ||
| if (! $this->lockExists()) { | ||
| return collect(); | ||
| } | ||
|
|
||
| $content = Storage::disk(self::Disk)->get(self::Lock); | ||
|
|
||
| return collect(json_decode($content, true)['recipes'] ?? []); | ||
| } | ||
|
|
||
| public function findByKey(string $key): ?array | ||
| { | ||
| return $this->all()->first(fn ($recipe) => $recipe['key'] === $key); | ||
| } | ||
|
|
||
| public function exists(string $key): bool | ||
| { | ||
| return $this->all()->contains('key', $key); | ||
| } | ||
|
|
||
| private function lockExists(): bool | ||
| { | ||
| return Storage::disk(self::Disk)->exists(self::Lock); | ||
| } | ||
|
|
||
| private function validateIntegrity(string $content): string | ||
| { | ||
| return hash('sha512', $content); | ||
| } | ||
|
|
||
| private function updateLock(string $key, array $data): void | ||
| { | ||
| $lockData = $this->lockExists() ? json_decode(Storage::disk(self::Disk)->get(self::Lock), true) : ['recipes' => []]; | ||
|
|
||
| $existingIndex = collect($lockData['recipes'])->search(fn ($recipe) => $recipe['key'] === $key); | ||
|
|
||
| if (is_int($existingIndex)) { | ||
| $lockData['recipes'][$existingIndex] = array_merge(['key' => $key], $data); | ||
| } else { | ||
| $lockData['recipes'][] = array_merge(['key' => $key], $data); | ||
| } | ||
|
|
||
| Storage::disk(self::Disk)->put(self::Lock, json_encode($lockData, JSON_PRETTY_PRINT)); | ||
| } | ||
|
|
||
| private function extractRecipe($content, $namespace): void | ||
| { | ||
| $tempZipName = 'temp_recipe_' . uniqid() . '.zip'; | ||
| $tempDisk = Storage::disk('local'); | ||
| $tempDisk->put($tempZipName, $content); | ||
| $tempZipPath = $tempDisk->path($tempZipName); | ||
|
|
||
| $zip = new ZipArchive; | ||
| if ($zip->open($tempZipPath) !== true) { | ||
| $tempDisk->delete($tempZipName); | ||
| throw new Exception('Failed to open zip file.'); | ||
| } | ||
|
|
||
| $disk = Storage::disk(self::Disk); | ||
| $extractPath = $disk->path($namespace); | ||
|
|
||
| if (! $zip->extractTo($extractPath)) { | ||
| $zip->close(); | ||
| $tempDisk->delete($tempZipName); | ||
| throw new Exception('Failed to extract zip file.'); | ||
| } | ||
|
|
||
| $zip->close(); | ||
| $tempDisk->delete($tempZipName); | ||
| } | ||
| } |
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 |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| <?php | ||
|
|
||
| namespace App\Services; | ||
|
|
||
| use Illuminate\Support\Collection; | ||
| use Illuminate\Support\Facades\Http; | ||
|
|
||
| class MiseService | ||
| { | ||
| protected string $url; | ||
|
|
||
| public function __construct() | ||
| { | ||
| $this->url = config('app.mise-url'); | ||
| } | ||
|
|
||
| public function all(): Collection | ||
| { | ||
| $data = Http::get($this->url . '/api/recipes') | ||
| ->throw() | ||
| ->json('data'); | ||
|
|
||
| return collect($data); | ||
| } | ||
|
|
||
| public function findByKey(string $recipe): Collection | ||
| { | ||
| $data = Http::get($this->url . '/api/recipes/' . $recipe) | ||
| ->throw() | ||
| ->json('data'); | ||
|
|
||
| return collect($data); | ||
| } | ||
|
|
||
| public function allForSelect(): Collection | ||
| { | ||
| return $this->all()->pluck('name', 'key'); | ||
| } | ||
|
|
||
| public function keys(): Collection | ||
| { | ||
| return $this->all()->pluck('key'); | ||
| } | ||
| } |
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.
I'm never totally sure about best practices here, but is there any value in us shipping a hash of the file contents? I know people do that, but I'm trying to figure out if there's any way that helps us in this context.
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.
Have leaned into a simple
sha512integrity check, the api would return the the integrity check, and then we would also perform a hash check when we download the content/zip file