Merge pull request #167 from microsoftgraph/dev

Release 2.1.0

Author: Ndiritu

CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+### Changed
+
+## [2.1.0]
+
+### Added
+
+- Enables initialising `GraphPhpLeagueAccessTokenProvider` with custom cache.

README.md

@@ -8,7 +8,7 @@ To install the `microsoft-graph-core` library with Composer, either run `compose
 ```
 {
     "require": {
-        "microsoft/microsoft-graph-core": "^2.0.3"
+        "microsoft/microsoft-graph-core": "^2.1.0"
     }
 }
 ```

composer.json

@@ -13,7 +13,7 @@
 	],
 	"require": {
 		"php": "^8.0 || ^7.4",
-		"microsoft/kiota-authentication-phpleague": "^1.0.1",
+		"microsoft/kiota-authentication-phpleague": "^1.1.0",
 		"microsoft/kiota-http-guzzle": "^1.1.0",
 		"microsoft/kiota-serialization-json": "^1.0.1",
 		"microsoft/kiota-serialization-text": "^1.0.1",

src/Authentication/GraphPhpLeagueAccessTokenProvider.php

@@ -9,8 +9,8 @@
 namespace Microsoft\Graph\Core\Authentication;
 
 
-use InvalidArgumentException;
 use Microsoft\Graph\Core\NationalCloud;
+use Microsoft\Kiota\Authentication\Cache\AccessTokenCache;
 use Microsoft\Kiota\Authentication\Oauth\ProviderFactory;
 use Microsoft\Kiota\Authentication\Oauth\TokenRequestContext;
 use Microsoft\Kiota\Authentication\PhpLeagueAccessTokenProvider;
@@ -38,13 +38,16 @@ class GraphPhpLeagueAccessTokenProvider extends PhpLeagueAccessTokenProvider
      * @param array<string> $scopes if left empty, it's set to ["https://[graph national cloud host]/.default"] scope
      * @param string $nationalCloud Defaults to https://graph.microsoft.com. See
      * https://learn.microsoft.com/en-us/graph/deployments
+     * @param AccessTokenCache|null $accessTokenCache Defaults to an in-memory cache if null
      */
     public function __construct(
         TokenRequestContext $tokenRequestContext,
         array $scopes = [],
-        string $nationalCloud = NationalCloud::GLOBAL
+        string $nationalCloud = NationalCloud::GLOBAL,
+        ?AccessTokenCache $accessTokenCache = null
     )
     {
+        $nationalCloud = empty($nationalCloud) ? NationalCloud::GLOBAL : $nationalCloud;
         $allowedHosts = [
             "graph.microsoft.com",
             "graph.microsoft.us",
@@ -61,6 +64,24 @@ public function __construct(
             $tokenBaseServiceUrl,
             $nationalCloud
         );
-        parent::__construct($tokenRequestContext, $scopes, $allowedHosts, $oauthProvider);
+        parent::__construct($tokenRequestContext, $scopes, $allowedHosts, $oauthProvider, $accessTokenCache);
+    }
+
+    /**
+     * Get an instance of GraphPhpLeagueAccessTokenProvider with a custom cache
+     *
+     * @param AccessTokenCache $accessTokenCache
+     * @param TokenRequestContext $tokenRequestContext
+     * @param array<string> $scopes
+     * @return GraphPhpLeagueAccessTokenProvider
+     */
+    public static function createWithCache(
+        AccessTokenCache $accessTokenCache,
+        TokenRequestContext $tokenRequestContext,
+        array $scopes = []
+    ): self
+    {
+        return new GraphPhpLeagueAccessTokenProvider(
+            $tokenRequestContext, $scopes, NationalCloud::GLOBAL, $accessTokenCache);
     }
 }

src/Authentication/GraphPhpLeagueAuthenticationProvider.php

@@ -9,8 +9,8 @@
 namespace Microsoft\Graph\Core\Authentication;
 
 use Microsoft\Graph\Core\NationalCloud;
-use Microsoft\Kiota\Abstractions\Authentication\BaseBearerTokenAuthenticationProvider;
 use Microsoft\Kiota\Authentication\Oauth\TokenRequestContext;
+use Microsoft\Kiota\Authentication\PhpLeagueAuthenticationProvider;
 
 /**
  * Class GraphPhpLeagueAuthenticationProvider
@@ -19,7 +19,7 @@
  * @license https://opensource.org/licenses/MIT MIT License
  * @link https://developer.microsoft.com/graph
  */
-class GraphPhpLeagueAuthenticationProvider extends BaseBearerTokenAuthenticationProvider
+class GraphPhpLeagueAuthenticationProvider extends PhpLeagueAuthenticationProvider
 {
     /**
      * @param TokenRequestContext $tokenRequestContext
@@ -34,6 +34,7 @@ public function __construct(
     )
     {
         $accessTokenProvider = new GraphPhpLeagueAccessTokenProvider($tokenRequestContext, $scopes, $nationalCloud);
-        parent::__construct($accessTokenProvider);
+        parent::__construct($tokenRequestContext, $scopes, $accessTokenProvider->getAllowedHosts());
     }
+
 }

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.3";
+    const SDK_VERSION = "2.1.0";
 
     // Define error constants
     const MAX_PAGE_SIZE = 999;

tests/Authentication/GraphPhpLeagueAccessTokenProviderTest.php

@@ -2,9 +2,14 @@
 
 namespace Microsoft\Graph\Core\Test\Authentication;
 
+use GuzzleHttp\Client;
+use GuzzleHttp\Handler\MockHandler;
+use GuzzleHttp\Psr7\Request;
+use GuzzleHttp\Psr7\Response;
 use League\OAuth2\Client\Token\AccessToken;
 use Microsoft\Graph\Core\Authentication\GraphPhpLeagueAccessTokenProvider;
 use Microsoft\Graph\Core\NationalCloud;
+use Microsoft\Kiota\Authentication\Cache\InMemoryAccessTokenCache;
 use Microsoft\Kiota\Authentication\Oauth\ClientCredentialContext;
 use PHPUnit\Framework\TestCase;
 
@@ -44,4 +49,24 @@ public function testCorrectOAuthEndpointsSet(): void
         $this->assertEquals("$baseUrl/tenant/oauth2/v2.0/authorize", $tokenProvider->getOauthProvider()->getBaseAuthorizationUrl());
     }
 
+    public function testCreateWithCache(): void
+    {
+        $tokenRequestContext = new ClientCredentialContext('tenant', 'clientId', 'secret');
+        $cache = new InMemoryAccessTokenCache();
+        $tokenProvider = GraphPhpLeagueAccessTokenProvider::createWithCache($cache, $tokenRequestContext, ['https://graph.microsoft.com/.default']);
+        $mockResponses = [
+            function (Request $request) use ($tokenRequestContext) {
+                parse_str($request->getBody()->getContents(), $requestBodyMap);
+                $expectedBody = array_merge($tokenRequestContext->getParams(), [
+                    'scope' => 'https://graph.microsoft.com/.default'
+                ]);
+                $this->assertEquals($expectedBody, $requestBodyMap);
+                return new Response(200, [], json_encode(['access_token' => 'xyz', 'expires_in' => 1]));
+            },
+        ];
+        $tokenProvider->getOauthProvider()->setHttpClient(new Client(['handler' => new MockHandler($mockResponses)]));
+        $tokenProvider->getAuthorizationTokenAsync('https://graph.microsoft.com/me');
+        $this->assertEquals('xyz', $cache->getTokenWithContext($tokenRequestContext)->getToken());
+    }
+
 }