Beautiful Open-Source Form Builder
Dynamic OauthDriver scope (#544)
Chirag Chhatralada0ea044755e
diff --git a/api/app/Http/Controllers/Auth/OAuthController.php b/api/app/Http/Controllers/Auth/OAuthController.phpindex dfb1a407f..18ad9761f 100644--- a/api/app/Http/Controllers/Auth/OAuthController.php+++ b/api/app/Http/Controllers/Auth/OAuthController.php@@ -93,6 +93,7 @@ class OAuthController extends Controller$oauthProvider->update(['access_token' => $socialiteUser->token,'refresh_token' => $socialiteUser->refreshToken,+ 'scopes' => $socialiteUser->approvedScopes]);return $oauthProvider->user;@@ -139,6 +140,7 @@ class OAuthController extends Controller'refresh_token' => $socialiteUser->refreshToken,'name' => $socialiteUser->getName(),'email' => $socialiteUser->getEmail(),+ 'scopes' => $socialiteUser->approvedScopes]);return $user;diff --git a/api/app/Http/Controllers/Settings/OAuthProviderController.php b/api/app/Http/Controllers/Settings/OAuthProviderController.phpindex f477fe78d..6f6d281bb 100644--- a/api/app/Http/Controllers/Settings/OAuthProviderController.php+++ b/api/app/Http/Controllers/Settings/OAuthProviderController.php@@ -26,8 +26,10 @@ class OAuthProviderController extends Controller$userId = Auth::id();cache()->put("oauth-intention:{$userId}", $request->input('intention'), 60 * 5);+ // Connecting an account for integrations purposes+ // Adding full scopes to the driverreturn response()->json([- 'url' => $service->getDriver()->getRedirectUrl(),+ 'url' => $service->getDriver()->fullScopes()->getRedirectUrl(),]);}@@ -47,6 +49,7 @@ class OAuthProviderController extends Controller'refresh_token' => $driverUser->refreshToken,'name' => $driverUser->getName(),'email' => $driverUser->getEmail(),+ 'scopes' => $driverUser->approvedScopes]);diff --git a/api/app/Http/Resources/OAuthProviderResource.php b/api/app/Http/Resources/OAuthProviderResource.phpindex a7fa2b47e..58247ab67 100644--- a/api/app/Http/Resources/OAuthProviderResource.php+++ b/api/app/Http/Resources/OAuthProviderResource.php@@ -32,6 +32,7 @@ class OAuthProviderResource extends JsonResourcefn () => OAuthProviderUserResource::make($this->resource->user),null,),+ 'scopes' => $this->resource->scopes];}}diff --git a/api/app/Integrations/OAuth/Drivers/Contracts/OAuthDriver.php b/api/app/Integrations/OAuth/Drivers/Contracts/OAuthDriver.phpindex 78f04e291..1ca92a19a 100644--- a/api/app/Integrations/OAuth/Drivers/Contracts/OAuthDriver.php+++ b/api/app/Integrations/OAuth/Drivers/Contracts/OAuthDriver.php@@ -7,7 +7,14 @@ use Laravel\Socialite\Contracts\User;interface OAuthDriver{public function getRedirectUrl(): string;- public function setRedirectUrl($url): self;+ public function setRedirectUrl(string $url): self;+ public function setScopes(array $scopes): self;public function getUser(): User;public function canCreateUser(): bool;++ /**+ * Set up all the scopes required by OpnForm for various integrations.+ * This method configures the necessary permissions for the current OAuth driver.+ */+ public function fullScopes(): self;}diff --git a/api/app/Integrations/OAuth/Drivers/OAuthGoogleDriver.php b/api/app/Integrations/OAuth/Drivers/OAuthGoogleDriver.phpindex aa73d6ad0..e340f7f62 100644--- a/api/app/Integrations/OAuth/Drivers/OAuthGoogleDriver.php+++ b/api/app/Integrations/OAuth/Drivers/OAuthGoogleDriver.php@@ -11,6 +11,7 @@ use Laravel\Socialite\Two\GoogleProvider;class OAuthGoogleDriver implements OAuthDriver{private ?string $redirectUrl = null;+ private ?array $scopes = [];protected GoogleProvider $provider;@@ -22,7 +23,7 @@ class OAuthGoogleDriver implements OAuthDriverpublic function getRedirectUrl(): string{return $this->provider- ->scopes([Sheets::DRIVE_FILE])+ ->scopes($this->scopes ?? [])->stateless()->redirectUrl($this->redirectUrl ?? config('services.google.redirect'))->with([@@ -46,10 +47,20 @@ class OAuthGoogleDriver implements OAuthDriverreturn true;}- public function setRedirectUrl($url): OAuthDriver+ public function setRedirectUrl(string $url): OAuthDriver{$this->redirectUrl = $url;return $this;}+ public function setScopes(array $scopes): OAuthDriver+ {+ $this->scopes = $scopes;+ return $this;+ }++ public function fullScopes(): OAuthDriver+ {+ return $this->setScopes([Sheets::DRIVE_FILE]);+ }}diff --git a/api/app/Models/OAuthProvider.php b/api/app/Models/OAuthProvider.phpindex 1ef6a095a..2fef4cde8 100644--- a/api/app/Models/OAuthProvider.php+++ b/api/app/Models/OAuthProvider.php@@ -30,7 +30,8 @@ class OAuthProvider extends Model* @var array*/protected $hidden = [- 'access_token', 'refresh_token',+ 'access_token',+ 'refresh_token',];protected function casts()@@ -38,6 +39,7 @@ class OAuthProvider extends Modelreturn ['provider' => OAuthProviderService::class,'token_expires_at' => 'datetime',+ 'scopes' => 'array'];}diff --git a/api/database/migrations/2024_08_27_124933_add_scopes_to_oauth_providers.php b/api/database/migrations/2024_08_27_124933_add_scopes_to_oauth_providers.phpnew file mode 100644index 000000000..163ae1e99--- /dev/null+++ b/api/database/migrations/2024_08_27_124933_add_scopes_to_oauth_providers.php@@ -0,0 +1,35 @@+<?php++use Illuminate\Database\Migrations\Migration;+use Illuminate\Database\Query\Expression;+use Illuminate\Database\Schema\Blueprint;+use Illuminate\Support\Facades\DB;+use Illuminate\Support\Facades\Schema;++return new class () extends Migration {+ /**+ * Run the migrations.+ */+ public function up(): void+ {+ $driver = DB::getDriverName();++ Schema::table('oauth_providers', function (Blueprint $table) use ($driver) {+ if ($driver === 'mysql') {+ $table->json('scopes')->default(new Expression('(JSON_OBJECT())'));+ } else {+ $table->json('scopes')->default('{}');+ }+ });+ }++ /**+ * Reverse the migrations.+ */+ public function down(): void+ {+ Schema::table('oauth_providers', function (Blueprint $table) {+ $table->dropColumn('scopes');+ });+ }+};diff --git a/api/database/migrations/2024_08_29_110048_update_oauth_providers_token_columns.php b/api/database/migrations/2024_08_29_110048_update_oauth_providers_token_columns.phpnew file mode 100644index 000000000..9adae6d74--- /dev/null+++ b/api/database/migrations/2024_08_29_110048_update_oauth_providers_token_columns.php@@ -0,0 +1,33 @@+<?php++use Illuminate\Database\Migrations\Migration;+use Illuminate\Database\Schema\Blueprint;+use Illuminate\Support\Facades\Schema;++return new class () extends Migration {+ /**+ * Run the migrations.+ *+ * @return void+ */+ public function up()+ {+ Schema::table('oauth_providers', function (Blueprint $table) {+ $table->text('access_token')->change();+ $table->text('refresh_token')->change();+ });+ }++ /**+ * Reverse the migrations.+ *+ * @return void+ */+ public function down()+ {+ Schema::table('oauth_providers', function (Blueprint $table) {+ $table->string('access_token')->change();+ $table->string('refresh_token')->change();+ });+ }+};diff --git a/client/components/forms/FlatSelectInput.vue b/client/components/forms/FlatSelectInput.vueindex 7f6b4c414..a0aa6090b 100644--- a/client/components/forms/FlatSelectInput.vue+++ b/client/components/forms/FlatSelectInput.vue@@ -33,6 +33,9 @@theme.FlatSelectInput.spacing.vertical,theme.FlatSelectInput.fontSize,theme.FlatSelectInput.option,+ {+ '!cursor-not-allowed !bg-gray-200': disableOptions.includes(option[optionKey]),+ },]"@click="onSelect(option[optionKey])">@@ -50,9 +53,15 @@:theme="theme"/></template>- <p class="flex-grow">- {{ option[displayKey] }}- </p>+ <UTooltip+ :text="disableOptionsTooltip"+ :prevent="!disableOptions.includes(option[optionKey])"+ class="w-full"+ >+ <p class="flex-grow">+ {{ option[displayKey] }}+ </p>+ </UTooltip></div></template><div@@ -98,7 +107,9 @@ export default {emitKey: {type: String, default: "value"},displayKey: {type: String, default: "name"},loading: {type: Boolean, default: false},- multiple: {type: Boolean, default: false},+ multiple: { type: Boolean, default: false },+ disableOptions: { type: Array, default: () => [] },+ disableOptionsTooltip: {type: String, default: "Not allowed"},},setup(props, context) {return {@@ -111,7 +122,7 @@ export default {computed: {},methods: {onSelect(value) {- if (this.disabled) {+ if (this.disabled || this.disableOptions.includes(value)) {return}diff --git a/client/components/open/integrations/GoogleSheetsIntegration.vue b/client/components/open/integrations/GoogleSheetsIntegration.vueindex 51d66722c..9b6352119 100644--- a/client/components/open/integrations/GoogleSheetsIntegration.vue+++ b/client/components/open/integrations/GoogleSheetsIntegration.vue@@ -4,12 +4,17 @@:integration="props.integration":form="form">- <div class="my-5">- <select-input+ <div class="mb-4">+ <p class="text-gray-500 mb-4">+ Adds new entry to spreadsheets on each form submission.+ </p>+ <FlatSelectInputv-if="providers.length"v-model="integrationData.oauth_id"name="provider":options="providers"+ :disable-options="disableProviders"+ disable-options-tooltip="Re-connect account to fix permissions"display-key="email"option-key="id"emit-key="id"@@ -19,8 +24,8 @@<template #help><InputHelp><span>- Add an entry to spreadsheets on each form submission.<NuxtLink+ class="text-blue-500":to="{ name: 'settings-connections' }">Click here@@ -29,7 +34,7 @@</span></InputHelp></template>- </select-input>+ </FlatSelectInput><v-buttonv-else@@ -44,6 +49,7 @@</template><script setup>+import FlatSelectInput from '~/components/forms/FlatSelectInput.vue'import IntegrationWrapper from './components/IntegrationWrapper.vue'const props = defineProps({@@ -55,6 +61,7 @@ const props = defineProps({const providersStore = useOAuthProvidersStore()const providers = computed(() => providersStore.getAll.filter(provider => provider.provider == 'google'))+const disableProviders = computed(() => providersStore.getAll.filter(provider => !provider.scopes.includes(providersStore.googleDrivePermission)).map((provider) => provider.id))function connect () {providersStore.connect('google', true)diff --git a/client/pages/settings/connections.vue b/client/pages/settings/connections.vueindex 73ea1491a..8c28f0c06 100644--- a/client/pages/settings/connections.vue+++ b/client/pages/settings/connections.vue@@ -8,7 +8,7 @@<small class="text-gray-600">Manage your external connections.</small></div><UButton- label="Connect new account"+ label="Connect account"icon="i-heroicons-plus":loading="loading"@click="providerModal = true"diff --git a/client/stores/oauth_providers.js b/client/stores/oauth_providers.jsindex 1e3a15ebf..01631d0a4 100644--- a/client/stores/oauth_providers.js+++ b/client/stores/oauth_providers.js@@ -7,6 +7,8 @@ export const useOAuthProvidersStore = defineStore("oauth_providers", () => {const contentStore = useContentStore()const alert = useAlert()+ const googleDrivePermission = 'https://www.googleapis.com/auth/drive.file'+const services = computed(() => {return [{@@ -92,6 +94,7 @@ export const useOAuthProvidersStore = defineStore("oauth_providers", () => {return {...contentStore,+ googleDrivePermission,services,getService,fetchOAuthProviders,