Add progress bar to top of page for nicer loading indicator styles

DaneEveritt · DaneEveritt · commit d3a06e1ca8ee · 2020-04-10T12:41:08.000-07:00
diff --git a/resources/scripts/api/http.ts b/resources/scripts/api/http.ts
@@ -1,6 +1,8 @@
 import axios, { AxiosInstance } from 'axios';
+import { store } from '@/state';
 
 const http: AxiosInstance = axios.create({
+    timeout: 20000,
     headers: {
         'X-Requested-With': 'XMLHttpRequest',
         'Accept': 'application/json',
@@ -9,6 +11,18 @@ const http: AxiosInstance = axios.create({
     },
 });
 
+http.interceptors.request.use(req => {
+    store.getActions().progress.startContinuous();
+
+    return req;
+});
+
+http.interceptors.response.use(resp => {
+    store.getActions().progress.setComplete();
+
+    return resp;
+});
+
 // If we have a phpdebugbar instance registered at this point in time go
 // ahead and route the response data through to it so things show up.
 // @ts-ignore
diff --git a/resources/scripts/components/App.tsx b/resources/scripts/components/App.tsx
@@ -9,6 +9,7 @@ import AuthenticationRouter from '@/routers/AuthenticationRouter';
 import { Provider } from 'react-redux';
 import { SiteSettings } from '@/state/settings';
 import { DefaultTheme, ThemeProvider } from 'styled-components';
+import ProgressBar from '@/components/elements/ProgressBar';
 
 interface ExtendedWindow extends Window {
     SiteConfiguration?: SiteSettings;
@@ -57,6 +58,7 @@ const App = () => {
         <ThemeProvider theme={theme}>
             <StoreProvider store={store}>
                 <Provider store={store}>
+                    <ProgressBar/>
                     <div className={'mx-auto w-auto'}>
                         <BrowserRouter basename={'/'} key={'root-router'}>
                             <Switch>
diff --git a/resources/scripts/components/elements/ListRefreshIndicator.tsx b/resources/scripts/components/elements/ListRefreshIndicator.tsx
diff --git a/resources/scripts/components/elements/ProgressBar.tsx b/resources/scripts/components/elements/ProgressBar.tsx
@@ -0,0 +1,73 @@
+import React, { useEffect, useRef, useState } from 'react';
+import styled from 'styled-components';
+import { useStoreActions, useStoreState } from 'easy-peasy';
+import { randomInt } from '@/helpers';
+import { CSSTransition } from 'react-transition-group';
+
+const BarFill = styled.div`
+    ${tw`h-full bg-cyan-400`};
+    transition: 250ms ease-in-out;
+    box-shadow: 0 -2px 10px 2px hsl(178, 78%, 57%);
+`;
+
+export default () => {
+    const interval = useRef<number>(null);
+    const timeout = useRef<number>(null);
+    const [ visible, setVisible ] = useState(false);
+    const progress = useStoreState(state => state.progress.progress);
+    const continuous = useStoreState(state => state.progress.continuous);
+    const setProgress = useStoreActions(actions => actions.progress.setProgress);
+
+    useEffect(() => {
+        return () => {
+            timeout.current && clearTimeout(timeout.current);
+            interval.current && clearInterval(interval.current);
+        };
+    }, []);
+
+    useEffect(() => {
+        setVisible((progress || 0) > 0);
+
+        if (progress === 100) {
+            // @ts-ignore
+            timeout.current = setTimeout(() => setProgress(undefined), 500);
+        }
+    }, [ progress ]);
+
+    useEffect(() => {
+        if (!continuous) {
+            interval.current && clearInterval(interval.current);
+            return;
+        }
+
+        if (!progress || progress === 0) {
+            setProgress(randomInt(20, 30));
+        }
+    }, [ continuous ]);
+
+    useEffect(() => {
+        if (continuous) {
+            interval.current && clearInterval(interval.current);
+            if ((progress || 0) >= 90) {
+                setProgress(90);
+            } else {
+                // @ts-ignore
+                interval.current = setTimeout(() => setProgress(progress + randomInt(1, 5)), 500);
+            }
+        }
+    }, [ progress, continuous ]);
+
+    return (
+        <div className={'w-full fixed'} style={{ height: '2px' }}>
+            <CSSTransition
+                timeout={250}
+                appear={true}
+                in={visible}
+                unmountOnExit={true}
+                classNames={'fade'}
+            >
+                <BarFill style={{ width: progress === undefined ? '100%' : `${progress}%` }}/>
+            </CSSTransition>
+        </div>
+    );
+};
diff --git a/resources/scripts/components/server/backups/BackupContainer.tsx b/resources/scripts/components/server/backups/BackupContainer.tsx
@@ -1,6 +1,6 @@
 import React, { useEffect, useState } from 'react';
 import Spinner from '@/components/elements/Spinner';
-import getServerBackups, { ServerBackup } from '@/api/server/backups/getServerBackups';
+import getServerBackups from '@/api/server/backups/getServerBackups';
 import useServer from '@/plugins/useServer';
 import useFlash from '@/plugins/useFlash';
 import { httpErrorToHuman } from '@/api/http';
@@ -9,7 +9,6 @@ import CreateBackupButton from '@/components/server/backups/CreateBackupButton';
 import FlashMessageRender from '@/components/FlashMessageRender';
 import BackupRow from '@/components/server/backups/BackupRow';
 import { ServerContext } from '@/state/server';
-import ListRefreshIndicator from '@/components/elements/ListRefreshIndicator';
 
 export default () => {
     const { uuid } = useServer();
@@ -36,7 +35,6 @@ export default () => {
 
     return (
         <div className={'mt-10 mb-6'}>
-            <ListRefreshIndicator visible={loading}/>
             <FlashMessageRender byKey={'backups'} className={'mb-4'}/>
             {!backups.length ?
                 <p className="text-center text-sm text-neutral-400">
diff --git a/resources/scripts/components/server/databases/DatabasesContainer.tsx b/resources/scripts/components/server/databases/DatabasesContainer.tsx
@@ -10,7 +10,6 @@ import CreateDatabaseButton from '@/components/server/databases/CreateDatabaseBu
 import Can from '@/components/elements/Can';
 import useFlash from '@/plugins/useFlash';
 import useServer from '@/plugins/useServer';
-import ListRefreshIndicator from '@/components/elements/ListRefreshIndicator';
 
 export default () => {
     const { uuid, featureLimits } = useServer();
@@ -41,7 +40,6 @@ export default () => {
                 :
                 <CSSTransition classNames={'fade'} timeout={250}>
                     <>
-                        <ListRefreshIndicator visible={loading}/>
                         {databases.length > 0 ?
                             databases.map((database, index) => (
                                 <DatabaseRow
diff --git a/resources/scripts/components/server/schedules/ScheduleContainer.tsx b/resources/scripts/components/server/schedules/ScheduleContainer.tsx
@@ -1,18 +1,15 @@
-import React, { useEffect, useMemo, useState } from 'react';
-import getServerSchedules, { Schedule } from '@/api/server/schedules/getServerSchedules';
+import React, { useEffect, useState } from 'react';
+import getServerSchedules from '@/api/server/schedules/getServerSchedules';
 import { ServerContext } from '@/state/server';
 import Spinner from '@/components/elements/Spinner';
 import { RouteComponentProps } from 'react-router-dom';
 import FlashMessageRender from '@/components/FlashMessageRender';
 import ScheduleRow from '@/components/server/schedules/ScheduleRow';
 import { httpErrorToHuman } from '@/api/http';
-import { Actions, useStoreActions } from 'easy-peasy';
-import { ApplicationStore } from '@/state';
 import EditScheduleModal from '@/components/server/schedules/EditScheduleModal';
 import Can from '@/components/elements/Can';
 import useServer from '@/plugins/useServer';
 import useFlash from '@/plugins/useFlash';
-import ListRefreshIndicator from '@/components/elements/ListRefreshIndicator';
 
 export default ({ match, history }: RouteComponentProps) => {
     const { uuid } = useServer();
@@ -37,7 +34,6 @@ export default ({ match, history }: RouteComponentProps) => {
     return (
         <div className={'my-10 mb-6'}>
             <FlashMessageRender byKey={'schedules'} className={'mb-4'}/>
-            <ListRefreshIndicator visible={loading}/>
             {(!schedules.length && loading) ?
                 <Spinner size={'large'} centered={true}/>
                 :
diff --git a/resources/scripts/components/server/users/UsersContainer.tsx b/resources/scripts/components/server/users/UsersContainer.tsx
@@ -9,7 +9,6 @@ import FlashMessageRender from '@/components/FlashMessageRender';
 import getServerSubusers from '@/api/server/users/getServerSubusers';
 import { httpErrorToHuman } from '@/api/http';
 import Can from '@/components/elements/Can';
-import ListRefreshIndicator from '@/components/elements/ListRefreshIndicator';
 
 export default () => {
     const [ loading, setLoading ] = useState(true);
@@ -48,7 +47,6 @@ export default () => {
 
     return (
         <div className={'mt-10 mb-6'}>
-            <ListRefreshIndicator visible={loading}/>
             <FlashMessageRender byKey={'users'} className={'mb-4'}/>
             {!subusers.length ?
                 <p className={'text-center text-sm text-neutral-400'}>
diff --git a/resources/scripts/easy-peasy.d.ts b/resources/scripts/easy-peasy.d.ts
@@ -1,9 +1,13 @@
 // noinspection ES6UnusedImports
-import EasyPeasy from 'easy-peasy';
+import EasyPeasy, { Actions, State } from 'easy-peasy';
 import { ApplicationStore } from '@/state';
 
 declare module 'easy-peasy' {
     export function useStoreState<Result>(
-        mapState: (state: ApplicationStore) => Result,
+        mapState: (state: State<ApplicationStore>) => Result,
+    ): Result;
+
+    export function useStoreActions<Result>(
+        mapActions: (actions: Actions<ApplicationStore>) => Result,
     ): Result;
 }
diff --git a/resources/scripts/helpers.ts b/resources/scripts/helpers.ts
@@ -9,3 +9,5 @@ export function bytesToHuman (bytes: number): string {
 }
 
 export const bytesToMegabytes = (bytes: number) => Math.floor(bytes / 1000 / 1000);
+
+export const randomInt = (low: number, high: number) => Math.floor(Math.random() * (high - low) + low);
diff --git a/resources/scripts/state/index.ts b/resources/scripts/state/index.ts
@@ -3,19 +3,22 @@ import flashes, { FlashStore } from '@/state/flashes';
 import user, { UserStore } from '@/state/user';
 import permissions, { GloablPermissionsStore } from '@/state/permissions';
 import settings, { SettingsStore } from '@/state/settings';
+import progress, { ProgressStore } from '@/state/progress';
 
 export interface ApplicationStore {
     permissions: GloablPermissionsStore;
     flashes: FlashStore;
     user: UserStore;
     settings: SettingsStore;
+    progress: ProgressStore;
 }
 
 const state: ApplicationStore = {
     permissions,
     flashes,
     user,
     settings,
+    progress,
 };
 
 export const store = createStore(state);
diff --git a/resources/scripts/state/progress.ts b/resources/scripts/state/progress.ts
@@ -0,0 +1,30 @@
+import { action, Action } from 'easy-peasy';
+
+export interface ProgressStore {
+    continuous: boolean;
+    progress?: number;
+
+    startContinuous: Action<ProgressStore>;
+    setProgress: Action<ProgressStore, number | undefined>;
+    setComplete: Action<ProgressStore>;
+}
+
+const progress: ProgressStore = {
+    continuous: false,
+    progress: undefined,
+
+    startContinuous: action(state => {
+        state.continuous = true;
+    }),
+
+    setProgress: action((state, payload) => {
+        state.progress = payload;
+    }),
+
+    setComplete: action(state => {
+        state.progress = 100;
+        state.continuous = false;
+    }),
+};
+
+export default progress;

Original file line number	Diff line number	Diff line change
`@@ -9,3 +9,5 @@ export function bytesToHuman (bytes: number): string {`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`export const bytesToMegabytes = (bytes: number) => Math.floor(bytes / 1000 / 1000);`
	`12`	`+`
	`13`	`+export const randomInt = (low: number, high: number) => Math.floor(Math.random() * (high - low) + low);`