DEV Community: Ibrar Hussain

Efficient Webhook Handling in Laravel Using Unique Jobs

Ibrar Hussain — Mon, 15 Jul 2024 07:06:31 +0000

One of the Laravel projects I'm working on connects to multiple third-party applications, and we use webhooks to sync data between them.

Recently, I encountered an issue where our Laravel application was receiving multiple webhook calls from a third-party application for the same object within 10 seconds. Processing each of these calls individually is inefficient because it updates the same data in the database multiple times, draining our server and database resources, especially under high traffic.

To optimize this, we want to process only a single webhook call out of the multiple received within a 10-second window. Laravel has a built-in feature called Unique Jobs that can help us achieve this.

Here’s how we can use this feature:

First, let's define our queue job:

class UpdateProductFromWebhook implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

    public $product;

    /**
     * Create the event listener for this class.
     */
    public function __construct($product)
    {
        $this->product = $product;
    }

    /**
     * Execute the job.
     *
     * @return void
     */
    public function handle()
    {
        // Logic here
    }
}

To make this job unique, we need to implement the ShouldBeUnique interface. We also need to set the uniqueFor property to 10 seconds and define the uniqueId method to use the product ID as the unique identifier. Here’s the updated job class:

class UpdateProductFromWebhook implements ShouldQueue, ShouldBeUnique
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

     /**
     * The number of seconds after which the job's unique lock will be released.
     *
     * @var int
     */
    public $uniqueFor = 10;  // 10 seconds

    public $product;

    /**
     * The unique ID of the job.
     */
    public function uniqueId(): string
    {
        return sprintf('Product::%s', $this->product->id);
    }

    /**
     * Create the event listener for this class.
     */
    public function __construct(object $product)
    {
        $this->product = $product;
    }

    /**
     * Execute the job.
     *
     * @return void
     */
    public function handle()
    {
        // Logic here
    }
}

With these changes, the job will be unique for 10 seconds. If multiple webhook calls for the same product are received within this period, only the first one will be processed, and the rest will be ignored, thus conserving server and database resources.

This concept can be applied to your application's existing queue jobs to prevent duplicate processing and improve efficiency. By ensuring that jobs are unique within a specific time frame, you can reduce unnecessary load on your server and database, leading to better performance and resource utilization.

Installing PHP 8.0 on MacOS: Overcoming Disabled Versions

Ibrar Hussain — Tue, 06 Feb 2024 00:35:06 +0000

PHP is advancing rapidly, and now with PHP 8.3 in play, PHP 8.0 is no longer supported and not easy to install in the usual way. For instance, if you're a Valet user, you might face issues with commands like valet install php@8.0 or valet use php@8.0, and via brew, a message might appear, indicating:

Error: php@8.0 has been disabled because it is a versioned formula!

For projects still relying on PHP 8.0, follow these steps for a solution:

Step 1

brew tap shivammathur/php

Step 2

brew install shivammathur/php/php@8.0

Step 3

php -v

You should see the following result:

PHP 8.0.30 (cli) (built: Nov  7 2023 03:00:28) ( NTS )

If you need older versions, like PHP 7.3, you can follow the same steps.

Step 4

For Valet users, linking PHP 8.0 is crucial. Use this command:

valet link php@8.0

This links PHP 8.0 to Valet, enabling you to switch between PHP versions seamlessly. For instance:

valet use php@8.0

I hope this guide proves helpful for you.

Happy coding!

References:

RDS MySQL vs. Aurora: A Comprehensive Performance Guide

Ibrar Hussain — Wed, 17 Jan 2024 07:33:22 +0000

Whenever we create a new Laravel application, MySQL (community edition) is our default choice, and it might be yours too. It's easy to use and performs well. However, if your project involves substantial and growing data, you might have noticed increased response times in your APIs. In a recent effort to optimize our project and reduce API response times, we explored AWS Aurora (MySQL-Compatible) and decided to use it instead of MySQL for our production server.

Aurora is a fully managed relational database engine compatible with MySQL and PostgreSQL.

Here's a brief comparison of RDS MySQL and Aurora:

Performance Comparison

1. Read and Write Performance

MySQL:

Performance depends on the selected instance type.
Read scalability is achieved through read replicas.

Aurora:

Outperforms MySQL in read and write operations.
Its distributed architecture enhances both read and write scalability.

2. Replication

MySQL:

Replication is available, but it may impact overall performance.
Read replicas operate asynchronously.

Aurora:

Aurora Replicas provide low-latency, high-throughput read scalability.
Storage-based replication boosts overall performance.

