Open-Source API Development Ecosystem • https://hoppscotch.io • Offline, On-Prem & Cloud • Web, Desktop & CLI • Open-Source Alternative to Postman, Insomnia
TypeScript apiapi-clientapi-restapi-testingdeveloper-toolsgraphqlhttphttp-clientpwarestrest-apispatestingtesting-toolstoolsvuevuejswebsocket
feat: dynamically load enabled auth providers (#3646)
Akash K5209c0a8ca83
diff --git a/packages/hoppscotch-common/locales/en.json b/packages/hoppscotch-common/locales/en.jsonindex 1d70b503b..55b9a1cb9 100644--- a/packages/hoppscotch-common/locales/en.json+++ b/packages/hoppscotch-common/locales/en.json@@ -308,7 +308,8 @@"proxy_error": "Proxy error","script_fail": "Could not execute pre-request script","something_went_wrong": "Something went wrong",- "test_script_fail": "Could not execute post-request script"+ "test_script_fail": "Could not execute post-request script",+ "authproviders_load_error": "Unable to load auth providers"},"export": {"as_json": "Export as JSON",diff --git a/packages/hoppscotch-common/src/components/app/ActionHandler.vue b/packages/hoppscotch-common/src/components/app/ActionHandler.vueindex 6f1cfa547..89aaa64a0 100644--- a/packages/hoppscotch-common/src/components/app/ActionHandler.vue+++ b/packages/hoppscotch-common/src/components/app/ActionHandler.vue@@ -1,7 +1,7 @@<template><AppShortcuts :show="showShortcuts" @close="showShortcuts = false" /><AppShare :show="showShare" @hide-modal="showShare = false" />- <FirebaseLogin :show="showLogin" @hide-modal="showLogin = false" />+ <FirebaseLogin v-if="showLogin" @hide-modal="showLogin = false" /></template><script setup lang="ts">diff --git a/packages/hoppscotch-common/src/components/firebase/Login.vue b/packages/hoppscotch-common/src/components/firebase/Login.vueindex 2f042cf6b..a9cd44011 100644--- a/packages/hoppscotch-common/src/components/firebase/Login.vue+++ b/packages/hoppscotch-common/src/components/firebase/Login.vue@@ -1,64 +1,71 @@<template><HoppSmartModal- v-if="show"dialog:title="`${t('auth.login_to_hoppscotch')}`"styles="sm:max-w-md"@close="hideModal"><template #body>- <div v-if="mode === 'sign-in'" class="flex flex-col space-y-2">- <HoppSmartItem- v-for="provider in allowedAuthProviders"- :key="provider.id"- :loading="provider.isLoading.value"- :icon="provider.icon"- :label="provider.label"- @click="provider.action"- />-- <hr v-if="additonalLoginItems.length > 0" />-- <HoppSmartItem- v-for="loginItem in additonalLoginItems"- :key="loginItem.id"- :icon="loginItem.icon"- :label="loginItem.text(t)"- @click="doAdditionalLoginItemClickAction(loginItem)"- />- </div>- <form- v-if="mode === 'email'"- class="flex flex-col space-y-2"- @submit.prevent="signInWithEmail"- >- <HoppSmartInput- v-model="form.email"- type="email"- placeholder=" "- :label="t('auth.email')"- input-styles="floating-input"- />-- <HoppButtonPrimary- :loading="signingInWithEmail"- type="submit"- :label="`${t('auth.send_magic_link')}`"- />- </form>- <div v-if="mode === 'email-sent'" class="flex flex-col px-4">- <div class="flex max-w-md flex-col items-center justify-center">- <icon-lucide-inbox class="h-6 w-6 text-accent" />- <h3 class="my-2 text-center text-lg">- {{ t("auth.we_sent_magic_link") }}- </h3>- <p class="text-center">- {{- t("auth.we_sent_magic_link_description", { email: form.email })- }}- </p>+ <template v-if="isLoadingAllowedAuthProviders">+ <div class="flex justify-center">+ <HoppSmartSpinner /></div>- </div>+ </template>++ <template v-else>+ <div v-if="mode === 'sign-in'" class="flex flex-col space-y-2">+ <HoppSmartItem+ v-for="provider in allowedAuthProviders"+ :key="provider.id"+ :loading="provider.isLoading.value"+ :icon="provider.icon"+ :label="provider.label"+ @click="provider.action"+ />++ <hr v-if="additonalLoginItems.length > 0" />++ <HoppSmartItem+ v-for="loginItem in additonalLoginItems"+ :key="loginItem.id"+ :icon="loginItem.icon"+ :label="loginItem.text(t)"+ @click="doAdditionalLoginItemClickAction(loginItem)"+ />+ </div>+ <form+ v-if="mode === 'email'"+ class="flex flex-col space-y-2"+ @submit.prevent="signInWithEmail"+ >+ <HoppSmartInput+ v-model="form.email"+ type="email"+ placeholder=" "+ :label="t('auth.email')"+ input-styles="floating-input"+ />++ <HoppButtonPrimary+ :loading="signingInWithEmail"+ type="submit"+ :label="`${t('auth.send_magic_link')}`"+ />+ </form>+ <div v-if="mode === 'email-sent'" class="flex flex-col px-4">+ <div class="flex max-w-md flex-col items-center justify-center">+ <icon-lucide-inbox class="h-6 w-6 text-accent" />+ <h3 class="my-2 text-center text-lg">+ {{ t("auth.we_sent_magic_link") }}+ </h3>+ <p class="text-center">+ {{+ t("auth.we_sent_magic_link_description", { email: form.email })+ }}+ </p>+ </div>+ </div>+ </template></template><template #footer><div@@ -109,7 +116,7 @@</template><script setup lang="ts">-import { Ref, computed, onMounted, ref } from "vue"+import { Ref, onMounted, ref } from "vue"import { useI18n } from "@composables/i18n"import { useStreamSubscriber } from "@composables/stream"@@ -127,9 +134,7 @@ import { useService } from "dioc/vue"import { LoginItemDef } from "~/platform/auth"import { PersistenceService } from "~/services/persistence"-defineProps<{- show: boolean-}>()+import * as E from "fp-ts/Either"const emit = defineEmits<{(e: "hide-modal"): void@@ -145,6 +150,8 @@ const form = {email: "",}+const isLoadingAllowedAuthProviders = ref(true)+const signingInWithGoogle = ref(false)const signingInWithGitHub = ref(false)const signingInWithMicrosoft = ref(false)@@ -162,21 +169,42 @@ type AuthProviderItem = {isLoading: Ref<boolean>}-const additonalLoginItems = computed(- () => platform.auth.additionalLoginItems ?? []-)+let allowedAuthProviders: AuthProviderItem[] = []+let additonalLoginItems: LoginItemDef[] = []const doAdditionalLoginItemClickAction = async (item: LoginItemDef) => {await item.onClick()emit("hide-modal")}-onMounted(() => {+onMounted(async () => {const currentUser$ = platform.auth.getCurrentUserStream()subscribeToStream(currentUser$, (user) => {if (user) hideModal()})++ const res = await platform.auth.getAllowedAuthProviders()++ if (E.isLeft(res)) {+ toast.error(`${t("error.authproviders_load_error")}`)+ isLoadingAllowedAuthProviders.value = false+ return+ }++ // setup the normal auth providers+ const enabledAuthProviders = authProvidersAvailable.filter((provider) =>+ res.right.includes(provider.id)+ )+ allowedAuthProviders = enabledAuthProviders++ // setup the additional login items+ additonalLoginItems =+ platform.auth.additionalLoginItems?.filter((item) =>+ res.right.includes(item.id)+ ) ?? []++ isLoadingAllowedAuthProviders.value = false})const showLoginSuccess = () => {@@ -275,14 +303,7 @@ const signInWithEmail = async () => {})}-const hideModal = () => {- mode.value = "sign-in"- toast.clear()-- emit("hide-modal")-}--const authProviders: AuthProviderItem[] = [+const authProvidersAvailable: AuthProviderItem[] = [{id: "GITHUB",icon: IconGithub,@@ -315,19 +336,10 @@ const authProviders: AuthProviderItem[] = [},]-// Do not format the `import.meta.env.VITE_ALLOWED_AUTH_PROVIDERS` call into multiple lines!-// prettier-ignore-const allowedAuthProvidersIDsString =- import.meta.env.VITE_ALLOWED_AUTH_PROVIDERS--const allowedAuthProvidersIDs = allowedAuthProvidersIDsString- ? allowedAuthProvidersIDsString.split(",")- : []--const allowedAuthProviders =- allowedAuthProvidersIDs.length > 0- ? authProviders.filter((provider) =>- allowedAuthProvidersIDs.includes(provider.id)- )- : authProviders+const hideModal = () => {+ mode.value = "sign-in"+ toast.clear()++ emit("hide-modal")+}</script>diff --git a/packages/hoppscotch-common/src/platform/auth.ts b/packages/hoppscotch-common/src/platform/auth.tsindex 529f51133..d2920c46e 100644--- a/packages/hoppscotch-common/src/platform/auth.ts+++ b/packages/hoppscotch-common/src/platform/auth.ts@@ -2,6 +2,7 @@ import { ClientOptions } from "@urql/core"import { Observable } from "rxjs"import { Component } from "vue"import { getI18n } from "~/modules/i18n"+import * as E from "fp-ts/Either"/*** A common (and required) set of fields that describe a user.@@ -222,6 +223,11 @@ export type AuthPlatformDef = {*/setDisplayName: (name: string) => Promise<void>+ /**+ * Returns the list of allowed auth providers for the platform ( the currently supported ones are GOOGLE, GITHUB, EMAIL, MICROSOFT, SAML )+ */+ getAllowedAuthProviders: () => Promise<E.Either<string, string[]>>+/*** Defines the additional login items that should be shown in the login screen*/diff --git a/packages/hoppscotch-selfhost-web/package.json b/packages/hoppscotch-selfhost-web/package.jsonindex fef4de863..97ae9e75d 100644--- a/packages/hoppscotch-selfhost-web/package.json+++ b/packages/hoppscotch-selfhost-web/package.json@@ -37,7 +37,8 @@"stream-browserify": "^3.0.0","util": "^0.12.5","vue": "^3.3.8",- "workbox-window": "^7.0.0"+ "workbox-window": "^7.0.0",+ "zod": "^3.22.4"},"devDependencies": {"@graphql-codegen/add": "^5.0.0",diff --git a/packages/hoppscotch-selfhost-web/src/main.ts b/packages/hoppscotch-selfhost-web/src/main.tsindex 6d3a3278e..46be730c5 100644--- a/packages/hoppscotch-selfhost-web/src/main.ts+++ b/packages/hoppscotch-selfhost-web/src/main.ts@@ -1,5 +1,5 @@import { createHoppApp } from "@hoppscotch/common"-import { def as authDef } from "./platform/auth"+import { def as authDef } from "./platform/auth/auth.platform"import { def as environmentsDef } from "./platform/environments/environments.platform"import { def as collectionsDef } from "./platform/collections/collections.platform"import { def as settingsDef } from "./platform/settings/settings.platform"diff --git a/packages/hoppscotch-selfhost-web/src/platform/auth/auth.api.ts b/packages/hoppscotch-selfhost-web/src/platform/auth/auth.api.tsnew file mode 100644index 000000000..ee0808715--- /dev/null+++ b/packages/hoppscotch-selfhost-web/src/platform/auth/auth.api.ts@@ -0,0 +1,30 @@+import axios from "axios"+import * as E from "fp-ts/Either"+import { z } from "zod"++const expectedAllowedProvidersSchema = z.object({+ // currently supported values are "GOOGLE", "GITHUB", "EMAIL", "MICROSOFT", "SAML"+ // keeping it as string to avoid backend accidentally breaking frontend when adding new providers+ providers: z.array(z.string()),+})++export const getAllowedAuthProviders = async () => {+ try {+ const res = await axios.get(+ `${import.meta.env.VITE_BACKEND_API_URL}/auth/providers`,+ {+ withCredentials: true,+ }+ )++ const parseResult = expectedAllowedProvidersSchema.safeParse(res.data)++ if (!parseResult.success) {+ return E.left("SOMETHING_WENT_WRONG")+ }++ return E.right(parseResult.data.providers)+ } catch (_) {+ return E.left("SOMETHING_WENT_WRONG")+ }+}diff --git a/packages/hoppscotch-selfhost-web/src/platform/auth.ts b/packages/hoppscotch-selfhost-web/src/platform/auth/auth.platform.tssimilarity index 99%rename from packages/hoppscotch-selfhost-web/src/platform/auth.tsrename to packages/hoppscotch-selfhost-web/src/platform/auth/auth.platform.tsindex 879b9249a..6783f60df 100644--- a/packages/hoppscotch-selfhost-web/src/platform/auth.ts+++ b/packages/hoppscotch-selfhost-web/src/platform/auth/auth.platform.ts@@ -8,6 +8,7 @@ import { PersistenceService } from "@hoppscotch/common/services/persistence"import axios from "axios"import { BehaviorSubject, Subject } from "rxjs"import { Ref, ref, watch } from "vue"+import { getAllowedAuthProviders } from "./auth.api"export const authEvents$ = new Subject<AuthEvent | { event: "token_refresh" }>()const currentUser$ = new BehaviorSubject<HoppUser | null>(null)@@ -341,4 +342,5 @@ export const def: AuthPlatformDef = {window.location.href = "/"}},+ getAllowedAuthProviders,}diff --git a/packages/hoppscotch-selfhost-web/src/platform/collections/collections.platform.ts b/packages/hoppscotch-selfhost-web/src/platform/collections/collections.platform.tsindex 568c80a36..234d45e57 100644--- a/packages/hoppscotch-selfhost-web/src/platform/collections/collections.platform.ts+++ b/packages/hoppscotch-selfhost-web/src/platform/collections/collections.platform.ts@@ -1,4 +1,4 @@-import { authEvents$, def as platformAuth } from "@platform/auth"+import { authEvents$, def as platformAuth } from "@platform/auth/auth.platform"import { CollectionsPlatformDef } from "@hoppscotch/common/platform/collections"import { runDispatchWithOutSyncing } from "../../lib/sync"diff --git a/packages/hoppscotch-selfhost-web/src/platform/environments/environments.platform.ts b/packages/hoppscotch-selfhost-web/src/platform/environments/environments.platform.tsindex 8d5042228..93b88cac5 100644--- a/packages/hoppscotch-selfhost-web/src/platform/environments/environments.platform.ts+++ b/packages/hoppscotch-selfhost-web/src/platform/environments/environments.platform.ts@@ -1,4 +1,4 @@-import { authEvents$, def as platformAuth } from "@platform/auth"+import { authEvents$, def as platformAuth } from "@platform/auth/auth.platform"import {createEnvironment,deleteEnvironment,diff --git a/packages/hoppscotch-selfhost-web/src/platform/history/history.platform.ts b/packages/hoppscotch-selfhost-web/src/platform/history/history.platform.tsindex fd0042a71..9e364e304 100644--- a/packages/hoppscotch-selfhost-web/src/platform/history/history.platform.ts+++ b/packages/hoppscotch-selfhost-web/src/platform/history/history.platform.ts@@ -1,4 +1,4 @@-import { authEvents$, def as platformAuth } from "@platform/auth"+import { authEvents$, def as platformAuth } from "@platform/auth/auth.platform"import {restHistoryStore,RESTHistoryEntry,diff --git a/packages/hoppscotch-selfhost-web/src/platform/settings/settings.platform.ts b/packages/hoppscotch-selfhost-web/src/platform/settings/settings.platform.tsindex a8aca2e72..61b838810 100644--- a/packages/hoppscotch-selfhost-web/src/platform/settings/settings.platform.ts+++ b/packages/hoppscotch-selfhost-web/src/platform/settings/settings.platform.ts@@ -1,6 +1,6 @@import { SettingsPlatformDef } from "@hoppscotch/common/platform/settings"import { settingsSyncer } from "./settings.sync"-import { authEvents$, def as platformAuth } from "@platform/auth"+import { authEvents$, def as platformAuth } from "@platform/auth/auth.platform"import {createUserSettings,getUserSettings,diff --git a/packages/hoppscotch-selfhost-web/src/platform/tabState/tabState.platform.ts b/packages/hoppscotch-selfhost-web/src/platform/tabState/tabState.platform.tsindex 2c8966010..1ce65094a 100644--- a/packages/hoppscotch-selfhost-web/src/platform/tabState/tabState.platform.ts+++ b/packages/hoppscotch-selfhost-web/src/platform/tabState/tabState.platform.ts@@ -2,7 +2,7 @@ import { PersistableTabState } from "@hoppscotch/common/services/tab"import { HoppRESTDocument } from "@hoppscotch/common/helpers/rest/document"import { HoppUser } from "@hoppscotch/common/platform/auth"import { TabStatePlatformDef } from "@hoppscotch/common/platform/tab"-import { def as platformAuth } from "@platform/auth"+import { def as platformAuth } from "@platform/auth/auth.platform"import { getCurrentRestSession, updateUserSession } from "./tabState.api"import { SessionType } from "../../api/generated/graphql"import * as E from "fp-ts/Either"diff --git a/pnpm-lock.yaml b/pnpm-lock.yamlindex cc0dde3d4..94fd6bca9 100644--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -1099,6 +1099,9 @@ importers:workbox-window:specifier: ^7.0.0version: 7.0.0+ zod:+ specifier: ^3.22.4+ version: 3.22.4devDependencies:'@graphql-codegen/add':specifier: ^5.0.0@@ -7645,7 +7648,7 @@ packages:dependencies:'@intlify/bundle-utils': 7.4.0([email protected])'@intlify/shared': 9.4.1- '@rollup/pluginutils': 5.0.3([email protected])+ '@rollup/pluginutils': 5.0.3([email protected])'@vue/compiler-sfc': 3.3.10debug: 4.3.4([email protected])fast-glob: 3.3.1@@ -9365,6 +9368,7 @@ packages:estree-walker: 2.0.2picomatch: 2.3.1rollup: 2.79.1+ dev: true/@rollup/[email protected]([email protected]):resolution: {integrity: sha512-hfllNN4a80rwNQ9QCxhxuHCGHMAvabXqxNdaChUSSadMre7t4iEUI6fFAhBOn/eIYTgYVhBv7vCLsAJ4u3lf3g==}@@ -9379,7 +9383,6 @@ packages:estree-walker: 2.0.2picomatch: 2.3.1rollup: 3.29.4- dev: true/@rollup/[email protected]([email protected]):resolution: {integrity: sha512-XTIWOPPcpvyKI6L1NHo0lFlCyznUEyPmPY1mc3KpPVDYulHSTvyeLNVW00QTLIAFNhR3kYnJTQHeGqU4M3n09g==}@@ -11264,7 +11267,7 @@ packages:regenerator-runtime: 0.13.11systemjs: 6.14.2terser: 5.24.0transitivePeerDependencies:- supports-color@@ -11297,7 +11300,7 @@ packages:vite: ^4.0.0 || ^5.0.0vue: ^3.2.25dependencies:vue: 3.3.9([email protected])dev: true@@ -11857,7 +11860,7 @@ packages:dependencies:'@vue/compiler-ssr': 3.3.9'@vue/shared': 3.3.9- vue: 3.3.9([email protected])+ vue: 3.3.9([email protected])/@vue/[email protected]:resolution: {integrity: sha512-Ewzq5Yhimg7pSztDV+RH1UDKBzmtqieXQlpTVm2AwraoRL/Rks96mvd8Vgi7Lj+h+TH8dv7mXD3FRZR3TUvbSg==}@@ -23454,6 +23457,7 @@ packages:chokidar: 3.5.3immutable: 4.3.2source-map-js: 1.0.2+ dev: trueresolution: {integrity: sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw==}@@ -25457,7 +25461,7 @@ packages:dependencies:fast-glob: 3.3.1unplugin: 1.4.0dev: true@@ -26279,7 +26283,7 @@ packages:vite: ^2.0.0 || ^3.0.0 || ^4.0.0dependencies:fast-glob: 3.3.1dev: true@@ -26297,7 +26301,7 @@ packages:peerDependencies:vite: '>=2.0.0'dependencies:dev: true@@ -26538,7 +26542,7 @@ packages:debug: 4.3.4([email protected])fast-glob: 3.3.2pretty-bytes: 6.1.1workbox-build: 7.0.0workbox-window: 7.0.0transitivePeerDependencies:@@ -26632,7 +26636,7 @@ packages:'@vue/compiler-sfc': 3.3.8debug: 4.3.4([email protected])fast-glob: 3.3.1vue: 3.3.9([email protected])vue-router: 4.2.5([email protected])transitivePeerDependencies:@@ -26758,7 +26762,6 @@ packages:terser: 5.24.0optionalDependencies:fsevents: 2.3.3- dev: trueresolution: {integrity: sha512-ulr8rNLA6rkyFAlVWw2q5YJ91v098AFQ2R0PRFwPzREXOUJQPtFUG0t+/ZikhaOCDqFoDhN6/v8Sq0o4araFAw==}@@ -26790,12 +26793,13 @@ packages:dependencies:'@types/node': 17.0.27esbuild: 0.18.20- postcss: 8.4.31+ postcss: 8.4.32rollup: 3.29.4sass: 1.69.5terser: 5.24.0optionalDependencies:fsevents: 2.3.3+ dev: trueresolution: {integrity: sha512-ulr8rNLA6rkyFAlVWw2q5YJ91v098AFQ2R0PRFwPzREXOUJQPtFUG0t+/ZikhaOCDqFoDhN6/v8Sq0o4araFAw==}