Merge pull request #96 from microsoftgraph/dev

Release 2.0.0-RC7

Author: Ndiritu

.github/workflows/pr-validation.yml

@@ -18,14 +18,17 @@ defaults:
 jobs:
   validate-pull-request:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-versions: ['7.4', '8.0', '8.1', '8.2']
     steps:
-    - uses: actions/checkout@v3.3.0
+    - uses: actions/checkout@v3.5.2
       with:
         submodules: 'true'
     - name: Setup PHP and Xdebug for Code Coverage report
       uses: shivammathur/setup-php@v2
       with:
-        php-version: '7.4'
+        php-version: ${{ matrix.php-versions }}
         coverage: xdebug
     - name: Validate composer file
       run: |
@@ -34,8 +37,15 @@ jobs:
       run: |
         composer install
     - name: Run tests
-      run : |
-        vendor/bin/phpunit --coverage-text
+      run: ./vendor/bin/phpunit --coverage-clover=coverage.xml
+    - name: Fix code coverage paths
+      run: sed -i 's@'$GITHUB_WORKSPACE'@/github/workspace/@g' coverage.xml
+    - name: SonarCloud Scan
+      if: ${{ matrix.php-versions == '8.0' }}
+      uses: SonarSource/sonarcloud-github-action@master
+      env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
     - name: Run static analysis
       run: |
         vendor/bin/phpstan analyse --memory-limit=500M --error-format=github

.github/workflows/tag-release.yml

@@ -18,7 +18,7 @@ jobs:
   create-tag:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3.3.0
+    - uses: actions/checkout@v3.5.2
 
     - name: Get SDK version and set environment variable
       run: |

.github/workflows/update-docs.yml

@@ -15,7 +15,7 @@ jobs:
   run-php-documentor:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3.3.0
+      - uses: actions/checkout@v3.5.2
         with:
           ref: ${{ github.ref }}
 

README.md

