Refactorings for OData request/response processing (bug fixes)

vgrem · Oct 20, 2019 · f3fa485 · f3fa485
1 parent 79f5cda
commit f3fa485
Show file tree

Hide file tree

Showing 19 changed files with 188 additions and 130 deletions.
diff --git a/examples/GraphConsole/ConsoleTasks.php b/examples/GraphConsole/ConsoleTasks.php
@@ -35,7 +35,7 @@ function downloadPhoto(GraphServiceClient $client,$targetFilePath){
     $options = new \Office365\PHP\Client\Runtime\Utilities\RequestOptions($url);
     //$options->StreamHandle = $fp;
     try {
-        $content = $client->executeQueryDirect($options);
+        $response = $client->executeQueryDirect($options);
 
     } catch (Exception $e) {
     }

diff --git a/examples/SharePoint/FilesExamples.php b/examples/SharePoint/FilesExamples.php
@@ -184,7 +184,7 @@ function downloadFileAsStream(ClientRuntimeContext $ctx, $fileUrl, $targetFilePa
 
     $fp = fopen($targetFilePath, 'w+');
     $url = $ctx->getServiceRootUrl() . "web/getfilebyserverrelativeurl('$fileUrl')/\$value";
-    $options = new \Office365\PHP\Client\Runtime\Utilities\RequestOptions($url);
+    $options = new RequestOptions($url);
     $options->StreamHandle = $fp;
     $ctx->executeQueryDirect($options);
     fclose($fp);
@@ -199,7 +199,7 @@ function renameFolder($webUrl, $authCtx, $folderUrl,$folderNewName)
     $request = new RequestOptions($url);
     $ctx = new ClientContext($url,$authCtx);
     $resp = $ctx->executeQueryDirect($request);
-    $data = json_decode($resp);
+    $data = json_decode($resp->getContent());
 
     $itemPayload = array(
         '__metadata' => array ('type' => $data->d->__metadata->type),

diff --git a/src/OutlookServices/OutlookClient.php b/src/OutlookServices/OutlookClient.php
@@ -25,7 +25,9 @@ public function __construct(IAuthenticationContext $authContext, $version = Offi
     {
         $this->version = $version;
         $this->serviceRootUrl = $this->serviceRootUrl . $version . "/";
-        parent::__construct($this->serviceRootUrl, $authContext, new JsonFormat(ODataMetadataLevel::Verbose), $version);
+        $format = new JsonFormat(ODataMetadataLevel::Verbose);
+        $format->addProperty("type","#Microsoft.OutlookServices.*");
+        parent::__construct($this->serviceRootUrl, $authContext,$format, $version);
     }
 
 
@@ -53,7 +55,6 @@ private function prepareOutlookServicesRequest(RequestOptions $request,ClientAct
     }
 
 
-
     /**
      * @return User
      */

diff --git a/src/Runtime/ClientObject.php b/src/Runtime/ClientObject.php
@@ -148,7 +148,7 @@ function toJson(ODataFormat $format)
                 $payload[$key] = $value;
         }
         if ($format instanceof JsonLightFormat && $format->MetadataLevel == ODataMetadataLevel::Verbose) {
-            $format->ensureMetadataAnnotation($this, $payload);
+            $format->ensureMetadataProperty($this, $payload);
         }
         return $payload;
     }

diff --git a/src/Runtime/ClientRequest.php b/src/Runtime/ClientRequest.php
@@ -8,7 +8,6 @@
 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;
 
 
 /**
@@ -69,10 +68,8 @@ public function __construct(ClientRuntimeContext $context)
      */
     public function addQuery(ClientAction $query, $resultObject = null)
     {
-        if (isset($resultObject)) {
-            $queryId = $query->getId();
-            $this->resultObjects[$queryId] = $resultObject;
-        }
+        $queryId = $query->getId();
+        $this->resultObjects[$queryId] = $resultObject;
         $this->queries[] = $query;
     }
 
@@ -98,6 +95,14 @@ public function afterExecuteQuery(callable $event)
     public abstract function executeQuery();
 
 
+    /**
+     * @param RequestOptions $request
+     * @return ClientResponse
+     * @throws Exception
+     */
+    public abstract function executeQueryDirect(RequestOptions $request);
+
+
     /**
      * @param RequestOptions $request
      */
@@ -110,7 +115,7 @@ protected abstract function setRequestHeaders(RequestOptions $request);
     public abstract function processResponse($response);
 
     /**
-     * Build Client Request
+     * Build Request
      * @return RequestOptions
      */
     protected abstract function buildRequest();
@@ -126,19 +131,6 @@ public function addQueryAndResultObject(ClientObject $clientObject, ODataQueryOp
     }
 
 
-    /**
-     * @param RequestOptions $request
-     * @param array $responseInfo
-     * @return string
-     * @throws Exception
-     */
-    public function executeQueryDirect(RequestOptions $request, &$responseInfo = array())
-    {
-        $this->context->authenticateRequest($request); //Auth mandatory headers
-        $this->setRequestHeaders($request); //set request headers
-        return Requests::execute($request,$responseInfo);
-    }
-
     /**
      * @return ClientAction[]
      */

diff --git a/src/Runtime/ClientResponse.php b/src/Runtime/ClientResponse.php
@@ -8,12 +8,16 @@
 
 abstract class ClientResponse
 {
-    public function __construct($payload,$details)
+    public function __construct($content, $details)
     {
-        $this->Payload = $payload;
+        $this->Content = $content;
         $this->StatusCode = $details['HttpCode'];
     }
 
+    public function getContent(){
+        return $this->Content;
+    }
+
     /**
      * @param IEntityType|ClientResult $object
      * @param ODataFormat $format
@@ -22,8 +26,12 @@ abstract  function map($object,$format);
 
     abstract function validate();
 
+    /**
+     * @var integer
+     */
     protected $StatusCode;
 
-    protected $Payload;
+
+    protected $Content;
 
 }
diff --git a/src/Runtime/ClientRuntimeContext.php b/src/Runtime/ClientRuntimeContext.php
@@ -2,6 +2,7 @@
 
 namespace Office365\PHP\Client\Runtime;
 
+use Exception;
 use Office365\PHP\Client\Runtime\Auth\IAuthenticationContext;
 use Office365\PHP\Client\Runtime\OData\ODataRequest;
 use Office365\PHP\Client\Runtime\OData\ODataFormat;
@@ -145,13 +146,12 @@ public function executeQuery()
 
     /**
      * @param RequestOptions $options
-     * @param array $responseInfo
-     * @return string
-     * @throws \Exception
+     * @return ClientResponse
+     * @throws Exception
      */
-    public function executeQueryDirect(RequestOptions $options,&$responseInfo = [])
+    public function executeQueryDirect(RequestOptions $options)
     {
-        return $this->getPendingRequest()->executeQueryDirect($options, $responseInfo);
+        return $this->getPendingRequest()->executeQueryDirect($options);
     }
 
 

diff --git a/src/Runtime/ClientValueObject.php b/src/Runtime/ClientValueObject.php
@@ -54,7 +54,7 @@ function toJson(ODataFormat $format)
                 $payload[$key] = $val;
         }
         if ($format instanceof JsonLightFormat && $format->MetadataLevel == ODataMetadataLevel::Verbose) {
-            $format->ensureMetadataAnnotation($this, $payload);
+            $format->ensureMetadataProperty($this, $payload);
         }
         return $payload;
     }

