quasar-ui-danx 0.4.68 → 0.4.71

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quasar-ui-danx",
-  "version": "0.4.68",
+  "version": "0.4.71",
   "author": "Dan <dan@flytedesk.com>",
   "description": "DanX Vue / Quasar component library",
   "license": "MIT",

package/src/helpers/actions.ts

@@ -1,7 +1,7 @@
 import { useDebounceFn } from "@vueuse/core";
 import { FaSolidCopy as CopyIcon, FaSolidPencil as EditIcon, FaSolidTrash as DeleteIcon } from "danx-icon";
 import { uid } from "quasar";
-import { h, isReactive, Ref, shallowReactive, shallowRef } from "vue";
+import { h, Ref, shallowRef } from "vue";
 import { ConfirmActionDialog, CreateNewWithNameDialog } from "../components";
 import type {
 	ActionGlobalOptions,
@@ -55,39 +55,27 @@ export function useActions(actions: ActionOptions[], globalOptions: ActionGlobal
 	 */
 	function getAction(actionName: string, actionOptions?: Partial<ActionOptions>): ResourceAction {
 		/// Resolve the action options or resource action based on the provided input
-		let resourceAction: Partial<ResourceAction> = actions.find(a => a.name === actionName) || { name: actionName };
-
-		if (actionOptions) {
-			Object.assign(resourceAction, actionOptions);
-		}
+		const baseOptions: Partial<ResourceAction> = actions.find(a => a.name === actionName) || { name: actionName };
 
 		// If the action is already reactive, return it
-		if (!isReactive(resourceAction) || !("__type" in resourceAction)) {
-			resourceAction = storeObject({
-				onAction: globalOptions?.routes?.applyAction,
-				onBatchAction: globalOptions?.routes?.batchAction,
-				onBatchSuccess: globalOptions?.controls?.clearSelectedRows,
-				...globalOptions,
-				...resourceAction,
-				isApplying: false,
-				__type: "__Action:" + namespace
-			});
-
-			// Splice the resourceAction in place of the action in the actions list
-			actions.splice(actions.findIndex(a => a.name === actionName), 1, resourceAction as ResourceAction);
-		}
-
-		// Return a clone of the action so it can be modified without affecting the original
-		const clonedAction = shallowReactive({ ...resourceAction }) as ResourceAction;
+		const resourceAction = storeObject({
+			onAction: globalOptions?.routes?.applyAction,
+			onBatchAction: globalOptions?.routes?.batchAction,
+			onBatchSuccess: globalOptions?.controls?.clearSelectedRows,
+			...baseOptions,
+			...actionOptions,
+			isApplying: false,
+			__type: "__Action:" + namespace
+		}) as ResourceAction;
 
 		// Assign Trigger function if it doesn't exist
-		if (clonedAction.debounce) {
-			clonedAction.trigger = useDebounceFn((target, input) => performAction(clonedAction, target, input), clonedAction.debounce);
+		if (resourceAction.debounce) {
+			resourceAction.trigger = useDebounceFn((target, input) => performAction(resourceAction, target, input), resourceAction.debounce);
 		} else {
-			clonedAction.trigger = (target, input) => performAction(clonedAction, target, input);
+			resourceAction.trigger = (target, input) => performAction(resourceAction, target, input);
 		}
 
-		return clonedAction;
+		return resourceAction;
 	}
 
 	/**

package/src/helpers/request.ts

@@ -1,6 +1,6 @@
 import { Ref } from "vue";
 import { danxOptions } from "../config";
-import { HttpResponse, RequestApi } from "../types";
+import { ActiveRequest, HttpResponse, RequestApi } from "../types";
 import { sleep } from "./utils";
 
 /**
@@ -8,7 +8,7 @@ import { sleep } from "./utils";
  * to make GET and POST requests easier w/ JSON payloads
  */
 export const request: RequestApi = {
-	abortControllers: {},
+	activeRequests: {},
 
 	url(url) {
 		if (url.startsWith("http")) {
@@ -19,20 +19,29 @@ export const request: RequestApi = {
 
 	async call(url, options) {
 		options = options || {};
-		const abortKey = options?.abortOn !== undefined ? options.abortOn : url + JSON.stringify(options.params || "");
+		const requestKey = options?.requestKey || url + JSON.stringify(options.params || "");
+		const waitOnPrevious = !!options?.waitOnPrevious;
+		const useMostRecentResponse = !!options?.useMostRecentResponse;
+		const shouldAbortPrevious = !waitOnPrevious;
 		const timestamp = Date.now();
 
-		if (abortKey) {
-			const abort = new AbortController();
-			const previousAbort = request.abortControllers[abortKey];
+		// If there was a request with the same key made that is still active, track that here
+		const previousRequest = request.activeRequests[requestKey];
+
+		// Set the current active request to this one
+		const currentRequest: ActiveRequest = { timestamp };
+		request.activeRequests[requestKey] = currentRequest;
+
+		if (shouldAbortPrevious) {
 			// If there is already an abort controller set for this key, abort it
-			if (previousAbort) {
-				previousAbort.abort.abort("Request was aborted due to a newer request being made");
+			if (previousRequest) {
+				previousRequest.abortController?.abort("Request was aborted due to a newer request being made");
 			}
 
+			const abortController = new AbortController();
 			// Set the new abort controller for this key
-			request.abortControllers[abortKey] = { abort, timestamp };
-			options.signal = abort.signal;
+			currentRequest.abortController = abortController;
+			options.signal = abortController.signal;
 		}
 
 		if (options.params) {
@@ -47,49 +56,85 @@ export const request: RequestApi = {
 			delete options.params;
 		}
 
-		let response = null;
+		let resolvePromise!: (value: any) => any;
+		let rejectPromise!: (reason?: any) => any;
+		currentRequest.requestPromise = new Promise((resolve, reject) => {
+			resolvePromise = resolve;
+			rejectPromise = reject;
+		});
+
+		// If there is a previous request still active, wait for it to finish before proceeding (if the waitForPrevious flag is set)
+		if (waitOnPrevious && previousRequest?.requestPromise) {
+			try {
+				await previousRequest.requestPromise;
+			} catch (e) {
+				// We don't care if it fails, we just need to wait for it to complete
+			}
+		}
+
+		// Wait to finish the request before proceeding
+		let response: Response;
 		try {
 			response = await fetch(request.url(url), options);
 		} catch (e) {
 			if (options.ignoreAbort && (e + "").match(/Request was aborted/)) {
-				return { abort: true };
+				const abortResponse = { abort: true };
+				resolvePromise(abortResponse);
+				return abortResponse;
 			}
+			rejectPromise(e);
 			throw e;
 		}
 
 		// Verify the app version of the client and server are matching
 		checkAppVersion(response);
 
-		// handle the case where the request was aborted too late, and we need to abort the response via timestamp check
-		if (abortKey) {
-			// If the request was aborted too late, but there was still another request that was made after the current,
-			// then abort the current request with an abort flag
-			if (timestamp < request.abortControllers[abortKey].timestamp) {
-				return { abort: true };
+		// Track the most recent request (maybe another request with the same key was made after this request started)
+		let mostRecentRequest = request.activeRequests[requestKey];
+
+		// Always fetch the result
+		let responseJson = await response.json();
+
+		// Send the real JSON response to the promise in case other requests are waiting on this request result
+		resolvePromise(responseJson);
+
+		// If this request is not the most recent request...
+		if (mostRecentRequest.timestamp !== timestamp) {
+			// and it should be aborted but was aborted too late, return an aborted response
+			if (shouldAbortPrevious) {
+				responseJson = { abort: true };
+			} else if (useMostRecentResponse) {
+				// or if there is a more recent request, and the useMoreRecentResponse flag is set, update this response to the more recent one
+				do {
+					// Always update on each iteration to make sure we're checking the current most recent
+					// (maybe additional requests will be made before the current most recent finishes)
+					mostRecentRequest = request.activeRequests[requestKey];
+					responseJson = await mostRecentRequest.requestPromise;
+
+					// If the most recent request is the same as this one, break out of the loop
+					if (request.activeRequests[requestKey].timestamp === mostRecentRequest.timestamp) {
+						break;
+					}
+				} while (mostRecentRequest.timestamp !== request.activeRequests[requestKey].timestamp);
 			}
-
-			// Otherwise, the current is the most recent request, so we can delete the abort controller
-			delete request.abortControllers[abortKey];
 		}
 
-		const result = await response.json();
-
 		if (response.status === 401) {
 			const onUnauthorized = danxOptions.value.request?.onUnauthorized;
-			return onUnauthorized ? onUnauthorized(result, response) : {
+			return onUnauthorized ? onUnauthorized(responseJson, response) : {
 				error: true,
 				message: "Unauthorized",
-				...result
+				...responseJson
 			};
 		}
 
 		if (response.status > 400) {
-			if (result.exception && !result.error) {
-				result.error = true;
+			if (responseJson.exception && !responseJson.error) {
+				responseJson.error = true;
 			}
 		}
 
-		return result;
+		return responseJson;
 	},
 
 	async poll(url: string, options, interval, fnUntil) {

package/src/helpers/routes.ts

@@ -56,7 +56,8 @@ export function useActionRoutes(baseUrl: string, extend?: object): ListControlsR
 		async applyAction(action, target, data, options?) {
 			options = {
 				...options,
-				ignoreAbort: true,
+				waitOnPrevious: true,
+				useMostRecentResponse: true,
 				headers: {
 					...options?.headers,
 					"X-Timestamp": Date.now().toString()
@@ -86,7 +87,7 @@ export function useActionRoutes(baseUrl: string, extend?: object): ListControlsR
 		batchAction(action, targets, data, options?) {
 			options = {
 				...options,
-				ignoreAbort: true
+				waitOnPrevious: true
 			};
 			return request.post(`${baseUrl}/batch-action`, { action, filter: { id: targets.map(r => r.id) }, data }, options);
 		},

package/src/types/requests.d.ts

@@ -1,7 +1,15 @@
 import { AnyObject } from "./shared";
 
+export interface ActiveRequest {
+	requestPromise?: Promise<any>,
+	abortController?: AbortController,
+	timestamp: number
+}
+
 export interface RequestApi {
-	abortControllers: { [key: string]: { abort: AbortController, timestamp: number } };
+	activeRequests: {
+		[key: string]: ActiveRequest
+	};
 
 	url(url: string): string;
 
@@ -30,7 +38,9 @@ export interface RequestOptions {
 }
 
 export interface RequestCallOptions extends RequestInit {
-	abortOn?: string;
+	requestKey?: string;
+	waitOnPrevious?: boolean;
+	useMostRecentResponse?: boolean;
 	ignoreAbort?: boolean;
 	params?: AnyObject;
 }