Introduced additional properties for ClientRequest to allow manage request queue

Author: vgrem

src/Runtime/CSOM/CSOMRequest.php

@@ -57,17 +57,16 @@ protected function setRequestHeaders(RequestOptions $request)
      * @param $response
      * @param $resultObject
      */
-    public function processResponse($response, $resultObject)
+    public function processResponse($response)
     {
         // TODO: Implement processResponse() method.
     }
 
     /**
      * Build Client Request
-     * @param ClientAction $query
      * @return RequestOptions
      */
-    protected function buildRequest(ClientAction $query)
+    protected function buildRequest()
     {
         // TODO: Implement buildRequest() method.
     }

src/Runtime/ClientRequest.php

@@ -5,6 +5,7 @@
 
 
 use Office365\PHP\Client\Runtime\OData\ODataQueryOptions;
+use Office365\PHP\Client\Runtime\Utilities\Guid;
 use Office365\PHP\Client\Runtime\Utilities\RequestOptions;
 use Office365\PHP\Client\Runtime\Utilities\Requests;
 
@@ -37,6 +38,14 @@ abstract class ClientRequest
     protected $resultObjects = array();
 
 
+    /** @var Guid  */
+    protected $requestId;
+
+
+    /** @var integer */
+    protected $requestStatus;
+
+
     /**
      * ClientRequest constructor.
      * @param ClientRuntimeContext $context
@@ -48,6 +57,8 @@ public function __construct(ClientRuntimeContext $context)
             "BeforeExecuteQuery" => null,
             "AfterExecuteQuery" => null
         );
+        $this->requestId = Guid::newGuid();
+        $this->requestStatus = ClientRequestStatus::Active;
     }
 
     /**
@@ -135,11 +146,14 @@ public function getActions(){
     }
 
     /**
-     * Clears all queries and resultObjects.
+     * @return int
      */
-    public function clear()
-    {
-        $this->queries = [];
-        $this->resultObjects = [];
+    public function getRequestStatus(){
+        return $this->requestStatus;
     }
+
+    /**
+     * @return ClientRequest
+     */
+    public abstract function getNextRequest();
 }

src/Runtime/ClientRequestStatus.php

@@ -0,0 +1,13 @@
+<?php
+
+
+namespace Office365\PHP\Client\Runtime;
+
+abstract class ClientRequestStatus
+{
+    const Active = 1;
+    const InProgress = 2;
+    const CompletedSuccess = 3;
+    const CompletedException = 4;
+}
+

src/Runtime/ClientRuntimeContext.php

