mirror of
https://github.com/robonen/tools.git
synced 2026-03-20 10:54:44 +00:00
feat(vue): use cancellablePromise in useAsyncState for promise cancellation
Co-authored-by: robonen <26167508+robonen@users.noreply.github.com>
This commit is contained in:
@@ -22,6 +22,7 @@ describe(useAsyncState, () => {
|
|||||||
expect(isLoading.value).toBeTruthy();
|
expect(isLoading.value).toBeTruthy();
|
||||||
expect(error.value).toBe(null);
|
expect(error.value).toBe(null);
|
||||||
|
|
||||||
|
await nextTick();
|
||||||
await nextTick();
|
await nextTick();
|
||||||
|
|
||||||
expect(state.value).toBe('data');
|
expect(state.value).toBe('data');
|
||||||
@@ -41,6 +42,7 @@ describe(useAsyncState, () => {
|
|||||||
expect(isLoading.value).toBeTruthy();
|
expect(isLoading.value).toBeTruthy();
|
||||||
expect(error.value).toBe(null);
|
expect(error.value).toBe(null);
|
||||||
|
|
||||||
|
await nextTick();
|
||||||
await nextTick();
|
await nextTick();
|
||||||
|
|
||||||
expect(state.value).toBe('data');
|
expect(state.value).toBe('data');
|
||||||
@@ -60,6 +62,7 @@ describe(useAsyncState, () => {
|
|||||||
expect(isLoading.value).toBeTruthy();
|
expect(isLoading.value).toBeTruthy();
|
||||||
expect(error.value).toBe(null);
|
expect(error.value).toBe(null);
|
||||||
|
|
||||||
|
await nextTick();
|
||||||
await nextTick();
|
await nextTick();
|
||||||
|
|
||||||
expect(state.value).toBe('initial');
|
expect(state.value).toBe('initial');
|
||||||
@@ -77,6 +80,7 @@ describe(useAsyncState, () => {
|
|||||||
{ onSuccess },
|
{ onSuccess },
|
||||||
);
|
);
|
||||||
|
|
||||||
|
await nextTick();
|
||||||
await nextTick();
|
await nextTick();
|
||||||
|
|
||||||
expect(onSuccess).toHaveBeenCalledWith('data');
|
expect(onSuccess).toHaveBeenCalledWith('data');
|
||||||
@@ -92,6 +96,7 @@ describe(useAsyncState, () => {
|
|||||||
{ onError },
|
{ onError },
|
||||||
);
|
);
|
||||||
|
|
||||||
|
await nextTick();
|
||||||
await nextTick();
|
await nextTick();
|
||||||
|
|
||||||
expect(onError).toHaveBeenCalledWith(error);
|
expect(onError).toHaveBeenCalledWith(error);
|
||||||
@@ -164,6 +169,7 @@ describe(useAsyncState, () => {
|
|||||||
expect(isReady.value).toBeFalsy();
|
expect(isReady.value).toBeFalsy();
|
||||||
expect(error.value).toBe(null);
|
expect(error.value).toBe(null);
|
||||||
|
|
||||||
|
await nextTick();
|
||||||
await nextTick();
|
await nextTick();
|
||||||
|
|
||||||
expect(state.value).toBe('data');
|
expect(state.value).toBe('data');
|
||||||
@@ -289,6 +295,7 @@ describe(useAsyncState, () => {
|
|||||||
executeImmediately();
|
executeImmediately();
|
||||||
resolvePromise!('new data');
|
resolvePromise!('new data');
|
||||||
await nextTick();
|
await nextTick();
|
||||||
|
await nextTick();
|
||||||
|
|
||||||
expect(state.value).toBe('new data');
|
expect(state.value).toBe('new data');
|
||||||
expect(isReady.value).toBeTruthy();
|
expect(isReady.value).toBeTruthy();
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import { ref, shallowRef, watch } from 'vue';
|
import { ref, shallowRef, watch } from 'vue';
|
||||||
import type { Ref, ShallowRef, UnwrapRef } from 'vue';
|
import type { Ref, ShallowRef, UnwrapRef } from 'vue';
|
||||||
import { isFunction, sleep } from '@robonen/stdlib';
|
import { isFunction, sleep, cancellablePromise as makeCancellable, CancelledError } from '@robonen/stdlib';
|
||||||
|
|
||||||
export interface UseAsyncStateOptions<Shallow extends boolean, Data = any> {
|
export interface UseAsyncStateOptions<Shallow extends boolean, Data = any> {
|
||||||
delay?: number;
|
delay?: number;
|
||||||
@@ -51,10 +51,13 @@ export function useAsyncState<Data, Params extends any[] = [], Shallow extends b
|
|||||||
const isLoading = ref(false);
|
const isLoading = ref(false);
|
||||||
const isReady = ref(false);
|
const isReady = ref(false);
|
||||||
|
|
||||||
let version = 0;
|
let cancelPending: ((reason?: string) => void) | undefined;
|
||||||
|
|
||||||
const execute = async (actualDelay = delay, ...params: any[]) => {
|
const execute = async (actualDelay = delay, ...params: any[]) => {
|
||||||
const currentVersion = ++version;
|
cancelPending?.();
|
||||||
|
|
||||||
|
let active = true;
|
||||||
|
cancelPending = () => { active = false; };
|
||||||
|
|
||||||
if (resetOnExecute)
|
if (resetOnExecute)
|
||||||
state.value = initialState;
|
state.value = initialState;
|
||||||
@@ -66,20 +69,25 @@ export function useAsyncState<Data, Params extends any[] = [], Shallow extends b
|
|||||||
if (actualDelay > 0)
|
if (actualDelay > 0)
|
||||||
await sleep(actualDelay);
|
await sleep(actualDelay);
|
||||||
|
|
||||||
const promise = isFunction(maybePromise) ? maybePromise(...params as Params) : maybePromise;
|
if (!active)
|
||||||
|
return state.value as Data;
|
||||||
|
|
||||||
|
const rawPromise = isFunction(maybePromise) ? maybePromise(...params as Params) : maybePromise;
|
||||||
|
const { promise, cancel } = makeCancellable(rawPromise);
|
||||||
|
cancelPending = (reason?: string) => {
|
||||||
|
active = false;
|
||||||
|
cancel(reason);
|
||||||
|
};
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const data = await promise;
|
const data = await promise;
|
||||||
|
|
||||||
if (currentVersion !== version)
|
|
||||||
return state.value as Data;
|
|
||||||
|
|
||||||
state.value = data;
|
state.value = data;
|
||||||
isReady.value = true;
|
isReady.value = true;
|
||||||
onSuccess?.(data);
|
onSuccess?.(data);
|
||||||
}
|
}
|
||||||
catch (e: unknown) {
|
catch (e: unknown) {
|
||||||
if (currentVersion !== version)
|
if (e instanceof CancelledError)
|
||||||
return state.value as Data;
|
return state.value as Data;
|
||||||
|
|
||||||
error.value = e;
|
error.value = e;
|
||||||
@@ -89,7 +97,7 @@ export function useAsyncState<Data, Params extends any[] = [], Shallow extends b
|
|||||||
throw e;
|
throw e;
|
||||||
}
|
}
|
||||||
finally {
|
finally {
|
||||||
if (currentVersion === version)
|
if (active)
|
||||||
isLoading.value = false;
|
isLoading.value = false;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -101,7 +109,8 @@ export function useAsyncState<Data, Params extends any[] = [], Shallow extends b
|
|||||||
};
|
};
|
||||||
|
|
||||||
const abort = () => {
|
const abort = () => {
|
||||||
version++;
|
cancelPending?.();
|
||||||
|
cancelPending = undefined;
|
||||||
isLoading.value = false;
|
isLoading.value = false;
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -120,10 +129,12 @@ export function useAsyncState<Data, Params extends any[] = [], Shallow extends b
|
|||||||
|
|
||||||
function waitResolve() {
|
function waitResolve() {
|
||||||
return new Promise<UseAsyncStateReturnBase<Data, Params, Shallow>>((resolve, reject) => {
|
return new Promise<UseAsyncStateReturnBase<Data, Params, Shallow>>((resolve, reject) => {
|
||||||
watch(
|
const unwatch = watch(
|
||||||
isLoading,
|
isLoading,
|
||||||
(loading) => {
|
(loading) => {
|
||||||
if (loading === false) {
|
if (loading === false) {
|
||||||
|
unwatch();
|
||||||
|
|
||||||
if (error.value)
|
if (error.value)
|
||||||
reject(error.value);
|
reject(error.value);
|
||||||
else
|
else
|
||||||
@@ -132,7 +143,6 @@ export function useAsyncState<Data, Params extends any[] = [], Shallow extends b
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
immediate: true,
|
immediate: true,
|
||||||
once: true,
|
|
||||||
flush: 'sync',
|
flush: 'sync',
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|||||||
Reference in New Issue
Block a user