Laravel 11: ограничение скорости выполнения заданий, которое не должно превышать ограничение скорости внешнего API

Чтобы эффективно обрабатывать ограничения скорости Shopify API с помощью системы очередей Laravel, вам необходимо учесть несколько ключевых моментов в вашей реализации.

Пожалуйста, выполните следующие действия и надеюсь, что проблема решена:

Конфигурация ограничения первой скорости:

AppServiceProvider Конфигурация

use Illuminate\Support\Facades\RateLimiter;

public function boot(): void
{
    RateLimiter::for('shopify-api-requests', function () {
        return [
            Limit::perSecond(2)->by('shopify-api'),
            Limit::perMinute(40)->by('shopify-api'),
        ];
    });
}

Вторая Job конфигурация

Класс работы

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Log;
use Illuminate\Redis\Limit;

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

    public $endpoint;
    public $method;
    public $data;

    public function __construct(string $endpoint, string $method = 'GET', array $data = null)
    {
        $this->endpoint = $endpoint;
        $this->method = $method;
        $this->data = $data;
    }

    public function backoff(): array
    {
        return [2, 10, 20]; // Adjusted backoff times
    }

    public function tries(): int
    {
        return 5; // Increase tries to accommodate retries within the rate limits
    }

    public function middleware(): array
    {
        return [
            new RateLimited('shopify-api-requests'),
        ];
    }

    public function handle()
    {
        // Construct the full URL
        $url = 'https://' . config('settings.SHOPIFY_API_DOMAIN') . '/admin/api/' . config('settings.SHOPIFY_API_VERSION') . '/' . $this->endpoint;

        $response = Http::withHeaders([
            'X-Shopify-Access-Token' => config('settings.SHOPIFY_API_KEY'),
            'Content-Type' => 'application/json',
        ])->{$this->method}($url, $this->data);

        // Handle the response
        if ($response->failed()) {
            // Log failure
            Log::error("Shopify API Request Failed (" . $response->status() . "): " . $response->body() . " " . $url);

            // If all retries fail, log a separate error
            if ($this->attempts() >= $this->tries()) {
                Log::critical("All retries for Shopify API Request Failed: " . $url);
            }

            // Re-throw the exception to allow Laravel to handle retries
            throw new \Exception("Shopify API request failed.");
        } else {
            // Log success
            Log::info("Shopify API Request Successful");
        }
    }
}

Третья обработка Retries и Notifications

Обработка сбоев в работе

use Illuminate\Support\Facades\Notification;
use App\Notifications\JobFailedNotification;

public function failed(\Exception $exception)
{
    // Notify the admin when all retries have failed
    Notification::route('mail', config('settings.ADMIN_EMAIL'))
        ->notify(new JobFailedNotification($this->endpoint, $exception));
}

Я столкнулся с аналогичной проблемой, связанной с ограничением скорости с внешним API.

Можете ли вы удалить метод tries и добавить метод retryUntil?

public function retryUntil(): \DateTime
{
    return now()->addMinutes(Illuminate\Support\Carbon::MINUTES_PER_HOUR * 2);
}

Вот реализация My Job

<?php

namespace App\Jobs\Report\PrtgReport;

use App\Models\User;
use DateTime;
use Illuminate\Bus\Batchable;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\Middleware\WithoutOverlapping;
use Illuminate\Queue\SerializesModels;
use Illuminate\Support\Carbon;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Http;

class SendExternalRequest implements ShouldQueue
{
    use Batchable;
    use Dispatchable;
    use InteractsWithQueue;
    use Queueable;
    use SerializesModels;

    /**
     * The number of seconds the job can run before timing out.
     *
     * @var int
     */
    public $timeout = 120;

    /**
     * Create a new job instance.
     *
     * @return void
     */
    public function __construct(User $user)
    {
        //
    }

    /**
     * Execute the job.
     *
     * @return void
     */
    public function handle()
    {
        $response = Http::baseUrl('mybaseurl.com')
            ->get('test.php', []);

        if ($response->successful()) {
            //logic Goes here

        } else {
            $this->release(10);
        }
    }

    /**
     * Get the middleware the job should pass through.
     *
     * @return array<int, object>
     */
    public function middleware(): array
    {
        return [
            new APIRateLimiterMiddleware(),

            (new WithoutOverlapping(User::class.':HIT:'.$this->user->id))
                ->releaseAfter(10),
        ];
    }

    /**
     * Determine the time at which the job should timeout.
     */
    public function retryUntil(): DateTime
    {
        return now()->addMinutes(Carbon::MINUTES_PER_HOUR * 2);
    }
}

И вот промежуточное программное обеспечение, которое я использую

<?php

namespace App\Jobs\Middleware;

use App\Models\User;
use Closure;
use Illuminate\Support\Facades\Redis;

class APIRateLimiterMiddleware
{
    /**
     * Process the queued job.
     *
     * @param  \Closure(object): void  $next
     */
    public function handle(object $job, Closure $next): void
    {
        Redis::throttle('API'.':Screenshot')
            ->block(0)
            ->allow(1)
            ->every(3) // Allow 1 job every 3 seconds
            ->then(function () use ($job, $next) {
                // Lock obtained...
                $next($job);
            }, function () use ($job) {
                // Could not obtain lock...
                $job->release(3); // Release the job back to the queue after 3 seconds
            });
    }
}

Предоставленный мной код - это всего лишь образец моей реализации, пожалуйста. обязательно приспособьтесь к вашим требованиям.