3. Considerations for Cost Efficiency

MySQL:

Cost-effective for smaller workloads.
Suitable for applications with moderate performance requirements.

Aurora:

High performance can justify the higher cost.
Cost-efficient for large-scale, high-traffic scenarios.

Choosing Between RDS MySQL and Aurora

Consider Your Workload:

MySQL might be more cost-effective for smaller workloads.
Aurora is suitable for demanding applications with high-performance requirements.

Evaluate Your Budget:

MySQL is more budget-friendly but may have limitations in performance.
- Aurora's higher cost may be justified for applications demanding top-notch performance.

Scalability Requirements:

If seamless scalability is crucial, Aurora's automatic scaling capabilities could make it the preferred choice.

Choosing between MySQL and Aurora comes down to your application needs and budget requirements. The auto load balancing feature in Aurora adds an extra layer of reliability by seamlessly transitioning to a replica in case the main Writer instance goes down. This dynamic adaptability sets Aurora apart, ensuring uninterrupted service.

I hope this comprehensive guide provides you with the insights needed to make an informed decision aligned with your business goals.

Setup DynamoDB Docker Container for Local Development

Ibrar Hussain — Fri, 12 Jan 2024 20:41:30 +0000

DynamoDB is a powerful NoSQL database service provided by AWS. If you're developing applications that use DynamoDB, having a local environment for testing is crucial. Docker makes setting up a local DynamoDB instance for your development needs easy.

Install Docker Desktop

If you don't have Docker Desktop installed, follow these steps:

Download Docker Desktop:
Visit the Docker Desktop website and download the appropriate version for your operating system.
Install Docker Desktop:
Follow the installation instructions for your operating system.

Set Up DynamoDB with Docker

Create a Folder:

mkdir docker-workspace

Navigate to the Folder:

cd docker-workspace

Create a Docker Compose File:

touch docker-compose.yml

Open docker-compose.yml and Add the Following Content:

version: "3.7"
services:
  # DynamoDB Server
    command: "-jar DynamoDBLocal.jar -sharedDb -dbPath ./data"
    image: "amazon/dynamodb-local:latest"
    container_name: dynamodb
    ports:
      - "8000:8000"
    volumes:
      - "./docker/dynamodb:/home/dynamodblocal/data"
    working_dir: /home/dynamodblocal
    networks:
      - docker_workspace_network

Save and Close the File.
Start Docker Containers:

docker-compose up -d

Access DynamoDB Local Console

Once the Docker container is up and running, you can access the DynamoDB interface by downloading AWS NoSQL Workbench here for your operating system. Follow the instructions here for installation. On successful installation, you can add a new connection in the Operation builder section for your DynamoDB local.

Using DynamoDB in Your Application

Now that you have a local DynamoDB instance running, you can configure your application (in my case Laravel application) to use it. Update your application's DynamoDB configuration to point to localhost:8000.

DYNAMODB_HOST=http://localhost:8000

With this setup, you can develop and test your application locally with DynamoDB.

Refer to the official DynamoDB Local documentation for more advanced configurations and details.

Happy coding!

Setup Redis Docker Container to Use with Laravel App

Ibrar Hussain — Fri, 12 Jan 2024 11:07:19 +0000

If you are working on Laravel project optimization, you might have considered using cache, with Redis being a popular choice. Laravel provides support for multiple cache drivers, including Redis.

To start using Redis, you'll first need to install the phpredis package. You can do this by running the following command:

composer require predis/predis

Next, update your .env file and change the CACHE_DRIVER value to redis:

CACHE_DRIVER=redis

Now, let's set up Redis using a Docker container. If you don't have Docker Desktop installed, follow these steps:

Install Docker Desktop

Download Docker Desktop:
Visit the Docker Desktop website and download the appropriate version for your operating system.
Install Docker Desktop:
Follow the installation instructions for your operating system.

Set Up Redis with Docker

Create a Folder:

mkdir docker-workspace

Navigate to the Folder:

cd docker-workspace

Create a Docker Compose File:

touch docker-compose.yml

Open docker-compose.yml and Add the Following Content:

version: "3.7"
services:
  # Redis Server for Cache
  redis-cache:
    image: redis:latest
    restart: always
    ports:
      - "6379:6379"
    command: redis-server --save 20 1 --loglevel warning
    volumes:
      - cache:/data

volumes:
  cache:
    driver: local

Save and Close the File.
Start Docker Containers:

docker-compose up -d

With this setup, you now have a Redis server running in a Docker container, ready to be used for caching in your Laravel application.