diff --git a/src/Runtime/OData/JsonFormat.php b/src/Runtime/OData/JsonFormat.php
@@ -14,10 +14,11 @@ public function __construct($metadataLevel)
         parent::__construct($metadataLevel);
         $this->Streaming = false;
         $this->IEEE754Compatible = true;
-        $this->Annotations["collection"] = "value";
-        $this->Annotations["annotation"] = "@odata.*";
+        $this->addProperty("control","*@odata.*");
+        $this->addProperty("collection","value");
     }
 
+
     /**
      * @return string
      * @throws Exception

diff --git a/src/Runtime/OData/JsonLightFormat.php b/src/Runtime/OData/JsonLightFormat.php
@@ -11,27 +11,31 @@
 class JsonLightFormat extends ODataFormat
 {
 
-
     public function __construct($metadataLevel)
     {
         parent::__construct($metadataLevel);
         if($metadataLevel === ODataMetadataLevel::Verbose){
-            $this->Annotations['__deferred'] = "deferred";
-            $this->Annotations['__metadata'] = "metadata";
-            $this->Annotations['collection'] = "results";
-            $this->Annotations['security'] = "d";
+            $this->addProperty('deferred',"__deferred");
+            $this->addProperty('metadata',"__metadata");
+            $this->addProperty('collection',"results");
+            $this->addProperty('security',"d");
         }
     }
 
-    public function setFunctionAnnotation($fnName){
-        $this->Annotations['function'] = $fnName;
+
+    public  function getFunctionProperty(){
+        return $this->getProperty('function');
+    }
+
+    public  function getSecurityProperty(){
+        return $this->getProperty('security');
     }
 
     /**
      * @param $type IEntityType
      * @param $payload array
      */
