Feature/about screen add option to check for and trigger updates (#485)

* [VersionMapping] Require server version "r1436" for preview

* Move ts util types to new type file

* Add buttons for updating server and webUI
This commit is contained in:
schroda
2023-12-09 23:08:27 +01:00
committed by GitHub
parent 2caf88ce51
commit 78310496aa
13 changed files with 389 additions and 39 deletions

25
src/UtilTypes.d.ts vendored Normal file
View File

@@ -0,0 +1,25 @@
/*
* Copyright (C) Contributors to the Suwayomi project
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
*/
type ExtractByKeyValue<T, Key extends keyof T, Value extends T[Key]> = T extends
| Record<Key, Value>
| Partial<Record<Key, Value>>
? T
: never;
type RecursivePartial<T> = {
[P in keyof T]?: T[P] extends (infer U)[]
? RecursivePartial<U>[]
: T[P] extends object | undefined
? RecursivePartial<T[P]>
: T[P];
};
type OptionalProperty<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
type PropertiesNever<T> = { [key in keyof T]?: never };

View File

@@ -10,7 +10,7 @@ import { ExpandLess, ExpandMore } from '@mui/icons-material';
import { Collapse, ListItemButton, ListItemText, Stack, Box } from '@mui/material'; import { Collapse, ListItemButton, ListItemText, Stack, Box } from '@mui/material';
import React from 'react'; import React from 'react';
// eslint-disable-next-line import/no-cycle // eslint-disable-next-line import/no-cycle
import { ExtractByKeyValue, SourceFilters } from '@/typings'; import { SourceFilters } from '@/typings';
import { Options } from '@/components/source/SourceOptions'; import { Options } from '@/components/source/SourceOptions';
interface Props { interface Props {

View File

@@ -339,6 +339,16 @@
}, },
"time": { "time": {
"hour_short": "h" "hour_short": "h"
},
"update": {
"label": {
"available": "Update available",
"check_failure": "Could not check for update",
"checking": "Checking for update",
"up_to_date": "This is the latest version",
"update_failure": "Update failed",
"updating": "{{progress}}% | Updating…"
}
} }
}, },
"library": { "library": {
@@ -531,6 +541,8 @@
"label": { "label": {
"channel": "$t(settings.webui.title.webui) channel", "channel": "$t(settings.webui.title.webui) channel",
"github": "$t(global.label.github) $t(settings.webui.title.webui)", "github": "$t(global.label.github) $t(settings.webui.title.webui)",
"update_failure": "Could not update $t(settings.webui.title.webui)",
"update_success": "Updated $t(settings.webui.title.webui) to version {{version}}. Refresh required",
"version": "$t(settings.webui.title.webui) version" "version": "$t(settings.webui.title.webui) version"
} }
} }

View File