For a more detailed guide on setting up Docker containers for other services like MySQL and Mailhog, you can refer to my previous articles (Mailhog, MySQL).

Happy coding!

Debugging Laravel: Printing SQL Queries with Ease

Ibrar Hussain — Mon, 08 Jan 2024 20:47:01 +0000

As developers working on Laravel projects, there are moments when we need to delve into the inner workings of SQL queries. Printing the SQL query along with its bindings becomes crucial for debugging or running queries in SQL editors like Sequel Ace to verify expected results.

Laravel, although not having this feature out of the box (as of Laravel 9), provides methods like toSql() for printing queries without bindings and getBindings() for printing bindings separately. Let's explore how to print them together using a simple example:

Example Query:

$query = UserModel::where('email', 'name@example.com');

Using `toSql()` and `getBindings()`:

$rawQuery = str_replace('?', "'?'", $query->toSql());
logger()->info(vsprintf(str_replace('?', '%s', $rawQuery), $query->getBindings()));

This will output:

 select * from `users` where `email` = 'name@example.com' and `users`.`deleted_at` is null

Macroable Trait for Convenience:

For a more convenient and reusable approach, you can create a Macroable Trait. In your AppServiceProvider:

Builder::macro('toSqlWithBindings', function () {
    $rawQuery = str_replace('?', "'?'", $this->toSql());

    return vsprintf(str_replace('?', '%s', $rawQuery), $this->getBindings());
});

Now, you can use it seamlessly in your code:

UserModel::where('email', 'name@example.com')->toSqlWithBindings();

This will output the same SQL query as before.

Conclusion:

By incorporating these techniques, you can easily print SQL queries with bindings, empowering you to debug and optimize your Laravel applications effectively.

Happy coding!

Simplifying Amazon Q Setup in PhpStorm

Ibrar Hussain — Sat, 30 Dec 2023 03:57:03 +0000

Engaging with generative AI-powered chatbots has never been easier! Amazon Q, a dynamic alternative to ChatGPT, seamlessly integrates into PhpStorm, offering an intuitive solution for problem-solving, content generation, and taking actions within both your AWS account and favorite editor. Let's embark on the journey of setting up Amazon Q in PhpStorm with these straightforward steps:

Today, we will go through the process of how to setup Amazon Q with PhpStorm, following are the steps:

Step 1: Open PhpStorm Settings

Navigate to the top-left menu in PhpStorm, click on PhpStorm, and select Settings.

Step 2: Access Marketplace in Plugins

Within the Settings, choose the Marketplace in the Plugins section.

Step 3: Install AWS Toolkit

Search for AWS Toolkit and click Install. After successful installation, restart PhpStorm when prompted.

Step 4: Sign into AWS Toolkit

After restarting, click on the AWS icon in the top-left panel, go to Developer Tools, and click Sign in to get started.

Step 5: Create AWS Builder ID

Create an AWS Builder ID for free and click on Connect. Follow the on-screen instructions to proceed.

Step 6: Confirm in Browser

A code will be generated; click Proceed To Browser, confirm the code in the browser, and click Confirm and continue.

Step 7: Create AWS Builder Account

Follow the steps to create an AWS Builder Account. Once created, allow AWS Toolkit for JetBrains to access your data by clicking Allow.

Completion: Amazon Q Integration in PhpStorm

Upon success, you'll see the Amazon Q panel in PhpStorm. Check Amazon Q status under Developer Tools.

You can confirm Amazon Q status by clicking on the AWS icon, then Developer Tools, and you should see the following:

You're all set! Click on Chat with Q to open the chat window.

Begin your conversational journey with Amazon Q effortlessly integrated into your PhpStorm environment!

Setting Up Amazon CodeWhisperer: Your GitHub Copilot Alternative in PhpStorm

Ibrar Hussain — Thu, 19 Oct 2023 06:57:07 +0000

As a developer, the constant task of writing code can become tiresome. To alleviate this, having a personal assistant that aids in writing code more efficiently becomes essential. This is where AI-based coding tools like GitHub Copilot and Amazon CodeWhisperer come into play.

GitHub Copilot is an excellent tool, but it comes with a paid subscription. On the other hand, its alternative, Amazon CodeWhisperer, offers two tiers: "Individual tier" and "Professional tier," with the "Individual tier" being free.

Today, we'll walk through the steps of installing the free version of Amazon CodeWhisperer in PhpStorm. Here are the steps:

Step 1:

In PhpStorm, click on the top-left menu PhpStorm, and then select Settings.

