Forem: trungpv

Laravel: Why I Love Cache:remember(‘me’, fn () => ‘I Love Laravel’);

trungpv — Wed, 08 Jun 2022 08:14:38 +0000

Today I want to share you guys about the feature that I feel impress the most when I develop the Laravel app.

After few years, I think Redis is the important part I must use for every Laravel projects that I start.

Why? The Redis is very useful like: Caching, Queue… I can not name which parts or services use it. Help me comments If you know.

Talk about the use case, It easy for you guys can imagination

Today, I have an issue to improve the Laravel Sanctum that I use to authenticate the API. But the table personal_access_tokens read and write too much. So, I think it worthless in the app. You can read detail here[https://dylanbaine.com/read/scaling-laravel-sanctum]. I only show you why I love Cache:remember

Instead of make the query for every request, We can use the Cache to reduce stress on the server. I think you can not see it for the small app. But for the large app and especially when you use the AWS Lambda which cost how much you use it. It save your money :)

Example:

// Before

return static::where('token', hash('sha256', $token))->first();

// After

return Cache::remember("PersonalAccessToken::$token", 600, function () use ($token) {
    return parent::findToken($token) ?? '_null_';
});

An other use case, When you make the dashboard and counting the numbers.
But every time you access the page, It will make a query. So, for example you make a count query with the table have 30 mils records. I think it will cost few seconds and I think you do not need it in the real-time.

// Before
$usersCount = User::count();

// After
$usersCount = Cache::remember('usersCount', $seconds, function () {
    return User::count();
});

