Skip to content

Commit fd4a81c

Browse files
committed
made review changes
1 parent cbae797 commit fd4a81c

File tree

20 files changed

+201
-176
lines changed

20 files changed

+201
-176
lines changed

app/config/collections.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
use Utopia\Database\Database;
66
use Utopia\Database\Helpers\ID;
77

8-
$providers = Config::getParam('authProviders', []);
8+
$providers = Config::getParam('oAuthProviders', []);
99
$auth = Config::getParam('auth', []);
1010

1111
/**
@@ -4008,7 +4008,7 @@
40084008
'filters' => ['json'],
40094009
],
40104010
[
4011-
'$id' => ID::custom('authProviders'),
4011+
'$id' => ID::custom('oAuthProviders'),
40124012
'type' => Database::VAR_STRING,
40134013
'format' => '',
40144014
'size' => 16384,

app/config/events.php

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -261,29 +261,28 @@
261261
'update' => [
262262
'$description' => 'This event triggers when a message is updated.',
263263
],
264-
'topics' => [
265-
'$model' => Response::MODEL_TOPIC,
264+
],
265+
'topics' => [
266+
'$model' => Response::MODEL_TOPIC,
267+
'$resource' => true,
268+
'$description' => 'This event triggers on any topic event.',
269+
'create' => [
270+
'$description' => 'This event triggers when a provider is created.',
271+
],
272+
'delete' => [
273+
'$description' => 'This event triggers when a provider is deleted.'
274+
],
275+
'subscribers' => [
276+
'$model' => Response::MODEL_SUBSCRIBER,
266277
'$resource' => true,
267-
'$description' => 'This event triggers on any topic event.',
278+
'$description' => 'This event triggers on any subscriber event.',
268279
'create' => [
269-
'$description' => 'This event triggers when a provider is created.',
280+
'$description' => 'This event triggers when a subscriber is created.',
270281
],
271282
'delete' => [
272-
'$description' => 'This event triggers when a provider is deleted.'
273-
],
274-
'subscribers' => [
275-
'$model' => Response::MODEL_SUBSCRIBER,
276-
'$resource' => true,
277-
'$description' => 'This event triggers on any subscriber event.',
278-
'create' => [
279-
'$description' => 'This event triggers when a subscriber is created.',
280-
],
281-
'delete' => [
282-
'$description' => 'This event triggers when a subscriber is deleted.'
283-
],
283+
'$description' => 'This event triggers when a subscriber is deleted.'
284284
],
285285
],
286-
287286
],
288287
'providers' => [
289288
'$model' => Response::MODEL_PROVIDER,

app/controllers/api/account.php

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@
299299
->label('sdk.methodType', 'webAuth')
300300
->label('abuse-limit', 50)
301301
->label('abuse-key', 'ip:{ip}')
302-
->param('provider', '', new WhiteList(\array_keys(Config::getParam('authProviders')), true), 'OAuth2 Provider. Currently, supported providers are: ' . \implode(', ', \array_keys(\array_filter(Config::getParam('authProviders'), fn($node) => (!$node['mock'])))) . '.')
302+
->param('provider', '', new WhiteList(\array_keys(Config::getParam('oAuthProviders')), true), 'OAuth2 Provider. Currently, supported providers are: ' . \implode(', ', \array_keys(\array_filter(Config::getParam('oAuthProviders'), fn($node) => (!$node['mock'])))) . '.')
303303
->param('success', '', fn($clients) => new Host($clients), 'URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project\'s platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.', true, ['clients'])
304304
->param('failure', '', fn($clients) => new Host($clients), 'URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project\'s platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.', true, ['clients'])
305305
->param('scopes', [], new ArrayList(new Text(APP_LIMIT_ARRAY_ELEMENT_SIZE), APP_LIMIT_ARRAY_PARAMS_SIZE), 'A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of ' . APP_LIMIT_ARRAY_PARAMS_SIZE . ' scopes are allowed, each ' . APP_LIMIT_ARRAY_ELEMENT_SIZE . ' characters long.', true)
@@ -311,14 +311,14 @@
311311
$protocol = $request->getProtocol();
312312

313313
$callback = $protocol . '://' . $request->getHostname() . '/v1/account/sessions/oauth2/callback/' . $provider . '/' . $project->getId();
314-
$providerEnabled = $project->getAttribute('authProviders', [])[$provider . 'Enabled'] ?? false;
314+
$providerEnabled = $project->getAttribute('oAuthProviders', [])[$provider . 'Enabled'] ?? false;
315315

316316
if (!$providerEnabled) {
317317
throw new Exception(Exception::PROJECT_PROVIDER_DISABLED, 'This provider is disabled. Please enable the provider from your ' . APP_NAME . ' console to continue.');
318318
}
319319

320-
$appId = $project->getAttribute('authProviders', [])[$provider . 'Appid'] ?? '';
321-
$appSecret = $project->getAttribute('authProviders', [])[$provider . 'Secret'] ?? '{}';
320+
$appId = $project->getAttribute('oAuthProviders', [])[$provider . 'Appid'] ?? '';
321+
$appSecret = $project->getAttribute('oAuthProviders', [])[$provider . 'Secret'] ?? '{}';
322322

323323
if (!empty($appSecret) && isset($appSecret['version'])) {
324324
$key = App::getEnv('_APP_OPENSSL_KEY_V' . $appSecret['version']);
@@ -358,7 +358,7 @@
358358
->label('scope', 'public')
359359
->label('docs', false)
360360
->param('projectId', '', new Text(1024), 'Project ID.')
361-
->param('provider', '', new WhiteList(\array_keys(Config::getParam('authProviders')), true), 'OAuth2 provider.')
361+
->param('provider', '', new WhiteList(\array_keys(Config::getParam('oAuthProviders')), true), 'OAuth2 provider.')
362362
->param('code', '', new Text(2048, 0), 'OAuth2 code. This is a temporary code that the will be later exchanged for an access token.', true)
363363
->param('state', '', new Text(2048), 'Login state params.', true)
364364
->param('error', '', new Text(2048, 0), 'Error code returned from the OAuth2 provider.', true)
@@ -391,7 +391,7 @@
391391
->label('origin', '*')
392392
->label('docs', false)
393393
->param('projectId', '', new Text(1024), 'Project ID.')
394-
->param('provider', '', new WhiteList(\array_keys(Config::getParam('authProviders')), true), 'OAuth2 provider.')
394+
->param('provider', '', new WhiteList(\array_keys(Config::getParam('oAuthProviders')), true), 'OAuth2 provider.')
395395
->param('code', '', new Text(2048, 0), 'OAuth2 code. This is a temporary code that the will be later exchanged for an access token.', true)
396396
->param('state', '', new Text(2048), 'Login state params.', true)
397397
->param('error', '', new Text(2048, 0), 'Error code returned from the OAuth2 provider.', true)
@@ -430,7 +430,7 @@
430430
->label('docs', false)
431431
->label('usage.metric', 'sessions.{scope}.requests.create')
432432
->label('usage.params', ['provider:{request.provider}'])
433-
->param('provider', '', new WhiteList(\array_keys(Config::getParam('authProviders')), true), 'OAuth2 provider.')
433+
->param('provider', '', new WhiteList(\array_keys(Config::getParam('oAuthProviders')), true), 'OAuth2 provider.')
434434
->param('code', '', new Text(2048, 0), 'OAuth2 code. This is a temporary code that the will be later exchanged for an access token.', true)
435435
->param('state', '', new Text(2048), 'OAuth2 state params.', true)
436436
->param('error', '', new Text(2048, 0), 'Error code returned from the OAuth2 provider.', true)
@@ -448,17 +448,17 @@
448448
$callback = $protocol . '://' . $request->getHostname() . '/v1/account/sessions/oauth2/callback/' . $provider . '/' . $project->getId();
449449
$defaultState = ['success' => $project->getAttribute('url', ''), 'failure' => ''];
450450
$validateURL = new URL();
451-
$appId = $project->getAttribute('authProviders', [])[$provider . 'Appid'] ?? '';
452-
$appSecret = $project->getAttribute('authProviders', [])[$provider . 'Secret'] ?? '{}';
453-
$providerEnabled = $project->getAttribute('authProviders', [])[$provider . 'Enabled'] ?? false;
451+
$appId = $project->getAttribute('oAuthProviders', [])[$provider . 'Appid'] ?? '';
452+
$appSecret = $project->getAttribute('oAuthProviders', [])[$provider . 'Secret'] ?? '{}';
453+
$providerEnabled = $project->getAttribute('oAuthProviders', [])[$provider . 'Enabled'] ?? false;
454454

455455
$className = 'Appwrite\\Auth\\OAuth2\\' . \ucfirst($provider);
456456

457457
if (!\class_exists($className)) {
458458
throw new Exception(Exception::PROJECT_PROVIDER_UNSUPPORTED);
459459
}
460460

461-
$providers = Config::getParam('authProviders');
461+
$providers = Config::getParam('oAuthProviders');
462462
$providerName = $providers[$provider]['name'] ?? '';
463463

464464
/** @var Appwrite\Auth\OAuth2 $oauth2 */
@@ -2296,8 +2296,8 @@
22962296
$provider = $session->getAttribute('provider');
22972297
$refreshToken = $session->getAttribute('providerRefreshToken');
22982298

