I was always looking for a quick playground for testing/debugging any PHP application esp. for Magento 2.
Luckily, I got to know about Tinkerwell App in some twitter feed and thought of giving a try.
.@tinkerwellapp + Magento 2 is a great combo. It allows me to SSH into the server and execute code on the real order object for example. In this case, i was debugging why a credit memo couldn’t get created for this order. pic.twitter.com/msS5Enx4Oc— Michiel Gerritsen (@mbdgerritsen) March 2, 2020
If you don’t know about Tinerwell app
Tinkerwell is the magical code editor that runs your code within local and remote PHP applications. In other words, it’s a RELP(read-eval-print loop) for PHP.
Though there are some tools like
- PHP’s interactive mode in CLI (php -a),
- n98-magerun’s dev:console
But the main advantage of the Tinkerwell app over others is that it can tinker locally and also remotely(via SSH). Also, it has official IDE plugins so that you can run code directly from your favorite code editor(VSCode, Sublime Text 3 and PhpStorm).
Tinkerwell is a commercial app that only costs around 15 USD and really worth it.
After purchasing, you will get an email with a link to download the app along with the license key.
After downloading you can simply install the installer file and configure the License Key, so nothing fancy about it.
Configuring for Magento 2
Currently(as the time of writing), the major PHP applications supported by Tinkerwell app are:
- Magento 2
The full list can be found at – https://github.com/tinkerwellapp/drivers
Tinkerwell “drivers” determine how the application should be bootstrapped – and can even provide variables that should be available automatically.
Since Magento 2 is supported by default, you just need to set the working directory in local or remote.
Tinkering with Magento 2 Locally
Open the app and click on the folder icon (1) and set your local Magento 2 working directory(2). That’s it.
Now, you can run/debug any Magento 2 code (core & custom) with the realtime preview on the right pane. For example, it may look like
$objectManager variable is available by default (via Magento 2 driver)
Problem: If you are getting an error
Zend_Db_Adapter_Exception with message ‘SQLSTATE[HY000]  No such file or directory’
Solution: Just replace ‘localhost’ by the IP address(127.0.0.1) for DB host in the file
Tinkering with Magento 2 Remotely (via SSH)
For remote interactive debugging, you can connect via Action (1) > Connect Via SSH. You will see a similar popup as below:
Just fill-up the SSH login details and connect(2). Now you are able to able to run the code in remote.
Though there are some alternatives, Tinkerwell works quite well locally and remotely for testing out any PHP code (not only limited to Laravel, Magento 2 or other PHP frameworks).
It’s really quite helpful in quick testing/debugging any PHP code and saves a lot of time.
You might be interested in following Twitter discussion
Question: How do you debug smartly in M2 production server?— Magento Extensions & Services (@magepsycho) April 14, 2020
Please share your views!@magento @MageOverflow @MagentoMP @max_pronko @markshust @mrloo @VinaiKopp @LBajsarowicz @PeterJaap
Happy tinkering with PHP!