v4 Abstract APIs

[rahul286]

Update

Description below is bit outdated. v4 is built using WP CLI as base. The following checklist reperesent items that v4 needs to provide at some point on its own because there is no equivalent in WP CLI.

---

After going through all options, it looks like most of our work will be around symfony/console library. But if we build based on symfony/console directly, or use laravel or something else depends on the bigger picture.

Below is list of some components and libraries we will likely need.

EE_CLI

• [x] ORM - to interact with SQLite. Laravel - https://laravel.com/docs/5.4/eloquent
• [x] Migration - to manage database changes between upgrades. Laravel - https://laravel.com/docs/5.4/migrations . Outside - https://phinx.org/ looks good. (Moved https://github.com/EasyEngine/easyengine/issues/852)
• [x] Job Queue - to put a long-running process in a job queue. Laravel - https://laravel.com/docs/5.4/queues (moved #1031)
• [x] Cron/Scheduler - a cron manager so at OS level we insert one or few cron and manage other frequents job internally. Laravel - https://laravel.com/docs/5.4/scheduling (moved to https://github.com/EasyEngine/easyengine/issues/1026 )
• [x] Email Service - a wrapper which can queue emails, send them via PHP's sendmail or an external service Amazon SES. Laravel - https://laravel.com/docs/5.4/mail
• [x] Error Logging - Local/remote destination. Level of errors/log message displayed. Laravel - https://laravel.com/docs/5.4/errors
• [ ] Notification Abstraction - Send notifications to Slack or via webhooks. Laravel - https://laravel.com/docs/5.4/notifications
• [x] Docker Wrapper - Looks good https://github.com/docker-php/docker-php (docker-php did not support docker-compose so we built own wrapper https://github.com/EasyEngine/easyengine/blob/master-v4/php/class-ee-docker.php )
• [x] Debian Package Wrapper - 404 🕵️(not required EEv4 installs all "packages" as docker image)image)
• [x] Mac Homebrew Wrapper - 404 🕵️(not required EEv4 installs all "packages" as docker image)
• [x] Hooks API - a way to inject third-party codes the same way we do it WordPress using action & filter. Seems Laravel has https://laravel.com/docs/5.4/events (Moved to https://github.com/EasyEngine/easyengine/issues/1027)
• [X] Package Manager - Similar to wp package command - http://wp-cli.org/commands/package/ (we are using WP_CLI as base so this is sorted)
• [X] Phar distribution - https://github.com/box-project/box2/ looks good (solved in https://github.com/EasyEngine/easyengine/issues/857 and https://github.com/EasyEngine/easyengine/blob/develop-v4/ci/README.md )

EE_REST_API

• [ ] Authentication Layer - Laravel - https://laravel.com/docs/5.4/passport
• [ ] Routes and command mapping - Larvel has this built-in https://laravel.com/docs/5.4/artisan#programmatically-executing-commands

EE_WEB

Web interface will be made with Laravel for sure! 😉

Common

• [x] Test frameworks - PHPUnit, Behat, etc
• [ ] Translation ready. equivalent to i18n/l10n in WordPress ecosystem

T0-DO

• [x] Finalise - if we will be using Laravel for CLI! Pros vs Cons
• [x] Build independent composer packages e.g. EEStackManager to keep EE core small and share more codes with the community

[rahul286]

Laravel - https://laracasts.com/discuss/channels/general-discussion/building-a-plugin-system

https://github.com/jumilla/laravel-extension

https://github.com/pingpong-labs/modules https://github.com/nWidart/laravel-modules https://github.com/joshbrw/laravel-module-installer

http://packalyst.com/packages/tag/modules

[buddye]

What did you guys end up deciding? Huge EE fan, but would love a system like this. Love Laravel, how can I help?

[brightidea]

Have you considered doing a Vue.js or React.js SPA for the Web interface? Laravel has awesome support for both of these libraries and with Wordpress adopting one of them (has decision been made?) it would go along with what WP developers will have to get used to... :)

I'm frontend JS developer with experience in both + wordpress and would love to help!

[robwilde]

Laravel Artisan would be fantastic. The user base is massive and by far the most popular in PHP. This will make the learning curve and adoption for others more forgivable. The more people we have utilising ee the stronger it will become, hopefully. I love ee and use it for all my development, WordPress, Laravel and Angular. Building 4 on laravel will allow me to extend it with so many fantastic ideas.

[rahul286]

@robwilde thanks for bumping the thread.

Unfortunately, Laravel and Symfony, both did not make the cut.

We choose to use WP_CLI code base as a starting point.

I will write more about this choice soon on EE blog https://easyengine.io/blog/ .

If you or anyone else can review PHP codebase, it will help.

Here are pull requests with new codebase awaiting review - https://github.com/EasyEngine/easyengine/pulls

[robwilde]

Cool, that was something I didn't think about. I am a heavy wp-cli user so happy to hear it. Will check on the pulls and see if I can help.

[rahul286]

Ironically we started with wp-cli first, then took a break, explored PHP-cli frameworks, coded mini CLI apps on them, learned few lesson, back to wp-cli! :-)

Glad to know you like wp-cli :-)

[benzon]

Dont do Vue.js or React.js, they are like NodeJS one huge slip and slide no clear direction just all over the god damn place.

if any thing has to be used it should be AngularJS, adleest there is a direction and control compared to the others.

[rahul286]

@benzon currently we are not thinking about web-interface. The goal is to get minimal CLI version ready first.

[renatonascalves]

I'm glad wp-cli was chosen! :)

[rahul286]

We went with WP-CLI. We also followed WP-CLI structure for individual commands.

Some sample below. More on the way.

https://github.com/EasyEngine/site-command https://github.com/EasyEngine/wp-command

[michacassola]

Looks like the research here is done?

[rahul286]

@michacassola yep. I need to go through checklist from issue details so we can document correctly what we are doing. Few things will need to be moved to own issues e.g. docker + cron.

[rahul286]

@michacassola Just created an issue for docker + cron https://github.com/EasyEngine/easyengine/issues/1026