Step 2:

Choose the Marketplace in the Plugins section.

Step 3:

Search for AWS Toolkit and click Install.

After successful installation, restart the IDE when prompted.

Step 4:

After restarting, click on the AWS icon in the top-left panel, navigate to Developer Tools, and double-click Start.

A window will appear; select the first option and click the Connect button.

Step 5:

In the window, a code will be displayed. Click on Proceed to Browser.

A new window should open in a browser. Confirm that it's displaying the same code as shown in the previous window and then click Confirm and Continue.

You'll be prompted to create an AWS Builder Account.

Follow the steps to create your account. Once the account is successfully created, you'll be asked to allow AWS Toolkit for JetBrains to access your data. Click Allow.

Upon success, you'll see the following message:

Step 6:

Back in PhpStorm, you'll see a message asking you to stay connected to CodeWhisperer. Click Yes.

You can confirm CodeWhisperer status by clicking on the AWS icon, then Developer Tools, and you should see the following message:

References:

Resolving SSH Permission Denied Errors Due to OpenSSH Version Vulnerabilities

Ibrar Hussain — Sat, 25 Feb 2023 10:44:00 +0000

If you have encountered errors while using SSH, such as the ones below:

Example 1:

foo@12.34.56.789: Permission denied (publickey).

Example 2:

sign_and_send_pubkey: no mutual signature supported
foo@12.34.56.789: Permission denied (publickey).

It's possible that you may be using an older version of OpenSSH on your server that is vulnerable to the SHA-1 algorithm, which was disabled in OpenSSH version 8.8 (2021-09-26). If you're certain that you've correctly added the public key to your server, this could be the cause of the error messages.

To determine your local OpenSSH version, enter the following command:

ssh -vv local

The result should look like this:

To resolve the issue, add PubkeyAcceptedKeyTypes +ssh-rsa to your Host entry in the ~/.ssh/config file. It should look like this:

Host fooServer
PubkeyAcceptedKeyTypes +ssh-rsa
Hostname 12.34.56.789
User forge
IdentityFile=~/.ssh/id_rsa

After making these changes, try again and the issue should be resolved.

Optimizing Bitbucket Pipelines with Custom Docker Images

Ibrar Hussain — Thu, 16 Feb 2023 02:27:00 +0000

In this article, we will discuss the process of customizing an existing Docker Hub image, installing the required libraries and packages, building the new image, and pushing it to your Docker Hub account.

Suppose your project requires the Docker Hub image php:8.0.26-cli for your Bitbucket pipeline, but the installation of required libraries and packages, such as composer, git, curl, rsync, zip, mysql-client, gd, and grpc, is taking too long. In such a situation, you need to create a custom image and pre-install all the required packages, which will reduce the pipeline build time.

Here are the steps to create a custom Docker image:

Make sure that you have installed Docker Client, if not, then you need to install it first.
Create a new folder foo-custom-image.
Inside this folder create a new file Dockerfile.
Open the Dockerfile and add the following:

From php:8.0.26-cli

RUN apt-get update && apt-get install -qy \
        unzip \
        git \
        curl \
        rsync \
        libmcrypt-dev \
        libzip-dev \
        zip \
        default-mysql-client \
        libfreetype6-dev \
        libjpeg62-turbo-dev \
        libpng-dev \
        zlib1g-dev

RUN curl -sSLf \
        -o /usr/local/bin/install-php-extensions \
        https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions && \
    chmod +x /usr/local/bin/install-php-extensions && \
    install-php-extensions grpc-1.45.0

RUN docker-php-ext-configure gd --with-freetype --with-jpeg \
    && docker-php-ext-install pdo_mysql zip gd

RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer

Save and close the file.
Login to your Docker Hub account using the command docker login. This command will ask for your credentials, and if all goes well, then you will get a success message
Build the docker image using the following command:

docker image build --platform linux/amd64 -t foobar/custom-cicd-php-8-cli:1.0.0 ./

In the above command:

foobar should be replaced with your Docker Hub account username.
custom-cicd-php-8-cli is the name of the image, which can be changed to anything.
1.0.0 is the tag version

NOTE: This command can take up to 45 minutes, as grpc take quite a long time to install.

Once build is successfully finished, you can push the image to your Docker Hub account using the following command:

docker push foobar/custom-cicd-php-8-cli:1.0.0

