feat: introducing server configurations in admin dashboard (#3628)
Co-authored-by: jamesgeorge007 <jamesgeorge998001@gmail.com>
This commit is contained in:
Joel Jacob Stephen
committed by
GitHub
GitHub
parent
a8cc569786
commit
f3edd001d7
345
packages/hoppscotch-sh-admin/src/composables/useConfigHandler.ts
Normal file
345
packages/hoppscotch-sh-admin/src/composables/useConfigHandler.ts
Normal file
@@ -0,0 +1,345 @@
|
||||
import { computed, onMounted, ref } from 'vue';
|
||||
import { cloneDeep } from 'lodash-es';
|
||||
import { UseMutationResponse } from '@urql/vue';
|
||||
import { useClientHandler } from './useClientHandler';
|
||||
import { useToast } from './toast';
|
||||
import { useI18n } from '~/composables/i18n';
|
||||
import {
|
||||
InfraConfigEnum,
|
||||
InfraConfigsDocument,
|
||||
AllowedAuthProvidersDocument,
|
||||
EnableAndDisableSsoMutation,
|
||||
UpdateInfraConfigsMutation,
|
||||
ResetInfraConfigsMutation,
|
||||
EnableAndDisableSsoArgs,
|
||||
InfraConfigArgs,
|
||||
} from '~/helpers/backend/graphql';
|
||||
|
||||
// Types
|
||||
export type SsoAuthProviders = 'google' | 'microsoft' | 'github';
|
||||
|
||||
export type Config = {
|
||||
providers: {
|
||||
google: {
|
||||
name: SsoAuthProviders;
|
||||
enabled: boolean;
|
||||
fields: {
|
||||
client_id: string;
|
||||
client_secret: string;
|
||||
};
|
||||
};
|
||||
github: {
|
||||
name: SsoAuthProviders;
|
||||
enabled: boolean;
|
||||
fields: {
|
||||
client_id: string;
|
||||
client_secret: string;
|
||||
};
|
||||
};
|
||||
microsoft: {
|
||||
name: SsoAuthProviders;
|
||||
enabled: boolean;
|
||||
fields: {
|
||||
client_id: string;
|
||||
client_secret: string;
|
||||
};
|
||||
};
|
||||
};
|
||||
|
||||
mailConfigs: {
|
||||
name: string;
|
||||
enabled: boolean;
|
||||
fields: {
|
||||
mailer_smtp_url: string;
|
||||
mailer_from_address: string;
|
||||
};
|
||||
};
|
||||
};
|
||||
|
||||
type UpdatedConfigs = {
|
||||
name: string;
|
||||
value: string;
|
||||
};
|
||||
|
||||
/** Composable that handles all operations related to server configurations
|
||||
* @param updatedConfigs A Config Object contatining the updated configs
|
||||
*/
|
||||
export function useConfigHandler(updatedConfigs?: Config) {
|
||||
const t = useI18n();
|
||||
const toast = useToast();
|
||||
|
||||
// Fetching infra configurations
|
||||
const {
|
||||
fetching: fetchingInfraConfigs,
|
||||
error: infraConfigsError,
|
||||
list: infraConfigs,
|
||||
fetchList: fetchInfraConfigs,
|
||||
} = useClientHandler(InfraConfigsDocument, (x) => x.infraConfigs, {
|
||||
configNames: [
|
||||
'GOOGLE_CLIENT_ID',
|
||||
'GOOGLE_CLIENT_SECRET',
|
||||
'MICROSOFT_CLIENT_ID',
|
||||
'MICROSOFT_CLIENT_SECRET',
|
||||
'GITHUB_CLIENT_ID',
|
||||
'GITHUB_CLIENT_SECRET',
|
||||
'MAILER_SMTP_URL',
|
||||
'MAILER_ADDRESS_FROM',
|
||||
] as InfraConfigEnum[],
|
||||
});
|
||||
|
||||
// Fetching allowed auth providers
|
||||
const {
|
||||
fetching: fetchingAllowedAuthProviders,
|
||||
error: allowedAuthProvidersError,
|
||||
list: allowedAuthProviders,
|
||||
fetchList: fetchAllowedAuthProviders,
|
||||
} = useClientHandler(
|
||||
AllowedAuthProvidersDocument,
|
||||
(x) => x.allowedAuthProviders,
|
||||
{}
|
||||
);
|
||||
|
||||
// Current and working configs
|
||||
const currentConfigs = ref<Config>();
|
||||
const workingConfigs = ref<Config>();
|
||||
|
||||
onMounted(async () => {
|
||||
await fetchInfraConfigs();
|
||||
await fetchAllowedAuthProviders();
|
||||
|
||||
// Transforming the fetched data into a Configs object
|
||||
currentConfigs.value = {
|
||||
providers: {
|
||||
google: {
|
||||
name: 'google',
|
||||
enabled: allowedAuthProviders.value.includes('GOOGLE'),
|
||||
fields: {
|
||||
client_id:
|
||||
infraConfigs.value.find((x) => x.name === 'GOOGLE_CLIENT_ID')
|
||||
?.value ?? '',
|
||||
client_secret:
|
||||
infraConfigs.value.find((x) => x.name === 'GOOGLE_CLIENT_SECRET')
|
||||
?.value ?? '',
|
||||
},
|
||||
},
|
||||
github: {
|
||||
name: 'github',
|
||||
enabled: allowedAuthProviders.value.includes('GITHUB'),
|
||||
fields: {
|
||||
client_id:
|
||||
infraConfigs.value.find((x) => x.name === 'GITHUB_CLIENT_ID')
|
||||
?.value ?? '',
|
||||
client_secret:
|
||||
infraConfigs.value.find((x) => x.name === 'GITHUB_CLIENT_SECRET')
|
||||
?.value ?? '',
|
||||
},
|
||||
},
|
||||
microsoft: {
|
||||
name: 'microsoft',
|
||||
enabled: allowedAuthProviders.value.includes('MICROSOFT'),
|
||||
fields: {
|
||||
client_id:
|
||||
infraConfigs.value.find((x) => x.name === 'MICROSOFT_CLIENT_ID')
|
||||
?.value ?? '',
|
||||
client_secret:
|
||||
infraConfigs.value.find(
|
||||
(x) => x.name === 'MICROSOFT_CLIENT_SECRET'
|
||||
)?.value ?? '',
|
||||
},
|
||||
},
|
||||
},
|
||||
mailConfigs: {
|
||||
name: 'email',
|
||||
enabled: allowedAuthProviders.value.includes('EMAIL'),
|
||||
fields: {
|
||||
mailer_smtp_url:
|
||||
infraConfigs.value.find((x) => x.name === 'MAILER_SMTP_URL')
|
||||
?.value ?? '',
|
||||
mailer_from_address:
|
||||
infraConfigs.value.find((x) => x.name === 'MAILER_ADDRESS_FROM')
|
||||
?.value ?? '',
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
// Cloning the current configs to working configs
|
||||
// Changes are made only to working configs
|
||||
workingConfigs.value = cloneDeep(currentConfigs.value);
|
||||
});
|
||||
|
||||
// Trasforming the working configs back into the format required by the mutations
|
||||
const updatedInfraConfigs = computed(() => {
|
||||
let config: UpdatedConfigs[] = [
|
||||
{
|
||||
name: '',
|
||||
value: '',
|
||||
},
|
||||
];
|
||||
|
||||
if (updatedConfigs?.providers.google.enabled) {
|
||||
config.push(
|
||||
{
|
||||
name: 'GOOGLE_CLIENT_ID',
|
||||
value: updatedConfigs?.providers.google.fields.client_id ?? '',
|
||||
},
|
||||
{
|
||||
name: 'GOOGLE_CLIENT_SECRET',
|
||||
value: updatedConfigs?.providers.google.fields.client_secret ?? '',
|
||||
}
|
||||
);
|
||||
} else {
|
||||
config = config.filter(
|
||||
(item) =>
|
||||
item.name !== 'GOOGLE_CLIENT_ID' &&
|
||||
item.name !== 'GOOGLE_CLIENT_SECRET'
|
||||
);
|
||||
}
|
||||
if (updatedConfigs?.providers.microsoft.enabled) {
|
||||
config.push(
|
||||
{
|
||||
name: 'MICROSOFT_CLIENT_ID',
|
||||
value: updatedConfigs?.providers.microsoft.fields.client_id ?? '',
|
||||
},
|
||||
{
|
||||
name: 'MICROSOFT_CLIENT_SECRET',
|
||||
value: updatedConfigs?.providers.microsoft.fields.client_secret ?? '',
|
||||
}
|
||||
);
|
||||
} else {
|
||||
config = config.filter(
|
||||
(item) =>
|
||||
item.name !== 'MICROSOFT_CLIENT_ID' &&
|
||||
item.name !== 'MICROSOFT_CLIENT_SECRET'
|
||||
);
|
||||
}
|
||||
|
||||
if (updatedConfigs?.providers.github.enabled) {
|
||||
config.push(
|
||||
{
|
||||
name: 'GITHUB_CLIENT_ID',
|
||||
value: updatedConfigs?.providers.github.fields.client_id ?? '',
|
||||
},
|
||||
{
|
||||
name: 'GITHUB_CLIENT_SECRET',
|
||||
value: updatedConfigs?.providers.github.fields.client_secret ?? '',
|
||||
}
|
||||
);
|
||||
} else {
|
||||
config = config.filter(
|
||||
(item) =>
|
||||
item.name !== 'GITHUB_CLIENT_ID' &&
|
||||
item.name !== 'GITHUB_CLIENT_SECRET'
|
||||
);
|
||||
}
|
||||
|
||||
if (updatedConfigs?.mailConfigs.enabled) {
|
||||
config.push(
|
||||
{
|
||||
name: 'MAILER_SMTP_URL',
|
||||
value: updatedConfigs?.mailConfigs.fields.mailer_smtp_url ?? '',
|
||||
},
|
||||
{
|
||||
name: 'MAILER_ADDRESS_FROM',
|
||||
value: updatedConfigs?.mailConfigs.fields.mailer_from_address ?? '',
|
||||
}
|
||||
);
|
||||
} else {
|
||||
config = config.filter(
|
||||
(item) =>
|
||||
item.name !== 'MAILER_SMTP_URL' && item.name !== 'MAILER_ADDRESS_FROM'
|
||||
);
|
||||
}
|
||||
|
||||
config = config.filter((item) => item.name !== '');
|
||||
|
||||
return config;
|
||||
});
|
||||
|
||||
// Trasforming the working configs back into the format required by the mutations
|
||||
const updatedAllowedAuthProviders = computed(() => {
|
||||
return [
|
||||
{
|
||||
provider: 'GOOGLE',
|
||||
status: updatedConfigs?.providers.google.enabled ? 'ENABLE' : 'DISABLE',
|
||||
},
|
||||
{
|
||||
provider: 'MICROSOFT',
|
||||
status: updatedConfigs?.providers.microsoft.enabled
|
||||
? 'ENABLE'
|
||||
: 'DISABLE',
|
||||
},
|
||||
{
|
||||
provider: 'GITHUB',
|
||||
status: updatedConfigs?.providers.github.enabled ? 'ENABLE' : 'DISABLE',
|
||||
},
|
||||
{
|
||||
provider: 'EMAIL',
|
||||
status: updatedConfigs?.mailConfigs.enabled ? 'ENABLE' : 'DISABLE',
|
||||
},
|
||||
];
|
||||
});
|
||||
|
||||
// Updating the auth provider configurations
|
||||
const updateAuthProvider = async (
|
||||
updateProviderStatus: UseMutationResponse<EnableAndDisableSsoMutation>
|
||||
) => {
|
||||
const variables = {
|
||||
providerInfo:
|
||||
updatedAllowedAuthProviders.value as EnableAndDisableSsoArgs[],
|
||||
};
|
||||
|
||||
const result = await updateProviderStatus.executeMutation(variables);
|
||||
|
||||
if (result.error) {
|
||||
toast.error(t('configs.auth_providers.update_failure'));
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
// Updating the infra configurations
|
||||
const updateInfraConfigs = async (
|
||||
updateInfraConfigsMutation: UseMutationResponse<UpdateInfraConfigsMutation>
|
||||
) => {
|
||||
const variables = {
|
||||
infraConfigs: updatedInfraConfigs.value as InfraConfigArgs[],
|
||||
};
|
||||
|
||||
const result = await updateInfraConfigsMutation.executeMutation(variables);
|
||||
|
||||
if (result.error) {
|
||||
toast.error(t('configs.mail_configs.update_failure'));
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
// Resetting the infra configurations
|
||||
const resetInfraConfigs = async (
|
||||
resetInfraConfigsMutation: UseMutationResponse<ResetInfraConfigsMutation>
|
||||
) => {
|
||||
const result = await resetInfraConfigsMutation.executeMutation();
|
||||
|
||||
if (result.error) {
|
||||
toast.error(t('configs.reset.failure'));
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
};
|
||||
|
||||
return {
|
||||
currentConfigs,
|
||||
workingConfigs,
|
||||
updatedInfraConfigs,
|
||||
updatedAllowedAuthProviders,
|
||||
updateAuthProvider,
|
||||
updateInfraConfigs,
|
||||
resetInfraConfigs,
|
||||
fetchingInfraConfigs,
|
||||
fetchingAllowedAuthProviders,
|
||||
infraConfigsError,
|
||||
allowedAuthProvidersError,
|
||||
};
|
||||
}
|
||||
Reference in New Issue
Block a user