Anyway, You must read this page in the Laravel document: [https://laravel.com/docs/9.x/cache#retrieve-store]

Laravel: Use Increment IDs , UUIDs, ULIDs as primary key or optional field for the Eloquent model

trungpv — Sun, 01 May 2022 10:11:13 +0000

I think out there are too many posts that talk about this but If you see this post. Thank you for reading. I just want to share my journey and experience with it 🧐.

In the beginning, I have no idea about the pros and cons of the UUIDs and ULIDs. I know it is an idea that helps us hide the increment IDs from the end-user who can not guest it 🐣.

So, I finish all the steps on the tutorial through the internet. Or maybe my English is not good enough to understand deeply the idea 🤯.

After I use it for a few projects and practice it. I will tell you about it and I want to challenge myself to write a blog like
a habit.

Use Increment IDs , UUIDs, ULIDs

I think for the beginner you should not use it except that you must need it in the project for some reasons like hiding increment IDs, distributing database, big data...

Because I saw that it makes your DB bigger for the space, slower query, and inconvenience when we use other libraries.

👉 The answer is which one you feel happy when you work with and keep it simple that use Increment IDs

Use UUIDs, ULIDs as Primary key or Optional field

I will write down my experience and my suggestion when I use it then you guys can decide 🤓 on your project.

In the beginning, I use it as the primary key of the table. Everything is good except I need to custom the migration of the lib when I use third-party libs. But I think we will deal with some issues like slow query because I used to query chunk the table so we need to keep one field in order like the increment IDs. The disk space will be bigger compared with the Increment IDs.

Now, I think I will use the UUIDs, ULIDs like the optional field. Because we can keep the default structure of the eloquent model and we can have another unique field to adapt to the small requirement of the project.

In the end, We should use the thing in the project scope.

Laravel Filament: How to fix 403 error on production environment

trungpv — Sun, 01 May 2022 03:31:10 +0000

After I installed the Laravel Filament on my local env and very impress because It’s to easy to setup, nice UI and document.

And

then I push it on production server. The 403 page show 😄

I have no idea about it and search google. So, we miss one step which is not mention in the v2 document.

So, We need implements Filament\Models\Contracts\FilamentUser in the app/Models/User.php model and add method canAccessFilament.

<?php

namespace App\Models;

use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Laravel\Sanctum\HasApiTokens;
use Filament\Models\Contracts\FilamentUser;

class User extends Authenticatable implements FilamentUser
{
    use HasApiTokens, HasFactory, Notifiable;

    /**
     * The attributes that are mass assignable.
     *
     * @var array<int, string>
     */
    protected $fillable = [
        'name',
        'email',
        'password',
    ];

    /**
     * The attributes that should be hidden for serialization.
     *
     * @var array<int, string>
     */
    protected $hidden = [
        'password',
        'remember_token',
    ];

    /**
     * The attributes that should be cast.
     *
     * @var array<string, string>
     */
    protected $casts = [
        'email_verified_at' => 'datetime',
    ];

    public function canAccessFilament(): bool
    {
        return str_ends_with($this->email, '@xxx.com');
    }
}

Laravel: How to tracking user IP after they register or login

trungpv — Sun, 01 May 2022 03:26:15 +0000

Brainstorm

The plan is create a new column in the user table to store the user country code as the source country that user sign up from and the table to store the history of the user ip address for every day or every time user they login into the system.

We will have 2 events to trigger and store the information

After user registration
After user login and when user visit the backend for the normal user (Caching to too many action when they access the page)

Research

Now, We need to find some libs to help us do this stuff 😎. Because, I'm kind of lazy guy. Just want to take advance and help my productive.

Searching google.com and github.com then I found few libs to help us. But I saw that this one clean and the last commit just 19 days ago which mean It is good support from the creator.

https://github.com/stevebauman/location

Let's go

1. Play around



composer require stevebauman/location

Create a route to test the data first before we go deep into it



use Stevebauman\Location\Facades\Location;

Route::get('/_t', function () {
    if ($position = Location::get()) {
        // Successfully retrieved position.
        return $position;
    } else {
        // Failed retrieving position.
        return ':(';
    }
})->name('test');

Result:



{
  "ip": "66.102.0.0",
  "countryName": "United States",
  "countryCode": "US",
  "regionCode": "CA",
  "regionName": "California",
  "cityName": "Mountain View",
  "zipCode": "94043",
  "isoCode": null,
  "postalCode": null,
  "latitude": "37.422",
  "longitude": "-122.084",
  "metroCode": null,
  "areaCode": "CA",
  "timezone": "America/Los_Angeles",
  "driver": "Stevebauman\\Location\\Drivers\\IpApi"
}

As you can see, We will base on the data above to create the migration in the Laravel project.

2. Migration

Create country_code column to the users table



php artisan make:migration add_country_code_column_to_users_table



<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class AddCountryCodeColumnToUsersTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::table('users', function (Blueprint $table) {
            $table->string('country_code')->nullable()->index();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::table('users', function (Blueprint $table) {
            $table->dropColumn('country_code');
        });
    }
}

Create a history table to store user IP address



php artisan make:model UserIpAddress -m



<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class CreateUserIpAddressesTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('user_ip_addresses', function (Blueprint $table) {
            $table->id();
            $table->string('ip')->index(); // "66.102.0.0",
            $table->string("countryName")->nullable(); // "United States",
            $table->string("countryCode")->nullable(); // "US",
            $table->string("regionCode")->nullable(); // "CA",
            $table->string("regionName")->nullable(); // "California",
            $table->string("cityName")->nullable(); // "Mountain View",
            $table->string("zipCode")->nullable(); // "94043",
            $table->string("isoCode")->nullable(); // null,
            $table->string("postalCode")->nullable(); // null,
            $table->string("latitude")->nullable(); // "37.422",
            $table->string("longitude")->nullable(); // "-122.084",
            $table->string("metroCode")->nullable(); // null,
            $table->string("areaCode")->nullable(); // "CA",
            $table->string("timezone")->nullable(); // "America/Los_Angeles",
            $table->char('user_id', 26)->index();
            $table->timestamps();

            $table->index(['ip', 'user_id']);
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('user_ip_addresses');
    }
}



<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class UserIpAddress extends Model
{
    use HasFactory;

    protected $guarded = [];

    public function parseData($data)
    {
        $payload = [];

        $payload["countryName"] = $data["countryName"] ?? false;
        $payload["countryCode"] = $data["countryCode"] ?? false;
        $payload["regionCode"] = $data["regionCode"] ?? false;
        $payload["regionName"] = $data["regionName"] ?? false;
        $payload["cityName"] = $data["cityName"] ?? false;
        $payload["zipCode"] = $data["zipCode"] ?? false;
        $payload["isoCode"] = $data["isoCode"] ?? false;
        $payload["postalCode"] = $data["postalCode"] ?? false;
        $payload["latitude"] = $data["latitude"] ?? false;
        $payload["longitude"] = $data["longitude"] ?? false;
        $payload["metroCode"] = $data["metroCode"] ?? false;
        $payload["areaCode"] = $data["areaCode"] ?? false;
        $payload["timezone"] = $data["timezone"] ?? false;

        return $payload;
    }
}

3. Store Information with Laravel Events

After few years, I working with Laravel. The one I loved that the queue and especially that the Laravel Horizon is very powerful when we process parallel the tasks and jobs at the same time.

If you do not have experience about the Laravel Queue. It is a mistake when you working with the Laravel stack 🌝

So, We go into the Laravel Events. I love Laravel document. They made it very useful, clean and clear. 🎉

After I research I found 2 events we can use it which are Illuminate\Auth\Events\Registered, Illuminate\Auth\Events\Login. You can check it out in app/Providers/EventServiceProvider.php file



<?php

namespace App\Providers;

use Illuminate\Auth\Events\Registered;
use Illuminate\Auth\Events\Login;
use Illuminate\Auth\Listeners\SendEmailVerificationNotification;
use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Event;

class EventServiceProvider extends ServiceProvider
{
    /**
     * The event listener mappings for the application.
     *
     * @var array
     */
    protected $listen = [
        Registered::class => [

        ],
        Login::class => [

        ]
    ];

    /**
     * Register any events for your application.
     *
     * @return void
     */
    public function boot()
    {

    }
}

So now, I will create 2 listeners to listen those event to trigger my code and store information.

Let’s read the Laravel event document to learn how to create the listener.



php artisan make:listener LogUserIpAddressLoginListener
php artisan make:listener LogUserIpAddressRegisteredListener



<?php

namespace App\Listeners;

use App\Models\UserIpAddress;
use Illuminate\Auth\Events\Login;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\InteractsWithQueue;
use Stevebauman\Location\Facades\Location;

class LogUserIpAddressLoginListener
{
    /**
     * Create the event listener.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }

    /**
     * Handle the event.
     *
     * @param  \App\Events\Login  $event
     * @return void
     */
    public function handle(Login $event)
    {
        $user = $event->user;
        if ($user) {
            if ($position = Location::get()) {
                $userIpAddress = new UserIpAddress(
                    UserIpAddress::parseData((array) $position)
                );
                $userIpAddress->ip = $position->ip;
                $userIpAddress->user_id = $user->id;
                $userIpAddress->save();
            }
        }
    }
}



<?php

namespace App\Listeners;

use Illuminate\Auth\Events\Registered;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\InteractsWithQueue;
use Stevebauman\Location\Facades\Location;

class LogUserIpAddressRegisteredListener
{
    /**
     * Create the event listener.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }

    /**
     * Handle the event.
     *
     * @param  \App\Events\Registered  $event
     * @return void
     */
    public function handle(Registered $event)
    {
        $user = $event->user;
        if ($user) {
            if ($position = Location::get()) {
                $user->country_code = $position->countryCode;
                $user->save();
            }
        }
    }
}

Then we add 2 listeners into the EventServiceProvider



<?php

namespace App\Providers;

use App\Listeners\LogUserIpAddressLoginListener;
use App\Listeners\LogUserIpAddressRegisteredListener;
use Illuminate\Auth\Events\Registered;
use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Event;
use Illuminate\Auth\Events\Login;

class EventServiceProvider extends ServiceProvider
{
    /**
     * The event listener mappings for the application.
     *
     * @var array
     */
    protected $listen = [
        Registered::class => [
            LogUserIpAddressRegisteredListener::class
        ],
        Login::class => [
            LogUserIpAddressLoginListener::class
        ]
    ];

    /**
     * Register any events for your application.
     *
     * @return void
     */
    public function boot()
    {

    }
}

Done 🎉

If you want to make it faster and cooler that you can use the Queue (Because for the site which have big traffic and huge users that we can process it later and do not stress on the server). By implements the Illuminate\Contracts\Queue\ShouldQueue for those listeners. That’s why I <3 Laravel.

Enjoy the result.

Thanks for reading 👋