Upon successful push, confirm the changes in Docker Hub account.
You can delete your local docker image(s) by following these steps:
- Run docker images to list the images on your local machine.
- From the list, copy the Image ID for your docker image that you want to delete.
- Run docker rmi [Image ID]
- This command should delete the docker image with provided Image ID
Once everything is ready, now you can use this custom image in your Bitbucket pipeline and test your pipeline for build time.

How to Upgrade MySQL 5.7 to 8.0 on Mac

Ibrar Hussain — Tue, 10 Jan 2023 22:54:29 +0000

As new versions of MySQL are coming out, at one point you will need to upgrade your MySQL version as well.

In this article, we will assume that we are using MySQL 5.7 for your local development on Mac and want to upgrade it the latest version (MySQL 8.0).

Followings are the steps to follow:

Step # 1

Make sure to do database dump for all of your databases, as you will need these to re-import it again when MySQL is successfully upgraded.

Step # 2

Confirm that your running MySQL 5.7 via the following command:

brew services list

this should show the mysql with 5.7 version running.

Before you start upgrading process, make sure to double-check that your existing MySQL 5.7 setup ticks all the boxes on the sanity checklist before upgrading to MySQL 8.0.

You can do it by running the following command:

mysqlcheck -u root -p --all-databases --check-upgrade

The above command should OK for all without any errors.

Step # 3

Check for MySQL processes via the following command:

ps -ax | grep mysql

Stop and kill any MySQL processes via the following command:

kill {PID}

Step # 4

Take a backup of my.cnf located at: /usr/local/etc/my.cnf

and remove this file via command: rm /usr/local/etc/my.cnf

Step # 5

Uninstall MySQL via the following command:

brew remove mysql
brew cleanup

You can confirm the uninstall by running brew services list and there should not be mysql listed

Step # 6

Install latest version 8.0 of the MySQL:

brew install mysql
brew services start mysql

Once done, you can confirm the version of the MySQL by running the command: mysql --version which should show the latest version of the MySQL

Step # 7

Setup default root password with the following command:

mysql_secure_installation

It should prompt you steps like the following screenshot:

Step # 8

Connect to mysql via Sequel Ace

and create any relevant databases and import them from your previous backup dump.

How to fix Nginx symlink caching issue

Ibrar Hussain — Tue, 13 Dec 2022 07:17:59 +0000

Let's assume that you have a Laravel application running through nginx and pointing to the current folder which is symlink of the latest release folder you have.

root /home/foo/domain.com.au/current/public;

If you update your symlink for the current to a new release, your application will still be point to the older release.

To resolve this, add the following lines to your nginx file after include fastcgi_params;

fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
fastcgi_param DOCUMENT_ROOT $realpath_root;

and it should look this:

Now, if you change/update the symlink it should be working properly, and point to the correct release folder.

DEV Community: Ibrar Hussain

Efficient Webhook Handling in Laravel Using Unique Jobs

Installing PHP 8.0 on MacOS: Overcoming Disabled Versions

Step 1

Step 2

Step 3

Step 4

RDS MySQL vs. Aurora: A Comprehensive Performance Guide

Performance Comparison

1. Read and Write Performance

2. Replication

3. Considerations for Cost Efficiency

Choosing Between RDS MySQL and Aurora

Setup DynamoDB Docker Container for Local Development

Install Docker Desktop

Set Up DynamoDB with Docker

Access DynamoDB Local Console

Using DynamoDB in Your Application

Setup Redis Docker Container to Use with Laravel App

Install Docker Desktop

Set Up Redis with Docker

Debugging Laravel: Printing SQL Queries with Ease

Example Query:

Using toSql() and getBindings():

Macroable Trait for Convenience:

Conclusion:

Simplifying Amazon Q Setup in PhpStorm

Step 1: Open PhpStorm Settings

Step 2: Access Marketplace in Plugins

Step 3: Install AWS Toolkit

Step 4: Sign into AWS Toolkit

Step 5: Create AWS Builder ID

Step 6: Confirm in Browser

Step 7: Create AWS Builder Account

Completion: Amazon Q Integration in PhpStorm

Setting Up Amazon CodeWhisperer: Your GitHub Copilot Alternative in PhpStorm

Step 1:

Step 2:

Step 3:

Step 4:

Step 5:

Step 6:

Resolving SSH Permission Denied Errors Due to OpenSSH Version Vulnerabilities

Optimizing Bitbucket Pipelines with Custom Docker Images

How to Upgrade MySQL 5.7 to 8.0 on Mac

Step # 1

Step # 2

Step # 3

Step # 4

Step # 5

Step # 6

Step # 7

Step # 8

How to fix Nginx symlink caching issue

Using `toSql()` and `getBindings()`: