Powerful REPL for the Laravel framework.

This PR forwards things like --no-ansi and -vv to psysh in the proper way, instead of ignoring them. Once this PR is merged, we can tag tinker v2.4.0.

// cc @bobthecow

• Tinker Version: 2.6.1
• Laravel Version: 8.47.0
• PHP Version: 8.0.7
• Psy Shell: v0.10.8
• Database Driver & Version:

Description:

Tinker is not using colors, all the text is white only, this issue happened when I installed a latest version of Laravel ( 8.47.0 ), I went to try some oldest versions of Laravel ( 8.46.0 and older ) tinker worked fine, text was colored fine, what should we do?

Steps To Reproduce The Issue:

It happens whenever we create a fresh Laravel project with composer

composer create-project laravel/laravel .

Samples

cmd

cmder

needs more info 

This inconsistency took me a while to wrap my head around.

>>> dispatch(new App\Jobs\TestJob)
=> Illuminate\Foundation\Bus\PendingDispatch {#1328}
>>> exit

Expected: PendingDispatch is dispatched when the object is destructed. Actual: Doesn't dispatch.

>>> $pending = dispatch(new App\Jobs\TestJob)
=> Illuminate\Foundation\Bus\PendingDispatch {#1328}
>>> exit

This will dispatch.

I'm probably biased due to my current situation, and/or don't fully understand composer with --production.

I am trying to get my Laravel Spark application ready for production in a secure environment. Psy/psysh came up with a security issue after doing composer install --production on the project to prepare it for a security audit. I am trying to think of a use case for tinker to be used in production, and it would seem (to me anyway) that psy/psysh would be better suited to require-dev.

Am I misunderstanding how composer works? Or would it make sense to move psy/psysh to require-dev?

I'm having this error on latest Tinker and Laravel, when attempting to call artisan tinker.

In Configuration.php line 352:
                              
  [ErrorException]            
  mkdir(): Permission denied

After some investigations it turned out that Psysh is trying to mkdir /run/user/0/psysh, which is not accessible.

~~Possibly related to #33~~

It would be fantastic if tinker supported multiple line statements... because then you could just cut and paste from your code rather than having to remove newline chars before pasting... for example rather than this:

$d=DeviceCamera::with(['device'=>function($query){$query->select('devices.id as device_id', 'name as camera_name', 'slug as webcam_name')->groupBy('devices.id');},'device.device'=>function($query){$query->select('id','id as camera_id', 'camera_lens_type_id', 'settings',DB::raw("cast(settings->>'viewport_order' as int) as viewport_order"))->groupBy('id');},'deployments'=>function($query){$query->select('deployments.id as deployment_id','vessel_id')->groupBy('vessel_id')->groupBy('deployments.id');},'videos'=>function($query){$query->select('videos.id as video_id','server_id as vid_server_id',DB::raw("max(video_duration) as video_duration"),DB::raw('max(size) as size'),DB::raw('min(video_start_timestamp) as video_start_timestamp'),DB::raw('max(video_end_timestamp) as video_end_timestamp'),DB::raw('(array_agg(video_path))[1] as video_path'),'video_name')->groupBy('server_id')->groupBy('video_name');},'videos.server.device'=>function($query){$query->select('id as server_id',DB::raw("(array_agg(settings->>'fqdn'))[1] as fqdn"),DB::raw("(array_agg(settings->>'rtmp_path'))[1] as rtmp_path"));}])->get();

I could have this

$d = DeviceCamera::with([
    'device'  => function ($query) {
        $query->select(
            'devices.id as device_id', 'name as camera_name', 'slug as webcam_name'
        )->groupBy('devices.id');
    },
    'device.device' => function ($query) {
        $query->select(
            'id', 'id as camera_id', 'camera_lens_type_id', 'settings',
            DB::raw("cast(settings->>'viewport_order' as int) as viewport_order")
        )->groupBy('id');
    },
    'deployments' => function ($query) {
        $query->select(
            'deployments.id as deployment_id', 'vessel_id'
        )->groupBy('vessel_id')->groupBy('deployments.id');
    },
    'videos' => function ($query) {
        $query->select(
            'videos.id as video_id',
            'server_id as vid_server_id',
            DB::raw("max(video_duration) as video_duration"),
            DB::raw('max(size) as size'),
            DB::raw('min(video_start_timestamp) as video_start_timestamp'),
            DB::raw('max(video_end_timestamp) as video_end_timestamp'),
            DB::raw('(array_agg(video_path))[1] as video_path'),
            'video_name'
        )->groupBy('server_id')->groupBy('video_name');
    },
    'videos.server.device' => function ($query) {
        $query->select(
            'id as server_id',
            DB::raw("(array_agg(settings->>'fqdn'))[1] as fqdn"),
            DB::raw("(array_agg(settings->>'rtmp_path'))[1] as rtmp_path")
        );
    }])->get();

• Laravel Version: 5.7.16
• PHP Version: 7.3.0

Please advise if this is a PsyShell bug, in which case I will file this issue at their repo.

After upgrading PHP to 7.3.0 - latest version (and Xdebug to 2.7.0beta1 latest version compatible with PHP 7.3, in case it matters), tinker is no longer working. It launches correctly but I after I input a command it just exits with no error, nothing written to log file and status code 0.

Using Laravel Framework 5.4.23

and

name     : laravel/tinker
descrip. : Powerful REPL for the Laravel framework.
keywords : REPL, Tinker, laravel, psysh
versions : * v1.0.0
type     : library
license  : MIT License (MIT) (OSI approved) https://spdx.org/licenses/MIT.html#licenseText
source   : [git] https://github.com/laravel/tinker.git 3d5b675b55b24ccbf86395964042dbe061d5a965
dist     : [zip] https://api.github.com/repos/laravel/tinker/zipball/3d5b675b55b24ccbf86395964042dbe061d5a965 3d5b675b55b24ccbf86395964042dbe061d5a965
names    : laravel/tinker

autoload
psr-4
Laravel\Tinker\ => src/

requires
illuminate/console ~5.1
illuminate/contracts ~5.1
illuminate/support ~5.1
php >=5.5.9
psy/psysh 0.7.*|0.8.*
symfony/var-dumper ~3.0

requires (dev)
phpunit/phpunit ~4.0|~5.0

suggests
illuminate/database The Illuminate Database package (~5.1).

when i do php artisan tinker as described on Repo's README.md file i got this error:

[Symfony\Component\Console\Exception\CommandNotFoundException]
  Command "tinker" is not defined.

i tried this on an empty project from scratch and tinker is working - not on my current project

This PR adds a new 'tinker.after-loop' event, that gets fired after each execution of a command in the tinker shell while.

Example

If this gets merged, you could add this snippet to the boot method of your AppServiceProvider:

\Illuminate\Support\Facades\Event::listen('tinker.after-loop', function () {
    echo 'You just executed something through tinker!' . PHP_EOL;
});

and the following output would be generated during a tinker session:

» php artisan tinker
Psy Shell v0.10.3 (PHP 7.3.11-0ubuntu0.19.10.3 — cli) by Justin Hileman
>>> echo 'Hi GitHub' . PHP_EOL
Hi GitHub
You just executed something through tinker!
>>> echo 'Another one!' . PHP_EOL
Another one!
You just executed something through tinker!
>>>

Motivation

This enables third-parties to react to commands executed during tinker sessions. The concrete example that motivated this PR was Laravels telescope package. Executed queries, logs or model-events will not be recorded by telescope, as the application will not shut down while inside the tinker-loop. As an example that can be used for replication (executed in a fresh Laravel application with telescope installed):

» php artisan tinker
Psy Shell v0.9.12 (PHP 7.3.11-0ubuntu0.19.10.3 — cli) by Justin Hileman
>>> App\User::create(['email' => '[email protected]', 'name' => 'I will not be recorded', 'password' => 'password']);
=> App\User {#3133
     email: "[email protected]",
     name: "I will not be recorded",
     updated_at: "2020-04-10 11:49:55",
     created_at: "2020-04-10 11:49:55",
     id: 99,
   }

After you close the shell and navigate to /telescope/models, there is no entry recorded, as the ListensForStorageOpportunities-trait only handles the termination of the app and worker loops . This caused confusion in the past and could be fixed through the event implemented in this PR.

Implementation

Psy\Shell has an array of $loopListeners that listen for certain lifecycle events of the shell.

These are implementations of the Psy\ExecutionLoop\Listener-interface and can not be modified, once an instance of Psy\Shell was constructed. They are set initially to whatever getDefaultLoopListeners() returns. For this reason, I created a new Laravel\Tinker\Shell extends Psy\Shell, overwrites the getDefaultLoopListeners()-method and adds another Listener. This Laravel\Tinker\Shell\Listener\TinkerEventEmitter-Listener then publishes the 'tinker.after-loop' event in its afterLoop-method, that gets called by Psy\Shell::afterLoop.

The only modification to the existing Code is, that the TinkerCommand now needs to construct a TinkerShell instead of the standard Psy\Shell.

Notes

• I am not sure how I should add tests for this, as I did not found any existing tests that handle comparable situations. If tests are reqiured, it would be nice if someone could guide me in the right direction.
• I used the event-helper inside the TinkerEventEmitter::afterLoop-method. If this is discouraged I will change it to use $this->app['events']->dispatch or something like that.

If this gets merged, I would happily open another PR for telescope that makes the ListensForStorageOpportunities-trait also handle the 'tinker.after-loop'-event and thereby make it work more reliably with tinker.

• Tinker Version: 1.0.8
• PHP Version: 7.1.19

Description:

Tinker with either the -q (quiet) or the -n (no interaction) does not fully respect these options. Use case is an include file that echos stuff as part of a build process, but it cannot be run headless.

Steps To Reproduce:

> php artisan tinker -q prints prompt >>> and the Exit: Goodbye. message.

> php artisan tinker -n waits for interaction before exiting.

File hello_world.php:

<?php echo('Hello world!');

> php artisan tinker -qn hello_world.php pauses until exit is typed in shell.

Found some unexpected behaviour when dispatching jobs within tinker - namely jobs are dispatched the loop after you call them.

I don’t know enough about queues (or tinker!) to know why.

Psy Shell v0.8.11 (PHP 7.1.8 — cli) by Justin Hileman
>>> App\Jobs\TestJob::dispatch(1);
=> Illuminate\Foundation\Bus\PendingDispatch {#831}
>>> App\Jobs\ TestJob::dispatch(2);
string(23) "TestJob(1) actually queued"
=> Illuminate\Foundation\Bus\PendingDispatch {#825}
>>> App\Jobs\ TestJob::dispatch(3);
string(23) "TestJob(2) actually queued"
=> Illuminate\Foundation\Bus\PendingDispatch {#834}
>>> App\Jobs\ TestJob::dispatch(4);
string(23) "TestJob(3) actually queued"
=> Illuminate\Foundation\Bus\PendingDispatch {#846}
>>> $nop = true
=> true
>>> 3
=> 3
>>> sleep(1)
=> 0
>>> exit
string(23) "TestJob(4) actually queued"
Exit:  Goodbye.

The dispatching of jobs is delayed, and if you exit from tinker right after a dispatch() then the job (usually!) isn’t dispatched. (except it was in the test above!)

It's the same in Laravel 5.4 and 5.5.