Added ability to abort with details fixed minor issues with abort and…

… client getting abort details
voryx · Jan 26, 2016 · 442b2b8 · 442b2b8
1 parent d199224
commit 442b2b8
Show file tree

Hide file tree

Showing 7 changed files with 171 additions and 8 deletions.
diff --git a/src/Thruway/Authentication/AuthenticationManager.php b/src/Thruway/Authentication/AuthenticationManager.php
@@ -272,7 +272,7 @@ private function onHelloAuthHandler($authMethod, $authMethodInfo, Realm $realm,
             // this is handling the return of the onhello RPC call
 
             if (isset($res[0]) && $res[0] == "FAILURE") {
-                $session->abort(new \stdClass(), "thruway.error.authentication_failure");
+                $this->abortSessionUsingResponse($session, $res);
 
                 return;
             }
@@ -315,7 +315,7 @@ private function onHelloAuthHandler($authMethod, $authMethodInfo, Realm $realm,
 
         $onHelloError = function () use ($session) {
             Logger::error($this, "onhello rejected the promise");
-            $session->abort("thruway.error.unknown");
+            $session->abort(new \stdClass(), "thruway.error.unknown");
         };
 
         $onHelloAuthHandler = $authMethodInfo['handlers']->onhello;
@@ -408,14 +408,16 @@ private function onAuthenticateHandler($authMethod, $authMethodInfo, Realm $real
                 $session->setAuthenticated(true);
                 $session->sendMessage(new WelcomeMessage($session->getSessionId(), $welcomeDetails));
 
+            } elseif (isset($res[0]) && $res[0] == "FAILURE") {
+                $this->abortSessionUsingResponse($session, $res);
             } else {
                 $session->abort(new \stdClass(), "thruway.error.authentication_failure");
             }
         };
 
         $onAuthenticateError = function () use ($session) {
             Logger::error($this, "onauthenticate rejected the promise");
-            $session->abort("thruway.error.unknown");
+            $session->abort(new \stdClass(), "thruway.error.unknown");
         };
 
         $extra                    = new \stdClass();
@@ -574,4 +576,38 @@ public function readyToAuthenticate()
         return $this->getReady();
     }
 
+    /**
+     * Send an abort message to the session if the Authenticator sent a FAILURE response
+     * Returns true if the abort was sent, false otherwise
+     *
+     * @param Session $session
+     * @param $response
+     * @return bool
+     * @throws \Exception
+     */
+    private function abortSessionUsingResponse(Session $session, $response) {
+        // $response needs to be a failure
+        if (!isset($response[0]) || $response[0] !== 'FAILURE') {
+            return false;
+        }
+
+        if (!isset($response[1]) || !is_object($response[1])) {
+            // there are no other details to send - just fail it
+            $session->abort(new \stdClass(), "thruway.error.authentication_failure");
+            return true;
+        }
+
+        $details = new \stdClass();
+        if (isset($response[1]->details) && is_object($response[1]->details)) {
+            $details = $response[1]->details;
+        }
+
+        $abortUri = "thruway.error.authentication_failure";
+        if (isset($response[1]->abort_uri) && is_scalar($response[1]->abort_uri)) {
+            $abortUri = $response[1]->abort_uri;
+        }
+
+        $session->abort($details, $abortUri);
+        return true;
+    }
 }
