Merge pull request #88 from mainmatter/add-perform-count

feat: add performCount to derived state

src/lib/task.ts

@@ -51,6 +51,7 @@ function _task<TArgs = undefined, TReturn = unknown>(
 		last_successful: undefined as undefined | TReturn,
 		error: undefined as undefined | unknown,
 		results,
+		performCount: 0,
 	});
 
 	const abort_controllers = new Set<{ controller: AbortController; listener: () => void }>();
@@ -111,6 +112,7 @@ function _task<TArgs = undefined, TReturn = unknown>(
 				() => {
 					result.update((old) => {
 						old.is_loading = true;
+						old.performCount++;
 						return old;
 					});
 					queueMicrotask(async () => {

src/lib/tests/components/default.svelte

@@ -9,8 +9,8 @@
 	export let return_value: (value: unknown) => void = () => {};
 	export let argument = 0;
 
-	const default_task = task.default(fn);
-	const options_task = task(fn, { kind: 'default' });
+	export const default_task = task.default(fn);
+	export const options_task = task(fn, { kind: 'default' });
 
 	let latest_task_instance: ReturnType<typeof default_task.perform>;
 	let latest_options_task_instance: ReturnType<typeof options_task.perform>;

src/lib/tests/components/drop.svelte

@@ -10,8 +10,8 @@
 	export let argument = 0;
 	export let max = 1;
 
-	const default_task = task.drop(fn, { max });
-	const options_task = task(fn, { kind: 'drop', max });
+	export const default_task = task.drop(fn, { max });
+	export const options_task = task(fn, { kind: 'drop', max });
 
 	let latest_task_instance: ReturnType<typeof default_task.perform>;
 	let latest_options_task_instance: ReturnType<typeof options_task.perform>;

src/lib/tests/components/enqueue.svelte

@@ -10,8 +10,8 @@
 	export let argument = 0;
 	export let max = 1;
 
-	const default_task = task.enqueue(fn, { max });
-	const options_task = task(fn, { kind: 'enqueue', max });
+	export const default_task = task.enqueue(fn, { max });
+	export const options_task = task(fn, { kind: 'enqueue', max });
 
 	let latest_task_instance: ReturnType<typeof default_task.perform>;
 	let latest_options_task_instance: ReturnType<typeof options_task.perform>;

src/lib/tests/components/keep_latest.svelte

@@ -10,8 +10,8 @@
 	export let argument = 0;
 	export let max = 1;
 
-	const default_task = task.keepLatest(fn, { max });
-	const options_task = task(fn, { kind: 'keepLatest', max });
+	export const default_task = task.keepLatest(fn, { max });
+	export const options_task = task(fn, { kind: 'keepLatest', max });
 
 	let latest_task_instance: ReturnType<typeof default_task.perform>;
 	let latest_options_task_instance: ReturnType<typeof options_task.perform>;

src/lib/tests/components/restart.svelte

@@ -10,8 +10,8 @@
 	export let argument = 0;
 	export let max = 1;
 
-	const default_task = task.restart(fn, { max });
-	const options_task = task(fn, { kind: 'restart', max });
+	export const default_task = task.restart(fn, { max });
+	export const options_task = task(fn, { kind: 'restart', max });
 
 	let latest_task_instance: ReturnType<typeof default_task.perform>;
 	let latest_options_task_instance: ReturnType<typeof options_task.perform>;

src/lib/tests/task.test.ts

@@ -22,12 +22,42 @@ function all_options(fn: (selector: string) => void) {
 }
 
 describe.each([
-	{ component: Default, name: 'default' },
-	{ component: Enqueue, name: 'enqueue' },
-	{ component: Drop, name: 'drop' },
-	{ component: KeepLatest, name: 'keepLatest' },
-	{ component: Restart, name: 'restart' },
-])('task - basic functionality $name', ({ component }) => {
+	{
+		component: Default,
+		name: 'default',
+		perform_count: {
+			expected: 5,
+		},
+	},
+	{
+		component: Enqueue,
+		name: 'enqueue',
+		perform_count: {
+			expected: 5,
+		},
+	},
+	{
+		component: Drop,
+		name: 'drop',
+		perform_count: {
+			expected: 1,
+		},
+	},
+	{
+		component: KeepLatest,
+		name: 'keepLatest',
+		perform_count: {
+			expected: 2,
+		},
+	},
+	{
+		component: Restart,
+		name: 'restart',
+		perform_count: {
+			expected: 5,
+		},
+	},
+])('task - basic functionality $name', ({ component, perform_count }) => {
 	all_options((selector) => {
 		it('calls the function you pass in', async () => {
 			const fn = vi.fn();
@@ -118,6 +148,24 @@ describe.each([
 			});
 			expect(passed_in_value).toBe(argument);
 		});
+
+		it('has the correct derived state for performCount', async () => {
+			const fn = vi.fn();
+			const { getByTestId, component: instance } = render(component, {
+				fn,
+			});
+			const store = instance[`${selector}_task`] as Task;
+			const perform = getByTestId(`perform-${selector}`);
+			perform.click();
+			perform.click();
+			perform.click();
+			perform.click();
+			perform.click();
+			await vi.waitFor(() => {
+				expect(fn).toHaveBeenCalledTimes(perform_count.expected);
+			});
+			expect(get(store).performCount).toBe(perform_count.expected);
+		});
 	});
 
 	it('re-throws any error thrown in the perform function and has the error in the error field of the store', async () => {