@@ -412,6 +412,21 @@ export const FULL_UPDATER_STATUS = gql`
} }
`; `;
export const ABOUT_WEBUI = gql`
fragment ABOUT_WEBUI on AboutWebUI {
channel
tag
}
`;
export const WEBUI_UPDATE_CHECK = gql`
fragment WEBUI_UPDATE_CHECK on WebUIUpdateCheck {
channel
tag
updateAvailable
}
`;
export const WEBUI_UPDATE_INFO = gql` export const WEBUI_UPDATE_INFO = gql`
fragment WEBUI_UPDATE_INFO on WebUIUpdateInfo { fragment WEBUI_UPDATE_INFO on WebUIUpdateInfo {
channel channel

View File

@@ -2143,6 +2143,10 @@ export type PartialUpdaterStatusFragment = { __typename?: 'UpdateStatus', isRunn
export type FullUpdaterStatusFragment = { __typename?: 'UpdateStatus', isRunning: boolean, completeJobs: { __typename?: 'UpdateStatusType', mangas: { __typename?: 'MangaNodeList', totalCount: number, nodes: Array<{ __typename?: 'MangaType', unreadCount: number, downloadCount: number, artist?: string | null, author?: string | null, chaptersLastFetchedAt?: any | null, description?: string | null, genre: Array<string>, id: number, inLibrary: boolean, inLibraryAt: any, initialized: boolean, lastFetchedAt?: any | null, realUrl?: string | null, status: MangaStatus, thumbnailUrl?: string | null, title: string, url: string, chapters: { __typename?: 'ChapterNodeList', totalCount: number }, meta: Array<{ __typename?: 'MangaMetaType', key: string, value: string }>, source?: { __typename?: 'SourceType', displayName: string, iconUrl: string, id: any, isConfigurable: boolean, isNsfw: boolean, lang: string, name: string, supportsLatest: boolean } | null }> } }, failedJobs: { __typename?: 'UpdateStatusType', mangas: { __typename?: 'MangaNodeList', totalCount: number, nodes: Array<{ __typename?: 'MangaType', id: number, title: string, thumbnailUrl?: string | null }> } }, pendingJobs: { __typename?: 'UpdateStatusType', mangas: { __typename?: 'MangaNodeList', totalCount: number, nodes: Array<{ __typename?: 'MangaType', id: number, title: string, thumbnailUrl?: string | null }> } }, runningJobs: { __typename?: 'UpdateStatusType', mangas: { __typename?: 'MangaNodeList', totalCount: number, nodes: Array<{ __typename?: 'MangaType', id: number, title: string, thumbnailUrl?: string | null }> } }, skippedJobs: { __typename?: 'UpdateStatusType', mangas: { __typename?: 'MangaNodeList', totalCount: number, nodes: Array<{ __typename?: 'MangaType', id: number, title: string, thumbnailUrl?: string | null }> } }, updatingCategories: { __typename?: 'UpdateStatusCategoryType', categories: { __typename?: 'CategoryNodeList', totalCount: number, nodes: Array<{ __typename?: 'CategoryType', id: number, name: string, includeInUpdate: IncludeInUpdate }> } }, skippedCategories: { __typename?: 'UpdateStatusCategoryType', categories: { __typename?: 'CategoryNodeList', totalCount: number, nodes: Array<{ __typename?: 'CategoryType', id: number, name: string, includeInUpdate: IncludeInUpdate }> } } }; export type FullUpdaterStatusFragment = { __typename?: 'UpdateStatus', isRunning: boolean, completeJobs: { __typename?: 'UpdateStatusType', mangas: { __typename?: 'MangaNodeList', totalCount: number, nodes: Array<{ __typename?: 'MangaType', unreadCount: number, downloadCount: number, artist?: string | null, author?: string | null, chaptersLastFetchedAt?: any | null, description?: string | null, genre: Array<string>, id: number, inLibrary: boolean, inLibraryAt: any, initialized: boolean, lastFetchedAt?: any | null, realUrl?: string | null, status: MangaStatus, thumbnailUrl?: string | null, title: string, url: string, chapters: { __typename?: 'ChapterNodeList', totalCount: number }, meta: Array<{ __typename?: 'MangaMetaType', key: string, value: string }>, source?: { __typename?: 'SourceType', displayName: string, iconUrl: string, id: any, isConfigurable: boolean, isNsfw: boolean, lang: string, name: string, supportsLatest: boolean } | null }> } }, failedJobs: { __typename?: 'UpdateStatusType', mangas: { __typename?: 'MangaNodeList', totalCount: number, nodes: Array<{ __typename?: 'MangaType', id: number, title: string, thumbnailUrl?: string | null }> } }, pendingJobs: { __typename?: 'UpdateStatusType', mangas: { __typename?: 'MangaNodeList', totalCount: number, nodes: Array<{ __typename?: 'MangaType', id: number, title: string, thumbnailUrl?: string | null }> } }, runningJobs: { __typename?: 'UpdateStatusType', mangas: { __typename?: 'MangaNodeList', totalCount: number, nodes: Array<{ __typename?: 'MangaType', id: number, title: string, thumbnailUrl?: string | null }> } }, skippedJobs: { __typename?: 'UpdateStatusType', mangas: { __typename?: 'MangaNodeList', totalCount: number, nodes: Array<{ __typename?: 'MangaType', id: number, title: string, thumbnailUrl?: string | null }> } }, updatingCategories: { __typename?: 'UpdateStatusCategoryType', categories: { __typename?: 'CategoryNodeList', totalCount: number, nodes: Array<{ __typename?: 'CategoryType', id: number, name: string, includeInUpdate: IncludeInUpdate }> } }, skippedCategories: { __typename?: 'UpdateStatusCategoryType', categories: { __typename?: 'CategoryNodeList', totalCount: number, nodes: Array<{ __typename?: 'CategoryType', id: number, name: string, includeInUpdate: IncludeInUpdate }> } } };
export type AboutWebuiFragment = { __typename?: 'AboutWebUI', channel: string, tag: string };
export type WebuiUpdateCheckFragment = { __typename?: 'WebUIUpdateCheck', channel: string, tag: string, updateAvailable: boolean };
export type WebuiUpdateInfoFragment = { __typename?: 'WebUIUpdateInfo', channel: string, tag: string }; export type WebuiUpdateInfoFragment = { __typename?: 'WebUIUpdateInfo', channel: string, tag: string };
export type WebuiUpdateStatusFragment = { __typename?: 'WebUIUpdateStatus', progress: number, state: UpdateState, info: { __typename?: 'WebUIUpdateInfo', channel: string, tag: string } }; export type WebuiUpdateStatusFragment = { __typename?: 'WebUIUpdateStatus', progress: number, state: UpdateState, info: { __typename?: 'WebUIUpdateInfo', channel: string, tag: string } };
@@ -2458,6 +2462,11 @@ export type UpdateWebuiMutationVariables = Exact<{
export type UpdateWebuiMutation = { __typename?: 'Mutation', updateWebUI: { __typename?: 'WebUIUpdatePayload', clientMutationId?: string | null, updateStatus: { __typename?: 'WebUIUpdateStatus', progress: number, state: UpdateState, info: { __typename?: 'WebUIUpdateInfo', channel: string, tag: string } } } }; export type UpdateWebuiMutation = { __typename?: 'Mutation', updateWebUI: { __typename?: 'WebUIUpdatePayload', clientMutationId?: string | null, updateStatus: { __typename?: 'WebUIUpdateStatus', progress: number, state: UpdateState, info: { __typename?: 'WebUIUpdateInfo', channel: string, tag: string } } } };
export type ResetWebuiUpdateStatusMutationVariables = Exact<{ [key: string]: never; }>;
export type ResetWebuiUpdateStatusMutation = { __typename?: 'Mutation', resetWebUIUpdateStatus: { __typename?: 'WebUIUpdateStatus', state: UpdateState, info: { __typename?: 'WebUIUpdateInfo', channel: string, tag: string } } };
export type ResetServerSettingsMutationVariables = Exact<{ export type ResetServerSettingsMutationVariables = Exact<{
input: ResetSettingsInput; input: ResetSettingsInput;
}>; }>;

View File

@@ -7,7 +7,7 @@
*/ */
import gql from 'graphql-tag'; import gql from 'graphql-tag';
import { WEBUI_UPDATE_STATUS } from '@/lib/graphql/Fragments'; import { WEBUI_UPDATE_INFO, WEBUI_UPDATE_STATUS } from '@/lib/graphql/Fragments';
export const UPDATE_WEBUI = gql` export const UPDATE_WEBUI = gql`
${WEBUI_UPDATE_STATUS} ${WEBUI_UPDATE_STATUS}
@@ -20,3 +20,15 @@ export const UPDATE_WEBUI = gql`
} }
} }
`; `;
export const RESET_WEBUI_UPDATE_STATUS = gql`
${WEBUI_UPDATE_INFO}
mutation RESET_WEBUI_UPDATE_STATUS {
resetWebUIUpdateStatus {
info {
...WEBUI_UPDATE_INFO
}
state
}
}
`;

