@naturalcycles/js-lib 14.84.0 → 14.85.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/dist/decorators/asyncMemo.decorator.d.ts +35 -9
  2. package/dist/decorators/asyncMemo.decorator.js +39 -34
  3. package/dist/decorators/decorator.util.d.ts +1 -1
  4. package/dist/decorators/decorator.util.js +2 -2
  5. package/dist/decorators/logMethod.decorator.d.ts +6 -4
  6. package/dist/decorators/logMethod.decorator.js +3 -3
  7. package/dist/decorators/memo.decorator.d.ts +29 -29
  8. package/dist/decorators/memo.decorator.js +42 -53
  9. package/dist/decorators/memo.util.d.ts +6 -6
  10. package/dist/decorators/memoFn.d.ts +5 -0
  11. package/dist/decorators/memoFn.js +32 -37
  12. package/dist/decorators/memoFnAsync.d.ts +10 -0
  13. package/dist/decorators/memoFnAsync.js +69 -0
  14. package/dist/decorators/memoSimple.decorator.d.ts +1 -1
  15. package/dist/decorators/memoSimple.decorator.js +3 -3
  16. package/dist/error/assert.d.ts +4 -4
  17. package/dist/error/error.model.d.ts +1 -0
  18. package/dist/index.d.ts +1 -0
  19. package/dist/index.js +1 -0
  20. package/dist/promise/pRetry.d.ts +2 -2
  21. package/dist/promise/pTimeout.d.ts +3 -2
  22. package/dist-esm/decorators/asyncMemo.decorator.js +40 -47
  23. package/dist-esm/decorators/decorator.util.js +2 -2
  24. package/dist-esm/decorators/logMethod.decorator.js +3 -3
  25. package/dist-esm/decorators/memo.decorator.js +41 -53
  26. package/dist-esm/decorators/memoFn.js +32 -37
  27. package/dist-esm/decorators/memoFnAsync.js +65 -0
  28. package/dist-esm/decorators/memoSimple.decorator.js +3 -3
  29. package/dist-esm/index.js +1 -0
  30. package/package.json +1 -1
  31. package/src/decorators/asyncMemo.decorator.ts +88 -61
  32. package/src/decorators/decorator.util.ts +2 -2
  33. package/src/decorators/logMethod.decorator.ts +16 -7
  34. package/src/decorators/memo.decorator.ts +66 -102
  35. package/src/decorators/memo.util.ts +7 -7
  36. package/src/decorators/memoFn.ts +33 -51
  37. package/src/decorators/memoFnAsync.ts +91 -0
  38. package/src/decorators/memoSimple.decorator.ts +4 -4
  39. package/src/error/assert.ts +4 -4
  40. package/src/error/error.model.ts +2 -0
  41. package/src/index.ts +1 -0
  42. package/src/promise/pRetry.ts +2 -2
  43. package/src/promise/pTimeout.ts +3 -2
@@ -7,6 +7,11 @@ export interface MemoizedFunction {
7
7
  cache: MemoCache
8
8
  }
9
9
 
