Merge pull request #26 from tookantech/ImplementTimeout

[feat] handle timeout
tookantech · Apr 8, 2024 · b9af6bb · b9af6bb
2 parents ed5c45c + b840802
commit b9af6bb
Show file tree

Hide file tree

Showing 12 changed files with 79 additions and 64 deletions.
diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -7,63 +7,51 @@ on:
     branches: [main]
 
 jobs:
-  test:
+  tests:
     runs-on: ${{ matrix.os }}
     strategy:
-      fail-fast: true
+      fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest]
-        php: [8.2, 8.1, 8.0]
-        laravel: ['7.*', '8.*', '9.*', '10.*', '11.*']
-        stability: [prefer-stable]
+        os: [ubuntu-latest]
+        php: [8.3, 8.2, 8.1]
+        laravel: [10.*, 11.*]
+        dependency-version: [prefer-lowest, prefer-stable]
         include:
-          - laravel: 10.*
-            testbench: 8.*
-          - laravel: 9.*
-            testbench: 7.*
-          - laravel: 8.*
-            testbench: 6.*
-          - laravel: 7.*
-            testbench: 5.*
-          - laravel: 11.*
-            testbench: 9.*
+          -   laravel: 10.*
+              testbench: 8.*
+          -   laravel: 11.*
+              testbench: 9.*
         exclude:
-          - laravel: 10.*
-            php: 8.0
-          - laravel: 7.*
-            php: 8.2
-          - laravel: 7.*
-            php: 8.1
-          - laravel: 11.*
-            php: 8.1
-          - laravel: 11.*
-            php: 8.0
+          -   laravel: 11.*
+              php: 8.1
 
-    name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
+    name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.dependency-version }}
 
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php }}
-          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
-          coverage: none
-
-      - name: Setup problem matchers
-        run: |
-          echo "::add-matcher::${{ runner.tool_cache }}/php.json"
-          echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
-
-      - name: Install dependencies
-        run: |
-          composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" "nesbot/carbon:${{ matrix.carbon }}" --no-interaction --no-update
-          composer update --${{ matrix.stability }} --prefer-dist --no-interaction
-
-      - name: List Installed Dependencies
-        run: composer show -D
-
-      - name: Execute tests
-        run: vendor/bin/pest --ci
+      -   name: Checkout code
+          uses: actions/checkout@v4
+
+      -   name: Install SQLite 3
+          run: |
+            sudo apt-get update
+            sudo apt-get install sqlite3
+
+      -   name: Setup PHP
+          uses: shivammathur/setup-php@v2
+          with:
+            php-version: ${{ matrix.php }}
+            extensions: curl, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, iconv
+            coverage: none
+
+      -   name: Install dependencies
+          run: |
+            composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" "nesbot/carbon:>=2.62.1" --no-interaction --no-update
+            composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction
+
+      -   name: Setup Problem Matches
+          run: |
+            echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+            echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
+
+      -   name: Execute tests
+          run: vendor/bin/pest
diff --git a/composer.json b/composer.json
@@ -33,7 +33,7 @@
     },
     "require-dev": {
         "laravel/pint": "^1.0",
-        "nunomaduro/collision": "^7.9",
+        "nunomaduro/collision": "^7.9 | ^8.0",
         "nunomaduro/larastan": "^2.0.1",
         "orchestra/testbench": "^5.0|^6.0|^7.0|^8.0|^9.0",
         "pestphp/pest": "^1.22|^2.34",

diff --git a/config/chapaar.php b/config/chapaar.php
@@ -18,6 +18,16 @@
      */
     'status' => false,
 
+    /*
+     * Timeout if a server does not return a response in seconds.
+     */
+    'timeout' => env('CHAPAAR_TIMEOUT', 30),
+
+    /*
+     * Connect timeout in seconds.
+     */
+    'connect_timeout' => env('CHAPAAR_CONNECT_TIMEOUT', 0),
+
     /*
      * Define configurations for different drivers
      */

diff --git a/src/Chapaar.php b/src/Chapaar.php
@@ -53,7 +53,7 @@ public function outbox(int $page_size = 100, int $page_number = 1): object
         return $this->driver()->outbox($page_size, $page_number);
     }
 
