ChoChoX/suwayomi-material-you-webui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add logic to retry all errored pages

Browse Source
This commit is contained in:
schroda
2024-12-07 04:47:28 +01:00
parent da0004de4a
commit be0d1dbf30
17 changed files with 135 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/modules/core/components/SpinnerImage.tsx
View File

@@ -30,11 +30,14 @@ interface IProps {
imgStyle?: SxProps<Theme>;
onLoad?: () => void;
onError?: () => void;
shouldDecode?: boolean;
useFetchApi?: boolean;
priority?: Priority;
retryKeyPrefix?: string;
}
export const SpinnerImage = forwardRef((props: IProps, imgRef: ForwardedRef<HTMLImageElement | null>) => {
@@ -45,9 +48,11 @@ export const SpinnerImage = forwardRef((props: IProps, imgRef: ForwardedRef<HTML
src,
alt,
onLoad,
onError,
spinnerStyle: { small, ...spinnerStyle } = {},
imgStyle,
priority,
retryKeyPrefix,
} = props;
const { t } = useTranslation();
@@ -63,6 +68,10 @@ export const SpinnerImage = forwardRef((props: IProps, imgRef: ForwardedRef<HTML
setIsLoading(loading);
setHasError(error);
if (error && !loading && !aborted) {
onError?.();
}
if (!loading && !error && !aborted) {
onLoad?.();
}
@@ -114,7 +123,7 @@ export const SpinnerImage = forwardRef((props: IProps, imgRef: ForwardedRef<HTML
clearTimeout(cacheTimeout);
imageRequest.abortRequest(new Error('Component was unmounted'));
};
}, [src, imgLoadRetryKey, showMissingImageIcon, shouldLoad]);
}, [src, imgLoadRetryKey, retryKeyPrefix, showMissingImageIcon, shouldLoad]);
return (
<>
@@ -134,7 +143,7 @@ export const SpinnerImage = forwardRef((props: IProps, imgRef: ForwardedRef<HTML
) : (
<Box
component="img"
key={`${src}_${imgLoadRetryKey}`}
key={`${src}_${imgLoadRetryKey}_${retryKeyPrefix}`}
sx={[
...(Array.isArray(imgStyle) ? (imgStyle ?? []) : [imgStyle]),
applyStyles(!imageSourceUrl || isLoading || hasError, {

10
src/modules/reader/components/overlay/navigation/desktop/ReaderNavBarDesktop.tsx
View File

@@ -57,7 +57,8 @@ export const ReaderNavBarDesktop = ({ isVisible, openSettings }: ReaderNavBarDes
const { setReaderNavBarWidth } = useNavBarContext();
const { manga } = useReaderStateMangaContext();
const { chapters, currentChapter, nextChapter, previousChapter } = useReaderStateChaptersContext();
const { pages, currentPageIndex } = userReaderStatePagesContext();
const { pages, currentPageIndex, pageLoadStates, setPageLoadStates, setRetryFailedPagesKeyPrefix } =
userReaderStatePagesContext();
const getOptionForDirection = useGetOptionForDirection();
@@ -118,7 +119,12 @@ export const ReaderNavBarDesktop = ({ isVisible, openSettings }: ReaderNavBarDes
mangaTitle={manga.title}
chapterTitle={currentChapter.name}
/>
<ReaderNavBarDesktopActions currentChapter={currentChapter} />
<ReaderNavBarDesktopActions
currentChapter={currentChapter}
pageLoadStates={pageLoadStates}
setPageLoadStates={setPageLoadStates}
setRetryFailedPagesKeyPrefix={setRetryFailedPagesKeyPrefix}
/>
</>
) : (
<LoadingPlaceholder />

28
src/modules/reader/components/overlay/navigation/desktop/ReaderNavBarDesktopActions.tsx
View File

@@ -15,13 +15,14 @@ import BookmarkBorderIcon from '@mui/icons-material/BookmarkBorder';
import OpenInNewIcon from '@mui/icons-material/OpenInNew';
import DownloadIcon from '@mui/icons-material/Download';
import ReplayIcon from '@mui/icons-material/Replay';
import { useMemo } from 'react';
import { useMemo, useRef } from 'react';
import DeleteIcon from '@mui/icons-material/Delete';
import { actionToTranslationKey, ChapterAction, Chapters } from '@/modules/chapter/services/Chapters.ts';
import { ReaderStateChapters } from '@/modules/reader/types/Reader.types.ts';
import { requestManager } from '@/lib/requests/RequestManager.ts';
import { DownloadStateIndicator } from '@/modules/core/components/DownloadStateIndicator.tsx';
import { DownloadStatusFieldsFragment } from '@/lib/graphql/generated/graphql.ts';
import { ReaderStatePages } from '@/modules/reader/types/ReaderProgressBar.types.ts';
const DownloadButton = ({
currentChapter,
@@ -60,11 +61,17 @@ const DownloadButton = ({
export const ReaderNavBarDesktopActions = ({
currentChapter,
}: Required<Pick<ReaderStateChapters, 'currentChapter'>>) => {
pageLoadStates,
setPageLoadStates,
setRetryFailedPagesKeyPrefix,
}: Required<Pick<ReaderStateChapters, 'currentChapter'>> &
Pick<ReaderStatePages, 'pageLoadStates' | 'setPageLoadStates' | 'setRetryFailedPagesKeyPrefix'>) => {
const { id, isBookmarked, realUrl } = currentChapter ?? { id: -1, isBookmarked: false, realUrl: '' };
const { t } = useTranslation();
const pageRetryKeyPrefix = useRef<number>(0);
const { data: downloaderData } = requestManager.useGetDownloadStatus();
const queue = downloaderData?.downloadStatus.queue ?? [];
@@ -73,6 +80,11 @@ export const ReaderNavBarDesktopActions = ({
[queue, id],
);
const haveSomePagesFailedToLoad = useMemo(
() => pageLoadStates.some((pageLoadState) => pageLoadState.error),
[pageLoadStates],
);
const bookmarkAction: Extract<ChapterAction, 'unbookmark' | 'bookmark'> = isBookmarked ? 'unbookmark' : 'bookmark';
return (
@@ -83,7 +95,17 @@ export const ReaderNavBarDesktopActions = ({
</IconButton>
</Tooltip>
<Tooltip title={t('reader.button.retry_load_pages')}>
<IconButton color="inherit">
<IconButton
onClick={() => {
setPageLoadStates((statePageLoadStates) =>
statePageLoadStates.map((pageLoadState) => ({ loaded: pageLoadState.loaded })),
);
setRetryFailedPagesKeyPrefix(`${pageRetryKeyPrefix.current}`);
pageRetryKeyPrefix.current = (pageRetryKeyPrefix.current + 1) % 1000;
}}
disabled={!haveSomePagesFailedToLoad}
color="inherit"
>
<ReplayIcon />
</IconButton>
</Tooltip>

4
src/modules/reader/components/overlay/progress-bar/variants/StandardReaderProgressBar.tsx
View File

@@ -68,8 +68,8 @@ export const StandardReaderProgressBar = () => {
backgroundColor: lighten(theme.palette.background.paper, 0.1),
}),
...applyStyles(
pageLoadStates[primary.index] &&
(!secondary || pageLoadStates[secondary.index]),
pageLoadStates[primary.index]?.loaded &&
(!secondary || pageLoadStates[secondary.index]?.loaded),
{
backgroundColor: darken(theme.palette.background.paper, 0.35),
...theme.applyStyles('dark', {

3
src/modules/reader/components/viewer/ReaderPage.tsx
View File

@@ -51,12 +51,12 @@ export const ReaderPage = forwardRef(
doublePage = false,
position,
shouldLoad,
retryKeyPrefix,
...props
}: Omit<ComponentProps<typeof SpinnerImage>, 'ref' | 'spinnerStyle' | 'imgStyle'> & {
display: boolean;
doublePage?: boolean;
position?: 'left' | 'right';
onLoad?: () => void;
},
ref: ForwardedRef<HTMLImageElement | null>,
) => {
@@ -71,6 +71,7 @@ export const ReaderPage = forwardRef(
return (
<SpinnerImage
key={retryKeyPrefix}
{...props}
shouldLoad={shouldLoad}
shouldDecode

13
src/modules/reader/components/viewer/ReaderViewer.tsx
View File

@@ -47,8 +47,10 @@ export const ReaderViewer = forwardRef((_, ref: ForwardedRef<HTMLDivElement | nu
setPages,
totalPages,
pageUrls,
pageLoadStates,
setPageLoadStates,
transitionPageMode,
retryFailedPagesKeyPrefix,
} = userReaderStatePagesContext();
const { readingMode, shouldOffsetDoubleSpreads, readingDirection } = ReaderService.useSettings();
const { setScrollbarXSize, setScrollbarYSize } = useReaderScrollbarContext();
@@ -227,6 +229,8 @@ export const ReaderViewer = forwardRef((_, ref: ForwardedRef<HTMLDivElement | nu
currentPageIndex={currentPageIndex}
pages={actualPages}
transitionPageMode={transitionPageMode}
pageLoadStates={pageLoadStates}
retryFailedPagesKeyPrefix={retryFailedPagesKeyPrefix}
imageRefs={imageRefs}
onLoad={(pagesIndex, isPrimary = true) => {
const page = actualPages[pagesIndex];
@@ -240,7 +244,14 @@ export const ReaderViewer = forwardRef((_, ref: ForwardedRef<HTMLDivElement | nu
img.src = url;
}
setPageLoadStates((pageLoadStates) => pageLoadStates.toSpliced(index, 1, true));
setPageLoadStates((statePageLoadStates) =>
statePageLoadStates.toSpliced(index, 1, { loaded: true }),
);
}}
onError={(pageIndex) => {
setPageLoadStates((statePageLoadStates) =>
statePageLoadStates.toSpliced(pageIndex, 1, { loaded: false, error: true }),
);
}}
/>
</Stack>

2
src/modules/reader/components/viewer/pager/BasePager.tsx
View File

@@ -23,7 +23,7 @@ export const BasePager = ({
imageRefs,
createPage,
slots,
}: ReaderPagerProps & {
}: Omit<ReaderPagerProps, 'pageLoadStates' | 'retryFailedPagesKeyPrefix'> & {
createPage: (
page: ReaderStatePages['pages'][number],
pagesIndex: number,

12
src/modules/reader/components/viewer/pager/ReaderDoublePagedPager.tsx
View File

@@ -37,7 +37,13 @@ const getPagePosition = (
return isLtrReadingDirection ? 'right' : 'left';
};
export const ReaderDoublePagedPager = ({ onLoad, ...props }: ReaderPagerProps) => {
export const ReaderDoublePagedPager = ({
onLoad,
onError,
pageLoadStates,
retryFailedPagesKeyPrefix,
...props
}: ReaderPagerProps) => {
const { currentPageIndex, pages, totalPages } = props;
const { readingDirection } = ReaderService.useSettings();
@@ -63,10 +69,12 @@ export const ReaderDoublePagedPager = ({ onLoad, ...props }: ReaderPagerProps) =
{createReaderPage(
page,
() => onLoad?.(pagesIndex),
() => onError?.(primary.index),
shouldLoad,
shouldDisplay && isPrimaryPage,
currentPage.primary.index,
totalPages,
pageLoadStates[primary.index].error ? retryFailedPagesKeyPrefix : undefined,
hasSecondaryPage
? getPagePosition('first', themeDirection, readingDirection.value)
: undefined,
@@ -76,10 +84,12 @@ export const ReaderDoublePagedPager = ({ onLoad, ...props }: ReaderPagerProps) =
createReaderPage(
{ ...page, primary: { ...page.secondary! } },
() => onLoad?.(pagesIndex, false),
() => onError?.(secondary.index),
shouldLoad,
shouldDisplay && isSecondaryPage,
currentSecondaryPageIndex,
totalPages,
pageLoadStates[secondary.index].error ? retryFailedPagesKeyPrefix : undefined,
getPagePosition('second', themeDirection, readingDirection.value),
true,
)}

10
src/modules/reader/components/viewer/pager/ReaderHorizontalPager.tsx
View File

@@ -13,7 +13,13 @@ import { applyStyles } from '@/modules/core/utils/ApplyStyles.ts';
import { ReaderPagerProps, ReadingDirection } from '@/modules/reader/types/Reader.types.ts';
import { createReaderPage } from '@/modules/reader/utils/ReaderPager.utils.tsx';
export const ReaderHorizontalPager = ({ onLoad, ...props }: ReaderPagerProps) => {
export const ReaderHorizontalPager = ({
onLoad,
onError,
pageLoadStates,
retryFailedPagesKeyPrefix,
...props
}: ReaderPagerProps) => {
const { currentPageIndex, totalPages } = props;
const { pageGap, readingDirection } = ReaderService.useSettings();
@@ -28,10 +34,12 @@ export const ReaderHorizontalPager = ({ onLoad, ...props }: ReaderPagerProps) =>
createReaderPage(
page,
() => onLoad?.(pagesIndex),
() => onError?.(page.primary.index),
shouldLoad,
true,
currentPageIndex,
totalPages,
pageLoadStates[page.primary.index].error ? retryFailedPagesKeyPrefix : undefined,
undefined,
undefined,
setRef,

10
src/modules/reader/components/viewer/pager/ReaderPagedPager.tsx
View File

@@ -10,7 +10,13 @@ import { BasePager } from '@/modules/reader/components/viewer/pager/BasePager.ts
import { ReaderPagerProps } from '@/modules/reader/types/Reader.types.ts';
import { createReaderPage } from '@/modules/reader/utils/ReaderPager.utils.tsx';
export const ReaderPagedPager = ({ onLoad, ...props }: ReaderPagerProps) => {
export const ReaderPagedPager = ({
onLoad,
onError,
pageLoadStates,
retryFailedPagesKeyPrefix,
...props
}: ReaderPagerProps) => {
const { currentPageIndex, totalPages } = props;
return (
@@ -20,10 +26,12 @@ export const ReaderPagedPager = ({ onLoad, ...props }: ReaderPagerProps) => {
createReaderPage(
page,
() => onLoad?.(pagesIndex),
() => onError?.(page.primary.index),
shouldLoad,
shouldDisplay && currentPageIndex === page.primary.index,
currentPageIndex,
totalPages,
pageLoadStates[page.primary.index].error ? retryFailedPagesKeyPrefix : undefined,
)
}
slots={{

10
src/modules/reader/components/viewer/pager/ReaderVerticalPager.tsx
View File

@@ -11,7 +11,13 @@ import { BasePager } from '@/modules/reader/components/viewer/pager/BasePager.ts
import { ReaderPagerProps } from '@/modules/reader/types/Reader.types.ts';
import { createReaderPage } from '@/modules/reader/utils/ReaderPager.utils.tsx';
export const ReaderVerticalPager = ({ onLoad, ...props }: ReaderPagerProps) => {
export const ReaderVerticalPager = ({
onLoad,
onError,
pageLoadStates,
retryFailedPagesKeyPrefix,
...props
}: ReaderPagerProps) => {
const { currentPageIndex, totalPages } = props;
const { pageGap } = ReaderService.useSettings();
@@ -23,10 +29,12 @@ export const ReaderVerticalPager = ({ onLoad, ...props }: ReaderPagerProps) => {
createReaderPage(
page,
() => onLoad?.(pagesIndex),
() => onError?.(page.primary.index),
shouldLoad,
true,
currentPageIndex,
totalPages,
pageLoadStates[page.primary.index].error ? retryFailedPagesKeyPrefix : undefined,
undefined,
undefined,
setRef,

2
src/modules/reader/contexts/state/ReaderStatePagesContext.tsx
View File

@@ -25,6 +25,8 @@ export const ReaderStatePagesContext = createContext<ReaderStatePages>({
setPages: () => undefined,
transitionPageMode: ReaderTransitionPageMode.NONE,
setTransitionPageMode: () => undefined,
retryFailedPagesKeyPrefix: '',
setRetryFailedPagesKeyPrefix: () => undefined,
});
export const userReaderStatePagesContext = () => useContext(ReaderStatePagesContext);

15
src/modules/reader/contexts/state/ReaderStatePagesContextProvider.tsx
View File

@@ -23,6 +23,8 @@ export const ReaderStatePagesContextProvider = ({ children }: { children: ReactN
const [transitionPageMode, setTransitionPageMode] = useState<TContext['transitionPageMode']>(
ReaderTransitionPageMode.NONE,
);
const [retryFailedPagesKeyPrefix, setRetryFailedPagesKeyPrefix] =
useState<TContext['retryFailedPagesKeyPrefix']>('');
const value = useMemo(
() => ({
@@ -40,8 +42,19 @@ export const ReaderStatePagesContextProvider = ({ children }: { children: ReactN
setPages,
transitionPageMode,
setTransitionPageMode,
retryFailedPagesKeyPrefix,
setRetryFailedPagesKeyPrefix,
}),
[totalPages, pages, currentPageIndex, pageToScrollToIndex, pageUrls, pageLoadStates, transitionPageMode],
[
totalPages,
pages,
currentPageIndex,
pageToScrollToIndex,
pageUrls,
pageLoadStates,
transitionPageMode,
retryFailedPagesKeyPrefix,
],
);
return <ReaderStatePagesContext.Provider value={value}>{children}</ReaderStatePagesContext.Provider>;

4
src/modules/reader/screens/Reader.tsx
View File

@@ -147,7 +147,7 @@ export const Reader = () => {
setTotalPages(pagesPayload.chapter.pageCount);
setPages(createPagesData(pages));
setPageUrls(pages);
setPageLoadStates(pages.map(() => false));
setPageLoadStates(pages.map(() => ({ loaded: false })));
setCurrentPageIndex(initialReaderPageIndex);
setPageToScrollToIndex(initialReaderPageIndex);
} else {
@@ -156,7 +156,7 @@ export const Reader = () => {
setTotalPages(0);
setPages([createPageData('', 0)]);
setPageUrls([]);
setPageLoadStates([]);
setPageLoadStates([{ loaded: false }]);
}
setTransitionPageMode(ReaderTransitionPageMode.NONE);

11
src/modules/reader/types/Reader.types.ts
View File

@@ -209,9 +209,18 @@ export enum ReaderHotkey {
}
export interface ReaderPagerProps
extends Pick<ReaderStatePages, 'currentPageIndex' | 'pages' | 'totalPages' | 'transitionPageMode'> {
extends Pick<
ReaderStatePages,
| 'currentPageIndex'
| 'pages'
| 'totalPages'
| 'transitionPageMode'
| 'pageLoadStates'
| 'retryFailedPagesKeyPrefix'
> {
imageRefs: MutableRefObject<(HTMLElement | null)[]>;
onLoad?: (pagesIndex: number, isPrimary?: boolean) => void;
onError?: (pageIndex: number) => void;
}
export enum PageInViewportType {

6
src/modules/reader/types/ReaderProgressBar.types.ts
View File

@@ -31,12 +31,14 @@ export interface ReaderStatePages {
setPageToScrollToIndex: React.Dispatch<React.SetStateAction<number>>;
pageUrls: string[];
setPageUrls: React.Dispatch<React.SetStateAction<string[]>>;
pageLoadStates: boolean[];
setPageLoadStates: React.Dispatch<React.SetStateAction<boolean[]>>;
pageLoadStates: { loaded: boolean; error?: boolean }[];
setPageLoadStates: React.Dispatch<React.SetStateAction<{ loaded: boolean; error?: boolean }[]>>;
pages: PageData[];
setPages: React.Dispatch<React.SetStateAction<PageData[]>>;
transitionPageMode: ReaderTransitionPageMode;
setTransitionPageMode: React.Dispatch<React.SetStateAction<ReaderTransitionPageMode>>;
retryFailedPagesKeyPrefix: string;
setRetryFailedPagesKeyPrefix: React.Dispatch<React.SetStateAction<string>>;
}
export interface ReaderProgressBarProps

4
src/modules/reader/utils/ReaderPager.utils.tsx
View File

@@ -202,10 +202,12 @@ const getPageDownloadPriority = (currentPageIndex: number, pageIndex: number, to
export const createReaderPage = (
{ primary: { index, alt, url } }: ReaderStatePages['pages'][number],
onLoad: () => void,
onError: (() => void) | undefined,
shouldLoad: boolean,
display: boolean,
currentPageIndex: number,
totalPages: number,
retryKeyPrefix?: string,
position?: 'left' | 'right',
isDoublePage?: boolean,
setRef?: (ref: HTMLElement | null) => void,
@@ -219,8 +221,10 @@ export const createReaderPage = (
priority={getPageDownloadPriority(currentPageIndex, index, totalPages)}
position={position}
onLoad={onLoad}
onError={onError}
doublePage={isDoublePage}
shouldLoad={shouldLoad}
retryKeyPrefix={retryKeyPrefix}
/>
);