2299-
$appId = $project->getAttribute('authProviders', [])[$provider . 'Appid'] ?? '';
2300-
$appSecret = $project->getAttribute('authProviders', [])[$provider . 'Secret'] ?? '{}';
2299+
$appId = $project->getAttribute('oAuthProviders', [])[$provider . 'Appid'] ?? '';
2300+
$appSecret = $project->getAttribute('oAuthProviders', [])[$provider . 'Secret'] ?? '{}';
23012301

23022302
$className = 'Appwrite\\Auth\\OAuth2\\' . \ucfirst($provider);
23032303

app/controllers/api/avatars.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,8 @@
8484
$accessTokenExpiry = $gitHubSession->getAttribute('providerAccessTokenExpiry');
8585
$refreshToken = $gitHubSession->getAttribute('providerRefreshToken');
8686

87-
$appId = $project->getAttribute('authProviders', [])[$provider . 'Appid'] ?? '';
88-
$appSecret = $project->getAttribute('authProviders', [])[$provider . 'Secret'] ?? '{}';
87+
$appId = $project->getAttribute('oAuthProviders', [])[$provider . 'Appid'] ?? '';
88+
$appSecret = $project->getAttribute('oAuthProviders', [])[$provider . 'Secret'] ?? '{}';
8989

9090
$className = 'Appwrite\\Auth\\OAuth2\\' . \ucfirst($provider);
9191

0 commit comments

Comments
 (0)