-    public function ensureMetadataAnnotation($type, &$payload)
+    public function ensureMetadataProperty($type, &$payload)
     {
         $typeName = $type->getTypeName();
         if (substr($typeName, 0, 3) !== "SP.")

diff --git a/src/Runtime/OData/MetadataResolver.php b/src/Runtime/OData/MetadataResolver.php
@@ -19,8 +19,8 @@ public static function getMetadata(ClientRuntimeContext $ctx)
     {
         $metadataUrl = $ctx->getServiceRootUrl() . "/\$metadata";
         $options = new RequestOptions($metadataUrl);
-        $content = $ctx->executeQueryDirect($options);
-        return $content;
+        $response = $ctx->executeQueryDirect($options);
+        return $response->getContent();
     }
 
-}
+}
diff --git a/src/Runtime/OData/ODataFormat.php b/src/Runtime/OData/ODataFormat.php
@@ -6,16 +6,26 @@
 
 abstract class ODataFormat
 {
+
+
     public function __construct($metadataLevel)
     {
         $this->MetadataLevel = $metadataLevel;
-        $this->Annotations = array();
+        $this->properties = array();
+
     }
 
 
-    public function addAnnotation($name, $value)
+    public function addProperty($name, $value)
     {
-        $this->Annotations[$name] = $value;
+        $this->properties[$name] = $value;
+    }
+
+
+    public function getProperty($name){
+        if(isset($this->properties[$name]))
+            return $this->properties[$name];
+        return null;
     }
 
 
@@ -55,6 +65,6 @@ public function isAtom()
     /**
      * @var array
      */
-    public $Annotations;
+    protected $properties;
 
 }
diff --git a/src/Runtime/OData/ODataRequest.php b/src/Runtime/OData/ODataRequest.php
@@ -3,6 +3,7 @@
 
 namespace Office365\PHP\Client\Runtime\OData;
 
+use Cassandra\Value;
 use Exception;
 use Office365\PHP\Client\Runtime\ClientAction;
 use Office365\PHP\Client\Runtime\ClientRequestStatus;
@@ -13,6 +14,7 @@
 use Office365\PHP\Client\Runtime\ClientRuntimeContext;
 use Office365\PHP\Client\Runtime\HttpMethod;
 use Office365\PHP\Client\Runtime\Utilities\RequestOptions;
+use Office365\PHP\Client\Runtime\Utilities\Requests;
 
 
 /**
@@ -32,6 +34,22 @@ public function __construct(ClientRuntimeContext $context)
         $this->currentQuery = null;
     }
 
+
+
+    /**
+     * @param RequestOptions $request
+     * @return ClientResponse
+     * @throws Exception
+     */
+    public function executeQueryDirect(RequestOptions $request)
+    {
+        $this->context->authenticateRequest($request); //Auth mandatory headers
+        $this->setRequestHeaders($request); //set request headers
+        $content = Requests::execute($request,$responseInfo);
+        return new ODataResponse($content,$responseInfo);
+    }
+
+
     /**
      * Submit query to OData service
      * @throws Exception
@@ -48,18 +66,14 @@ public function executeQuery()
                 ));
             }
 
-            $responseInfo = array();
-            $payload = $this->executeQueryDirect($request, $responseInfo);
-            $response = new ODataResponse($payload,$responseInfo);
+            $response = $this->executeQueryDirect($request);
             $response->validate();
             if (is_callable($this->eventsList["AfterExecuteQuery"])) {
                 call_user_func_array($this->eventsList["AfterExecuteQuery"], array(
                     $response
                 ));
             }
-            if (!empty($payload)) {
-                $this->processResponse($response);
-            }
+            $this->processResponse($response);
             $this->requestStatus = ClientRequestStatus::CompletedSuccess;
         }
         catch(Exception $e){
@@ -75,11 +89,16 @@ public function executeQuery()
      */
     public function processResponse($response)
     {
-        $queryId = $this->currentQuery->getId();
-        if (!array_key_exists($queryId, $this->resultObjects)) {
+        $payload = $response->getContent();
+        if (empty($payload)) {
             return;
         }
+
+        $queryId = $this->currentQuery->getId();
         $resultObject = $this->resultObjects[$queryId];
+        if (is_null($resultObject)) {
+            return;
+        }
         $response->map($resultObject, $this->getFormat());
     }