DEV Community: Santhosh

Unable to set request header in laravel tests

Santhosh — Fri, 27 Mar 2020 16:45:39 +0000

I have a test which is trying to login and get details. I need to pass a bearer token in request header for this operation. Please see the below code. I could see that the header seldom has the headers that I set. Can anyone give me a pointer to fix this issue?

I am using Laravel 7.2.2, PHP 7.4,

And I am running php artisan test

Code:

public function a_user_can_get_details()
    {
        $this->create_user();

        $response = $this->json('POST', 
                    '/api/login', 
                    [
                        "email" => "john.doe@example.com",
                        "password" => "john123"
                    ]);
        $response->assertSuccessful();

        $token = Str::replaceLast('"', '', Str::replaceFirst('"', '', $response->getContent()));
        $headers = [
                        'Accept' => 'application/json',
                        'Content-Type' => 'application/json',
                        'Authorization' => 'Bearer ' . $token
                    ];


        $response = $this->withHeaders($headers)
                        ->get('api/user');

        $response->assertSuccessful();
        $this->assertCount(1, User::all());

    }

And here is the error I am getting. Actually, the test must pass. That is the right user name and password:

Response status code [403] is not a successful status code. Failed asserting that false is true.

  at tests/Feature/UserTest.php:141
    137|
    138|         $response = $this->withHeaders($headers)
    139|                         ->get('api/user');
    140|
  > 141|         $response->assertSuccessful();
    142|         $this->assertCount(1, User::all());
    143|
    144|     }
    145|

Written with StackEdit.

How to continuously run a Laravel queue listener on server

Santhosh — Thu, 31 Oct 2019 10:27:40 +0000

Laravel has a built-in queue management system which will help the main processing thread to ward off time taking asynchronous processes to a separate thread, also it can help the application to be scaled horizontally by adding multiple listeners/processors to simultaneously consume the queue.

In a development enviornment, we can listen to a queue by simply running

php artisan queue:listen

Where as, when we deploy this to a server, we cannot use this command. Because when we close the session, artisan command will exit. Earlier days, I was using screen command on linux to keep it running. Somehow, screen is a messy way to handle this situation.

To avoid this, we need to use a supervisor application to keep the artisan command alive.

There are many tools available to this purpose. A few of them are: forever, hypervisor, and pm2.

Here I am sharing the way how you can run artisan command using pm2.

pm2 start artisan --name QueueName --interpreter php -- queue:work --daemon

Explaining this, pm2 start will initialize artisan command. PM2 can start a named instance using --name, here QueueName will be the name of the instance. By default, commands will be run using node interpreter. So, --interpreter will set it to php. Finally, 'queue:work --daemon' is the argument to the php artisan command.

After running the above command from the laravel project root, run the following command to check the status.

pm2 list

Status must be online. If it is not, run

pm2 monit

to see the logs and take corrective actions.

Written with StackEdit.

How to create audit trail for laravel models with custom user table

Santhosh — Sun, 27 Oct 2019 15:48:41 +0000

Wherever there are entities with multiple states we would need to keep track of the changes made to the entity. Eg: A purchase order is drafted, then, quantity of the items are changed. Purchase order is sent to vendor. Purchase order is completed. Here, business owners will be interested in knowing 'Who' changed 'What' and 'When' of these changes.

There is an awesome package which can be used with Laravel to acheive this with minimal effort - Laravel Auditing. Minimum requirement is Laravel 5.8 or higher as of when I am writing this post.

Let me explain this with a blog example.

Create a new project

composer create-project laravel/laravel blog
cd blog

Create a new model for Posts and Comments

php artisan make:model Post -mcr
php artisan make:model Comment -mcr

-mcr option will create a migration and a resource controller for the model.

Now let us install the laravel Auditing package.

composer require owen-it/laravel-auditing

The above command will install laravel auditing.

To configure, edit the config/app.php and add the following to providers' array.

'providers' => [
    // ...

    OwenIt\Auditing\AuditingServiceProvider::class,

    // ...
],

Run the following commands to configure and to create audit tables:

php artisan vendor:publish --provider "OwenIt\Auditing\AuditingServiceProvider" --tag="config"
php artisan vendor:publish --provider "OwenIt\Auditing\AuditingServiceProvider" --tag="migrations"
php artisan migrate

Now, let us configure the models to start tracking the audit trails.

Edit Post.php and Comment.php to add laravel auditing traits and interfaces.

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use OwenIt\Auditing\Contracts\Auditable;

class Post extends Model implements Auditable
{
    use \OwenIt\Auditing\Auditable;

