mirror of
https://github.com/robonen/tools.git
synced 2026-03-20 19:04:46 +00:00
Compare commits
31 Commits
feat/stdli
...
fcf2b5cccd
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
fcf2b5cccd | ||
|
|
3747f5213e | ||
| daf18871a0 | |||
|
|
8bf9943e9e | ||
|
|
0e67715d9e | ||
|
|
3e43e4db3d | ||
| b8308e383c | |||
|
|
93c878cc35 | ||
| 7653975fa4 | |||
|
|
e2cb3f5a75 | ||
|
|
67fbad8930 | ||
|
|
e49c49e320 | ||
|
|
43cdc3b5e6 | ||
| a9a6c04176 | |||
| a6d3e8971f | |||
| 40dfdabd08 | |||
|
|
876a815fd3 | ||
| b1b9889ad2 | |||
|
|
9d2a393372 | ||
|
|
4071e49ad6 | ||
| 88bd87f9b0 | |||
|
|
ac265c05a8 | ||
| 69e5ebc085 | |||
| 48a85dbae2 | |||
| 0cfdce7456 | |||
| e035d1abca | |||
| 1851d5c80c | |||
| 48626a9fe5 | |||
| 04aa9e4721 | |||
| d55e3989f3 | |||
|
|
acee7e4167 |
4
.github/workflows/ci.yaml
vendored
4
.github/workflows/ci.yaml
vendored
@@ -16,14 +16,14 @@ jobs:
|
|||||||
contents: read
|
contents: read
|
||||||
pull-requests: write
|
pull-requests: write
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
|
|
||||||
- name: Install pnpm
|
- name: Install pnpm
|
||||||
uses: pnpm/action-setup@v4
|
uses: pnpm/action-setup@v4
|
||||||
with:
|
with:
|
||||||
run_install: false
|
run_install: false
|
||||||
|
|
||||||
- uses: actions/setup-node@v4
|
- uses: actions/setup-node@v6
|
||||||
with:
|
with:
|
||||||
node-version: ${{ env.NODE_VERSION }}
|
node-version: ${{ env.NODE_VERSION }}
|
||||||
cache: pnpm
|
cache: pnpm
|
||||||
|
|||||||
4
.github/workflows/publish.yaml
vendored
4
.github/workflows/publish.yaml
vendored
@@ -13,7 +13,7 @@ jobs:
|
|||||||
name: Check version changes and publish
|
name: Check version changes and publish
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
@@ -22,7 +22,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
run_install: false
|
run_install: false
|
||||||
|
|
||||||
- uses: actions/setup-node@v4
|
- uses: actions/setup-node@v6
|
||||||
with:
|
with:
|
||||||
node-version: ${{ env.NODE_VERSION }}
|
node-version: ${{ env.NODE_VERSION }}
|
||||||
cache: pnpm
|
cache: pnpm
|
||||||
|
|||||||
@@ -15,9 +15,9 @@
|
|||||||
"url": "git+https://github.com/robonen/tools.git",
|
"url": "git+https://github.com/robonen/tools.git",
|
||||||
"directory": "packages/tsconfig"
|
"directory": "packages/tsconfig"
|
||||||
},
|
},
|
||||||
"packageManager": "pnpm@10.13.1",
|
"packageManager": "pnpm@10.22.0",
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=22.17.1"
|
"node": ">=24.11.1"
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"**tsconfig.json"
|
"**tsconfig.json"
|
||||||
|
|||||||
@@ -18,9 +18,9 @@
|
|||||||
"url": "git+https://github.com/robonen/tools.git",
|
"url": "git+https://github.com/robonen/tools.git",
|
||||||
"directory": "packages/platform"
|
"directory": "packages/platform"
|
||||||
},
|
},
|
||||||
"packageManager": "pnpm@10.13.1",
|
"packageManager": "pnpm@10.22.0",
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=22.17.1"
|
"node": ">=24.11.1"
|
||||||
},
|
},
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"files": [
|
"files": [
|
||||||
|
|||||||
@@ -18,9 +18,9 @@
|
|||||||
"url": "git+https://github.com/robonen/tools.git",
|
"url": "git+https://github.com/robonen/tools.git",
|
||||||
"directory": "packages/stdlib"
|
"directory": "packages/stdlib"
|
||||||
},
|
},
|
||||||
"packageManager": "pnpm@10.13.1",
|
"packageManager": "pnpm@10.22.0",
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=22.17.1"
|
"node": ">=24.11.1"
|
||||||
},
|
},
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"files": [
|
"files": [
|
||||||
|
|||||||
@@ -1,3 +1,2 @@
|
|||||||
export * from './retry';
|
|
||||||
export * from './sleep';
|
export * from './sleep';
|
||||||
export * from './tryIt';
|
export * from './tryIt';
|
||||||
|
|||||||
@@ -1,250 +0,0 @@
|
|||||||
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
|
|
||||||
import { retry } from '.';
|
|
||||||
|
|
||||||
describe('retry', () => {
|
|
||||||
beforeEach(() => {
|
|
||||||
vi.useFakeTimers();
|
|
||||||
});
|
|
||||||
|
|
||||||
afterEach(() => {
|
|
||||||
vi.useRealTimers();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('return the result on first successful attempt', async () => {
|
|
||||||
const successFn = vi.fn().mockResolvedValue('success');
|
|
||||||
|
|
||||||
const result = await retry(successFn);
|
|
||||||
|
|
||||||
expect(result).toBe('success');
|
|
||||||
expect(successFn).toHaveBeenCalledTimes(1);
|
|
||||||
expect(successFn).toHaveBeenCalledWith({ count: 1, stop: expect.any(Function) });
|
|
||||||
});
|
|
||||||
|
|
||||||
it('use default times value of 2', async () => {
|
|
||||||
const failingFn = vi.fn().mockRejectedValue(new Error('Test error'));
|
|
||||||
|
|
||||||
await expect(retry(failingFn)).rejects.toThrow('Test error');
|
|
||||||
|
|
||||||
expect(failingFn).toHaveBeenCalledTimes(2);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('retry the specified number of times on failure', async () => {
|
|
||||||
const failingFn = vi.fn().mockRejectedValue(new Error('Test error'));
|
|
||||||
|
|
||||||
await expect(retry(failingFn, { times: 3 })).rejects.toThrow('Test error');
|
|
||||||
|
|
||||||
expect(failingFn).toHaveBeenCalledTimes(3);
|
|
||||||
expect(failingFn).toHaveBeenNthCalledWith(1, { count: 1, stop: expect.any(Function) });
|
|
||||||
expect(failingFn).toHaveBeenNthCalledWith(2, { count: 2, stop: expect.any(Function) });
|
|
||||||
expect(failingFn).toHaveBeenNthCalledWith(3, { count: 3, stop: expect.any(Function) });
|
|
||||||
});
|
|
||||||
|
|
||||||
it('succeed on the last attempt', async () => {
|
|
||||||
const partiallyFailingFn = vi.fn()
|
|
||||||
.mockRejectedValueOnce(new Error('First failure'))
|
|
||||||
.mockRejectedValueOnce(new Error('Second failure'))
|
|
||||||
.mockResolvedValue('success');
|
|
||||||
|
|
||||||
const result = await retry(partiallyFailingFn, { times: 3 });
|
|
||||||
|
|
||||||
expect(result).toBe('success');
|
|
||||||
expect(partiallyFailingFn).toHaveBeenCalledTimes(3);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('use custom shouldRetry function', async () => {
|
|
||||||
const networkError = new Error('Network failed');
|
|
||||||
networkError.name = 'NetworkError';
|
|
||||||
const failingFn = vi.fn().mockRejectedValue(networkError);
|
|
||||||
|
|
||||||
await expect(retry(failingFn, {
|
|
||||||
times: 3,
|
|
||||||
shouldRetry: (error) => error.name !== 'NetworkError'
|
|
||||||
})).rejects.toThrow('Network failed');
|
|
||||||
|
|
||||||
expect(failingFn).toHaveBeenCalledTimes(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('retry with custom shouldRetry based on count', async () => {
|
|
||||||
const testError = new Error('Test error');
|
|
||||||
const failingFn = vi.fn().mockRejectedValue(testError);
|
|
||||||
|
|
||||||
await expect(retry(failingFn, {
|
|
||||||
times: 5,
|
|
||||||
shouldRetry: (error, count) => count < 3 // Only retry first 2 attempts
|
|
||||||
})).rejects.toThrow('Test error');
|
|
||||||
|
|
||||||
expect(failingFn).toHaveBeenCalledTimes(3); // Initial + 2 retries
|
|
||||||
});
|
|
||||||
|
|
||||||
it('retry specific error types with custom shouldRetry', async () => {
|
|
||||||
const temporaryError = new Error('Temporary failure');
|
|
||||||
temporaryError.name = 'TemporaryError';
|
|
||||||
const permanentError = new Error('Permanent failure');
|
|
||||||
permanentError.name = 'PermanentError';
|
|
||||||
|
|
||||||
const failingFn = vi.fn()
|
|
||||||
.mockRejectedValueOnce(temporaryError)
|
|
||||||
.mockRejectedValueOnce(temporaryError)
|
|
||||||
.mockRejectedValueOnce(permanentError);
|
|
||||||
|
|
||||||
await expect(retry(failingFn, {
|
|
||||||
times: 5,
|
|
||||||
shouldRetry: (error) => error.name === 'TemporaryError'
|
|
||||||
})).rejects.toThrow('Permanent failure');
|
|
||||||
|
|
||||||
expect(failingFn).toHaveBeenCalledTimes(3);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('wait for the specified delay between retries', async () => {
|
|
||||||
const failingFn = vi.fn().mockRejectedValue(new Error('Test error'));
|
|
||||||
|
|
||||||
const retryPromise = retry(failingFn, { times: 3, delay: 1000 });
|
|
||||||
|
|
||||||
// First call should happen immediately
|
|
||||||
expect(failingFn).toHaveBeenCalledTimes(1);
|
|
||||||
|
|
||||||
// Advance time to trigger first retry
|
|
||||||
await vi.advanceTimersByTimeAsync(1000);
|
|
||||||
expect(failingFn).toHaveBeenCalledTimes(2);
|
|
||||||
|
|
||||||
// Advance time to trigger second retry
|
|
||||||
await vi.advanceTimersByTimeAsync(1000);
|
|
||||||
expect(failingFn).toHaveBeenCalledTimes(3);
|
|
||||||
|
|
||||||
await expect(retryPromise).rejects.toThrow('Test error');
|
|
||||||
});
|
|
||||||
|
|
||||||
it('use dynamic delay function', async () => {
|
|
||||||
const failingFn = vi.fn().mockRejectedValue(new Error('Test error'));
|
|
||||||
const delayFn = vi.fn((count: number) => count * 500);
|
|
||||||
|
|
||||||
const retryPromise = retry(failingFn, { times: 3, delay: delayFn });
|
|
||||||
|
|
||||||
// First call should happen immediately
|
|
||||||
expect(failingFn).toHaveBeenCalledTimes(1);
|
|
||||||
|
|
||||||
// First retry should wait for delay(2) = 1000ms
|
|
||||||
await vi.advanceTimersByTimeAsync(1000);
|
|
||||||
expect(failingFn).toHaveBeenCalledTimes(2);
|
|
||||||
expect(delayFn).toHaveBeenCalledWith(2);
|
|
||||||
|
|
||||||
// Second retry should wait for delay(3) = 1500ms
|
|
||||||
await vi.advanceTimersByTimeAsync(1500);
|
|
||||||
expect(failingFn).toHaveBeenCalledTimes(3);
|
|
||||||
expect(delayFn).toHaveBeenCalledWith(3);
|
|
||||||
|
|
||||||
await expect(retryPromise).rejects.toThrow('Test error');
|
|
||||||
});
|
|
||||||
|
|
||||||
it('not delay after the last attempt', async () => {
|
|
||||||
const failingFn = vi.fn().mockRejectedValue(new Error('Test error'));
|
|
||||||
|
|
||||||
const retryPromise = retry(failingFn, { times: 2, delay: 1000 });
|
|
||||||
|
|
||||||
// Wait for the first retry delay
|
|
||||||
await vi.advanceTimersByTimeAsync(1000);
|
|
||||||
|
|
||||||
// Should complete without further delays
|
|
||||||
await expect(retryPromise).rejects.toThrow('Test error');
|
|
||||||
expect(failingFn).toHaveBeenCalledTimes(2);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('handle zero delay', async () => {
|
|
||||||
const failingFn = vi.fn().mockRejectedValue(new Error('Test error'));
|
|
||||||
|
|
||||||
await expect(retry(failingFn, { times: 3, delay: 0 })).rejects.toThrow('Test error');
|
|
||||||
|
|
||||||
expect(failingFn).toHaveBeenCalledTimes(3);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('pass the count parameter to the function', async () => {
|
|
||||||
const countingFn = vi.fn(async ({ count }: { count: number }) => {
|
|
||||||
if (count < 3) {
|
|
||||||
throw new Error(`Attempt ${count} failed`);
|
|
||||||
}
|
|
||||||
return `Success on attempt ${count}`;
|
|
||||||
});
|
|
||||||
|
|
||||||
const result = await retry(countingFn, { times: 3 });
|
|
||||||
|
|
||||||
expect(result).toBe('Success on attempt 3');
|
|
||||||
expect(countingFn).toHaveBeenCalledWith({ count: 1, stop: expect.any(Function) });
|
|
||||||
expect(countingFn).toHaveBeenCalledWith({ count: 2, stop: expect.any(Function) });
|
|
||||||
expect(countingFn).toHaveBeenCalledWith({ count: 3, stop: expect.any(Function) });
|
|
||||||
});
|
|
||||||
|
|
||||||
it('throw the last error when all attempts fail', async () => {
|
|
||||||
const firstError = new Error('First error');
|
|
||||||
const lastError = new Error('Last error');
|
|
||||||
const failingFn = vi.fn()
|
|
||||||
.mockRejectedValueOnce(firstError)
|
|
||||||
.mockRejectedValueOnce(lastError);
|
|
||||||
|
|
||||||
await expect(retry(failingFn, { times: 2 })).rejects.toThrow('Last error');
|
|
||||||
});
|
|
||||||
|
|
||||||
it('handle times value of 1', async () => {
|
|
||||||
const failingFn = vi.fn().mockRejectedValue(new Error('Test error'));
|
|
||||||
|
|
||||||
await expect(retry(failingFn, { times: 1 })).rejects.toThrow('Test error');
|
|
||||||
|
|
||||||
expect(failingFn).toHaveBeenCalledTimes(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('handle function that returns non-promise values', async () => {
|
|
||||||
const syncFn = vi.fn(async ({ count }: { count: number }) => {
|
|
||||||
if (count === 1) {
|
|
||||||
throw new Error('First attempt failed');
|
|
||||||
}
|
|
||||||
return 'success';
|
|
||||||
});
|
|
||||||
|
|
||||||
const result = await retry(syncFn, { times: 2 });
|
|
||||||
|
|
||||||
expect(result).toBe('success');
|
|
||||||
expect(syncFn).toHaveBeenCalledTimes(2);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('handle complex return types', async () => {
|
|
||||||
const complexFn = vi.fn().mockResolvedValue({
|
|
||||||
data: [1, 2, 3],
|
|
||||||
status: 'ok',
|
|
||||||
metadata: { timestamp: 123456 }
|
|
||||||
});
|
|
||||||
|
|
||||||
const result = await retry(complexFn);
|
|
||||||
|
|
||||||
expect(result).toEqual({
|
|
||||||
data: [1, 2, 3],
|
|
||||||
status: 'ok',
|
|
||||||
metadata: { timestamp: 123456 }
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it('stop retrying when stop function is called', async () => {
|
|
||||||
const customError = new Error('Custom stop error');
|
|
||||||
const stopFn = vi.fn(async ({ count, stop }: { count: number, stop: (error: any) => void }) => {
|
|
||||||
if (count === 2) {
|
|
||||||
stop(customError);
|
|
||||||
}
|
|
||||||
throw new Error(`Attempt ${count} failed`);
|
|
||||||
});
|
|
||||||
|
|
||||||
await expect(retry(stopFn, { times: 5 })).rejects.toThrow('Custom stop error');
|
|
||||||
|
|
||||||
expect(stopFn).toHaveBeenCalledTimes(2);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('stop retrying with undefined error when stop is called without argument', async () => {
|
|
||||||
const stopFn = vi.fn(async ({ count, stop }: { count: number, stop: (error?: any) => void }) => {
|
|
||||||
if (count === 2) {
|
|
||||||
stop();
|
|
||||||
}
|
|
||||||
throw new Error(`Attempt ${count} failed`);
|
|
||||||
});
|
|
||||||
|
|
||||||
await expect(retry(stopFn, { times: 5 })).rejects.toBeUndefined();
|
|
||||||
|
|
||||||
expect(stopFn).toHaveBeenCalledTimes(2);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,22 +1,9 @@
|
|||||||
import { tryIt } from '../tryIt';
|
|
||||||
import { sleep } from '../sleep';
|
|
||||||
import { isFunction } from '../../types';
|
|
||||||
|
|
||||||
export interface RetryOptions {
|
export interface RetryOptions {
|
||||||
times?: number;
|
times?: number;
|
||||||
delay?: number | ((count: number) => number);
|
delay?: number;
|
||||||
shouldRetry?: (error: Error, count: number) => boolean;
|
backoff: (options: RetryOptions & { count: number }) => number;
|
||||||
}
|
}
|
||||||
|
|
||||||
export type RetryFunction<Return> = (
|
|
||||||
args: {
|
|
||||||
count: number;
|
|
||||||
stop: (error: any) => void;
|
|
||||||
},
|
|
||||||
) => Promise<Return>;
|
|
||||||
|
|
||||||
const RetryEarlyExit = Symbol('RetryEarlyExit');
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @name retry
|
* @name retry
|
||||||
* @category Async
|
* @category Async
|
||||||
@@ -38,51 +25,14 @@ const RetryEarlyExit = Symbol('RetryEarlyExit');
|
|||||||
* .then(response => response.json())
|
* .then(response => response.json())
|
||||||
* }, { times: 3, delay: 1000 });
|
* }, { times: 3, delay: 1000 });
|
||||||
*
|
*
|
||||||
* @since 0.0.8
|
|
||||||
*/
|
*/
|
||||||
export async function retry<Return>(
|
export async function retry<Return>(
|
||||||
fn: RetryFunction<Return>,
|
fn: () => Promise<Return>,
|
||||||
options: RetryOptions = {},
|
options: RetryOptions
|
||||||
): Promise<Return> {
|
) {
|
||||||
const {
|
const {
|
||||||
times = 2,
|
times = 3,
|
||||||
delay = 0,
|
|
||||||
shouldRetry,
|
|
||||||
} = options;
|
} = options;
|
||||||
|
|
||||||
let count = 1;
|
let count = 0;
|
||||||
let lastError: Error = new Error('Retry failed');
|
|
||||||
|
|
||||||
while (count <= times) {
|
|
||||||
const metadata = {
|
|
||||||
count,
|
|
||||||
stop: (error?: any) => {
|
|
||||||
throw { [RetryEarlyExit]: error };
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
const { error, data } = await tryIt(fn)(metadata);
|
|
||||||
|
|
||||||
if (!error)
|
|
||||||
return data;
|
|
||||||
|
|
||||||
if (RetryEarlyExit in error)
|
|
||||||
throw error[RetryEarlyExit];
|
|
||||||
|
|
||||||
if (shouldRetry && !shouldRetry(error, count))
|
|
||||||
throw error;
|
|
||||||
|
|
||||||
lastError = error;
|
|
||||||
count++;
|
|
||||||
|
|
||||||
// Don't delay after the last attempt
|
|
||||||
if (count <= times) {
|
|
||||||
const delayMs = isFunction(delay) ? delay(count) : delay;
|
|
||||||
|
|
||||||
if (delayMs > 0)
|
|
||||||
await sleep(delayMs);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
throw lastError;
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,62 +6,62 @@ describe('tryIt', () => {
|
|||||||
const syncFn = (x: number) => x * 2;
|
const syncFn = (x: number) => x * 2;
|
||||||
const wrappedSyncFn = tryIt(syncFn);
|
const wrappedSyncFn = tryIt(syncFn);
|
||||||
|
|
||||||
const { error, data } = wrappedSyncFn(2);
|
const [error, result] = wrappedSyncFn(2);
|
||||||
|
|
||||||
expect(error).toBeUndefined();
|
expect(error).toBeUndefined();
|
||||||
expect(data).toBe(4);
|
expect(result).toBe(4);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('handle synchronous functions with errors', () => {
|
it('handle synchronous functions with errors', () => {
|
||||||
const syncFn = (): void => { throw new Error('Test error') };
|
const syncFn = (): void => { throw new Error('Test error') };
|
||||||
const wrappedSyncFn = tryIt(syncFn);
|
const wrappedSyncFn = tryIt(syncFn);
|
||||||
|
|
||||||
const { error, data } = wrappedSyncFn();
|
const [error, result] = wrappedSyncFn();
|
||||||
|
|
||||||
expect(error).toBeInstanceOf(Error);
|
expect(error).toBeInstanceOf(Error);
|
||||||
expect(error?.message).toBe('Test error');
|
expect(error?.message).toBe('Test error');
|
||||||
expect(data).toBeUndefined();
|
expect(result).toBeUndefined();
|
||||||
});
|
});
|
||||||
|
|
||||||
it('handle asynchronous functions without errors', async () => {
|
it('handle asynchronous functions without errors', async () => {
|
||||||
const asyncFn = async (x: number) => x * 2;
|
const asyncFn = async (x: number) => x * 2;
|
||||||
const wrappedAsyncFn = tryIt(asyncFn);
|
const wrappedAsyncFn = tryIt(asyncFn);
|
||||||
|
|
||||||
const { error, data } = await wrappedAsyncFn(2);
|
const [error, result] = await wrappedAsyncFn(2);
|
||||||
|
|
||||||
expect(error).toBeUndefined();
|
expect(error).toBeUndefined();
|
||||||
expect(data).toBe(4);
|
expect(result).toBe(4);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('handle asynchronous functions with errors', async () => {
|
it('handle asynchronous functions with errors', async () => {
|
||||||
const asyncFn = async () => { throw new Error('Test error') };
|
const asyncFn = async () => { throw new Error('Test error') };
|
||||||
const wrappedAsyncFn = tryIt(asyncFn);
|
const wrappedAsyncFn = tryIt(asyncFn);
|
||||||
|
|
||||||
const { error, data } = await wrappedAsyncFn();
|
const [error, result] = await wrappedAsyncFn();
|
||||||
|
|
||||||
expect(error).toBeInstanceOf(Error);
|
expect(error).toBeInstanceOf(Error);
|
||||||
expect(error?.message).toBe('Test error');
|
expect(error?.message).toBe('Test error');
|
||||||
expect(data).toBeUndefined();
|
expect(result).toBeUndefined();
|
||||||
});
|
});
|
||||||
|
|
||||||
it('handle promise-based functions without errors', async () => {
|
it('handle promise-based functions without errors', async () => {
|
||||||
const promiseFn = (x: number) => Promise.resolve(x * 2);
|
const promiseFn = (x: number) => Promise.resolve(x * 2);
|
||||||
const wrappedPromiseFn = tryIt(promiseFn);
|
const wrappedPromiseFn = tryIt(promiseFn);
|
||||||
|
|
||||||
const { error, data } = await wrappedPromiseFn(2);
|
const [error, result] = await wrappedPromiseFn(2);
|
||||||
|
|
||||||
expect(error).toBeUndefined();
|
expect(error).toBeUndefined();
|
||||||
expect(data).toBe(4);
|
expect(result).toBe(4);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('handle promise-based functions with errors', async () => {
|
it('handle promise-based functions with errors', async () => {
|
||||||
const promiseFn = () => Promise.reject(new Error('Test error'));
|
const promiseFn = () => Promise.reject(new Error('Test error'));
|
||||||
const wrappedPromiseFn = tryIt(promiseFn);
|
const wrappedPromiseFn = tryIt(promiseFn);
|
||||||
|
|
||||||
const { error, data } = await wrappedPromiseFn();
|
const [error, result] = await wrappedPromiseFn();
|
||||||
|
|
||||||
expect(error).toBeInstanceOf(Error);
|
expect(error).toBeInstanceOf(Error);
|
||||||
expect(error?.message).toBe('Test error');
|
expect(error?.message).toBe('Test error');
|
||||||
expect(data).toBeUndefined();
|
expect(result).toBeUndefined();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@@ -1,8 +1,8 @@
|
|||||||
import { isPromise } from '../../types';
|
import { isPromise } from '../../types';
|
||||||
|
|
||||||
export type TryItReturn<Return> = Return extends Promise<any>
|
export type TryItReturn<Return> = Return extends Promise<any>
|
||||||
? Promise<{ error: Error; data: undefined } | { error: undefined; data: Awaited<Return> }>
|
? Promise<[Error, undefined] | [undefined, Awaited<Return>]>
|
||||||
: { error: Error; data: undefined } | { error: undefined; data: Return };
|
: [Error, undefined] | [undefined, Return];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @name tryIt
|
* @name tryIt
|
||||||
@@ -14,10 +14,10 @@ export type TryItReturn<Return> = Return extends Promise<any>
|
|||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* const wrappedFetch = tryIt(fetch);
|
* const wrappedFetch = tryIt(fetch);
|
||||||
* const { error, data } = await wrappedFetch('https://jsonplaceholder.typicode.com/todos/1');
|
* const [error, result] = await wrappedFetch('https://jsonplaceholder.typicode.com/todos/1');
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* const { error, data } = await tryIt(fetch)('https://jsonplaceholder.typicode.com/todos/1');
|
* const [error, result] = await tryIt(fetch)('https://jsonplaceholder.typicode.com/todos/1');
|
||||||
*
|
*
|
||||||
* @since 0.0.3
|
* @since 0.0.3
|
||||||
*/
|
*/
|
||||||
@@ -30,12 +30,12 @@ export function tryIt<Args extends any[], Return>(
|
|||||||
|
|
||||||
if (isPromise(result))
|
if (isPromise(result))
|
||||||
return result
|
return result
|
||||||
.then((value) => ({ error: undefined, data: value }))
|
.then((value) => [undefined, value])
|
||||||
.catch((error) => ({ error, data: undefined })) as TryItReturn<Return>;
|
.catch((error) => [error, undefined]) as TryItReturn<Return>;
|
||||||
|
|
||||||
return { error: undefined, data: result } as TryItReturn<Return>;
|
return [undefined, result] as TryItReturn<Return>;
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
return { error, data: undefined } as TryItReturn<Return>;
|
return [error, undefined] as TryItReturn<Return>;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -16,9 +16,9 @@
|
|||||||
"url": "git+https://github.com/robonen/tools.git",
|
"url": "git+https://github.com/robonen/tools.git",
|
||||||
"directory": "packages/renovate"
|
"directory": "packages/renovate"
|
||||||
},
|
},
|
||||||
"packageManager": "pnpm@10.13.1",
|
"packageManager": "pnpm@10.22.0",
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=22.17.1"
|
"node": ">=24.11.1"
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"default.json"
|
"default.json"
|
||||||
@@ -27,6 +27,6 @@
|
|||||||
"test": "renovate-config-validator ./default.json"
|
"test": "renovate-config-validator ./default.json"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"renovate": "^41.43.5"
|
"renovate": "^41.173.1"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
18
package.json
18
package.json
@@ -15,20 +15,20 @@
|
|||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://github.com/robonen/tools.git"
|
"url": "git+https://github.com/robonen/tools.git"
|
||||||
},
|
},
|
||||||
"packageManager": "pnpm@10.13.1",
|
"packageManager": "pnpm@10.22.0",
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=22.17.1"
|
"node": ">=24.11.1"
|
||||||
},
|
},
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/node": "^22.16.5",
|
"@types/node": "^24.10.1",
|
||||||
"citty": "^0.1.6",
|
|
||||||
"jiti": "^2.5.1",
|
|
||||||
"scule": "^1.3.0",
|
|
||||||
"jsdom": "catalog:",
|
|
||||||
"vitest": "catalog:",
|
|
||||||
"@vitest/coverage-v8": "catalog:",
|
"@vitest/coverage-v8": "catalog:",
|
||||||
"@vitest/ui": "catalog:"
|
"@vitest/ui": "catalog:",
|
||||||
|
"citty": "^0.1.6",
|
||||||
|
"jiti": "^2.6.1",
|
||||||
|
"jsdom": "catalog:",
|
||||||
|
"scule": "^1.3.0",
|
||||||
|
"vitest": "catalog:"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "pnpm -r build",
|
"build": "pnpm -r build",
|
||||||
|
|||||||
4602
pnpm-lock.yaml
generated
4602
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -5,11 +5,11 @@ packages:
|
|||||||
- web/*
|
- web/*
|
||||||
|
|
||||||
catalog:
|
catalog:
|
||||||
'@vitest/coverage-v8': ^3.2.4
|
'@vitest/coverage-v8': ^4.0.14
|
||||||
'@vue/test-utils': ^2.4.6
|
'@vue/test-utils': ^2.4.6
|
||||||
jsdom: ^26.1.0
|
jsdom: ^27.2.0
|
||||||
pathe: ^2.0.3
|
pathe: ^2.0.3
|
||||||
unbuild: 3.6.0
|
unbuild: 3.6.1
|
||||||
vitest: ^3.2.4
|
vitest: ^4.0.14
|
||||||
'@vitest/ui': ^3.2.4
|
'@vitest/ui': ^4.0.14
|
||||||
vue: ^3.5.18
|
vue: ^3.5.24
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@robonen/vue",
|
"name": "@robonen/vue",
|
||||||
"version": "0.0.9",
|
"version": "0.0.11",
|
||||||
"license": "Apache-2.0",
|
"license": "Apache-2.0",
|
||||||
"description": "Collection of powerful tools for Vue",
|
"description": "Collection of powerful tools for Vue",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
@@ -16,9 +16,9 @@
|
|||||||
"url": "git+https://github.com/robonen/tools.git",
|
"url": "git+https://github.com/robonen/tools.git",
|
||||||
"directory": "./packages/vue"
|
"directory": "./packages/vue"
|
||||||
},
|
},
|
||||||
"packageManager": "pnpm@10.13.1",
|
"packageManager": "pnpm@10.22.0",
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=22.17.1"
|
"node": ">=24.11.1"
|
||||||
},
|
},
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"files": [
|
"files": [
|
||||||
@@ -37,13 +37,13 @@
|
|||||||
"build": "unbuild"
|
"build": "unbuild"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@robonen/platform": "workspace:*",
|
|
||||||
"@robonen/stdlib": "workspace:*",
|
|
||||||
"@robonen/tsconfig": "workspace:*",
|
"@robonen/tsconfig": "workspace:*",
|
||||||
"@vue/test-utils": "catalog:",
|
"@vue/test-utils": "catalog:",
|
||||||
"unbuild": "catalog:"
|
"unbuild": "catalog:"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
"@robonen/platform": "workspace:*",
|
||||||
|
"@robonen/stdlib": "workspace:*",
|
||||||
"vue": "catalog:"
|
"vue": "catalog:"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
61
web/vue/src/composables/unrefElement/index.test.ts
Normal file
61
web/vue/src/composables/unrefElement/index.test.ts
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
import { describe, expect, it } from 'vitest';
|
||||||
|
import { computed, defineComponent, nextTick, ref, shallowRef } from 'vue';
|
||||||
|
import { mount } from '@vue/test-utils'
|
||||||
|
import { unrefElement } from '.';
|
||||||
|
|
||||||
|
describe('unrefElement', () => {
|
||||||
|
it('returns a plain element when passed a raw element', () => {
|
||||||
|
const htmlEl = document.createElement('div');
|
||||||
|
const svgEl = document.createElementNS('http://www.w3.org/2000/svg', 'svg');
|
||||||
|
|
||||||
|
expect(unrefElement(htmlEl)).toBe(htmlEl);
|
||||||
|
expect(unrefElement(svgEl)).toBe(svgEl);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns element when passed a ref or shallowRef to an element', () => {
|
||||||
|
const el = document.createElement('div');
|
||||||
|
const elRef = ref<HTMLElement | null>(el);
|
||||||
|
const shallowElRef = shallowRef<HTMLElement | null>(el);
|
||||||
|
|
||||||
|
expect(unrefElement(elRef)).toBe(el);
|
||||||
|
expect(unrefElement(shallowElRef)).toBe(el);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns element when passed a computed ref or getter function', () => {
|
||||||
|
const el = document.createElement('div');
|
||||||
|
const computedElRef = computed(() => el);
|
||||||
|
const elGetter = () => el;
|
||||||
|
|
||||||
|
expect(unrefElement(computedElRef)).toBe(el);
|
||||||
|
expect(unrefElement(elGetter)).toBe(el);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns component $el when passed a component instance', async () => {
|
||||||
|
const Child = defineComponent({
|
||||||
|
template: `<span class="child-el">child</span>`,
|
||||||
|
});
|
||||||
|
|
||||||
|
const Parent = defineComponent({
|
||||||
|
components: { Child },
|
||||||
|
template: `<Child ref="childRef" />`,
|
||||||
|
});
|
||||||
|
|
||||||
|
const wrapper = mount(Parent);
|
||||||
|
await nextTick();
|
||||||
|
|
||||||
|
const childInstance = (wrapper.vm as any).$refs.childRef;
|
||||||
|
const result = unrefElement(childInstance);
|
||||||
|
|
||||||
|
expect(result).toBe(childInstance.$el);
|
||||||
|
expect((result as HTMLElement).classList.contains('child-el')).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('handles null and undefined values', () => {
|
||||||
|
expect(unrefElement(undefined)).toBe(undefined);
|
||||||
|
expect(unrefElement(null)).toBe(null);
|
||||||
|
expect(unrefElement(ref(null))).toBe(null);
|
||||||
|
expect(unrefElement(ref(undefined))).toBe(undefined);
|
||||||
|
expect(unrefElement(() => null)).toBe(null);
|
||||||
|
expect(unrefElement(() => undefined)).toBe(undefined);
|
||||||
|
});
|
||||||
|
});
|
||||||
33
web/vue/src/composables/unrefElement/index.ts
Normal file
33
web/vue/src/composables/unrefElement/index.ts
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
import type { ComponentPublicInstance, MaybeRef, MaybeRefOrGetter } from 'vue';
|
||||||
|
import { toValue } from 'vue';
|
||||||
|
|
||||||
|
export type VueInstance = ComponentPublicInstance;
|
||||||
|
export type MaybeElement = HTMLElement | SVGElement | VueInstance | undefined | null;
|
||||||
|
|
||||||
|
export type MaybeElementRef<El extends MaybeElement = MaybeElement> = MaybeRef<El>;
|
||||||
|
export type MaybeComputedElementRef<El extends MaybeElement = MaybeElement> = MaybeRefOrGetter<El>;
|
||||||
|
|
||||||
|
export type UnRefElementReturn<T extends MaybeElement = MaybeElement> = T extends VueInstance ? Exclude<MaybeElement, VueInstance> : T | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @name unrefElement
|
||||||
|
* @category Components
|
||||||
|
* @description Unwraps a Vue element reference to get the underlying instance or DOM element.
|
||||||
|
*
|
||||||
|
* @param {MaybeComputedElementRef<El>} elRef - The element reference to unwrap.
|
||||||
|
* @returns {UnRefElementReturn<El>} - The unwrapped element or undefined.
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* const element = useTemplateRef<HTMLElement>('element');
|
||||||
|
* const result = unrefElement(element); // result is the element instance
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* const component = useTemplateRef<Component>('component');
|
||||||
|
* const result = unrefElement(component); // result is the component instance
|
||||||
|
*
|
||||||
|
* @since 0.0.11
|
||||||
|
*/
|
||||||
|
export function unrefElement<El extends MaybeElement>(elRef: MaybeComputedElementRef<El>): UnRefElementReturn<El> {
|
||||||
|
const plain = toValue(elRef);
|
||||||
|
return (plain as VueInstance)?.$el ?? plain;
|
||||||
|
}
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
import { inject, provide, type InjectionKey, type App } from 'vue';
|
import { inject as vueInject, provide as vueProvide, type InjectionKey, type App } from 'vue';
|
||||||
import { VueToolsError } from '../..';
|
import { VueToolsError } from '../..';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -34,8 +34,8 @@ import { VueToolsError } from '../..';
|
|||||||
export function useContextFactory<ContextValue>(name: string) {
|
export function useContextFactory<ContextValue>(name: string) {
|
||||||
const injectionKey: InjectionKey<ContextValue> = Symbol(name);
|
const injectionKey: InjectionKey<ContextValue> = Symbol(name);
|
||||||
|
|
||||||
const injectContext = <Fallback extends ContextValue = ContextValue>(fallback?: Fallback) => {
|
const inject = <Fallback extends ContextValue = ContextValue>(fallback?: Fallback) => {
|
||||||
const context = inject(injectionKey, fallback);
|
const context = vueInject(injectionKey, fallback);
|
||||||
|
|
||||||
if (context !== undefined)
|
if (context !== undefined)
|
||||||
return context;
|
return context;
|
||||||
@@ -43,8 +43,8 @@ export function useContextFactory<ContextValue>(name: string) {
|
|||||||
throw new VueToolsError(`useContextFactory: '${name}' context is not provided`);
|
throw new VueToolsError(`useContextFactory: '${name}' context is not provided`);
|
||||||
};
|
};
|
||||||
|
|
||||||
const provideContext = (context: ContextValue) => {
|
const provide = (context: ContextValue) => {
|
||||||
provide(injectionKey, context);
|
vueProvide(injectionKey, context);
|
||||||
return context;
|
return context;
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -54,8 +54,8 @@ export function useContextFactory<ContextValue>(name: string) {
|
|||||||
};
|
};
|
||||||
|
|
||||||
return {
|
return {
|
||||||
inject: injectContext,
|
inject,
|
||||||
provide: provideContext,
|
provide,
|
||||||
appProvide,
|
appProvide,
|
||||||
key: injectionKey,
|
key: injectionKey,
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,7 +1,8 @@
|
|||||||
import { inject, provide, type App, type InjectionKey } from 'vue';
|
import { useContextFactory } from '../useContextFactory';
|
||||||
|
import type { App, InjectionKey } from 'vue';
|
||||||
|
|
||||||
export interface useInjectionStoreOptions<Return> {
|
export interface useInjectionStoreOptions<Return> {
|
||||||
injectionKey: string | InjectionKey<Return>;
|
injectionName?: string;
|
||||||
defaultValue?: Return;
|
defaultValue?: Return;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -9,28 +10,28 @@ export interface useInjectionStoreOptions<Return> {
|
|||||||
* @name useInjectionStore
|
* @name useInjectionStore
|
||||||
* @category State
|
* @category State
|
||||||
* @description Create a global state that can be injected into components
|
* @description Create a global state that can be injected into components
|
||||||
*
|
*
|
||||||
* @param {Function} stateFactory A factory function that creates the state
|
* @param {Function} stateFactory A factory function that creates the state
|
||||||
* @param {useInjectionStoreOptions} options An object with the following properties
|
* @param {useInjectionStoreOptions} options An object with the following properties
|
||||||
* @param {string | InjectionKey} options.injectionKey The key to use for the injection
|
* @param {string | InjectionKey} options.injectionKey The key to use for the injection
|
||||||
* @param {any} options.defaultValue The default value to use when the state is not provided
|
* @param {any} options.defaultValue The default value to use when the state is not provided
|
||||||
* @returns {Object} An object with `useProvidingState`, `useAppProvidingState`, and `useInjectedState` functions
|
* @returns {Object} An object with `useProvidingState`, `useAppProvidingState`, and `useInjectedState` functions
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* const { useProvidingState, useInjectedState } = useInjectionStore(() => ref('Hello World'));
|
* const { useProvidingState, useInjectedState } = useInjectionStore(() => ref('Hello World'));
|
||||||
*
|
*
|
||||||
* // In a parent component
|
* // In a parent component
|
||||||
* const state = useProvidingState();
|
* const state = useProvidingState();
|
||||||
*
|
*
|
||||||
* // In a child component
|
* // In a child component
|
||||||
* const state = useInjectedState();
|
* const state = useInjectedState();
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* const { useProvidingState, useInjectedState } = useInjectionStore(() => ref('Hello World'), {
|
* const { useProvidingState, useInjectedState } = useInjectionStore(() => ref('Hello World'), {
|
||||||
* injectionKey: 'MyState',
|
* injectionKey: 'MyState',
|
||||||
* defaultValue: 'Default Value'
|
* defaultValue: 'Default Value'
|
||||||
* });
|
* });
|
||||||
*
|
*
|
||||||
* // In a plugin
|
* // In a plugin
|
||||||
* {
|
* {
|
||||||
* install(app) {
|
* install(app) {
|
||||||
@@ -38,31 +39,31 @@ export interface useInjectionStoreOptions<Return> {
|
|||||||
* state.value = 'Hello World';
|
* state.value = 'Hello World';
|
||||||
* }
|
* }
|
||||||
* }
|
* }
|
||||||
*
|
*
|
||||||
* // In a component
|
* // In a component
|
||||||
* const state = useInjectedState();
|
* const state = useInjectedState();
|
||||||
*
|
*
|
||||||
* @since 0.0.5
|
* @since 0.0.5
|
||||||
*/
|
*/
|
||||||
export function useInjectionStore<Args extends any[], Return>(
|
export function useInjectionStore<Args extends any[], Return>(
|
||||||
stateFactory: (...args: Args) => Return,
|
stateFactory: (...args: Args) => Return,
|
||||||
options?: useInjectionStoreOptions<Return>,
|
options?: useInjectionStoreOptions<Return>
|
||||||
) {
|
) {
|
||||||
const key = options?.injectionKey ?? Symbol(stateFactory.name ?? 'InjectionStore');
|
const ctx = useContextFactory<Return>(options?.injectionName ?? stateFactory.name ?? 'InjectionStore');
|
||||||
|
|
||||||
const useProvidingState = (...args: Args) => {
|
const useProvidingState = (...args: Args) => {
|
||||||
const state = stateFactory(...args);
|
const state = stateFactory(...args);
|
||||||
provide(key, state);
|
ctx.provide(state);
|
||||||
return state;
|
return state;
|
||||||
};
|
};
|
||||||
|
|
||||||
const useAppProvidingState = (app: App) => (...args: Args) => {
|
const useAppProvidingState = (app: App) => (...args: Args) => {
|
||||||
const state = stateFactory(...args);
|
const state = stateFactory(...args);
|
||||||
app.provide(key, state);
|
ctx.appProvide(app)(state);
|
||||||
return state;
|
return state;
|
||||||
};
|
};
|
||||||
|
|
||||||
const useInjectedState = () => inject(key, options?.defaultValue);
|
const useInjectedState = () => ctx.inject(options?.defaultValue);
|
||||||
|
|
||||||
return {
|
return {
|
||||||
useProvidingState,
|
useProvidingState,
|
||||||
|
|||||||
Reference in New Issue
Block a user