View File

@@ -7,9 +7,10 @@
*/ */
import gql from 'graphql-tag'; import gql from 'graphql-tag';
import { WEBUI_UPDATE_STATUS } from '@/lib/graphql/Fragments'; import { ABOUT_WEBUI, WEBUI_UPDATE_CHECK, WEBUI_UPDATE_STATUS } from '@/lib/graphql/Fragments';
export const GET_ABOUT = gql` export const GET_ABOUT = gql`
${ABOUT_WEBUI}
query GET_ABOUT { query GET_ABOUT {
aboutServer { aboutServer {
buildTime buildTime
@@ -21,8 +22,7 @@ export const GET_ABOUT = gql`
version version
} }
aboutWebUI { aboutWebUI {
channel ...ABOUT_WEBUI
tag
} }
} }
`; `;
@@ -38,11 +38,10 @@ export const CHECK_FOR_SERVER_UPDATES = gql`
`; `;
export const CHECK_FOR_WEBUI_UPDATE = gql` export const CHECK_FOR_WEBUI_UPDATE = gql`
${WEBUI_UPDATE_CHECK}
query CHECK_FOR_WEBUI_UPDATE { query CHECK_FOR_WEBUI_UPDATE {
checkForWebUIUpdate { checkForWebUIUpdate {
channel ...WEBUI_UPDATE_CHECK
tag
updateAvailable
} }
} }
`; `;

View File

@@ -36,6 +36,8 @@ import {
CheckForServerUpdatesQuery, CheckForServerUpdatesQuery,
CheckForServerUpdatesQueryVariables, CheckForServerUpdatesQueryVariables,
ClearCachedImagesInput, ClearCachedImagesInput,
CheckForWebuiUpdateQuery,
CheckForWebuiUpdateQueryVariables,
ClearDownloaderMutation, ClearDownloaderMutation,
ClearDownloaderMutationVariables, ClearDownloaderMutationVariables,
ClearServerCacheMutation, ClearServerCacheMutation,
@@ -151,12 +153,17 @@ import {
UpdateServerSettingsMutationVariables, UpdateServerSettingsMutationVariables,
UpdateSourcePreferencesMutation, UpdateSourcePreferencesMutation,
UpdateSourcePreferencesMutationVariables, UpdateSourcePreferencesMutationVariables,
UpdateWebuiMutation,
UpdateWebuiMutationVariables,
ValidateBackupQuery, ValidateBackupQuery,
ValidateBackupQueryVariables, ValidateBackupQueryVariables,
WebuiUpdateSubscription,
ResetWebuiUpdateStatusMutation,
ResetWebuiUpdateStatusMutationVariables,
} from '@/lib/graphql/generated/graphql.ts'; } from '@/lib/graphql/generated/graphql.ts';
import { GET_GLOBAL_METADATAS } from '@/lib/graphql/queries/GlobalMetadataQuery.ts'; import { GET_GLOBAL_METADATAS } from '@/lib/graphql/queries/GlobalMetadataQuery.ts';
import { SET_GLOBAL_METADATA } from '@/lib/graphql/mutations/GlobalMetadataMutation.ts'; import { SET_GLOBAL_METADATA } from '@/lib/graphql/mutations/GlobalMetadataMutation.ts';
import { CHECK_FOR_SERVER_UPDATES, GET_ABOUT } from '@/lib/graphql/queries/ServerInfoQuery.ts'; import { CHECK_FOR_SERVER_UPDATES, CHECK_FOR_WEBUI_UPDATE, GET_ABOUT } from '@/lib/graphql/queries/ServerInfoQuery.ts';
import { GET_EXTENSIONS } from '@/lib/graphql/queries/ExtensionQuery.ts'; import { GET_EXTENSIONS } from '@/lib/graphql/queries/ExtensionQuery.ts';
import { import {
GET_EXTENSIONS_FETCH, GET_EXTENSIONS_FETCH,
@@ -216,6 +223,8 @@ import { GET_SERVER_SETTINGS } from '@/lib/graphql/queries/SettingsQuery.ts';
import { UPDATE_SERVER_SETTINGS } from '@/lib/graphql/mutations/SettingsMutation.ts'; import { UPDATE_SERVER_SETTINGS } from '@/lib/graphql/mutations/SettingsMutation.ts';
import { BASE_MANGA_FIELDS, FULL_EXTENSION_FIELDS } from '@/lib/graphql/Fragments.ts'; import { BASE_MANGA_FIELDS, FULL_EXTENSION_FIELDS } from '@/lib/graphql/Fragments.ts';
import { CLEAR_SERVER_CACHE } from '@/lib/graphql/mutations/ImageMutation.ts'; import { CLEAR_SERVER_CACHE } from '@/lib/graphql/mutations/ImageMutation.ts';
import { RESET_WEBUI_UPDATE_STATUS, UPDATE_WEBUI } from '@/lib/graphql/mutations/ServerInfoMutation.ts';
import { WEBUI_UPDATE_SUBSCRIPTION } from '@/lib/graphql/subscriptions/ServerInfoSubscription.ts';
enum GQLMethod { enum GQLMethod {
QUERY = 'QUERY', QUERY = 'QUERY',
@@ -318,7 +327,7 @@ export const SPECIAL_ED_SOURCES = {
export class RequestManager { export class RequestManager {
public static readonly API_VERSION = '/api/v1/'; public static readonly API_VERSION = '/api/v1/';
private readonly graphQLClient = new GraphQLClient(); public readonly graphQLClient = new GraphQLClient();
private readonly restClient: RestClient = new RestClient(); private readonly restClient: RestClient = new RestClient();
@@ -862,12 +871,24 @@ export class RequestManager {
return this.doRequest(GQLMethod.USE_QUERY, GET_ABOUT, {}, options); return this.doRequest(GQLMethod.USE_QUERY, GET_ABOUT, {}, options);
} }
public useCheckForUpdate( public useCheckForServerUpdate(
options?: QueryHookOptions<CheckForServerUpdatesQuery, CheckForServerUpdatesQueryVariables>, options?: QueryHookOptions<CheckForServerUpdatesQuery, CheckForServerUpdatesQueryVariables>,
): AbortableApolloUseQueryResponse<CheckForServerUpdatesQuery, CheckForServerUpdatesQueryVariables> { ): AbortableApolloUseQueryResponse<CheckForServerUpdatesQuery, CheckForServerUpdatesQueryVariables> {
return this.doRequest(GQLMethod.USE_QUERY, CHECK_FOR_SERVER_UPDATES, {}, options); return this.doRequest(GQLMethod.USE_QUERY, CHECK_FOR_SERVER_UPDATES, {}, options);
} }
public useCheckForWebUIUpdate(
options?: QueryHookOptions<CheckForWebuiUpdateQuery, CheckForWebuiUpdateQueryVariables>,
): AbortableApolloUseQueryResponse<CheckForWebuiUpdateQuery, CheckForWebuiUpdateQueryVariables> {
return this.doRequest(GQLMethod.USE_QUERY, CHECK_FOR_WEBUI_UPDATE, {}, options);
}
public updateWebUI(
options?: MutationOptions<UpdateWebuiMutation, UpdateWebuiMutationVariables>,
): AbortableApolloMutationResponse<UpdateWebuiMutation> {
return this.doRequest(GQLMethod.MUTATION, UPDATE_WEBUI, undefined, options);
}
public useGetExtensionList( public useGetExtensionList(
options?: QueryHookOptions<GetExtensionsQuery, GetExtensionsQueryVariables>, options?: QueryHookOptions<GetExtensionsQuery, GetExtensionsQueryVariables>,
): AbortableApolloUseQueryResponse<GetExtensionsQuery, GetExtensionsQueryVariables> { ): AbortableApolloUseQueryResponse<GetExtensionsQuery, GetExtensionsQueryVariables> {
@@ -2004,6 +2025,18 @@ export class RequestManager {
): AbortableApolloUseMutationResponse<ClearServerCacheMutation, ClearServerCacheMutationVariables> { ): AbortableApolloUseMutationResponse<ClearServerCacheMutation, ClearServerCacheMutationVariables> {
return this.doRequest(GQLMethod.USE_MUTATION, CLEAR_SERVER_CACHE, { input }, options); return this.doRequest(GQLMethod.USE_MUTATION, CLEAR_SERVER_CACHE, { input }, options);
} }
public useWebUIUpdateSubscription(
options?: SubscriptionHookOptions<WebuiUpdateSubscription, WebuiUpdateSubscription>,
): SubscriptionResult<WebuiUpdateSubscription, WebuiUpdateSubscription> {
return this.doRequest(GQLMethod.USE_SUBSCRIPTION, WEBUI_UPDATE_SUBSCRIPTION, undefined, options);
}
public resetWebUIUpdateStatus(
options?: MutationOptions<ResetWebuiUpdateStatusMutation, ResetWebuiUpdateStatusMutationVariables>,
): AbortableApolloMutationResponse<ResetWebuiUpdateStatusMutation> {
return this.doRequest(GQLMethod.MUTATION, RESET_WEBUI_UPDATE_STATUS, undefined, options);
}
} }
export const requestManager = new RequestManager(); export const requestManager = new RequestManager();

View File

@@ -19,7 +19,9 @@ const typePolicies: StrictTypedTypePolicies = {
GlobalMetaType: { keyFields: ['key'] }, GlobalMetaType: { keyFields: ['key'] },
ExtensionType: { keyFields: ['apkName'] }, ExtensionType: { keyFields: ['apkName'] },
AboutServerPayload: { keyFields: [] }, AboutServerPayload: { keyFields: [] },
AboutWebUI: { keyFields: [] },
WebUIUpdateInfo: { keyFields: [] }, WebUIUpdateInfo: { keyFields: [] },
WebUIUpdateCheck: { keyFields: [] },
SettingsType: { keyFields: [] }, SettingsType: { keyFields: [] },
Query: { Query: {
fields: { fields: {

View File

@@ -12,11 +12,175 @@ import ListItem from '@mui/material/ListItem';
import ListItemText from '@mui/material/ListItemText'; import ListItemText from '@mui/material/ListItemText';
import { useTranslation } from 'react-i18next'; import { useTranslation } from 'react-i18next';
import ListSubheader from '@mui/material/ListSubheader'; import ListSubheader from '@mui/material/ListSubheader';
import { Divider } from '@mui/material'; import { Button, CircularProgress, Divider, Stack, Typography } from '@mui/material';
import RefreshIcon from '@mui/icons-material/Refresh';
import DownloadIcon from '@mui/icons-material/Download';
import OpenInNewIcon from '@mui/icons-material/OpenInNew';
import { t as translate } from 'i18next';
import DownloadingIcon from '@mui/icons-material/Downloading';
import { requestManager } from '@/lib/requests/RequestManager.ts'; import { requestManager } from '@/lib/requests/RequestManager.ts';
import { ListItemLink } from '@/components/util/ListItemLink'; import { ListItemLink } from '@/components/util/ListItemLink';
import { NavBarContext, useSetDefaultBackTo } from '@/components/context/NavbarContext'; import { NavBarContext, useSetDefaultBackTo } from '@/components/context/NavbarContext';
import { LoadingPlaceholder } from '@/components/util/LoadingPlaceholder'; import { LoadingPlaceholder } from '@/components/util/LoadingPlaceholder';
import { GetAboutQuery, UpdateState } from '@/lib/graphql/generated/graphql.ts';
import { ABOUT_WEBUI, WEBUI_UPDATE_CHECK } from '@/lib/graphql/Fragments.ts';
import { makeToast } from '@/components/util/Toast.tsx';
type AboutServer = GetAboutQuery['aboutServer'];
const getVersion = (aboutServer: AboutServer) => {
if (aboutServer.buildType === 'Stable') return `${aboutServer.version}`;
return `${aboutServer.version}-${aboutServer.revision}`;
};
const getBuildTime = (aboutServer: AboutServer) => new Date(aboutServer.buildTime * 1000).toUTCString();
const getUpdateCheckButtonIcon = (
isLoading: boolean,
isUpdateAvailable: boolean,
updateState?: UpdateState,
asLink: boolean = false,
) => {
const isUpdateInProgress = updateState === UpdateState.Downloading;
if (isUpdateInProgress) {
return <DownloadingIcon />;
}
if (isLoading) {
return <CircularProgress size={15} />;
}
const isRefreshRequired = !isUpdateAvailable || updateState === UpdateState.Error;
if (isRefreshRequired) {
return <RefreshIcon />;
}
return asLink ? <OpenInNewIcon /> : <DownloadIcon />;
};
const getUpdateCheckButtonText = (
isLoading: boolean,
isUpdateAvailable: boolean,
error: any,
updateState?: UpdateState,
progress: number = 0,
) => {
const isUpdating = updateState === UpdateState.Downloading;
if (isUpdating) {
return translate('global.update.label.updating', { progress });
}
const didUpdateFail = updateState === UpdateState.Error;
if (didUpdateFail) {
return translate('global.update.label.update_failure');
}
if (isLoading) {
return translate('global.update.label.checking');
}
if (error) {
return translate('global.update.label.check_failure');
}
if (isUpdateAvailable) {
return translate('global.update.label.available');
}
return translate('global.update.label.up_to_date');
};
type BaseVersionInfoProps = {
version: string;
isCheckingForUpdate: boolean;
isUpdateAvailable: boolean;
updateCheckError: any;
checkForUpdate: () => void;
};
type LinkVersionInfoProps = {
downloadAsLink: true;
url: string;
};
type TriggerVersionInfoProps = {
triggerUpdate: () => void;
updateState: UpdateState;
progress: number;
};
type VersionInfoProps =
| (BaseVersionInfoProps & PropertiesNever<TriggerVersionInfoProps> & LinkVersionInfoProps)
| (BaseVersionInfoProps & TriggerVersionInfoProps & PropertiesNever<LinkVersionInfoProps>);
const VersionInfo = ({
version,
isCheckingForUpdate,
isUpdateAvailable,
updateCheckError,
checkForUpdate,
triggerUpdate,
updateState,
progress,
downloadAsLink,
url,
}: VersionInfoProps) => {
const isUpdateInProgress = updateState === UpdateState.Downloading;
const onClick = () => {
if (isUpdateInProgress) {
return;
}
const shouldCheckForUpdate = !isUpdateAvailable || updateCheckError || updateState === UpdateState.Error;
if (shouldCheckForUpdate) {
checkForUpdate();
return;
}
if (isUpdateAvailable) {
triggerUpdate?.();
}
};
return (
<Stack alignItems="start">
<Typography component="span" variant="body2">
{version}
</Typography>
<Button
sx={{
marginTop: '5px',
backgroundColor: 'transparent',
pointerEvents: isUpdateInProgress ? 'none' : 'unset',
}}
size="small"
variant="outlined"
startIcon={getUpdateCheckButtonIcon(
isCheckingForUpdate,
isUpdateAvailable,
updateState,
downloadAsLink,
)}
onClick={onClick}
{...(!!url && isUpdateAvailable
? {
href: url,
target: '_blank',
}
: undefined)}
>
{getUpdateCheckButtonText(
isCheckingForUpdate,
isUpdateAvailable,
updateCheckError,
updateState,
progress,
)}
</Button>
</Stack>
);
};
export function About() { export function About() {
const { t } = useTranslation(); const { t } = useTranslation();
@@ -27,21 +191,82 @@ export function About() {
setAction(null); setAction(null);
}, [t]); }, [t]);
useSetDefaultBackTo('settings');
const { data } = requestManager.useGetAbout(); const { data } = requestManager.useGetAbout();
const { aboutServer, aboutWebUI } = data ?? {}; const { aboutServer, aboutWebUI } = data ?? {};
useSetDefaultBackTo('settings'); const {
data: serverUpdateCheckData,
loading: isCheckingForServerUpdate,
refetch: checkForServerUpdate,
error: serverUpdateCheckError,
} = requestManager.useCheckForServerUpdate({ notifyOnNetworkStatusChange: true });
const {
data: webUIUpdateData,
loading: isCheckingForWebUIUpdate,
refetch: checkForWebUIUpdate,
error: orgWebUIUpdateCheckError,
} = requestManager.useCheckForWebUIUpdate({ notifyOnNetworkStatusChange: true });
const webUIUpdateCheckError = orgWebUIUpdateCheckError || webUIUpdateData?.checkForWebUIUpdate.tag === '';
const { data: webUIUpdateStatusData } = requestManager.useWebUIUpdateSubscription();
const { state: webUIUpdateState, progress: webUIUpdateProgress } =
webUIUpdateStatusData?.webUIUpdateStatusChange ?? { state: UpdateState.Idle, progress: 0 };
useEffect(() => {
const isError = webUIUpdateState === UpdateState.Error;
if (isError) {
makeToast(t('settings.about.webui.label.update_failure'), 'error');
}
const updateFinished = webUIUpdateState === UpdateState.Finished;
const resetUpdateStatus = isError || updateFinished;
if (resetUpdateStatus) {
requestManager.resetWebUIUpdateStatus().response.catch(() => {});
}
if (!updateFinished) {
return;
}
makeToast(
t('settings.about.webui.label.update_success', {
version: webUIUpdateStatusData!.webUIUpdateStatusChange.info.tag,
}),
'success',
);
requestManager.graphQLClient.client.cache.writeFragment({
fragment: ABOUT_WEBUI,
data: {
__typename: 'AboutWebUI',
channel: webUIUpdateStatusData!.webUIUpdateStatusChange.info.channel,
tag: webUIUpdateStatusData!.webUIUpdateStatusChange.info.tag,
},
});
requestManager.graphQLClient.client.cache.writeFragment({
fragment: WEBUI_UPDATE_CHECK,
data: {
__typename: 'WebUIUpdateCheck',
channel: webUIUpdateStatusData!.webUIUpdateStatusChange.info.channel,
tag: webUIUpdateStatusData!.webUIUpdateStatusChange.info.tag,
updateAvailable: false,
},
});
}, [webUIUpdateState]);
if (!aboutServer || !aboutWebUI) { if (!aboutServer || !aboutWebUI) {
return <LoadingPlaceholder />; return <LoadingPlaceholder />;
} }
const version = () => { const selectedServerChannelInfo = serverUpdateCheckData?.checkForServerUpdates?.find(
if (aboutServer.buildType === 'Stable') return `${aboutServer.version}`; (channel) => channel.channel === aboutServer.buildType,
return `${aboutServer.version}-${aboutServer.revision}`; );
}; const isServerUpdateAvailable =
!!selectedServerChannelInfo?.tag && selectedServerChannelInfo.tag !== getVersion(aboutServer);
const buildTime = () => new Date(aboutServer.buildTime * 1000).toUTCString(); const isWebUIUpdateAvailable = !!webUIUpdateData?.checkForWebUIUpdate.updateAvailable;
return ( return (
<List> <List>
@@ -60,10 +285,26 @@ export function About() {
/> />
</ListItem> </ListItem>
<ListItem> <ListItem>
<ListItemText primary={t('settings.about.server.label.version')} secondary={version()} /> <ListItemText
primary={t('settings.about.server.label.version')}
secondary={
<VersionInfo
version={getVersion(aboutServer)}
isCheckingForUpdate={isCheckingForServerUpdate}
isUpdateAvailable={isServerUpdateAvailable}
updateCheckError={serverUpdateCheckError}
checkForUpdate={checkForServerUpdate}
downloadAsLink
url={selectedServerChannelInfo?.url ?? ''}
/>
}
/>
</ListItem> </ListItem>
<ListItem> <ListItem>
<ListItemText primary={t('settings.about.server.label.build_time')} secondary={buildTime()} /> <ListItemText
primary={t('settings.about.server.label.build_time')}
secondary={getBuildTime(aboutServer)}
/>
</ListItem> </ListItem>
</List> </List>
<Divider /> <Divider />
@@ -76,7 +317,21 @@ export function About() {
} }
> >
<ListItem> <ListItem>
<ListItemText primary={t('settings.about.webui.label.version')} secondary={aboutWebUI.tag} /> <ListItemText
primary={t('settings.about.webui.label.version')}
secondary={
<VersionInfo
version={aboutWebUI.tag}
isCheckingForUpdate={isCheckingForWebUIUpdate}
isUpdateAvailable={isWebUIUpdateAvailable}
updateCheckError={webUIUpdateCheckError}
checkForUpdate={checkForWebUIUpdate}
triggerUpdate={() => requestManager.updateWebUI().response.catch(() => {})}
progress={webUIUpdateProgress}
updateState={webUIUpdateState}
/>
}
/>
</ListItem> </ListItem>
<ListItem> <ListItem>
<ListItemText <ListItemText

View File

@@ -119,6 +119,10 @@ export const WebUISettings = () => {
setting: Setting, setting: Setting,
value: WebUISettingsType[Setting], value: WebUISettingsType[Setting],
) => { ) => {
if (setting === 'webUIChannel') {
requestManager.graphQLClient.client.cache.evict({ fieldName: 'checkForWebUIUpdate' });
}
mutateSettings({ variables: { input: { settings: { [setting]: value } } } }); mutateSettings({ variables: { input: { settings: { [setting]: value } } } });
}; };

View File

@@ -21,22 +21,6 @@ import {
SourcePreferenceChangeInput, SourcePreferenceChangeInput,
} from '@/lib/graphql/generated/graphql.ts'; } from '@/lib/graphql/generated/graphql.ts';
export type ExtractByKeyValue<T, Key extends keyof T, Value extends T[Key]> = T extends
| Record<Key, Value>
| Partial<Record<Key, Value>>
? T
: never;
export type RecursivePartial<T> = {
[P in keyof T]?: T[P] extends (infer U)[]
? RecursivePartial<U>[]
: T[P] extends object | undefined
? RecursivePartial<T[P]>
: T[P];
};
export type OptionalProperty<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
type GenericLocation<State = any> = Omit<Location, 'state'> & { state?: State }; type GenericLocation<State = any> = Omit<Location, 'state'> & { state?: State };
declare module 'react-router-dom' { declare module 'react-router-dom' {

View File

@@ -1,6 +1,6 @@
[ [
{ {
"uiVersion": "PREVIEW", "uiVersion": "PREVIEW",
"serverVersion": "r1431" "serverVersion": "r1436"
} }
] ]