From 9532f7a6985835237d560ff0a6d43ad92eb8f596 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jarda=20Kot=C4=9B=C5=A1ovec?= <jarda.kotesovec@gmail.com>
Date: Mon, 9 Dec 2024 15:10:37 +0100
Subject: [PATCH] pkp/pkp-lib#10663 Spinners for dashboard&workflow

---
 src/components/Spinner/Spinner.vue            | 37 +++++++++--
 src/components/Spinner/SpinnerFullScreen.vue  | 15 +++++
 src/composables/useFetch.js                   | 21 ++++++-
 src/pages/dashboard/DashboardPage.vue         | 20 ++++--
 src/pages/workflow/WorkflowPage.vue           | 15 ++++-
 .../composables/useWorkflowActions.js         |  2 +
 src/stores/progressStore.js                   | 62 +++++++++++++++++++
 7 files changed, 160 insertions(+), 12 deletions(-)
 create mode 100644 src/components/Spinner/SpinnerFullScreen.vue
 create mode 100644 src/stores/progressStore.js

diff --git a/src/components/Spinner/Spinner.vue b/src/components/Spinner/Spinner.vue
index fe7e9afb3..2addc8ba5 100644
--- a/src/components/Spinner/Spinner.vue
+++ b/src/components/Spinner/Spinner.vue
@@ -1,7 +1,25 @@
 <template>
-	<span class="pkpSpinner" aria-hidden="true" />
+	<span
+		class="pkpSpinner"
+		:class="{'pkpSpinner--big': sizeVariant === 'big'}"
+		aria-hidden="true"
+	>
+		<span v-if="message" class="ms-3 text-base-normal text-disabled">
+			{{ message }}
+		</span>
+	</span>
 </template>
-
+<script setup>
+defineProps({
+	message: {required: false, type: String, default: null},
+	sizeVariant: {
+		required: false,
+		type: String,
+		default: () => 'default',
+		validator: (prop) => ['default', 'big'].includes(prop),
+	},
+});
+</script>
 <style lang="less">
 @import '../../styles/_import';
 
@@ -14,15 +32,26 @@
 		vertical-align: middle;
 		animation: pkp_anim_spinner 0.6s linear infinite;
 		border-radius: 100%;
-		border-top: 1px solid @bg-anchor;
+		border-top: 1px solid @primary;
 		border-bottom: 1px solid transparent;
-		border-left: 1px solid @bg-anchor;
+		border-left: 1px solid @primary;
 		border-right: 1px solid transparent;
 		content: '';
 		opacity: 1;
 	}
 }
 
