mirror of
https://github.com/unraid/api.git
synced 2026-04-24 16:28:31 -05:00
a4f69dc539
When the sandbox is toggled via api, the api now restarts after a 3 second delay. The Connect settings UI also informs users, when applicable, that the api will restart before and after they apply their settings. ## Summary by CodeRabbit - **New Features** - Improved deployment commands now allow specifying a target server, streamlining the deployment process. - Enhanced settings synchronization provides clear feedback on when a system restart is required after updates. - Automatic service restart is now triggered after applying connection settings changes. - User interface enhancements include added contextual descriptions for toggle controls. - New functionality to refetch connection settings after updates, providing users with the latest information. - **Bug Fixes** - Improved user feedback regarding API restart status after settings updates.
143 lines
4.1 KiB
Vue
143 lines
4.1 KiB
Vue
<script lang="ts" setup>
|
|
// import { useI18n } from 'vue-i18n';
|
|
|
|
// const { t } = useI18n();
|
|
|
|
import { useMutation, useQuery } from '@vue/apollo-composable';
|
|
|
|
import { BrandButton, jsonFormsRenderers, Label } from '@unraid/ui';
|
|
import { JsonForms } from '@jsonforms/vue';
|
|
|
|
import type { ConnectSettingsValues } from '~/composables/gql/graphql';
|
|
|
|
import { getConnectSettingsForm, updateConnectSettings } from './graphql/settings.query';
|
|
|
|
/**--------------------------------------------
|
|
* Settings State & Form definition
|
|
*---------------------------------------------**/
|
|
|
|
const formState = ref<Partial<ConnectSettingsValues>>({});
|
|
const { result, refetch } = useQuery(getConnectSettingsForm);
|
|
const settings = computed(() => {
|
|
if (!result.value) return;
|
|
return result.value?.connect.settings;
|
|
});
|
|
watch(result, () => {
|
|
if (!result.value) return;
|
|
const { __typename, ...initialValues } = result.value.connect.settings.values;
|
|
formState.value = initialValues;
|
|
});
|
|
const restartRequired = computed(() => {
|
|
return settings.value?.values.sandbox !== formState.value?.sandbox;
|
|
});
|
|
|
|
/**--------------------------------------------
|
|
* Update Settings Actions
|
|
*---------------------------------------------**/
|
|
|
|
const {
|
|
mutate: mutateSettings,
|
|
loading: mutateSettingsLoading,
|
|
error: mutateSettingsError,
|
|
onDone: onMutateSettingsDone,
|
|
} = useMutation(updateConnectSettings);
|
|
|
|
const isUpdating = ref(false);
|
|
|
|
// prevent ui flash if loading finishes too fast
|
|
watchDebounced(
|
|
mutateSettingsLoading,
|
|
(loading) => {
|
|
isUpdating.value = loading;
|
|
},
|
|
{
|
|
debounce: 100,
|
|
}
|
|
);
|
|
|
|
// show a toast when the update is done
|
|
onMutateSettingsDone(() => {
|
|
globalThis.toast.success('Updated API Settings', {
|
|
description: restartRequired.value ? 'The API is restarting...' : undefined,
|
|
});
|
|
});
|
|
|
|
/**--------------------------------------------
|
|
* Form Config & Actions
|
|
*---------------------------------------------**/
|
|
|
|
const jsonFormsConfig = {
|
|
restrict: false,
|
|
trim: false,
|
|
};
|
|
|
|
const renderers = [...jsonFormsRenderers];
|
|
|
|
/** Called when the user clicks the "Apply" button */
|
|
const submitSettingsUpdate = async () => {
|
|
console.log('[ConnectSettings] trying to update settings to', formState.value);
|
|
await mutateSettings({ input: formState.value });
|
|
await refetch();
|
|
};
|
|
|
|
/** Called whenever a JSONForms form control changes */
|
|
const onChange = ({ data }: { data: Record<string, unknown> }) => {
|
|
formState.value = data;
|
|
};
|
|
</script>
|
|
|
|
<template>
|
|
<!-- common api-related actions -->
|
|
<div
|
|
class="grid grid-cols-settings items-baseline pl-3 gap-y-6 [&>*:nth-child(odd)]:text-end [&>*:nth-child(even)]:ml-10"
|
|
>
|
|
<Label>Account Status:</Label>
|
|
<div v-html="'<unraid-i18n-host><unraid-auth></unraid-auth></unraid-i18n-host>'"></div>
|
|
<Label>Download Unraid API Logs:</Label>
|
|
<div
|
|
v-html="
|
|
'<unraid-i18n-host><unraid-download-api-logs></unraid-download-api-logs></unraid-i18n-host>'
|
|
"
|
|
></div>
|
|
</div>
|
|
<!-- auto-generated settings form -->
|
|
<div class="mt-6 pl-3 [&_.vertical-layout]:space-y-6">
|
|
<JsonForms
|
|
v-if="settings"
|
|
:schema="settings.dataSchema"
|
|
:uischema="settings.uiSchema"
|
|
:renderers="renderers"
|
|
:data="formState"
|
|
:config="jsonFormsConfig"
|
|
:readonly="isUpdating"
|
|
@change="onChange"
|
|
/>
|
|
<!-- form submission & fallback reaction message -->
|
|
<div class="mt-6 grid grid-cols-settings gap-y-6 items-baseline">
|
|
<div class="text-sm text-end">
|
|
<p v-if="isUpdating">Applying Settings...</p>
|
|
<p v-else-if="restartRequired">The API will restart after settings are applied.</p>
|
|
</div>
|
|
<div class="col-start-2 ml-10 space-y-4">
|
|
<BrandButton
|
|
variant="outline-primary"
|
|
padding="lean"
|
|
size="12px"
|
|
class="leading-normal"
|
|
@click="submitSettingsUpdate"
|
|
>
|
|
Apply
|
|
</BrandButton>
|
|
<p v-if="mutateSettingsError" class="text-sm text-unraid-red-500">
|
|
✕ Error: {{ mutateSettingsError.message }}
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</template>
|
|
<style lang="postcss">
|
|
/* Import unraid-ui globals first */
|
|
@import '@unraid/ui/styles';
|
|
@import '../../assets/main.css';
|
|
</style>
|