    // ...
}

Once this is done, whenever you create a Post using this model, it will create a corresponding record in the audit table. To retrieve the audit trail of a particular post, you can use the auto injected relationships of Posts.

$post = Post::with('audits')->first();  //Get the first post

The above will give you the user id of who created the post. There could be a challenge if the application is not using the default user table nor the Auth middleware. In this case, Audit will not catch the user id. Instead it will pass in a null value for user id.

Nevertheless, we have a fix for that.

In app folder, create another folder- "Resolvers" and a file inside that- "UserResolver.php".

<?php

namespace App\Resolvers;

use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Config;
use App\User;

class UserResolver implements \OwenIt\Auditing\Contracts\UserResolver
{
    /**
     * {@inheritdoc}
     */
    public static function resolve()
    {
        $guards = Config::get('audit.user.guards', [
            'web',
            'api',
        ]);
        foreach ($guards as $guard) {   
            if (Auth::guard($guard)->check()) {
                return  Auth::guard($guard)->user();
            }
            else
            {
                return User::find(config('userid', null));
            }
        }
    }
}

Now, tell Laravel Audit to resolve users using this file. For that, edit config/audit.php to have the newly created user resolved class configurations in.

'resolver' => [
        'user'       => App\Resolvers\UserResolver::class,
        'ip_address' => OwenIt\Auditing\Resolvers\IpAddressResolver::class,
        'user_agent' => OwenIt\Auditing\Resolvers\UserAgentResolver::class,
        'url'        => OwenIt\Auditing\Resolvers\UrlResolver::class,
    ],

And thats it! Auditing will work like a gem!

As always, say thanks to the package maintainers: http://laravel-auditing.com/

How to use Passport with Laravel Modules (nwidart)

Santhosh — Wed, 18 Sep 2019 03:18:58 +0000

Let me introduce these two packages for those who are new to it.

Laravel Passport:

Laravel makes API authentication a breeze using Laravel Passport, which provides a full OAuth2 server implementation for your Laravel application in a matter of minutes. Passport is built on top of the League OAuth2 server that is maintained by Andy Millington and Simon Hamp.

Note: I followed the Medium article to configure Passport - Here is the medium article for further reference.

Laravel Modules:

nwidart/laravel-modules is a Laravel package which was created to manage your large Laravel app using modules. A module is like a Laravel package, it has some views, controllers or models. This package is supported and tested in Laravel 5.

This package is a re-published, re-organised and maintained version of pingpong/modules, which isn't maintained anymore. This package is used in AsgardCMS.

When creating enterprise applications, it will be much useful to develop them as modular as possible to make it maintainable. I was going through a scenario where I have to implement a users module using Laravel Module and authentication is using Passport. Here is how I did it.

1.Start a new laravel project

composer create-project laravel/laravel my-app

For making it less clutter, I moved the default migrations out of this project. We will later be adding it back to the project under user module.

cd my-app

2. Install and configure Laravel Modules:

composer require nwidart/laravel-modules
php artisan vendor:publish --provider="Nwidart\Modules\LaravelModulesServiceProvider"

3. Add Modules folder to autoload array in composer.json:

"autoload": {
        "psr-4": {
            "App\\": "app/",
            "Modules\\": "Modules/"
        },
        "classmap": [
            "database/seeds",
            "database/factories"
        ]
    },

4. Run auto load

composer dumpautoload

5. Create Users module and model:

php artisan module:make Users
php artisan module:make-model User Users

6. Copy the migration under *my-app/Modules/Users/Database/Migrations*

We will set up the login and registration functionalities once we finish configuring the Passport.

7. Install and configure Passport:

composer require laravel/passport

8. Edit config/app.php to add Passport service provider

'providers' =>[
Laravel\Passport\PassportServiceProvider::class,
],

9. Run migrate and install - Install will create the token keys for security.

php artisan migrate
php artisan passport:install

10. Move the app/User.php to Modules/Users/Entities/User.php

11. app/Providers/AuthServiceProvider.php

<?php
namespace App\Providers;
use Laravel\Passport\Passport; 
use Illuminate\Support\Facades\Gate; 
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
class AuthServiceProvider extends ServiceProvider 
{ 
    /** 
     * The policy mappings for the application. 
     * 
     * @var array 
     */ 
    protected $policies = [ 
        'App\Model' => 'App\Policies\ModelPolicy', 
    ];
/** 
     * Register any authentication / authorization services. 
     * 
     * @return void 
     */ 
    public function boot() 
    { 
        $this->registerPolicies(); 
        Passport::routes(); 
    } 
}