@@ -1,13 +1,14 @@
 # Get started with the Microsoft Graph Core SDK for PHP
 
 [![Latest Stable Version](https://poser.pugx.org/microsoft/microsoft-graph-core/version)](https://packagist.org/packages/microsoft/microsoft-graph-core)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=microsoftgraph_msgraph-sdk-php-core&metric=coverage)](https://sonarcloud.io/dashboard?id=microsoftgraph_msgraph-sdk-php-core)
 
 ## Install the Core Library
 To install the `microsoft-graph-core` library with Composer, either run `composer require microsoft/microsoft-graph-core`, or edit your `composer.json` file:
 ```
 {
     "require": {
-        "microsoft/microsoft-graph-core": "^2.0.0-RC4"
+        "microsoft/microsoft-graph-core": "^2.0.0-RC7"
     }
 }
 ```

composer.json

@@ -13,11 +13,10 @@
 	],
 	"require": {
 		"php": "^8.0 || ^7.4",
-		"microsoft/kiota-authentication-phpleague": "^0.4.0",
-		"microsoft/kiota-http-guzzle": "^0.4.0",
-		"microsoft/kiota-serialization-json": "^0.3.0",
-		"microsoft/kiota-serialization-text": "^0.3.0",
-		"microsoft/kiota-abstractions": "^0.4.0",
+		"microsoft/kiota-authentication-phpleague": "^0.6.0",
+		"microsoft/kiota-http-guzzle": "^0.6.0",
+		"microsoft/kiota-serialization-json": "^0.4.0",
+		"microsoft/kiota-serialization-text": "^0.5.0",
 		"php-http/httplug": "^2.2",
 		"php-http/guzzle7-adapter": "^1.0",
 		"ext-json": "*"

phpstan.neon

@@ -1,5 +1,5 @@
 parameters:
-	level: 3
+	level: 9
 	polluteScopeWithAlwaysIterableForeach: false
 	polluteScopeWithLoopInitialAssignments: false
 	paths:

sonar-project.properties

@@ -0,0 +1,5 @@
+sonar.projectKey=microsoftgraph_msgraph-sdk-php-core
+sonar.organization=microsoftgraph2
+sonar.php.coverage.reportPaths=coverage.xml
+sonar.sources=src/
+sonar.tests=tests/

src/Authentication/GraphPhpLeagueAccessTokenProvider.php

@@ -0,0 +1,37 @@
+<?php
+/**
+ * Copyright (c) Microsoft Corporation.  All Rights Reserved.
+ * Licensed under the MIT License.  See License in the project root
+ * for license information.
+ */
+
+
+namespace Microsoft\Graph\Core\Authentication;
+
+
+use Microsoft\Kiota\Authentication\Oauth\TokenRequestContext;
+use Microsoft\Kiota\Authentication\PhpLeagueAccessTokenProvider;
+
+/**
+ * Class GraphPhpLeagueAccessTokenProvider
+ *
+ * Fetches an access token using the PHP League OAuth 2.0 client library while setting default Graph allowed hosts
+ *
+ * @package Microsoft\Graph\Core\Authentication
+ * @copyright 2023 Microsoft Corporation
+ * @license https://opensource.org/licenses/MIT MIT License
+ * @link https://developer.microsoft.com/graph
+ */
+class GraphPhpLeagueAccessTokenProvider extends PhpLeagueAccessTokenProvider
+{
+    /**
+     * @param TokenRequestContext $tokenRequestContext
+     * @param array<string> $scopes if left empty, it's set to ["https://[graph national cloud host]/.default"] scope
+     */
+    public function __construct(TokenRequestContext $tokenRequestContext, array $scopes = [])
+    {
+        $allowedHosts = ["graph.microsoft.com", "graph.microsoft.us", "dod-graph.microsoft.us", "graph.microsoft.de",
+            "microsoftgraph.chinacloudapi.cn", "canary.graph.microsoft.com"];
+        parent::__construct($tokenRequestContext, $scopes, $allowedHosts);
+    }
+}

src/Authentication/GraphPhpLeagueAuthenticationProvider.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Copyright (c) Microsoft Corporation.  All Rights Reserved.
+ * Licensed under the MIT License.  See License in the project root
+ * for license information.
+ */
+
+
+namespace Microsoft\Graph\Core\Authentication;
+
+use Microsoft\Kiota\Abstractions\Authentication\BaseBearerTokenAuthenticationProvider;
+use Microsoft\Kiota\Authentication\Oauth\TokenRequestContext;
+
+/**
+ * Class GraphPhpLeagueAuthenticationProvider
+ * @package Microsoft\Graph\Core\Authentication
+ * @copyright 2023 Microsoft Corporation
+ * @license https://opensource.org/licenses/MIT MIT License
+ * @link https://developer.microsoft.com/graph
+ */
+class GraphPhpLeagueAuthenticationProvider extends BaseBearerTokenAuthenticationProvider
+{
+    /**
+     * @param TokenRequestContext $tokenRequestContext
+     * @param array<string> $scopes defaults to ["https://[graph national cloud host]/.default"] scope
+     */
+    public function __construct(TokenRequestContext $tokenRequestContext, array $scopes = [])
+    {
+        $accessTokenProvider = new GraphPhpLeagueAccessTokenProvider($tokenRequestContext, $scopes);
+        parent::__construct($accessTokenProvider);
+    }
+}

src/BaseGraphRequestAdapter.php

@@ -28,13 +28,17 @@
 class BaseGraphRequestAdapter extends GuzzleRequestAdapter
 {
     /**
+     * @param GraphTelemetryOption $telemetryOption
      * @param AuthenticationProvider|null $authenticationProvider
-     * @param GraphTelemetryOption|null $telemetryOption
      * @param ParseNodeFactory|null $parseNodeFactory
      * @param SerializationWriterFactory|null $serializationWriterFactory
      * @param Client|null $guzzleClient
      */
-    public function __construct(?AuthenticationProvider $authenticationProvider = null, ?GraphTelemetryOption $telemetryOption = null, ?ParseNodeFactory $parseNodeFactory = null, ?SerializationWriterFactory $serializationWriterFactory = null, ?Client $guzzleClient = null)
+    public function __construct(GraphTelemetryOption $telemetryOption,
+                                ?AuthenticationProvider $authenticationProvider = null,
+                                ?ParseNodeFactory $parseNodeFactory = null,
+                                ?SerializationWriterFactory $serializationWriterFactory = null,
+                                ?Client $guzzleClient = null)
     {
         $authenticationProvider = ($authenticationProvider) ?? new AnonymousAuthenticationProvider();
         $guzzleClient = ($guzzleClient) ?? GraphClientFactory::setTelemetryOption($telemetryOption)::create();

src/GraphClientFactory.php

@@ -46,17 +46,17 @@ final class GraphClientFactory extends KiotaClientFactory
     /**
      * @var string Graph API host to use as base URL and for authentication
      */
-    private static $nationalCloud = NationalCloud::GLOBAL;
+    private static string $nationalCloud = NationalCloud::GLOBAL;
 
     /**
      * @var GraphClientFactory|null Store singleton instance of the GraphClientFactory
      */
-    private static $instance = null;
+    private static ?GraphClientFactory $instance = null;
 
     /**
      * @var GraphTelemetryOption|null telemetry config
      */
-    private static $graphTelemetryOption = null;
+    private static ?GraphTelemetryOption $graphTelemetryOption = null;
 
     /**
      * GraphClientFactory constructor.
@@ -105,7 +105,7 @@ public static function setTelemetryOption(GraphTelemetryOption $telemetryOption)
     /**
      * Create Guzzle client configured for Graph
      *
-     * @param array $guzzleConfig
+     * @param array<string, mixed> $guzzleConfig
      * @return Client
      */
     public static function createWithConfig(array $guzzleConfig): Client
@@ -141,7 +141,7 @@ public static function createWithMiddleware(HandlerStack $handlerStack): Client
      */
     public static function createAdapter(): HttpClientInterface {
         return new class(self::create()) implements HttpClientInterface {
-            private $clientAdapter;
+            private GuzzleAdapter $clientAdapter;
 
             public function __construct(Client $guzzleClient) {
                 $this->clientAdapter = new GuzzleAdapter($guzzleClient);
@@ -160,10 +160,10 @@ public function sendAsyncRequest(RequestInterface $request): Promise {
     /**
      * Return default handler stack for Graph
      *
-     * @param null $handler final handler
+     * @param callable|null $handler final handler
      * @return HandlerStack
      */
-    public static function getDefaultHandlerStack($handler = null): HandlerStack
+    public static function getDefaultHandlerStack(callable $handler = null): HandlerStack
     {
         $handler = ($handler) ?: Utils::chooseHandler();
         $handlerStack = new HandlerStack($handler);
@@ -176,7 +176,7 @@ public static function getDefaultHandlerStack($handler = null): HandlerStack
     /**
      * Returns Graph-specific config for Guzzle
      *
-     * @return array
+     * @return array<string, mixed>
      */
     private static function getDefaultConfig(): array {
         $config = [
@@ -189,9 +189,12 @@ private static function getDefaultConfig(): array {
             "base_uri" => self::$nationalCloud,
             'handler' => self::getDefaultHandlerStack()
         ];
-        if (extension_loaded('curl') && defined('CURL_VERSION_HTTP2') && curl_version()["features"] & CURL_VERSION_HTTP2 !== 0) {
-            // Enable HTTP/2 if curl extension exists and supports it
-            $config['version'] = '2';
+        if (extension_loaded('curl') && defined('CURL_VERSION_HTTP2')) {
+            $curlVersion = curl_version();
+            if ($curlVersion && ($curlVersion["features"] & CURL_VERSION_HTTP2) == CURL_VERSION_HTTP2) {
+                // Enable HTTP/2 if curl extension exists and supports it
+                $config['version'] = '2';
+            }
         }
         return $config;
     }

src/GraphConstants.php

@@ -25,7 +25,7 @@ final class GraphConstants
     const REST_ENDPOINT = "https://graph.microsoft.com/";
 
     // Define HTTP request constants
-    const SDK_VERSION = "2.0.0-RC4";
+    const SDK_VERSION = "2.0.0-RC7";
 
     // Define error constants
     const MAX_PAGE_SIZE = 999;

src/Middleware/FeatureFlagTrait.php

@@ -9,12 +9,19 @@
 namespace Microsoft\Graph\Core\Middleware;
 
 use Microsoft\Graph\Core\Middleware\Option\GraphTelemetryOption;
+use Microsoft\Kiota\Abstractions\RequestOption;
 
 /**
  * Adds feature flag to Guzzle options
  */
 trait FeatureFlagTrait
 {
+
+    /**
+     * @param int $featureFlag
+     * @param array<string, RequestOption> $options
+     * @return void
+     */
     function setFeatureFlag(int $featureFlag, array &$options): void {
         if (!array_key_exists(GraphTelemetryOption::class, $options)) {
             $telemetry = new GraphTelemetryOption();

src/Middleware/GraphCompressionHandler.php

@@ -10,6 +10,7 @@
 
 
 use GuzzleHttp\Promise\PromiseInterface;
+use Microsoft\Kiota\Abstractions\RequestOption;
 use Microsoft\Kiota\Http\Middleware\CompressionHandler;
 use Psr\Http\Message\RequestInterface;
 
@@ -26,6 +27,11 @@ class GraphCompressionHandler extends CompressionHandler
 
     const FEATURE_FLAG = 0x00000040;
 
+    /**
+     * @param RequestInterface $request
+     * @param array<string, RequestOption> $options
+     * @return PromiseInterface
+     */
     public function __invoke(RequestInterface $request, array $options): PromiseInterface
     {
         $this->setFeatureFlag(self::FEATURE_FLAG, $options);

src/Middleware/GraphRetryHandler.php

@@ -10,6 +10,7 @@
 
 
 use GuzzleHttp\Promise\PromiseInterface;
+use Microsoft\Kiota\Abstractions\RequestOption;
 use Microsoft\Kiota\Http\Middleware\RetryHandler;
 use Psr\Http\Message\RequestInterface;
 
@@ -28,7 +29,7 @@ class GraphRetryHandler extends RetryHandler
 
     /**
      * @param RequestInterface $request
-     * @param array $options
+     * @param array<string, RequestOption>  $options
      * @return PromiseInterface
      */
     public function __invoke(RequestInterface $request, array $options): PromiseInterface

src/Middleware/GraphTelemetryHandler.php

@@ -25,7 +25,7 @@
  */
 class GraphTelemetryHandler extends TelemetryHandler
 {
-    private $graphTelemetryOption;
+    private GraphTelemetryOption $graphTelemetryOption;
 
     /**
      * Create new instance
@@ -43,15 +43,16 @@ public function __construct(callable $nextHandler, ?GraphTelemetryOption $graphT
      * Handles the request
      *
      * @param RequestInterface $request
-     * @param array $options
+     * @param array<string, mixed> $options
      * @return PromiseInterface
      */
     public function __invoke(RequestInterface $request, array $options): PromiseInterface
     {
         // Merge custom request-level options with initial telemetry options
         if (array_key_exists(GraphTelemetryOption::class, $options)) {
             $graphTelemetryOption = $options[GraphTelemetryOption::class];
-            if (is_a($graphTelemetryOption, GraphTelemetryOption::class)) {
+            if (is_object($graphTelemetryOption) && is_a($graphTelemetryOption, GraphTelemetryOption::class)) {
+                // @phpstan-ignore-next-line
                 $this->graphTelemetryOption->override($options[GraphTelemetryOption::class]);
                 unset($options[GraphTelemetryOption::class]);
             }

src/Middleware/Option/GraphTelemetryOption.php

@@ -37,7 +37,7 @@ class GraphTelemetryOption extends TelemetryOption
      * @param string $apiVersion
      * @param string $serviceLibraryVersion
      */
-    public function __construct(string $apiVersion = '', string $serviceLibraryVersion = '')
+    public function __construct(string $apiVersion = GraphConstants::V1_API_VERSION, string $serviceLibraryVersion = '')
     {
         $this->setApiVersion($apiVersion);
         $this->serviceLibraryVersion = $serviceLibraryVersion;

src/Models/LargeFileUploadCreateSessionBody.php

@@ -23,6 +23,7 @@ public function __construct() {
      * @inheritDoc
      */
     public function getAdditionalData(): ?array {
+        /** @phpstan-ignore-next-line */
         return $this->backingStore->get('additionalData');
     }