+.pkpSpinner--big {
+	&:before {
+		width: 2rem;
+		height: 2rem;
+		border-top: 3px solid @primary;
+		border-bottom: 3px solid transparent;
+		border-left: 3px solid @primary;
+		border-right: 3px solid transparent;
+	}
+}
+
 // Animation
 @keyframes pkp_anim_spinner {
 	0% {
diff --git a/src/components/Spinner/SpinnerFullScreen.vue b/src/components/Spinner/SpinnerFullScreen.vue
new file mode 100644
index 000000000..48cf6347d
--- /dev/null
+++ b/src/components/Spinner/SpinnerFullScreen.vue
@@ -0,0 +1,15 @@
+<template>
+	<div
+		v-if="progressStore.isFullScreenSpinner"
+		class="fixed inset-0 z-50 flex items-center justify-center bg-default bg-opacity-75"
+	>
+		<Spinner size-variant="big" />
+	</div>
+</template>
+
+<script setup>
+import Spinner from '@/components/Spinner/Spinner.vue';
+import {useProgressStore} from '@/stores/progressStore';
+
+const progressStore = useProgressStore();
+</script>
diff --git a/src/composables/useFetch.js b/src/composables/useFetch.js
index 2a154c6db..424840806 100644
--- a/src/composables/useFetch.js
+++ b/src/composables/useFetch.js
@@ -1,6 +1,8 @@
-import {ref, unref} from 'vue';
+import {ref, unref, inject} from 'vue';
 import {ofetch, createFetch} from 'ofetch';
 import {useModalStore} from '@/stores/modalStore';
+import {useProgressStore} from '@/stores/progressStore';
+
 import {useDebounceFn} from '@vueuse/core';
 
 let ofetchInstance = ofetch;
@@ -15,6 +17,7 @@ export function getCSRFToken() {
 
 	return FALLBACK_TOKEN;
 }
+
 /**
  *
  * Composable for handling API requests
@@ -27,7 +30,8 @@ export function getCSRFToken() {
  * @param {Object} [options.body] - The request payload, typically used with 'POST', 'PUT', or 'DELETE' requests.
  * @param {Object} [options.headers] - Additional HTTP headers to be sent with the request.
  * @param {string} [options.method] - The HTTP method to be used for the request (e.g., 'GET', 'POST', etc.).
- * @param {number} options.debouncedMs - When the fetch should be debounce, this defines the delay
+ * @param {number} [options.debouncedMs] - When the fetch should be debounce, this defines the delay
+ * @param {boolean} [options.showFullScreenSpinner] - Automatically shows full screen spinner, when set to true
 
  * @returns {Object} An object containing several reactive properties and a method for performing the fetch operation:
  * @returns {Ref<Object|null>} return.data - A ref object containing the response data from the fetch operation.
@@ -64,6 +68,10 @@ export function useFetch(url, options = {}) {
 
 	let lastRequestController = null;
 
+	const modalLevel = inject('modalLevel');
+	const screenName = modalLevel?.value ? `modal_${modalLevel.value}` : 'base';
+	const progressStore = useProgressStore();
+
 	async function _fetch() {
 		if (lastRequestController) {
 			// abort in-flight request
@@ -95,6 +103,11 @@ export function useFetch(url, options = {}) {
 		}
 
 		isLoading.value = true;
+		progressStore.fetchStarted(screenName);
+		if (opts.showFullScreenSpinner) {
+			progressStore.startFullScreenSpinner();
+		}
+
 		isSuccess.value = null;
 		try {
 			const result = await ofetchInstance(unref(url), opts);
@@ -122,6 +135,10 @@ export function useFetch(url, options = {}) {
 		} finally {
 			lastRequestController = null;
 			isLoading.value = false;
+			progressStore.fetchFinished(screenName);
+			if (opts.showFullScreenSpinner) {
+				progressStore.stopFullScreenSpinner();
+			}
 		}
 	}
 
diff --git a/src/pages/dashboard/DashboardPage.vue b/src/pages/dashboard/DashboardPage.vue
index 3ef19791c..dd63d2686 100644
--- a/src/pages/dashboard/DashboardPage.vue
+++ b/src/pages/dashboard/DashboardPage.vue
@@ -1,11 +1,20 @@
 <template>
 	<div class="min-h-screentext-base-normal me-3 ms-5 text-base-normal">
 		<div class="">
-			<h2 class="flex items-center gap-4 py-6 text-5xl-bold">
-				{{
-					`${store.currentView.name} (${store.submissionsPagination.itemCount})`
-				}}
-			</h2>
+			<span>
+				<h2 class="flex-inline items-center gap-4 py-6 text-5xl-bold">
+					{{
+						`${store.currentView.name} (${store.submissionsPagination.itemCount})`
+					}}
+					<span class="ms-3">
+						<Spinner
+							size-variant="big"
+							:class="!store.isSubmissionsLoading ? 'invisible' : ''"
+						/>
+					</span>
+				</h2>
+			</span>
+
 			<div class="mt-2">
 				<div class="flex justify-between">
 					<div class="flex flex-row space-x-2">
@@ -54,6 +63,7 @@ import DashboardTable from './components/DashboardTable/DashboardTable.vue';
 import Search from '@/components/Search/Search.vue';
 
 import {useDashboardPageStore} from './dashboardPageStore';
+import Spinner from '@/components/Spinner/Spinner.vue';
 
 const props = defineProps({
 	dashboardPage: {
diff --git a/src/pages/workflow/WorkflowPage.vue b/src/pages/workflow/WorkflowPage.vue
index ffc9988a6..ac2b8372a 100644
--- a/src/pages/workflow/WorkflowPage.vue
+++ b/src/pages/workflow/WorkflowPage.vue
@@ -2,6 +2,17 @@
 	<SideModalBody>
 		<template #pre-title>
 			{{ workflowStore.submissionId }}
+			<span class="ms-3">
+				<Spinner
+					size-variant="big"
+					:message="t('common.refreshingData')"
+					:class="
+						progressStore.screensInProgress.includes('modal_1')
+							? ''
+							: 'invisible'
+					"
+				/>
+			</span>
 		</template>
 		<template #title>
 			<span v-if="selectedPublication" class="underline">
@@ -134,14 +145,16 @@ import {storeToRefs} from 'pinia';
 import SideMenu from '@/components/SideMenu/SideMenu.vue';
 import SideModalBody from '@/components/Modal/SideModalBody.vue';
 import StageBubble from '@/components/StageBubble/StageBubble.vue';
-
+import Spinner from '@/components/Spinner/Spinner.vue';
 import {useWorkflowStore} from './workflowStore';
+import {useProgressStore} from '@/stores/progressStore';
 import SideModalLayoutMenu2Columns from '@/components/Modal/SideModalLayoutMenu2Columns.vue';
 
 import {useLocalize} from '@/composables/useLocalize';
 const {localizeSubmission} = useLocalize();
 
 const workflowStore = useWorkflowStore();
+const progressStore = useProgressStore();
 
 const {submission, selectedPublication} = storeToRefs(workflowStore);
 </script>
diff --git a/src/pages/workflow/composables/useWorkflowActions.js b/src/pages/workflow/composables/useWorkflowActions.js
index 5ac905a93..b18fdcdf0 100644
--- a/src/pages/workflow/composables/useWorkflowActions.js
+++ b/src/pages/workflow/composables/useWorkflowActions.js
@@ -5,6 +5,7 @@ import {useUrl} from '@/composables/useUrl';
 import {useForm} from '@/composables/useForm';
 import {useFetch} from '@/composables/useFetch';
 import {useLegacyGridUrl} from '@/composables/useLegacyGridUrl';
+
 import WorkflowModalChangeSubmissionLanguage from '@/pages/workflow/modals/WorkflowChangeSubmissionLanguageModal.vue';
 
 import WorkflowSelectRevisionFormModal from '@/pages/workflow/modals/WorkflowSelectRevisionFormModal.vue';
@@ -284,6 +285,7 @@ export function useWorkflowActions({
 							createNewVersionUrl,
 							{
 								method: 'POST',
+								showFullScreenSpinner: true,
 							},
 						);
 						await fetch();
diff --git a/src/stores/progressStore.js b/src/stores/progressStore.js
new file mode 100644
index 000000000..ddbbb1e0f
--- /dev/null
+++ b/src/stores/progressStore.js
@@ -0,0 +1,62 @@
+import {defineStore} from 'pinia';
+import {ref, computed} from 'vue';
+
+export const useProgressStore = defineStore('progress', () => {
+	/**
+	 * Background spinner currently used on workflow page
+	 * Detects all fetch activity on current screen
+	 * */
+	const screenFetchesInProgress = ref({});
+	const screensInProgress = computed(() => {
+		const screens = [];
+		Object.keys(screenFetchesInProgress.value).forEach((key) => {
+			if (screenFetchesInProgress.value[key] > 0) {
+				screens.push(key);
+			}
+		});
+
+		return screens;
+	});
+
+	function fetchStarted(screenName = 'base') {
+		if (
+			Object.prototype.hasOwnProperty.call(
+				screenFetchesInProgress.value,
+				screenName,
+			)
+		) {
+			screenFetchesInProgress.value[screenName] = 0;
+		}
+
+		screenFetchesInProgress.value[screenName]++;
+	}
+
+	function fetchFinished(screenName = 'base') {
+		screenFetchesInProgress.value[screenName]--;
+	}
+
+	/**
+	 * Fullscreen spinner
+	 */
+
+	const isFullScreenSpinner = ref(false);
+	function startFullScreenSpinner() {
+		isFullScreenSpinner.value = true;
+	}
+	function stopFullScreenSpinner() {
+		isFullScreenSpinner.value = false;
+	}
+
+	return {
+		fetchStarted,
+		fetchFinished,
+		screensInProgress,
+
+		/**
+		 * Full Screen spinner
+		 */
+		isFullScreenSpinner,
+		startFullScreenSpinner,
+		stopFullScreenSpinner,
+	};
+});