diff --git a/src/Thruway/Connection.php b/src/Thruway/Connection.php
@@ -151,8 +151,8 @@ private function handleOnClose()
      */
     private function handleOnError()
     {
-        $this->client->on('error', function ($reason) {
-            $this->emit('error', [$reason]);
+        $this->client->on('error', function () {
+            $this->emit('error', func_get_args());
         });
     }
 

diff --git a/src/Thruway/Peer/Client.php b/src/Thruway/Peer/Client.php
@@ -365,7 +365,7 @@ public function processWelcome(ClientSession $session, WelcomeMessage $msg)
      */
     public function processAbort(ClientSession $session, AbortMessage $msg)
     {
-        $this->emit('error', [$msg->getResponseURI()]);
+        $this->emit('error', [$msg->getResponseURI(), $msg]);
         $session->shutdown();
     }
 

diff --git a/tests/Clients/AbortAfterAuthenticateWithDetailsAuthProviderClient.php b/tests/Clients/AbortAfterAuthenticateWithDetailsAuthProviderClient.php
@@ -0,0 +1,24 @@
+<?php
+
+class AbortAfterAuthenticateWithDetailsAuthProviderClient extends \Thruway\Authentication\AbstractAuthProviderClient {
+    /**
+     * @return string
+     */
+    public function getMethodName()
+    {
+        return 'abortafterauthenticatewithdetails';
+    }
+
+    public function preProcessAuthenticate(array $args) {
+        return [
+            "FAILURE",
+            [
+                "abort_uri" => "my.custom.abort.uri.2",
+                "details" => [
+                    "message" => "My custom abort message 2"
+                ]
+            ]
+        ];
+    }
+
+} 
diff --git a/tests/Clients/AbortAfterHelloWithDetailsAuthProviderClient.php b/tests/Clients/AbortAfterHelloWithDetailsAuthProviderClient.php
@@ -0,0 +1,24 @@
+<?php
+
+class AbortAfterHelloWithDetailsAuthProviderClient extends \Thruway\Authentication\AbstractAuthProviderClient {
+    /**
+     * @return string
+     */
+    public function getMethodName()
+    {
+        return 'abortafterhellowithdetails';
+    }
+
+    public function processHello(array $args) {
+        return [
+            "FAILURE",
+            [
+                "abort_uri" => "my.custom.abort.uri",
+                "details" => [
+                    "message" => "My custom abort message"
+                ]
+            ]
+        ];
+    }
+
+} 
diff --git a/tests/TestServer.php b/tests/TestServer.php
@@ -3,7 +3,9 @@
 require_once __DIR__ . '/bootstrap.php';
 require_once __DIR__ . '/Clients/InternalClient.php';
 require_once __DIR__ . '/Clients/SimpleAuthProviderClient.php';
+require_once __DIR__ . '/Clients/AbortAfterAuthenticateWithDetailsAuthProviderClient.php';
 require_once __DIR__ . '/Clients/AbortAfterHelloAuthProviderClient.php';
+require_once __DIR__ . '/Clients/AbortAfterHelloWithDetailsAuthProviderClient.php';
 require_once __DIR__ . '/Clients/DisclosePublisherClient.php';
 require_once __DIR__ . '/Clients/QueryParamAuthProviderClient.php';
 require_once __DIR__ . '/UserDb.php';
@@ -49,7 +51,8 @@
 
 // provide aborting auth provider
 $router->addInternalClient(new AbortAfterHelloAuthProviderClient(["abortafterhello"]));
-
+$router->addInternalClient(new AbortAfterHelloWithDetailsAuthProviderClient(["abortafterhellowithdetails"]));
+$router->addInternalClient(new AbortAfterAuthenticateWithDetailsAuthProviderClient(["aaawd"]));
 
 $router->addInternalClient(new QueryParamAuthProviderClient(["query_param_auth_realm"]));
 

diff --git a/tests/WAMP/AbortingRouterTest.php b/tests/WAMP/AbortingRouterTest.php
@@ -10,6 +10,8 @@ public function testAbortFollowingHello() {
                 "realm" => 'abortafterhello',
                 "url" => 'ws://127.0.0.1:8090',
                 "max_retries" => 0,
+                "authmethods" => ["abortafterhello"],
+                "onChallenge" => function () {}
             )
         );
 
@@ -30,6 +32,80 @@ function ($reason) {
 
         $this->_conn->open();
 
-        $this->assertEquals("wamp.error.not_authorized", $this->_testResult);
+        $this->assertEquals("thruway.error.authentication_failure", $this->_testResult);
+    }
+
+    public function testAbortFollowingHelloWithDetails() {
+        $this->_testResult = null;
+        $this->_error = null;
+
+        $this->_conn = new \Thruway\Connection(
+            array(
+                "realm" => 'abortafterhellowithdetails',
+                "url" => 'ws://127.0.0.1:8090',
+                "max_retries" => 0,
+                "authmethods" => ["abortafterhellowithdetails"],
+                "onChallenge" => function () {}
+            )
+        );
+
+        $this->_conn->on(
+            'open',
+            function (\Thruway\ClientSession $session) {
+                $this->_testResult = "connection opened.";
+                $this->_conn->close();
+            }
+        );
+
+        $this->_conn->on(
+            'error',
+            function ($reason, \Thruway\Message\AbortMessage $msg = null) {
+                $this->assertInstanceOf('\Thruway\Message\AbortMessage', $msg);
+                $this->assertEquals("my.custom.abort.uri", $msg->getResponseURI());
+                $this->assertEquals("My custom abort message", $msg->getDetails()->message);
+                $this->_testResult = $reason;
+            }
+        );
+
+        $this->_conn->open();
+
+        $this->assertEquals("my.custom.abort.uri", $this->_testResult);
+    }
+
+    public function testAbortFollowingAuthenticateWithDetails() {
+        $this->_testResult = null;
+        $this->_error = null;
+
+        $this->_conn = new \Thruway\Connection(
+            array(
+                "realm" => 'aaawd',
+                "url" => 'ws://127.0.0.1:8090',
+                "max_retries" => 0,
+                "authmethods" => ["abortafterauthenticatewithdetails"],
+                "onChallenge" => function () { return 'asdf'; }
+            )
+        );
+
+        $this->_conn->on(
+            'open',
+            function (\Thruway\ClientSession $session) {
+                $this->_testResult = "connection opened.";
+                $this->_conn->close();
+            }
+        );
+
+        $this->_conn->on(
+            'error',
+            function ($reason, \Thruway\Message\AbortMessage $msg = null) {
+                $this->assertInstanceOf('\Thruway\Message\AbortMessage', $msg);
+                $this->assertEquals("my.custom.abort.uri.2", $msg->getResponseURI());
+                $this->assertEquals("My custom abort message 2", $msg->getDetails()->message);
+                $this->_testResult = $reason;
+            }
+        );
+
+        $this->_conn->open();
+
+        $this->assertEquals("my.custom.abort.uri.2", $this->_testResult);
     }
 }