From b8034d9c095bc030a63281fe59381aa2bf299cbe Mon Sep 17 00:00:00 2001
From: Michel Bardelmeijer <m.bardelmeijer@gmail.com>
Date: Mon, 30 Oct 2023 13:50:48 +0100
Subject: [PATCH] Handle invalid RDAP response

---
 README.md                              |  6 +++++-
 src/Exceptions/InvalidRdapResponse.php | 16 ++++++++++++++++
 src/Exceptions/RdapException.php       |  8 ++++++++
 src/Exceptions/RdapRequestTimedOut.php |  4 ++--
 src/Rdap.php                           |  7 +++++++
 tests/RdapTest.php                     | 17 +++++++++++++++++
 6 files changed, 55 insertions(+), 3 deletions(-)
 create mode 100644 src/Exceptions/InvalidRdapResponse.php
 create mode 100644 src/Exceptions/RdapException.php

diff --git a/README.md b/README.md
index e2a3960..14661a6 100644
--- a/README.md
+++ b/README.md
@@ -165,10 +165,14 @@ $domain = Rdap::domain('google.com'); // returns an instance of `Spatie\Rdap\Res
 
 If you pass a non-existing domain, then the `domain()` function will return `null`.
 
-## Handling timeouts
+## Handling errors
 
 Sometimes RDAP is slow in responding. If a response isn't returned in a timely manner, a `Spatie\Rdap\Exceptions\RdapRequestTimedOut` exception will be thrown.
 
+Sometimes RDAP servers return with an invalid response. If that happens, a `Spatie\Rdap\Exceptions\InvalidRdapResponse` exception will be thrown.
+
+Both exceptions implement `Spatie\Rdap\Exceptions\RdapException`. You can catch that exception to handle both cases.
+
 ## Working with RDAP DNS
 
 For each TLD a specific server is used to respond to domain queries. Such a server is called a "DNS server". The official list of all RDAP DNS server is available as JSON [here](https://data.iana.org/rdap/dns.json).
diff --git a/src/Exceptions/InvalidRdapResponse.php b/src/Exceptions/InvalidRdapResponse.php
new file mode 100644
index 0000000..406a268
--- /dev/null
+++ b/src/Exceptions/InvalidRdapResponse.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Spatie\Rdap\Exceptions;
+
+use Exception;
+use Illuminate\Http\Client\ConnectionException;
+
+class InvalidRdapResponse extends Exception implements RdapException
+{
+    public static function make(string $domain): self
+    {
+        return new static(
+            "The request to RDAP to get domain data for `{$domain}` returned a invalid response.",
+        );
+    }
+}
diff --git a/src/Exceptions/RdapException.php b/src/Exceptions/RdapException.php
new file mode 100644
index 0000000..2375bda
--- /dev/null
+++ b/src/Exceptions/RdapException.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace Spatie\Rdap\Exceptions;
+
+interface RdapException
+{
+
+}
\ No newline at end of file
diff --git a/src/Exceptions/RdapRequestTimedOut.php b/src/Exceptions/RdapRequestTimedOut.php
index 8dff93a..78eb117 100644
--- a/src/Exceptions/RdapRequestTimedOut.php
+++ b/src/Exceptions/RdapRequestTimedOut.php
@@ -5,9 +5,9 @@
 use Exception;
 use Illuminate\Http\Client\ConnectionException;
 
-class RdapRequestTimedOut extends Exception
+class RdapRequestTimedOut extends Exception implements RdapException
 {
-    public static function make(string $domain, ConnectionException $exception)
+    public static function make(string $domain, ConnectionException $exception): self
     {
         return new static(
             "The request to RDAP to get domain data for `{$domain}` timed out.",
diff --git a/src/Rdap.php b/src/Rdap.php
index dd80c13..cb92262 100755
--- a/src/Rdap.php
+++ b/src/Rdap.php
@@ -5,6 +5,7 @@
 use Illuminate\Http\Client\ConnectionException;
 use Illuminate\Http\Client\RequestException;
 use Illuminate\Support\Facades\Http;
+use Spatie\Rdap\Exceptions\InvalidRdapResponse;
 use Spatie\Rdap\Exceptions\RdapRequestTimedOut;
 use Spatie\Rdap\Responses\DomainResponse;
 
@@ -47,6 +48,12 @@ public function domain(
             throw RdapRequestTimedOut::make($domain, $exception);
         }
 
+        if (empty($response)) {
+            // Some misconfigured RDAP servers might return (invalid) HTML responses.
+            // The JSON conversion will return an empty array in that case.
+            throw InvalidRdapResponse::make($domain);
+        }
+
         return new DomainResponse($response);
     }
 
diff --git a/tests/RdapTest.php b/tests/RdapTest.php
index 022b99a..43ca5f8 100644
--- a/tests/RdapTest.php
+++ b/tests/RdapTest.php
@@ -1,6 +1,8 @@
 <?php
 
+use Illuminate\Support\Facades\Http;
 use Spatie\Rdap\CouldNotFindRdapServer;
+use Spatie\Rdap\Exceptions\InvalidRdapResponse;
 use Spatie\Rdap\Exceptions\RdapRequestTimedOut;
 use Spatie\Rdap\Rdap;
 use Spatie\Rdap\Responses\DomainResponse;
@@ -52,3 +54,18 @@
         expect($timedOut)->toBeInstanceOf(RdapRequestTimedOut::class);
     }
 });
+
+it('throws a invalid response exception if rdap servers returns invalid response', function () {
+    Http::fake([
+        'rdap.nic.io/*' => Http::response('invalid response'),
+    ]);
+
+    try {
+        $result = $this->rdap->domain('invalid-domain-response.com');
+
+        // sometimes it returns null
+        expect($result)->toBeNull();
+    } catch (InvalidRdapResponse $invalidResponse) {
+        expect($invalidResponse)->toBeInstanceOf(InvalidRdapResponse::class);
+    }
+});