12. IMPORTANT: In config/auth.php, specify the api authentication driver to passport. Also, in providers, let laravel know that we have to use the User class inside Modules to be the model. NOT the default app/User::class.

<?php
return ['guards' => [   
    'web' => [   
        'driver' => 'session',   
        'provider' => 'users',   
    ],   
    'api' => [   
        'driver' => 'passport',   
        'provider' => 'users',   
    ],   
],
.
.
.
'providers' => [
        'users' => [
            'driver' => 'eloquent',
            'model' => Modules\Users\Entities\User::class,
        ],

        // 'users' => [
        //     'driver' => 'database',
        //     'table' => 'users',
        // ],
    ],

13. Add API Routes in Modules/Users/Routes/api.php

Route::post('login', 'UsersController@login');
Route::post('register', 'UsersController@register');

14. Create Users Controller - Laravel Module will create this on its own when we create the model.

<?php

namespace Modules\Users\Http\Controllers;

use Validator;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Modules\Users\Entities\User;
use Illuminate\Routing\Controller;
use Illuminate\Support\Facades\Auth; 

class UsersController extends Controller
{
    public $successStatus = 200;

    /**
    * Handles user logins
    *
    * @return void
    */
    public function login()
    {
        if(Auth::attempt(['email' => request('email'), 'password' => request('password')])){ 
            $user = Auth::user(); 
            $success['token'] =  $user->createToken('my-app')-> accessToken; 
            return response()->json(['success' => $success], $this-> successStatus); 
        } 
        else{ 
            return response()->json(['error'=>'Unauthorised'], 401); 
        } 
    }

    /** 
     * Register api 
     * 
     * @return \Illuminate\Http\Response 
     */ 
    public function register(Request $request) 
    { 
        $validator = Validator::make($request->all(), [ 
                'name' => 'required', 
                'email' => 'required|email', 
                'password' => 'required', 
                'c_password' => 'required|same:password', 
            ]);
            if ($validator->fails()) { 
                return response()->json(['error'=>$validator->errors()], 401);            
            }
            $input = $request->all(); 
            $input['password'] = bcrypt($input['password']); 
            $user = User::create($input); 
            $success['token'] =  $user->createToken('MyApp')-> accessToken; 
            $success['name'] =  $user->name;
            return response()->json(['success'=>$success], $this-> successStatus); 
        }

        /** 
        * details api 
        * 
        * @return \Illuminate\Http\Response 
        */ 
        public function details() 
        { 
            $user = Auth::user(); 
            return response()->json(['success' => $user], $this-> successStatus); 
        } 

    }

15. In command line, run the server and you will be able to test it using Postman or Insomnia.

php artisan serve

Please feel free to ask any questions on this article. I will be happy to help. Reach me - santhoshj at gmail dot com.

Written with StackEdit.

Laravel 6 and Make Auth

Santhosh — Sat, 07 Sep 2019 08:43:03 +0000

Laravel 6 came with a hero's welcome this Tuesday. When I started to try to see how the new one is, I was straight away hit at a wall.

php artisan make:auth

Make Auth command is not anymore available in Laravel 6. But, don't worry. we are covered with a better solution for this.

New package - Laravel UI
Laravel has come up with a new package - Laravel UI which separates UI part of an application apart. This could help developers to create a server only applicaiton (API host) or a Console only application, without having the extra burden of UI attached to it.

Laravel UI can be installed with composer command:

composer create-project laravel/laravel blog
cd blog
composer require laravel/ui

Once this package is installed successfully, it gives a few new artisan commands.

➜ php artisan ui --help
Description:
  Swap the front-end scaffolding for the application

Usage:
  ui [options] [--] <type>

Arguments:
  type                   The preset type (bootstrap, vue, react)

Options:
      --auth             Install authentication UI scaffolding
      --option[=OPTION]  Pass an option to the preset command (multiple values allowed)
  -h, --help             Display this help message
  -q, --quiet            Do not output any message
  -V, --version          Display this application version
      --ansi             Force ANSI output
      --no-ansi          Disable ANSI output
  -n, --no-interaction   Do not ask any interactive question
      --env[=ENV]        The environment the command should run under
  -v|vv|vvv, --verbose   Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

UI can be initiated with either VueJS or with React.

php artisan ui vue 
php artisan ui react

For creating authentication scaffolds, add --auth to the ui command.

php artisan ui:auth
php artisan ui:auth --views

Running the first command sets up the routes and scaffolds for authentication and second one sets up the views.

Fun time's up! Let us get back to work...!