@@ -134,23 +134,14 @@ public  function loadQuery(ClientObject $clientObject,ODataQueryOptions $query =
     /**
      * Submit client request to SharePoint OData/SOAP service
      *
-     * @return self
      */
     public function executeQuery()
     {
         while ($this->hasPendingRequest()) {
             $this->getPendingRequest()->executeQuery();
         }
-        return $this;
     }
 
-    /**
-     * @return bool
-     */
-    public function hasPendingRequest(){
-        $queries = $this->pendingRequest->getActions();
-        return !empty($queries);
-    }
 
 
     /**
@@ -192,20 +183,24 @@ public function getPendingRequest()
         if (!isset($this->pendingRequest)) {
             $this->pendingRequest = new ODataRequest($this);
         }
+        if($this->pendingRequest->getRequestStatus() != ClientRequestStatus::Active){
+            $this->pendingRequest = $this->pendingRequest->getNextRequest();
+        }
         return $this->pendingRequest;
     }
 
+
     /**
-     * Removes the pending request.
+     * @return bool
      */
-    public function removePendingRequest()
+    public function hasPendingRequest()
     {
-        if (!isset($this->pendingRequest)) {
-            return;
-        }
-        unset($this->pendingRequest);
+        $request = $this->getPendingRequest();
+        return ($request->getRequestStatus() == ClientRequestStatus::Active &&
+            count($request->getActions()) > 0);
     }
 
+
     /**
      * @return Version
      */

src/Runtime/OData/ODataRequest.php

@@ -6,6 +6,7 @@
 
 use Exception;
 use Office365\PHP\Client\Runtime\ClientAction;
+use Office365\PHP\Client\Runtime\ClientRequestStatus;
 use Office365\PHP\Client\Runtime\ClientResult;
 use Office365\PHP\Client\Runtime\IEntityType;
 use Office365\PHP\Client\Runtime\InvokeMethodQuery;
@@ -17,13 +18,13 @@
 use Office365\PHP\Client\SharePoint\ChangeLogItemQuery;
 
 
+
 /**
  * Client Request for OData provider.
  */
 class ODataRequest extends ClientRequest
 {
 
-
     public function __construct(ClientRuntimeContext $context)
     {
         parent::__construct($context);
@@ -35,19 +36,25 @@ public function __construct(ClientRuntimeContext $context)
      */
     public function executeQuery()
     {
-        $request = $this->buildRequest();
-        if (is_callable($this->eventsList["BeforeExecuteQuery"])) {
-            call_user_func_array($this->eventsList["BeforeExecuteQuery"], array(
-                $request,
-                $this->getCurrentAction()
-            ));
+        try{
+            $request = $this->buildRequest();
+            if (is_callable($this->eventsList["BeforeExecuteQuery"])) {
+                call_user_func_array($this->eventsList["BeforeExecuteQuery"], array(
+                    $request,
+                    $this->getCurrentAction()
+                ));
+            }
+            $responseInfo = array();
+            $response = $this->executeQueryDirect($request, $responseInfo);
+            if (!empty($response)) {
+                $this->processResponse($response);
+            }
+            $this->requestStatus = ClientRequestStatus::CompletedSuccess;
         }
-        $responseInfo = array();
-        $response = $this->executeQueryDirect($request, $responseInfo);
-        if (!empty($response)) {
-            $this->processResponse($response);
+        catch(Exception $e){
+            $this->requestStatus = ClientRequestStatus::CompletedException;
+            throw $e;
         }
-        array_shift($this->queries);
     }
 
 
@@ -57,12 +64,11 @@ public function executeQuery()
      */
     public function processResponse($response)
     {
-
         if (!array_key_exists($this->getCurrentAction()->getId(), $this->resultObjects)) {
             return;
         }
-
         $resultObject = $this->resultObjects[$this->getCurrentAction()->getId()];
+
         if ($this->getCurrentAction() instanceof InvokePostMethodQuery && $this->getCurrentAction()->MethodBody instanceof ChangeLogItemQuery) {
             $payload = $this->parseXmlResponse($response);
         } else {
@@ -78,7 +84,6 @@ public function processResponse($response)
             $this->getSerializationContext()->map($payload,$resultObject);
             $this->getCurrentAction()->getResourcePath()->ServerObjectIsNull = false;
         }
-        unset($this->resultObjects[$this->getCurrentAction()->getId()]);
     }
 
 
@@ -191,7 +196,19 @@ protected function getSerializationContext()
      * @return ClientAction|InvokePostMethodQuery
      */
     protected function getCurrentAction(){
-        return current($this->getActions());
+        return current($this->queries);
     }
 
+
+    public function getNextRequest()
+    {
+        $request = new ODataRequest($this->context);
+        if(count($this->queries) > 1) {
+            $request->queries = array_slice($this->queries, 1, count($this->queries)-1, true);
+            $request->resultObjects = $this->resultObjects;
+        }
+        return $request;
+    }
+
+
 }

tests/ClientContextTests.php

@@ -0,0 +1,37 @@
+<?php
+
+
+class ClientContextTests extends SharePointTestCase
+{
+    public function testIfSingleRequestProcessed()
+    {
+        try{
+            $listTitle = "Orders_" . rand(1,100000);
+            $list = self::$context->getWeb()->getLists()->getByTitle($listTitle);
+            self::$context->load($list);
+            self::$context->executeQuery();
+            self::assertFalse(self::$context->hasPendingRequest());
+        }
+        catch(Exception $e){
+            self::assertFalse(self::$context->hasPendingRequest());
+        }
+    }
+
+
+    public function testIfMultipleRequestsProcessed()
+    {
+        $numOfQueries = 2;
+        try {
+            for ($i = 0;$i < $numOfQueries; $i++) {
+                $listTitle = "Orders_" . rand(1, 100000);
+                $list = self::$context->getWeb()->getLists()->getByTitle($listTitle);
+                self::$context->load($list);
+            }
+            self::$context->executeQuery();
+            self::assertFalse(self::$context->hasPendingRequest());
+        } catch (Exception $e) {
+            self::assertTrue(self::$context->hasPendingRequest());
+        }
+    }
+
+}

tests/ListTest.php

@@ -1,14 +1,9 @@
 <?php
 
 
-require_once('SharePointTestCase.php');
-require_once('ListItemExtensions.php');
-
-
-
-
 class ListTest extends SharePointTestCase
 {
+
     public function testIfListCreated()
     {
         $listTitle = "Orders_" . rand(1,100000);
@@ -69,6 +64,4 @@ public function testDeleteList(\Office365\PHP\Client\SharePoint\SPList $listToDe
         $this->assertEquals(0,$result->getCount());
     }
 
-
-
 }

tests/SharePointTestCase.php

@@ -20,8 +20,6 @@ public static function setUpBeforeClass()
         $authCtx->acquireTokenForUser($Settings['UserName'],$Settings['Password']);
         //$authCtx->acquireTokenForApp($AppSettings['ClientId'],$AppSettings['ClientSecret'],$AppSettings['RedirectUrl']);
         self::$context = new ClientContext($Settings['Url'],$authCtx);
-
-
     }
 
     public static function tearDownAfterClass()