10
+ /**
11
+ * Only supports Sync functions.
12
+ * To support Async functions - use _memoFnAsync.
13
+ * Technically, you can use it with Async functions, but it'll return the Promise without awaiting it.
14
+ */
10
15
  export function _memoFn<T extends (...args: any[]) => any>(
11
16
  fn: T,
12
17
  opt: MemoOptions = {},
@@ -14,86 +19,63 @@ export function _memoFn<T extends (...args: any[]) => any>(
14
19
  const {
15
20
  logHit = false,
16
21
  logMiss = false,
17
- noLogArgs = false,
22
+ logArgs = true,
18
23
  logger = console,
19
- noCacheRejected = false,
20
- noCacheResolved = false,
24
+ cacheErrors = true,
21
25
  cacheFactory = () => new MapMemoCache(),
22
26
  cacheKeyFn = jsonMemoSerializer,
23
27
  } = opt
24
28
 
25
29
  const cache = cacheFactory()
26
- const awaitPromise = Boolean(noCacheRejected || noCacheResolved)
27
30
  const fnName = fn.name
28
31
 
29
32
  const memoizedFn = function (this: any, ...args: any[]): T {
30
33
  const ctx = this
31
34
  const cacheKey = cacheKeyFn(args)
35
+ let value: any
32
36
 
33
37
  if (cache.has(cacheKey)) {
34
38
  if (logHit) {
35
- logger.log(`${fnName}(${_getArgsSignature(args, noLogArgs)}) memoFn hit`)
39
+ logger.log(`${fnName}(${_getArgsSignature(args, logArgs)}) memoFn hit`)
36
40
  }
37
41
 
38
- const res = cache.get(cacheKey)
42
+ value = cache.get(cacheKey)
39
43
 
40
- if (awaitPromise) {
41
- return res instanceof Error ? (Promise.reject(res) as any) : Promise.resolve(res)
42
- } else {
43
- return res
44
+ if (value instanceof Error) {
45
+ throw value
44
46
  }
47
+
48
+ return value
45
49
  }
46
50
 
47
51
  const started = Date.now()
48
52
 
49
- const res: any = fn.apply(ctx, args)
50
-
51
- if (awaitPromise) {
52
- return (res as Promise<any>)
53
- .then(res => {
54
- // console.log('RESOLVED', res)
55
- if (logMiss) {
56
- logger.log(
57
- `${fnName}(${_getArgsSignature(args, noLogArgs)}) memoFn miss resolved (${_since(
58
- started,
59
- )})`,
60
- )
61
- }
62
-
63
- if (!noCacheResolved) {
64
- cache.set(cacheKey, res)
65
- }
53
+ try {
54
+ value = fn.apply(ctx, args)
66
55
 
67
- return res
68
- })
69
- .catch(err => {
70
- // console.log('REJECTED', err)
71
- if (logMiss) {
72
- logger.log(
73
- `${fnName}(${_getArgsSignature(args, noLogArgs)}) memoFn miss rejected (${_since(
74
- started,
75
- )})`,
76
- )
77
- }
56
+ try {
57
+ cache.set(cacheKey, value)
58
+ } catch (err) {
59
+ logger.error(err)
60
+ }
78
61
 
79
- if (!noCacheRejected) {
80
- // We put it to cache as raw Error, not Promise.reject(err)
81
- // So, we'll need to check if it's instanceof Error to reject it or resolve
82
- // Wrap as Error if it's not Error
83
- cache.set(cacheKey, err instanceof Error ? err : new Error(err))
84
- }
62
+ return value
63
+ } catch (err) {
64
+ if (cacheErrors) {
65
+ try {
66
+ cache.set(cacheKey, err)
67
+ } catch (err) {
68
+ logger.error(err)
69
+ }
70
+ }
85
71
 
86
- throw err
87
- }) as any
88
- } else {
72
+ throw err
73
+ } finally {
89
74
  if (logMiss) {
90
75
  logger.log(
91
- `${fnName}(${_getArgsSignature(args, noLogArgs)}) memoFn miss (${_since(started)})`,
76
+ `${fnName}(${_getArgsSignature(args, logArgs)}) memoFn miss (${_since(started)})`,
92
77
  )
93
78
  }
94
-
95
- cache.set(cacheKey, res)
96
- return res
97
79
  }
98
80
  }
99
81
 
@@ -0,0 +1,91 @@
1
+ import { _since } from '../time/time.util'
2
+ import { AsyncMemoOptions } from './asyncMemo.decorator'
3
+ import { _getArgsSignature } from './decorator.util'
4
+ import { AsyncMemoCache, jsonMemoSerializer, MapMemoCache } from './memo.util'
5
+
6
+ export interface MemoizedAsyncFunction {
7
+ cache: AsyncMemoCache
8
+ }
9
+
10
+ /**
11
+ * Only supports Sync functions.
12
+ * To support Async functions - use _memoFnAsync
13
+ */
14
+ export function _memoFnAsync<T extends (...args: any[]) => Promise<any>>(
15
+ fn: T,
16
+ opt: AsyncMemoOptions = {},
17
+ ): T & MemoizedAsyncFunction {
18
+ const {
19
+ logHit = false,
20
+ logMiss = false,
21
+ logArgs = true,
22
+ logger = console,
23
+ cacheRejections = true,
24
+ cacheFactory = () => new MapMemoCache(),
25
+ cacheKeyFn = jsonMemoSerializer,
26
+ } = opt
27
+
28
+ const cache = cacheFactory()
29
+ const fnName = fn.name
30
+
31
+ const memoizedFn = async function (this: any, ...args: any[]): Promise<any> {
32
+ const ctx = this
33
+ const cacheKey = cacheKeyFn(args)
34
+ let value: any
35
+
36
+ try {
37
+ value = await cache.get(cacheKey)
38
+ } catch (err) {
39
+ logger.error(err)
40
+ }
41
+
42
+ if (value !== undefined) {
43
+ if (logHit) {
44
+ logger.log(`${fnName}(${_getArgsSignature(args, logArgs)}) memoFnAsync hit`)
45
+ }
46
+
47
+ if (value instanceof Error) {
48
+ throw value
49
+ }
50
+
51
+ return value
52
+ }
53
+
54
+ const started = Date.now()
55
+
56
+ try {
57
+ value = await fn.apply(ctx, args)
58
+
59
+ void (async () => {
60
+ try {
61
+ await cache.set(cacheKey, value)
62
+ } catch (err) {
63
+ logger.error(err)
64
+ }
65
+ })()
66
+
67
+ return value
68
+ } catch (err) {
69
+ if (cacheRejections) {
70
+ void (async () => {
71
+ try {
72
+ await cache.set(cacheKey, err)
73
+ } catch (err) {
74
+ logger.error(err)
75
+ }
76
+ })()
77
+ }
78
+
79
+ throw err
80
+ } finally {
81
+ if (logMiss) {
82
+ logger.log(
83
+ `${fnName}(${_getArgsSignature(args, logArgs)}) memoFnAsync miss (${_since(started)})`,
84
+ )
85
+ }
86
+ }
87
+ }
88
+
89
+ Object.assign(memoizedFn, { cache })
90
+ return memoizedFn as T & MemoizedAsyncFunction
91
+ }
@@ -18,7 +18,7 @@ import { jsonMemoSerializer, MapMemoCache, MemoCache } from './memo.util'
18
18
  export interface MemoOpts {
19
19
  logHit?: boolean
20
20
  logMiss?: boolean
21
- noLogArgs?: boolean
21
+ logArgs?: boolean
22
22
  logger?: CommonLogger
23
23
  }
24
24
 
@@ -57,7 +57,7 @@ export const memoSimple =
57
57
  */
58
58
  const cache: MemoCache = new MapMemoCache()
59
59
 
60
- const { logHit, logMiss, noLogArgs, logger = console } = opt
60
+ const { logHit, logMiss, logArgs = true, logger = console } = opt
61
61
  const keyStr = String(key)
62
62
  const methodSignature = _getTargetMethodSignature(target, keyStr)
63
63
 
@@ -67,7 +67,7 @@ export const memoSimple =
67
67
 
68
68
  if (cache.has(cacheKey)) {
69
69
  if (logHit) {
70
- logger.log(`${methodSignature}(${_getArgsSignature(args, noLogArgs)}) @memo hit`)
70
+ logger.log(`${methodSignature}(${_getArgsSignature(args, logArgs)}) @memo hit`)
71
71
  }
72
72
  return cache.get(cacheKey)
73
73
  }
@@ -78,7 +78,7 @@ export const memoSimple =
78
78
 
79
79
  if (logMiss) {
80
80
  logger.log(
81
- `${methodSignature}(${_getArgsSignature(args, noLogArgs)}) @memo miss (${
81
+ `${methodSignature}(${_getArgsSignature(args, logArgs)}) @memo miss (${
82
82
  Date.now() - d
83
83
  } ms)`,
84
84
  )
@@ -1,4 +1,4 @@
1
- import { ErrorData, HttpErrorData, _deepEquals, _stringifyAny } from '..'
1
+ import { ErrorData, _deepEquals, _stringifyAny } from '..'
2
2
  import { AppError } from './app.error'
3
3
 
4
4
  /**
@@ -19,7 +19,7 @@ import { AppError } from './app.error'
19
19
  export function _assert(
20
20
  condition: any, // will be evaluated as Boolean
21
21
  message?: string,
22
- errorData?: Partial<HttpErrorData>,
22
+ errorData?: ErrorData,
23
23
  ): asserts condition {
24
24
  if (!condition) {
25
25
  throw new AssertionError(message || 'see stacktrace', {
@@ -39,7 +39,7 @@ export function _assertEquals<T>(
39
39
  actual: any,
40
40
  expected: T,
41
41
  message?: string,
42
- errorData?: Partial<HttpErrorData>,
42
+ errorData?: ErrorData,
43
43
  ): asserts actual is T {
44
44
  if (actual !== expected) {
45
45
  const msg = [
@@ -67,7 +67,7 @@ export function _assertDeepEquals<T>(
67
67
  actual: any,
68
68
  expected: T,
69
69
  message?: string,
70
- errorData?: Partial<HttpErrorData>,
70
+ errorData?: ErrorData,
71
71
  ): asserts actual is T {
72
72
  if (!_deepEquals(actual, expected)) {
73
73
  const msg = [
@@ -38,6 +38,8 @@ export interface ErrorData {
38
38
  */
39
39
  fingerprint?: string[]
40
40
 
41
+ httpStatusCode?: number
42
+
41
43
  /**
42
44
  * Open-ended.
43
45
  */
package/src/index.ts CHANGED
@@ -15,6 +15,7 @@ export * from './decorators/memo.decorator'
15
15
  export * from './decorators/asyncMemo.decorator'
16
16
  import { MemoCache, AsyncMemoCache } from './decorators/memo.util'
17
17
  export * from './decorators/memoFn'
18
+ export * from './decorators/memoFnAsync'
18
19
  export * from './decorators/retry.decorator'
19
20
  export * from './decorators/timeout.decorator'
20
21
  export * from './error/app.error'
@@ -1,4 +1,4 @@
1
- import { _since, _stringifyAny, AnyFunction, AnyObject, AppError, CommonLogger } from '..'
1
+ import { _since, _stringifyAny, AnyFunction, AppError, CommonLogger, ErrorData } from '..'
2
2
  import { TimeoutError } from './pTimeout'
3
3
 
4
4
  export interface PRetryOptions {
@@ -95,7 +95,7 @@ export interface PRetryOptions {
95
95
  /**
96
96
  * Will be merged with `err.data` object.
97
97
  */
98
- errorData?: AnyObject
98
+ errorData?: ErrorData
99
99
  }
100
100
 
101
101
  /**
@@ -1,5 +1,6 @@
1
1
  import { AppError } from '../error/app.error'
2
- import { AnyFunction, AnyObject } from '../types'
2
+ import { ErrorData } from '../error/error.model'
3
+ import { AnyFunction } from '../types'
3
4
 
4
5
  export class TimeoutError extends AppError {}
5
6
 
@@ -33,7 +34,7 @@ export interface PTimeoutOptions {
33
34
  /**
34
35
  * Will be merged with `err.data` object.
35
36
  */
36
- errorData?: AnyObject
37
+ errorData?: ErrorData
37
38
  }
38
39
 
39
40
  /**