-    protected function driver(Drivers $driver = null): DriverConnector
+    protected function driver(?Drivers $driver = null): DriverConnector
     {
         $connector = $driver
         ? Drivers::tryFrom($driver->value)->connector()

diff --git a/src/Contracts/DriverConnector.php b/src/Contracts/DriverConnector.php
@@ -21,7 +21,7 @@ public function verify($message);
 
     public function outbox($page_size = 100, $page_number = 1): object;
 
-    public function generateResponse(int $status, string $message, string $driver, array $data = null): object;
+    public function generateResponse(int $status, string $message, string $driver, ?array $data = null): object;
 
     public function generateAccountResponse($credit, $expire_date): object;
 

diff --git a/src/Drivers/Farapayamak/FarapayamakConnector.php b/src/Drivers/Farapayamak/FarapayamakConnector.php
@@ -4,6 +4,7 @@
 
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\GuzzleException;
+use GuzzleHttp\RequestOptions;
 use TookanTech\Chapaar\Contracts\DriverConnector;
 use TookanTech\Chapaar\Exceptions\ApiException;
 use TookanTech\Chapaar\Exceptions\HttpException;
@@ -21,11 +22,13 @@ public function __construct()
     {
         self::$setting = (object) config('chapaar.drivers.farapayamak');
         $this->client = new Client([
-            'headers' => [
+            RequestOptions::HEADERS => [
                 'Content-Type' => 'application/x-www-form-urlencoded',
                 'charset' => 'utf-8',
             ],
-            'http_errors' => false,
+            RequestOptions::HTTP_ERRORS => false,
+            RequestOptions::TIMEOUT => config('chapaar.timeout'),
+            RequestOptions::CONNECT_TIMEOUT => config('chapaar.connect_timeout'),
         ]);
 
     }

diff --git a/src/Drivers/Ghasedak/GhasedakConnector.php b/src/Drivers/Ghasedak/GhasedakConnector.php
@@ -4,6 +4,7 @@
 
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\GuzzleException;
+use GuzzleHttp\RequestOptions;
 use Illuminate\Http\Response;
 use TookanTech\Chapaar\Contracts\DriverConnector;
 use TookanTech\Chapaar\Exceptions\ApiException;
@@ -22,11 +23,13 @@ public function __construct()
     {
         self::$setting = (object) config('chapaar.drivers.ghasedak');
         $this->client = new Client([
-            'headers' => [
+            RequestOptions::HEADERS => [
                 'apikey' => self::$setting->api_key,
                 'cache-control' => 'no-cache',
                 'content-type' => 'application/x-www-form-urlencoded',
             ],
+            RequestOptions::TIMEOUT => config('chapaar.timeout'),
+            RequestOptions::CONNECT_TIMEOUT => config('chapaar.connect_timeout'),
         ]);
 
     }

diff --git a/src/Drivers/Kavenegar/KavenegarConnector.php b/src/Drivers/Kavenegar/KavenegarConnector.php
@@ -4,6 +4,7 @@
 
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\GuzzleException;
+use GuzzleHttp\RequestOptions;
 use Symfony\Component\HttpFoundation\Response;
 use TookanTech\Chapaar\Contracts\DriverConnector;
 use TookanTech\Chapaar\Exceptions\ApiException;
@@ -19,13 +20,15 @@ class KavenegarConnector implements DriverConnector
     public function __construct()
     {
         $this->client = (new Client([
-            'headers' => [
+            RequestOptions::HEADERS => [
                 'Accept' => 'application/json',
                 'Content-Type' => 'application/x-www-form-urlencoded',
                 'charset' => 'utf-8',
             ],
-            'verify' => false,
-            'http_errors' => false,
+            RequestOptions::VERIFY => false,
+            RequestOptions::HTTP_ERRORS => false,
+            RequestOptions::TIMEOUT => config('chapaar.timeout'),
+            RequestOptions::CONNECT_TIMEOUT => config('chapaar.connect_timeout'),
         ]));
         self::$setting = (object) config('chapaar.drivers.kavenegar');
     }

diff --git a/src/Drivers/SmsIr/SmsIrConnector.php b/src/Drivers/SmsIr/SmsIrConnector.php
@@ -4,6 +4,7 @@
 
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\GuzzleException;
+use GuzzleHttp\RequestOptions;
 use TookanTech\Chapaar\Contracts\DriverConnector;
 use TookanTech\Chapaar\Exceptions\ApiException;
 use TookanTech\Chapaar\Exceptions\HttpException;
@@ -19,11 +20,13 @@ public function __construct()
     {
         self::$setting = (object) config('chapaar.drivers.smsir');
         $this->client = new Client([
-            'headers' => [
+            RequestOptions::HEADERS => [
                 'x-api-key' => self::$setting->api_key,
                 'Accept' => 'text/plain',
                 'Content-Type' => 'application/json',
             ],
+            RequestOptions::TIMEOUT => config('chapaar.timeout'),
+            RequestOptions::CONNECT_TIMEOUT => config('chapaar.connect_timeout'),
         ]);
 
     }

diff --git a/src/Listeners/StoreSmsMessage.php b/src/Listeners/StoreSmsMessage.php
@@ -7,7 +7,7 @@
 
 class StoreSmsMessage
 {
-    public function handle(SmsSent $event)
+    public function handle(SmsSent $event): void
     {
 
         $response = $event->response;

diff --git a/src/Models/SmsMessage.php b/src/Models/SmsMessage.php
@@ -6,6 +6,11 @@
 use Illuminate\Database\Eloquent\Model;
 use TookanTech\Chapaar\Enums\Drivers;
 
+/**
+ * @property Drivers $driver
+ * @property AsCollection $data
+ * @property-write  int $status
+ */
 class SmsMessage extends Model
 {
     protected $fillable = [

diff --git a/src/SmsChannel.php b/src/SmsChannel.php
@@ -32,7 +32,7 @@ public function send($notifiable, $notification)
 
     }
 
-    protected function driver(Drivers $driver = null): DriverConnector
+    protected function driver(?Drivers $driver = null): DriverConnector
     {
         $connector = $driver
         ? Drivers::tryFrom($driver->value)->connector()