lancepioch / tree

Connect your Github Repository to your Forge Server and Tree automatically deploys any new pull requests for you

Hi there, I'm Lance 👋

I am the Project Maintainer of Pelican.

💬 Ask me about Livewire or Pelican if you have any technical questions 👍
⚡ Fun fact, I've got 5 years of martial arts experience 🥋
📫 Feel free to email me about anything business related, here: me@[my first name].sh 📧

tree's Issues

Throttle Forge API requests due to rate limiting

Laravel Forge restricts you to 60 api requests per minute.

Suggestion: Redis::throttle

Deleting a project will fail if the webhook is already removed

If there are no Forge servers, then warn the user instead

Disable the form.

Add this red warning box:

Sorry, it doesn't appear that you have any servers set up in Laravel Forge, you must have at least 1 in order to use this functionality!

Add html patterns to inputs

https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern

Dogfooding

Run this on this repo

Utilize Batchable Jobs

Job Batching: https://laravel.com/docs/8.x/queues#job-batching

Reference:

tree/app/Jobs/SetupSite.php

Lines 72 to 80 in f807f47

	WaitForSiteInstallation::withChain([
	new InstallRepository($branch, $pullRequest),
	new WaitForRepositoryInstallation($branch),
	new SetupSql($branch),
	new DeploySite($branch),
	new WaitForSiteDeployment($branch),
	new CheckSiteDeployment($branch),
	new RemoveInitialDeployment($branch),
	])->dispatch($branch);

Replace sleeps with new jobs

tree/app/Jobs/SetupSite.php

Lines 63 to 66 in bfc6384

	while ($site->status !== 'installed') {
	sleep(5);
	$site = $forge->site($project->forge_server_id, $site->id);
	}

tree/app/Jobs/SetupSite.php

Lines 82 to 87 in bfc6384

	while ($site->repositoryStatus !== 'installed') {
	sleep(5);
	$site = $forge->site($project->forge_server_id, $site->id);
	}
	sleep(10);

tree/app/Jobs/DeploySite.php

Lines 46 to 49 in c768d0e

	while ($site->deploymentStatus !== null) {
	sleep(5);
	$site = $forge->site($project->forge_server_id, $site->id);
	}

Use release method along with $tries.

Remove references to global namespaced facades

For example, you're referencing \DB or importing use DB. Instead import Illuminate\Support\Facades\DB and reference DB.

While global references are allowed through aliases, you should import the facade explicitly. This can improve clarity not only for developers, but static analysis used by your IDE.

Upgrade to Laravel 7

https://laravel.com/docs/7.x/upgrade

Add confirmed_at for initial webhook

tree/app/Http/Controllers/Webhooks/GithubPullRequestController.php

Lines 18 to 20 in acef803

	if ($event === 'ping') {
	return response()->json('ping');
	}

View all current Pull Requests for a project

Manually deploy or undeploy these sites as needed.

Support Forge User Isolation

Be able to pause a project for deployments

Add Tests

The api calls themselves are impossible to directly test, so they have to be mocked along with making sure the jobs eventually call the right commands.

Leverage custom tree or forest config files instead of changing the defaults

You should leverage ENV variables rather than hardcode values. If you find you're adding a lot of configuration options, consider creating a domain specific config file, such as core.php. Both will make app upgrades and deployments easier.

• config/app.php
• config/filesystems.php
• config/queue.php
• config/services.php

Add input validation for projects

Update Github Api Dependency

On February 11th your application (Laravel Forest) used an access token (with the User-Agent GuzzleHttp/6.5.1 curl/7.64.0 PHP/7.3.5) as part of a query parameter to access an endpoint through the GitHub API: https://api.github.com/user

Please use the Authorization HTTP header instead as using the access_token query parameter is deprecated and will be removed July 1st, 2020.

Visit https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api/#authenticating-using-query-parameters for more information.

Thanks,
The GitHub Team

Upgrade to Laravel 8

https://laravel.com/docs/8.x/upgrade

Utilize Form Requests

https://laravel.com/docs/5.6/validation#creating-form-requests

tree/app/Http/Controllers/WebhookController.php

Lines 15 to 44 in 098e9cb

	$input = $request->input();
	$signature = $request->header('X-Hub-Signature');
	$event = $request->header('X-GitHub-Event');
	if ($event === 'ping') {
	return response()->json('ping');
	}
	abort_unless(isset($input['pull_request']), 400, 'Not a Pull Request');
	abort_unless(isset($input['repository']), 400, 'Not a Repository');
	abort_if(is_null($signature) || !str_contains($signature, '='), 400, 'Signature Required');
	[$algorithm, $signature] = explode('=', $signature, 2);
	$pullRequest = $input['pull_request'];
	$project = Project::where('github_repo', $input['repository']['full_name'])->with(['branches', 'user'])->first();
	abort_if($project === null, 400, 'Project Not Found');
	$branch = $project->branches()->where('issue_number', $pullRequest['number'])->orderBy('id', 'desc')->first();
	// Signature Verification
	$hash = hash_hmac($algorithm, $request->getContent(), $project->webhook_secret);
	abort_unless(
	$hash === $signature,
	400,
	response()->json([
	'error' => 'Signature Verification Failed',
	'hash' => $hash,
	'signature' => $signature,
	])
	);

Respond positively to the initial webhook ping

Headers:

Request URL: https://example.com/api/webhooks/github/pullrequest
Request method: POST
content-type: application/json
Expect: 
User-Agent: GitHub-Hookshot/419cd30
X-GitHub-Delivery: cfa01320-5efd-11e8-967a-7c425233ad3b
X-GitHub-Event: ping
X-Hub-Signature: sha1=fa1c581afa123f5b1036166c3bc3603922421850

Upgrade to Laravel 6

Add PHP Insights

https://phpinsights.com

Scheduled Cleanup

Every day or hour, run a job that checks each open pull request and ensures that there is a current site deployed for them and that any sites deployed are closed if their pull request has also been closed.

Enforce resource actions in controllers

⚠ The following controllers contain actions outside of the 7 resource actions (index, create, store, show, edit, update, destroy). For more details, review the docs or watch Cruddy by Design to see if you can rework these into resource controllers.

• app/Http/Controllers/Auth/LoginController.php
• app/Http/Controllers/HomeController.php
• app/Http/Controllers/WebhookController.php

Native Environment Variable Injection

Instead of this in the deployment:

sed -i -E 's/GITHUB_CLIENT_ID=.+/GITHUB_CLIENT_ID=abc123def4567890abcd/' .env

It'd be nice to have a way to just set env variables for each project.

Try Single Action Controller (Method)

https://dyrynda.com.au/blog/single-action-controllers-in-laravel

Allow repos without admin access - this requires manual webhook creation

• Create project automatically if it doesn't already exist
• Add confirmed_at for initial ping from webhook
• Add section letting users know they just have to add webhook
• Secret won't be correct, so initial ping will fail probably, need to figure this one out

tree/app/Http/Controllers/Webhooks/GithubPullRequestController.php

Lines 18 to 20 in acef803

	if ($event === 'ping') {
	return response()->json('ping');
	}

Move app\Forge to more appropriate directory

Switch from Travis to Github for testing

Make the github name optional

If the user's Github name isn't set, then the app throws an error because it depends on that. Instead use the user's email address as a backup for their name.