UHF-8525: Renamed pubsub access_token setting to access_key to match …

…the actual name
City-of-Helsinki · Aug 31, 2023 · 284620a · 284620a
1 parent 917de45
commit 284620a
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 12 deletions.
diff --git a/config/schema/helfi_api_base.schema.yml b/config/schema/helfi_api_base.schema.yml
@@ -35,7 +35,7 @@ helfi_api_base.pubsub.settings:
   mapping:
     endpoint:
       type: string
-    access_token:
+    access_key:
       type: string
     hub:
       type: string

diff --git a/documentation/pubsub-messaging.md b/documentation/pubsub-messaging.md
@@ -7,7 +7,7 @@ Provides an integration to [Azure's Web PubSub service](https://azure.microsoft.
 You must define the following settings to use this feature:
 
 ```php
-$config['helfi_api_base.pubsub.settings']['access_token'] = '<access-token>';
+$config['helfi_api_base.pubsub.settings']['access_key'] = '<access-key>';
 // Url to Azure's wss endpoint, usually something like: yourservicename.webpubsub.azure.com
 $config['helfi_api_base.pubsub.settings']['endpoint'] = '<url to azure pubsub endpoint>';
 // Hub and group must be same in all instances that talk with each other.
@@ -82,7 +82,7 @@ See [CacheTagInvalidatorSubscriber](/src/EventSubscriber/CacheTagInvalidatorSubs
 
 ```php
 # public/sites/default/local.settings.php
-$config['helfi_api_base.pubsub.settings']['access_token'] = '<access-token>';
+$config['helfi_api_base.pubsub.settings']['access_key'] = '<access-key>';
 $config['helfi_api_base.pubsub.settings']['endpoint'] = '<url to azure pubsub endpoint>';
 $config['helfi_api_base.pubsub.settings']['hub'] = '<hub>';
 $config['helfi_api_base.pubsub.settings']['group'] = '<group>';

diff --git a/src/Azure/PubSub/PubSubClientFactory.php b/src/Azure/PubSub/PubSubClientFactory.php
@@ -35,7 +35,7 @@ public function create(Settings $settings, TimeInterface $time) : Client {
         'webpubsub.sendToGroup',
         'webpubsub.joinLeaveGroup',
       ],
-    ], $settings->accessToken, 'HS256');
+    ], $settings->accessKey, 'HS256');
 
     return new Client($url, [
       'headers' => [

diff --git a/src/Azure/PubSub/Settings.php b/src/Azure/PubSub/Settings.php
@@ -18,14 +18,14 @@ final class Settings {
    *   The group.
    * @param string $endpoint
    *   The API endpoint.
-   * @param string $accessToken
+   * @param string $accessKey
    *   The API access token.
    */
   public function __construct(
     public readonly string $hub,
     public readonly string $group,
     public readonly string $endpoint,
-    public readonly string $accessToken,
+    public readonly string $accessKey,
   ) {
   }
 

diff --git a/tests/src/Kernel/Cache/CacheTagInvalidatorTest.php b/tests/src/Kernel/Cache/CacheTagInvalidatorTest.php
@@ -39,7 +39,7 @@ protected function setUp() : void {
       ->set('endpoint', 'wss://localhost')
       ->set('hub', 'hub')
       ->set('group', 'group')
-      ->set('access_token', '123')
+      ->set('access_key', '123')
       ->save();
   }
 

diff --git a/tests/src/Unit/Azure/PubSub/SettingsTest.php b/tests/src/Unit/Azure/PubSub/SettingsTest.php
@@ -30,7 +30,7 @@ public function testSettings(array $values, array $expectedValues) : void {
     $this->assertSame($settings->hub, $expectedValues['hub']);
     $this->assertSame($settings->group, $expectedValues['group']);
     $this->assertSame($settings->endpoint, $expectedValues['endpoint']);
-    $this->assertSame($settings->accessToken, $expectedValues['access_token']);
+    $this->assertSame($settings->accessKey, $expectedValues['access_key']);
   }
 
   /**
@@ -46,13 +46,13 @@ public function settingsData() : array {
           'hub' => 'hub',
           'group' => 'group',
           'endpoint' => 'endpoint',
-          'access_token' => 'access_token',
+          'access_key' => 'access_key',
         ],
         [
           'hub' => 'hub',
           'group' => 'group',
           'endpoint' => 'endpoint',
-          'access_token' => 'access_token',
+          'access_key' => 'access_key',
         ],
       ],
     ];
@@ -63,13 +63,13 @@ public function settingsData() : array {
           'hub' => $value,
           'group' => $value,
           'endpoint' => $value,
-          'access_token' => $value,
+          'access_key' => $value,
         ],
         [
           'hub' => '',
           'group' => '',
           'endpoint' => '',
-          'access_token' => '',
+          'access_key' => '',
         ],
       ];
     }