From 5be6d8e90bd3fe275c31750169ab6471f94cfbfd Mon Sep 17 00:00:00 2001
From: Steven Nguyen <stnguyen90@users.noreply.github.com>
Date: Thu, 20 Jul 2023 15:54:38 -0700
Subject: [PATCH] Update Project providers to also include the provider key

Pass the provider key and name back so that a nicely formatted name
can be shown in the Appwrite Console.
---
 app/config/providers.php                                  | 4 ++--
 src/Appwrite/Utopia/Response/Model/Project.php            | 5 +++--
 src/Appwrite/Utopia/Response/Model/Provider.php           | 6 ++++++
 tests/e2e/Services/Projects/ProjectsConsoleClientTest.php | 4 ++--
 4 files changed, 13 insertions(+), 6 deletions(-)

diff --git a/app/config/providers.php b/app/config/providers.php
index 5e4dc0aa11..dedb4ec665 100644
--- a/app/config/providers.php
+++ b/app/config/providers.php
@@ -232,7 +232,7 @@ return [ // Ordered by ABC.
         'mock' => false
     ],
     'paypalSandbox' => [
-        'name' => 'PayPal',
+        'name' => 'PayPal Sandbox',
         'developers' => 'https://developer.paypal.com/docs/api/overview/',
         'icon' => 'icon-paypal',
         'enabled' => true,
@@ -302,7 +302,7 @@ return [ // Ordered by ABC.
         'mock' => false,
     ],
     'tradeshiftBox' => [
-        'name' => 'Tradeshift',
+        'name' => 'Tradeshift Sandbox',
         'developers' => 'https://developers.tradeshift.com/docs/api',
         'icon' => 'icon-tradeshiftbox',
         'enabled' => true,
diff --git a/src/Appwrite/Utopia/Response/Model/Project.php b/src/Appwrite/Utopia/Response/Model/Project.php
index 6fbc794698..ed41c250fc 100644
--- a/src/Appwrite/Utopia/Response/Model/Project.php
+++ b/src/Appwrite/Utopia/Response/Model/Project.php
@@ -136,7 +136,7 @@ class Project extends Model
                 'type' => Response::MODEL_PROVIDER,
                 'description' => 'List of Providers.',
                 'default' => [],
-                'example' => new \stdClass(),
+                'example' => [new \stdClass()],
                 'array' => true,
             ])
             ->addRule('platforms', [
@@ -273,7 +273,8 @@ class Project extends Model
             }
 
             $projectProviders[] = new Document([
-                'name' => ucfirst($key),
+                'key' => $key,
+                'name' => $provider['name'] ?? '',
                 'appId' => $providerValues[$key . 'Appid'] ?? '',
                 'secret' => $providerValues[$key . 'Secret'] ?? '',
                 'enabled' => $providerValues[$key . 'Enabled'] ?? false,
diff --git a/src/Appwrite/Utopia/Response/Model/Provider.php b/src/Appwrite/Utopia/Response/Model/Provider.php
index 0f14993508..c589011a46 100644
--- a/src/Appwrite/Utopia/Response/Model/Provider.php
+++ b/src/Appwrite/Utopia/Response/Model/Provider.php
@@ -15,6 +15,12 @@ class Provider extends Model
     public function __construct()
     {
         $this
+            ->addRule('key', [
+                'type' => self::TYPE_STRING,
+                'description' => 'Provider.',
+                'default' => '',
+                'example' => 'github',
+            ])
             ->addRule('name', [
                 'type' => self::TYPE_STRING,
                 'description' => 'Provider name.',
diff --git a/tests/e2e/Services/Projects/ProjectsConsoleClientTest.php b/tests/e2e/Services/Projects/ProjectsConsoleClientTest.php
index c09bd262e3..52991b4621 100644
--- a/tests/e2e/Services/Projects/ProjectsConsoleClientTest.php
+++ b/tests/e2e/Services/Projects/ProjectsConsoleClientTest.php
@@ -618,7 +618,7 @@ class ProjectsConsoleClientTest extends Scope
         foreach ($providers as $key => $provider) {
             $asserted = false;
             foreach ($response['body']['providers'] as $responseProvider) {
-                if ($responseProvider['name'] === ucfirst($key)) {
+                if ($responseProvider['key'] === $key) {
                     $this->assertEquals('AppId-' . ucfirst($key), $responseProvider['appId']);
                     $this->assertEquals('Secret-' . ucfirst($key), $responseProvider['secret']);
                     $this->assertFalse($responseProvider['enabled']);
@@ -660,7 +660,7 @@ class ProjectsConsoleClientTest extends Scope
         foreach ($providers as $key => $provider) {
             $asserted = false;
             foreach ($response['body']['providers'] as $responseProvider) {
-                if ($responseProvider['name'] === ucfirst($key)) {
+                if ($responseProvider['key'] === $key) {
                     // On first provider, test enabled=false
                     $this->assertEquals($i !== 0, $responseProvider['enabled']);
                     $asserted = true;