@naturalcycles/js-lib 14.63.0 → 14.67.0
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.
- package/dist/decorators/logMethod.decorator.d.ts +5 -0
- package/dist/decorators/logMethod.decorator.js +9 -9
- package/dist/decorators/memo.decorator.d.ts +11 -0
- package/dist/decorators/memo.decorator.js +6 -6
- package/dist/decorators/memoFn.js +5 -5
- package/dist/decorators/memoSimple.decorator.d.ts +2 -0
- package/dist/decorators/memoSimple.decorator.js +4 -10
- package/dist/error/error.model.d.ts +5 -0
- package/dist/error/tryCatch.d.ts +5 -0
- package/dist/error/tryCatch.js +3 -6
- package/dist/index.d.ts +3 -3
- package/dist/index.js +4 -2
- package/dist/log/commonLogger.d.ts +7 -12
- package/dist/log/commonLogger.js +53 -18
- package/dist/promise/pRetry.d.ts +5 -0
- package/dist/promise/pRetry.js +4 -4
- package/dist-esm/decorators/logMethod.decorator.js +9 -9
- package/dist-esm/decorators/memo.decorator.js +6 -6
- package/dist-esm/decorators/memoFn.js +5 -5
- package/dist-esm/decorators/memoSimple.decorator.js +4 -10
- package/dist-esm/error/tryCatch.js +3 -3
- package/dist-esm/index.js +2 -2
- package/dist-esm/log/commonLogger.js +50 -16
- package/dist-esm/promise/pRetry.js +4 -4
- package/package.json +1 -1
- package/src/decorators/logMethod.decorator.ts +15 -9
- package/src/decorators/memo.decorator.ts +27 -17
- package/src/decorators/memoFn.ts +11 -10
- package/src/decorators/memoSimple.decorator.ts +6 -4
- package/src/error/error.model.ts +7 -0
- package/src/error/tryCatch.ts +9 -7
- package/src/index.ts +6 -4
- package/src/log/commonLogger.ts +57 -22
- package/src/promise/pRetry.ts +16 -5
|
@@ -30,7 +30,7 @@ export const _Memo = (opt = {}) => (target, key, descriptor) => {
|
|
|
30
30
|
// UPD: tests show that normal Map also doesn't leak (to be tested further)
|
|
31
31
|
// Normal Map is needed to allow .dropCache()
|
|
32
32
|
const cache = new Map();
|
|
33
|
-
const { logHit, logMiss, noLogArgs, cacheFactory = () => new MapMemoCache(), cacheKeyFn = jsonMemoSerializer, noCacheRejected, noCacheResolved, } = opt;
|
|
33
|
+
const { logHit = false, logMiss = false, noLogArgs = false, logger = console, cacheFactory = () => new MapMemoCache(), cacheKeyFn = jsonMemoSerializer, noCacheRejected = false, noCacheResolved = false, } = opt;
|
|
34
34
|
const awaitPromise = Boolean(noCacheRejected || noCacheResolved);
|
|
35
35
|
const keyStr = String(key);
|
|
36
36
|
const methodSignature = _getTargetMethodSignature(target, keyStr);
|
|
@@ -42,7 +42,7 @@ export const _Memo = (opt = {}) => (target, key, descriptor) => {
|
|
|
42
42
|
}
|
|
43
43
|
else if (cache.get(ctx).has(cacheKey)) {
|
|
44
44
|
if (logHit) {
|
|
45
|
-
|
|
45
|
+
logger.log(`${_getMethodSignature(ctx, keyStr)}(${_getArgsSignature(args, noLogArgs)}) @_Memo hit`);
|
|
46
46
|
}
|
|
47
47
|
const res = cache.get(ctx).get(cacheKey);
|
|
48
48
|
if (awaitPromise) {
|
|
@@ -59,7 +59,7 @@ export const _Memo = (opt = {}) => (target, key, descriptor) => {
|
|
|
59
59
|
.then(res => {
|
|
60
60
|
// console.log('RESOLVED', res)
|
|
61
61
|
if (logMiss) {
|
|
62
|
-
|
|
62
|
+
logger.log(`${_getMethodSignature(ctx, keyStr)}(${_getArgsSignature(args, noLogArgs)}) @_Memo miss resolved (${_since(started)})`);
|
|
63
63
|
}
|
|
64
64
|
if (!noCacheResolved) {
|
|
65
65
|
cache.get(ctx).set(cacheKey, res);
|
|
@@ -69,7 +69,7 @@ export const _Memo = (opt = {}) => (target, key, descriptor) => {
|
|
|
69
69
|
.catch(err => {
|
|
70
70
|
// console.log('REJECTED', err)
|
|
71
71
|
if (logMiss) {
|
|
72
|
-
|
|
72
|
+
logger.log(`${_getMethodSignature(ctx, keyStr)}(${_getArgsSignature(args, noLogArgs)}) @_Memo miss rejected (${_since(started)})`);
|
|
73
73
|
}
|
|
74
74
|
if (!noCacheRejected) {
|
|
75
75
|
// We put it to cache as raw Error, not Promise.reject(err)
|
|
@@ -82,14 +82,14 @@ export const _Memo = (opt = {}) => (target, key, descriptor) => {
|
|
|
82
82
|
}
|
|
83
83
|
else {
|
|
84
84
|
if (logMiss) {
|
|
85
|
-
|
|
85
|
+
logger.log(`${_getMethodSignature(ctx, keyStr)}(${_getArgsSignature(args, noLogArgs)}) @_Memo miss (${_since(started)})`);
|
|
86
86
|
}
|
|
87
87
|
cache.get(ctx).set(cacheKey, res);
|
|
88
88
|
return res;
|
|
89
89
|
}
|
|
90
90
|
};
|
|
91
91
|
descriptor.value.dropCache = () => {
|
|
92
|
-
|
|
92
|
+
logger.log(`${methodSignature} @_Memo.dropCache()`);
|
|
93
93
|
cache.forEach(memoCache => memoCache.clear());
|
|
94
94
|
cache.clear();
|
|
95
95
|
};
|
|
@@ -2,7 +2,7 @@ import { _since } from '../time/time.util';
|
|
|
2
2
|
import { _getArgsSignature } from './decorator.util';
|
|
3
3
|
import { jsonMemoSerializer, MapMemoCache } from './memo.util';
|
|
4
4
|
export function _memoFn(fn, opt = {}) {
|
|
5
|
-
const { logHit, logMiss, noLogArgs, noCacheRejected, noCacheResolved, cacheFactory = () => new MapMemoCache(), cacheKeyFn = jsonMemoSerializer, } = opt;
|
|
5
|
+
const { logHit = false, logMiss = false, noLogArgs = false, logger = console, noCacheRejected = false, noCacheResolved = false, cacheFactory = () => new MapMemoCache(), cacheKeyFn = jsonMemoSerializer, } = opt;
|
|
6
6
|
const cache = cacheFactory();
|
|
7
7
|
const awaitPromise = Boolean(noCacheRejected || noCacheResolved);
|
|
8
8
|
const fnName = fn.name;
|
|
@@ -11,7 +11,7 @@ export function _memoFn(fn, opt = {}) {
|
|
|
11
11
|
const cacheKey = cacheKeyFn(args);
|
|
12
12
|
if (cache.has(cacheKey)) {
|
|
13
13
|
if (logHit) {
|
|
14
|
-
|
|
14
|
+
logger.log(`${fnName}(${_getArgsSignature(args, noLogArgs)}) memoFn hit`);
|
|
15
15
|
}
|
|
16
16
|
const res = cache.get(cacheKey);
|
|
17
17
|
if (awaitPromise) {
|
|
@@ -28,7 +28,7 @@ export function _memoFn(fn, opt = {}) {
|
|
|
28
28
|
.then(res => {
|
|
29
29
|
// console.log('RESOLVED', res)
|
|
30
30
|
if (logMiss) {
|
|
31
|
-
|
|
31
|
+
logger.log(`${fnName}(${_getArgsSignature(args, noLogArgs)}) memoFn miss resolved (${_since(started)})`);
|
|
32
32
|
}
|
|
33
33
|
if (!noCacheResolved) {
|
|
34
34
|
cache.set(cacheKey, res);
|
|
@@ -38,7 +38,7 @@ export function _memoFn(fn, opt = {}) {
|
|
|
38
38
|
.catch(err => {
|
|
39
39
|
// console.log('REJECTED', err)
|
|
40
40
|
if (logMiss) {
|
|
41
|
-
|
|
41
|
+
logger.log(`${fnName}(${_getArgsSignature(args, noLogArgs)}) memoFn miss rejected (${_since(started)})`);
|
|
42
42
|
}
|
|
43
43
|
if (!noCacheRejected) {
|
|
44
44
|
// We put it to cache as raw Error, not Promise.reject(err)
|
|
@@ -51,7 +51,7 @@ export function _memoFn(fn, opt = {}) {
|
|
|
51
51
|
}
|
|
52
52
|
else {
|
|
53
53
|
if (logMiss) {
|
|
54
|
-
|
|
54
|
+
logger.log(`${fnName}(${_getArgsSignature(args, noLogArgs)}) memoFn miss (${_since(started)})`);
|
|
55
55
|
}
|
|
56
56
|
cache.set(cacheKey, res);
|
|
57
57
|
return res;
|
|
@@ -3,12 +3,6 @@
|
|
|
3
3
|
// http://decodize.com/blog/2012/08/27/javascript-memoization-caching-results-for-better-performance/
|
|
4
4
|
// http://inlehmansterms.net/2015/03/01/javascript-memoization/
|
|
5
5
|
// https://community.risingstack.com/the-worlds-fastest-javascript-memoization-library/
|
|
6
|
-
/*
|
|
7
|
-
Optimized for 0 arguments (using SingleValueCache).
|
|
8
|
-
Optimized for 1 primitive argument (skips JSON.stringify).
|
|
9
|
-
Otherwise resorts to JSON.stringify.
|
|
10
|
-
Benchmark shows similar perf for ObjectCache and MapCache.
|
|
11
|
-
*/
|
|
12
6
|
import { _getArgsSignature, _getTargetMethodSignature } from './decorator.util';
|
|
13
7
|
import { jsonMemoSerializer, MapMemoCache } from './memo.util';
|
|
14
8
|
// memoSimple decorator is NOT exported. Only used in benchmarks currently
|
|
@@ -40,7 +34,7 @@ export const memoSimple = (opt = {}) => (target, key, descriptor) => {
|
|
|
40
34
|
}
|
|
41
35
|
*/
|
|
42
36
|
const cache = new MapMemoCache();
|
|
43
|
-
const { logHit, logMiss, noLogArgs } = opt;
|
|
37
|
+
const { logHit, logMiss, noLogArgs, logger = console } = opt;
|
|
44
38
|
const keyStr = String(key);
|
|
45
39
|
const methodSignature = _getTargetMethodSignature(target, keyStr);
|
|
46
40
|
descriptor.value = function (...args) {
|
|
@@ -48,20 +42,20 @@ export const memoSimple = (opt = {}) => (target, key, descriptor) => {
|
|
|
48
42
|
const cacheKey = jsonMemoSerializer(args);
|
|
49
43
|
if (cache.has(cacheKey)) {
|
|
50
44
|
if (logHit) {
|
|
51
|
-
|
|
45
|
+
logger.log(`${methodSignature}(${_getArgsSignature(args, noLogArgs)}) @memo hit`);
|
|
52
46
|
}
|
|
53
47
|
return cache.get(cacheKey);
|
|
54
48
|
}
|
|
55
49
|
const d = Date.now();
|
|
56
50
|
const res = originalFn.apply(ctx, args);
|
|
57
51
|
if (logMiss) {
|
|
58
|
-
|
|
52
|
+
logger.log(`${methodSignature}(${_getArgsSignature(args, noLogArgs)}) @memo miss (${Date.now() - d} ms)`);
|
|
59
53
|
}
|
|
60
54
|
cache.set(cacheKey, res);
|
|
61
55
|
return res;
|
|
62
56
|
};
|
|
63
57
|
descriptor.value.dropCache = () => {
|
|
64
|
-
|
|
58
|
+
logger.log(`${methodSignature} @memo.dropCache()`);
|
|
65
59
|
cache.clear();
|
|
66
60
|
};
|
|
67
61
|
return descriptor;
|
|
@@ -8,20 +8,20 @@ import { _since, _stringifyAny } from '../index';
|
|
|
8
8
|
* @experimental
|
|
9
9
|
*/
|
|
10
10
|
export function _tryCatch(fn, opt = {}) {
|
|
11
|
-
const { onError, logError, logSuccess
|
|
11
|
+
const { onError, logError = true, logSuccess = false, logger = console } = opt;
|
|
12
12
|
const fname = fn.name || 'anonymous';
|
|
13
13
|
return async function (...args) {
|
|
14
14
|
const started = Date.now();
|
|
15
15
|
try {
|
|
16
16
|
const r = await fn.apply(this, args);
|
|
17
17
|
if (logSuccess) {
|
|
18
|
-
|
|
18
|
+
logger.log(`tryCatch.${fname} succeeded in ${_since(started)}`);
|
|
19
19
|
}
|
|
20
20
|
return r;
|
|
21
21
|
}
|
|
22
22
|
catch (err) {
|
|
23
23
|
if (logError) {
|
|
24
|
-
|
|
24
|
+
logger.warn(`tryCatch.${fname} error in ${_since(started)}:\n${_stringifyAny(err, {
|
|
25
25
|
includeErrorData: true,
|
|
26
26
|
})}`);
|
|
27
27
|
}
|
package/dist-esm/index.js
CHANGED
|
@@ -50,6 +50,6 @@ import { _ms, _since } from './time/time.util';
|
|
|
50
50
|
import { _noop, _objectKeys, _passNothingPredicate, _passthroughMapper, _passthroughPredicate, _passUndefinedMapper, _stringMapEntries, _stringMapValues, } from './types';
|
|
51
51
|
import { _gb, _hb, _kb, _mb } from './unit/size.util';
|
|
52
52
|
import { is } from './vendor/is';
|
|
53
|
-
import {
|
|
53
|
+
import { commonLoggerMinLevel, noopLogger, commonLogLevelNumber, commonLoggerPipe, } from './log/commonLogger';
|
|
54
54
|
import { _safeJsonStringify } from './string/safeJsonStringify';
|
|
55
|
-
export { is, _Memo, _memoFn, _LogMethod, _getArgsSignature, _createPromiseDecorator, AppError, HttpError, AssertionError, _isErrorObject, _isHttpErrorObject, _isHttpErrorResponse, _assert, _assertEquals, _assertDeepEquals, _assertIsError, _assertIsString, _assertIsNumber, _assertTypeOf, _randomInt, _randomArrayItem, _createDeterministicRandom, _inRange, _stringMapValues, _stringMapEntries, _objectKeys, _capitalize, _upperFirst, _lowerFirst, _split, _removeWhitespace, _substringBefore, _substringBeforeLast, _substringAfter, _substringAfterLast, _substringBetweenLast, _replaceAll, _nl2br, _truncate, _truncateMiddle, _pick, _omit, _filterFalsyValues, _filterUndefinedValues, _filterNullishValues, _filterEmptyArrays, _filterEmptyValues, _filterObject, _undefinedIfEmpty, _isObject, _isPrimitive, _mapKeys, _mapValues, _mapObject, _objectNullValuesToUndefined, _deepEquals, _deepCopy, _isEmptyObject, _isEmpty, _merge, _deepTrim, _sortObjectDeep, _sortObject, _get, _set, _has, _unset, _mask, _invert, _invertMap, _by, _groupBy, _sortBy, _sortNumbers, _toFixed, _toPrecision, _round, _findLast, _takeWhile, _takeRightWhile, _dropWhile, _dropRightWhile, _countBy, _intersection, _difference, _shuffle, _mapToObject, _findKeyByValue, _anyToError, _anyToErrorObject, _errorToErrorObject, _errorObjectToAppError, _range, _uniq, _uniqBy, _flatten, _flattenDeep, _chunk, SimpleMovingAverage, _average, _averageWeighted, _percentile, _median, _debounce, _throttle, _Debounce, _Throttle, pMap, _passthroughMapper, _passUndefinedMapper, _passthroughPredicate, _passNothingPredicate, _noop, pBatch, ErrorMode, pFilter, pProps, pDelay, pDefer, pHang, pState, AggregatedError, pRetry, pTimeout, pTuple, _Retry, _Timeout, _tryCatch, _TryCatch, _try, pTry, _jsonParseIfPossible, _stringifyAny, _ms, _since, _hb, _gb, _mb, _kb, _snakeCase, _camelCase, _kebabCase, _sum, _sumBy, _clamp, _last, mergeJsonSchemaObjects, jsonSchema, JsonSchemaAnyBuilder, JSON_SCHEMA_ORDER, generateJsonSchemaFromData, _parseQueryString, _defineLazyProperty, _defineLazyProps, _lazyValue,
|
|
55
|
+
export { is, _Memo, _memoFn, _LogMethod, _getArgsSignature, _createPromiseDecorator, AppError, HttpError, AssertionError, _isErrorObject, _isHttpErrorObject, _isHttpErrorResponse, _assert, _assertEquals, _assertDeepEquals, _assertIsError, _assertIsString, _assertIsNumber, _assertTypeOf, _randomInt, _randomArrayItem, _createDeterministicRandom, _inRange, _stringMapValues, _stringMapEntries, _objectKeys, _capitalize, _upperFirst, _lowerFirst, _split, _removeWhitespace, _substringBefore, _substringBeforeLast, _substringAfter, _substringAfterLast, _substringBetweenLast, _replaceAll, _nl2br, _truncate, _truncateMiddle, _pick, _omit, _filterFalsyValues, _filterUndefinedValues, _filterNullishValues, _filterEmptyArrays, _filterEmptyValues, _filterObject, _undefinedIfEmpty, _isObject, _isPrimitive, _mapKeys, _mapValues, _mapObject, _objectNullValuesToUndefined, _deepEquals, _deepCopy, _isEmptyObject, _isEmpty, _merge, _deepTrim, _sortObjectDeep, _sortObject, _get, _set, _has, _unset, _mask, _invert, _invertMap, _by, _groupBy, _sortBy, _sortNumbers, _toFixed, _toPrecision, _round, _findLast, _takeWhile, _takeRightWhile, _dropWhile, _dropRightWhile, _countBy, _intersection, _difference, _shuffle, _mapToObject, _findKeyByValue, _anyToError, _anyToErrorObject, _errorToErrorObject, _errorObjectToAppError, _range, _uniq, _uniqBy, _flatten, _flattenDeep, _chunk, SimpleMovingAverage, _average, _averageWeighted, _percentile, _median, _debounce, _throttle, _Debounce, _Throttle, pMap, _passthroughMapper, _passUndefinedMapper, _passthroughPredicate, _passNothingPredicate, _noop, pBatch, ErrorMode, pFilter, pProps, pDelay, pDefer, pHang, pState, AggregatedError, pRetry, pTimeout, pTuple, _Retry, _Timeout, _tryCatch, _TryCatch, _try, pTry, _jsonParseIfPossible, _stringifyAny, _ms, _since, _hb, _gb, _mb, _kb, _snakeCase, _camelCase, _kebabCase, _sum, _sumBy, _clamp, _last, mergeJsonSchemaObjects, jsonSchema, JsonSchemaAnyBuilder, JSON_SCHEMA_ORDER, generateJsonSchemaFromData, _parseQueryString, _defineLazyProperty, _defineLazyProps, _lazyValue, commonLoggerMinLevel, noopLogger, commonLogLevelNumber, commonLoggerPipe, _safeJsonStringify, };
|
|
@@ -1,23 +1,57 @@
|
|
|
1
|
+
import { _noop } from '../index';
|
|
2
|
+
export const commonLogLevelNumber = {
|
|
3
|
+
log: 10,
|
|
4
|
+
warn: 20,
|
|
5
|
+
error: 30,
|
|
6
|
+
};
|
|
1
7
|
/**
|
|
2
|
-
*
|
|
8
|
+
* SimpleLogger that does nothing (noop).
|
|
3
9
|
*
|
|
4
10
|
* @experimental
|
|
5
11
|
*/
|
|
6
|
-
export
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
+
export const noopLogger = {
|
|
13
|
+
log: _noop,
|
|
14
|
+
warn: _noop,
|
|
15
|
+
error: _noop,
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* Creates a "child" logger that is "limited" to the specified CommonLogLevel.
|
|
19
|
+
*/
|
|
20
|
+
export function commonLoggerMinLevel(logger, minLevel, mutate = false) {
|
|
21
|
+
const level = commonLogLevelNumber[minLevel];
|
|
22
|
+
if (mutate) {
|
|
23
|
+
if (level > commonLogLevelNumber['log']) {
|
|
24
|
+
logger.log = _noop;
|
|
25
|
+
if (level > commonLogLevelNumber['warn']) {
|
|
26
|
+
logger.warn = _noop;
|
|
27
|
+
if (level > commonLogLevelNumber['error']) {
|
|
28
|
+
logger.error = _noop;
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
return logger;
|
|
33
|
+
}
|
|
34
|
+
if (level <= commonLogLevelNumber['log']) {
|
|
35
|
+
// All levels are kept
|
|
36
|
+
return logger;
|
|
37
|
+
}
|
|
38
|
+
if (level > commonLogLevelNumber['error']) {
|
|
39
|
+
// "Log nothing" logger
|
|
40
|
+
return noopLogger;
|
|
41
|
+
}
|
|
42
|
+
return {
|
|
43
|
+
log: _noop,
|
|
44
|
+
warn: level <= commonLogLevelNumber['warn'] ? logger.warn.bind(logger) : _noop,
|
|
45
|
+
error: logger.error.bind(logger), // otherwise it's "log nothing" logger (same as noopLogger)
|
|
46
|
+
};
|
|
12
47
|
}
|
|
13
|
-
const noop = () => { };
|
|
14
48
|
/**
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
* @experimental
|
|
49
|
+
* Creates a "proxy" CommonLogger that pipes log messages to all provided sub-loggers.
|
|
18
50
|
*/
|
|
19
|
-
export
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
51
|
+
export function commonLoggerPipe(loggers) {
|
|
52
|
+
return {
|
|
53
|
+
log: (...args) => loggers.forEach(logger => logger.log(...args)),
|
|
54
|
+
warn: (...args) => loggers.forEach(logger => logger.warn(...args)),
|
|
55
|
+
error: (...args) => loggers.forEach(logger => logger.error(...args)),
|
|
56
|
+
};
|
|
57
|
+
}
|
|
@@ -5,7 +5,7 @@ import { _since, _stringifyAny } from '..';
|
|
|
5
5
|
*/
|
|
6
6
|
// eslint-disable-next-line @typescript-eslint/ban-types
|
|
7
7
|
export function pRetry(fn, opt = {}) {
|
|
8
|
-
const { maxAttempts = 4, delay: initialDelay = 1000, delayMultiplier = 2, predicate } = opt;
|
|
8
|
+
const { maxAttempts = 4, delay: initialDelay = 1000, delayMultiplier = 2, predicate, logger = console, } = opt;
|
|
9
9
|
let { logFirstAttempt = false, logRetries = true, logFailures = false, logSuccess = false } = opt;
|
|
10
10
|
if (opt.logAll) {
|
|
11
11
|
logFirstAttempt = logRetries = logFailures = true;
|
|
@@ -23,17 +23,17 @@ export function pRetry(fn, opt = {}) {
|
|
|
23
23
|
try {
|
|
24
24
|
attempt++;
|
|
25
25
|
if ((attempt === 1 && logFirstAttempt) || (attempt > 1 && logRetries)) {
|
|
26
|
-
|
|
26
|
+
logger.log(`${fname} attempt #${attempt}...`);
|
|
27
27
|
}
|
|
28
28
|
const r = await fn.apply(this, args);
|
|
29
29
|
if (logSuccess) {
|
|
30
|
-
|
|
30
|
+
logger.log(`${fname} attempt #${attempt} succeeded in ${_since(started)}`);
|
|
31
31
|
}
|
|
32
32
|
resolve(r);
|
|
33
33
|
}
|
|
34
34
|
catch (err) {
|
|
35
35
|
if (logFailures) {
|
|
36
|
-
|
|
36
|
+
logger.warn(`${fname} attempt #${attempt} error in ${_since(started)}:\n${_stringifyAny(err, {
|
|
37
37
|
includeErrorData: true,
|
|
38
38
|
})}`);
|
|
39
39
|
}
|
package/package.json
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { SimpleMovingAverage, _stringifyAny } from '..'
|
|
1
|
+
import { SimpleMovingAverage, _stringifyAny, CommonLogger } from '..'
|
|
2
2
|
import { _ms } from '../time/time.util'
|
|
3
3
|
import { _getArgsSignature, _getMethodSignature } from './decorator.util'
|
|
4
4
|
|
|
@@ -46,6 +46,11 @@ export interface LogMethodOptions {
|
|
|
46
46
|
* Overrides `logResult`.
|
|
47
47
|
*/
|
|
48
48
|
logResultFn?: LogResultFn
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Defaults to `console`
|
|
52
|
+
*/
|
|
53
|
+
logger?: CommonLogger
|
|
49
54
|
}
|
|
50
55
|
|
|
51
56
|
/**
|
|
@@ -65,13 +70,13 @@ export interface LogMethodOptions {
|
|
|
65
70
|
export function _LogMethod(opt: LogMethodOptions = {}): MethodDecorator {
|
|
66
71
|
return (target, key, descriptor) => {
|
|
67
72
|
if (typeof descriptor.value !== 'function') {
|
|
68
|
-
throw new TypeError('@
|
|
73
|
+
throw new TypeError('@_LogMethod can be applied only to methods')
|
|
69
74
|
}
|
|
70
75
|
|
|
71
76
|
const originalFn = descriptor.value
|
|
72
77
|
const keyStr = String(key)
|
|
73
78
|
|
|
74
|
-
const { avg, noLogArgs, logStart, logResult, noLogResultLength } = opt
|
|
79
|
+
const { avg, noLogArgs, logStart, logResult, noLogResultLength, logger = console } = opt
|
|
75
80
|
let { logResultFn } = opt
|
|
76
81
|
if (!logResultFn) {
|
|
77
82
|
if (logResult) {
|
|
@@ -93,7 +98,7 @@ export function _LogMethod(opt: LogMethodOptions = {}): MethodDecorator {
|
|
|
93
98
|
const methodSignature = _getMethodSignature(ctx, keyStr)
|
|
94
99
|
const argsStr = _getArgsSignature(args, noLogArgs)
|
|
95
100
|
const callSignature = `${methodSignature}(${argsStr}) #${++count}`
|
|
96
|
-
if (logStart)
|
|
101
|
+
if (logStart) logger.log(`>> ${callSignature}`)
|
|
97
102
|
|
|
98
103
|
try {
|
|
99
104
|
const res = originalFn.apply(ctx, args)
|
|
@@ -102,20 +107,20 @@ export function _LogMethod(opt: LogMethodOptions = {}): MethodDecorator {
|
|
|
102
107
|
// Result is a Promise, will wait for resolution or rejection
|
|
103
108
|
return res
|
|
104
109
|
.then((r: any) => {
|
|
105
|
-
logFinished(callSignature, started, sma, logResultFn, r)
|
|
110
|
+
logFinished(logger, callSignature, started, sma, logResultFn, r)
|
|
106
111
|
return r
|
|
107
112
|
})
|
|
108
113
|
.catch((err: any) => {
|
|
109
|
-
logFinished(callSignature, started, sma, logResultFn, undefined, err)
|
|
114
|
+
logFinished(logger, callSignature, started, sma, logResultFn, undefined, err)
|
|
110
115
|
return Promise.reject(err)
|
|
111
116
|
})
|
|
112
117
|
} else {
|
|
113
118
|
// not a Promise
|
|
114
|
-
logFinished(callSignature, started, sma, logResultFn, res)
|
|
119
|
+
logFinished(logger, callSignature, started, sma, logResultFn, res)
|
|
115
120
|
return res
|
|
116
121
|
}
|
|
117
122
|
} catch (err) {
|
|
118
|
-
logFinished(callSignature, started, sma, logResultFn, undefined, err)
|
|
123
|
+
logFinished(logger, callSignature, started, sma, logResultFn, undefined, err)
|
|
119
124
|
throw err // rethrow
|
|
120
125
|
}
|
|
121
126
|
} as any
|
|
@@ -125,6 +130,7 @@ export function _LogMethod(opt: LogMethodOptions = {}): MethodDecorator {
|
|
|
125
130
|
}
|
|
126
131
|
|
|
127
132
|
function logFinished(
|
|
133
|
+
logger: CommonLogger,
|
|
128
134
|
callSignature: string,
|
|
129
135
|
started: number,
|
|
130
136
|
sma?: SimpleMovingAverage,
|
|
@@ -146,5 +152,5 @@ function logFinished(
|
|
|
146
152
|
t.push(...logResultFn(res))
|
|
147
153
|
}
|
|
148
154
|
|
|
149
|
-
|
|
155
|
+
logger.log(t.filter(Boolean).join(' '))
|
|
150
156
|
}
|
|
@@ -4,13 +4,20 @@
|
|
|
4
4
|
// http://inlehmansterms.net/2015/03/01/javascript-memoization/
|
|
5
5
|
// https://community.risingstack.com/the-worlds-fastest-javascript-memoization-library/
|
|
6
6
|
|
|
7
|
+
import { CommonLogger } from '../log/commonLogger'
|
|
7
8
|
import { _since } from '../time/time.util'
|
|
8
9
|
import { AnyObject } from '../types'
|
|
9
10
|
import { _getArgsSignature, _getMethodSignature, _getTargetMethodSignature } from './decorator.util'
|
|
10
11
|
import { jsonMemoSerializer, MapMemoCache, MemoCache } from './memo.util'
|
|
11
12
|
|
|
12
13
|
export interface MemoOptions {
|
|
14
|
+
/**
|
|
15
|
+
* Default to false
|
|
16
|
+
*/
|
|
13
17
|
logHit?: boolean
|
|
18
|
+
/**
|
|
19
|
+
* Default to false
|
|
20
|
+
*/
|
|
14
21
|
logMiss?: boolean
|
|
15
22
|
|
|
16
23
|
/**
|
|
@@ -18,6 +25,11 @@ export interface MemoOptions {
|
|
|
18
25
|
*/
|
|
19
26
|
noLogArgs?: boolean
|
|
20
27
|
|
|
28
|
+
/**
|
|
29
|
+
* Default to `console`
|
|
30
|
+
*/
|
|
31
|
+
logger?: CommonLogger
|
|
32
|
+
|
|
21
33
|
/**
|
|
22
34
|
* Provide a custom implementation of MemoCache.
|
|
23
35
|
* Function that creates an instance of `MemoCache`.
|
|
@@ -73,13 +85,14 @@ export const _Memo =
|
|
|
73
85
|
const cache = new Map<AnyObject, MemoCache>()
|
|
74
86
|
|
|
75
87
|
const {
|
|
76
|
-
logHit,
|
|
77
|
-
logMiss,
|
|
78
|
-
noLogArgs,
|
|
88
|
+
logHit = false,
|
|
89
|
+
logMiss = false,
|
|
90
|
+
noLogArgs = false,
|
|
91
|
+
logger = console,
|
|
79
92
|
cacheFactory = () => new MapMemoCache(),
|
|
80
93
|
cacheKeyFn = jsonMemoSerializer,
|
|
81
|
-
noCacheRejected,
|
|
82
|
-
noCacheResolved,
|
|
94
|
+
noCacheRejected = false,
|
|
95
|
+
noCacheResolved = false,
|
|
83
96
|
} = opt
|
|
84
97
|
|
|
85
98
|
const awaitPromise = Boolean(noCacheRejected || noCacheResolved)
|
|
@@ -95,11 +108,8 @@ export const _Memo =
|
|
|
95
108
|
cache.set(ctx, cacheFactory())
|
|
96
109
|
} else if (cache.get(ctx)!.has(cacheKey)) {
|
|
97
110
|
if (logHit) {
|
|
98
|
-
|
|
99
|
-
`${_getMethodSignature(ctx, keyStr)}(${_getArgsSignature(
|
|
100
|
-
args,
|
|
101
|
-
noLogArgs,
|
|
102
|
-
)}) @memoInstance hit`,
|
|
111
|
+
logger.log(
|
|
112
|
+
`${_getMethodSignature(ctx, keyStr)}(${_getArgsSignature(args, noLogArgs)}) @_Memo hit`,
|
|
103
113
|
)
|
|
104
114
|
}
|
|
105
115
|
|
|
@@ -121,11 +131,11 @@ export const _Memo =
|
|
|
121
131
|
.then(res => {
|
|
122
132
|
// console.log('RESOLVED', res)
|
|
123
133
|
if (logMiss) {
|
|
124
|
-
|
|
134
|
+
logger.log(
|
|
125
135
|
`${_getMethodSignature(ctx, keyStr)}(${_getArgsSignature(
|
|
126
136
|
args,
|
|
127
137
|
noLogArgs,
|
|
128
|
-
)}) @
|
|
138
|
+
)}) @_Memo miss resolved (${_since(started)})`,
|
|
129
139
|
)
|
|
130
140
|
}
|
|
131
141
|
|
|
@@ -138,11 +148,11 @@ export const _Memo =
|
|
|
138
148
|
.catch(err => {
|
|
139
149
|
// console.log('REJECTED', err)
|
|
140
150
|
if (logMiss) {
|
|
141
|
-
|
|
151
|
+
logger.log(
|
|
142
152
|
`${_getMethodSignature(ctx, keyStr)}(${_getArgsSignature(
|
|
143
153
|
args,
|
|
144
154
|
noLogArgs,
|
|
145
|
-
)}) @
|
|
155
|
+
)}) @_Memo miss rejected (${_since(started)})`,
|
|
146
156
|
)
|
|
147
157
|
}
|
|
148
158
|
|
|
@@ -157,11 +167,11 @@ export const _Memo =
|
|
|
157
167
|
})
|
|
158
168
|
} else {
|
|
159
169
|
if (logMiss) {
|
|
160
|
-
|
|
170
|
+
logger.log(
|
|
161
171
|
`${_getMethodSignature(ctx, keyStr)}(${_getArgsSignature(
|
|
162
172
|
args,
|
|
163
173
|
noLogArgs,
|
|
164
|
-
)}) @
|
|
174
|
+
)}) @_Memo miss (${_since(started)})`,
|
|
165
175
|
)
|
|
166
176
|
}
|
|
167
177
|
|
|
@@ -170,7 +180,7 @@ export const _Memo =
|
|
|
170
180
|
}
|
|
171
181
|
} as any
|
|
172
182
|
;(descriptor.value as any).dropCache = () => {
|
|
173
|
-
|
|
183
|
+
logger.log(`${methodSignature} @_Memo.dropCache()`)
|
|
174
184
|
cache.forEach(memoCache => memoCache.clear())
|
|
175
185
|
cache.clear()
|
|
176
186
|
}
|
package/src/decorators/memoFn.ts
CHANGED
|
@@ -12,11 +12,12 @@ export function _memoFn<T extends (...args: any[]) => any>(
|
|
|
12
12
|
opt: MemoOptions = {},
|
|
13
13
|
): T & MemoizedFunction {
|
|
14
14
|
const {
|
|
15
|
-
logHit,
|
|
16
|
-
logMiss,
|
|
17
|
-
noLogArgs,
|
|
18
|
-
|
|
19
|
-
|
|
15
|
+
logHit = false,
|
|
16
|
+
logMiss = false,
|
|
17
|
+
noLogArgs = false,
|
|
18
|
+
logger = console,
|
|
19
|
+
noCacheRejected = false,
|
|
20
|
+
noCacheResolved = false,
|
|
20
21
|
cacheFactory = () => new MapMemoCache(),
|
|
21
22
|
cacheKeyFn = jsonMemoSerializer,
|
|
22
23
|
} = opt
|
|
@@ -31,7 +32,7 @@ export function _memoFn<T extends (...args: any[]) => any>(
|
|
|
31
32
|
|
|
32
33
|
if (cache.has(cacheKey)) {
|
|
33
34
|
if (logHit) {
|
|
34
|
-
|
|
35
|
+
logger.log(`${fnName}(${_getArgsSignature(args, noLogArgs)}) memoFn hit`)
|
|
35
36
|
}
|
|
36
37
|
|
|
37
38
|
const res = cache.get(cacheKey)
|
|
@@ -52,7 +53,7 @@ export function _memoFn<T extends (...args: any[]) => any>(
|
|
|
52
53
|
.then(res => {
|
|
53
54
|
// console.log('RESOLVED', res)
|
|
54
55
|
if (logMiss) {
|
|
55
|
-
|
|
56
|
+
logger.log(
|
|
56
57
|
`${fnName}(${_getArgsSignature(args, noLogArgs)}) memoFn miss resolved (${_since(
|
|
57
58
|
started,
|
|
58
59
|
)})`,
|
|
@@ -68,7 +69,7 @@ export function _memoFn<T extends (...args: any[]) => any>(
|
|
|
68
69
|
.catch(err => {
|
|
69
70
|
// console.log('REJECTED', err)
|
|
70
71
|
if (logMiss) {
|
|
71
|
-
|
|
72
|
+
logger.log(
|
|
72
73
|
`${fnName}(${_getArgsSignature(args, noLogArgs)}) memoFn miss rejected (${_since(
|
|
73
74
|
started,
|
|
74
75
|
)})`,
|
|
@@ -86,8 +87,8 @@ export function _memoFn<T extends (...args: any[]) => any>(
|
|
|
86
87
|
}) as any
|
|
87
88
|
} else {
|
|
88
89
|
if (logMiss) {
|
|
89
|
-
|
|
90
|
-
`${fnName}(${_getArgsSignature(args, noLogArgs)})
|
|
90
|
+
logger.log(
|
|
91
|
+
`${fnName}(${_getArgsSignature(args, noLogArgs)}) memoFn miss (${_since(started)})`,
|
|
91
92
|
)
|
|
92
93
|
}
|
|
93
94
|
|
|
@@ -11,6 +11,7 @@ Otherwise resorts to JSON.stringify.
|
|
|
11
11
|
Benchmark shows similar perf for ObjectCache and MapCache.
|
|
12
12
|
*/
|
|
13
13
|
|
|
14
|
+
import { CommonLogger } from '../log/commonLogger'
|
|
14
15
|
import { _getArgsSignature, _getTargetMethodSignature } from './decorator.util'
|
|
15
16
|
import { jsonMemoSerializer, MapMemoCache, MemoCache } from './memo.util'
|
|
16
17
|
|
|
@@ -18,6 +19,7 @@ export interface MemoOpts {
|
|
|
18
19
|
logHit?: boolean
|
|
19
20
|
logMiss?: boolean
|
|
20
21
|
noLogArgs?: boolean
|
|
22
|
+
logger?: CommonLogger
|
|
21
23
|
}
|
|
22
24
|
|
|
23
25
|
// memoSimple decorator is NOT exported. Only used in benchmarks currently
|
|
@@ -55,7 +57,7 @@ export const memoSimple =
|
|
|
55
57
|
*/
|
|
56
58
|
const cache: MemoCache = new MapMemoCache()
|
|
57
59
|
|
|
58
|
-
const { logHit, logMiss, noLogArgs } = opt
|
|
60
|
+
const { logHit, logMiss, noLogArgs, logger = console } = opt
|
|
59
61
|
const keyStr = String(key)
|
|
60
62
|
const methodSignature = _getTargetMethodSignature(target, keyStr)
|
|
61
63
|
|
|
@@ -65,7 +67,7 @@ export const memoSimple =
|
|
|
65
67
|
|
|
66
68
|
if (cache.has(cacheKey)) {
|
|
67
69
|
if (logHit) {
|
|
68
|
-
|
|
70
|
+
logger.log(`${methodSignature}(${_getArgsSignature(args, noLogArgs)}) @memo hit`)
|
|
69
71
|
}
|
|
70
72
|
return cache.get(cacheKey)
|
|
71
73
|
}
|
|
@@ -75,7 +77,7 @@ export const memoSimple =
|
|
|
75
77
|
const res: any = originalFn.apply(ctx, args)
|
|
76
78
|
|
|
77
79
|
if (logMiss) {
|
|
78
|
-
|
|
80
|
+
logger.log(
|
|
79
81
|
`${methodSignature}(${_getArgsSignature(args, noLogArgs)}) @memo miss (${
|
|
80
82
|
Date.now() - d
|
|
81
83
|
} ms)`,
|
|
@@ -87,7 +89,7 @@ export const memoSimple =
|
|
|
87
89
|
return res
|
|
88
90
|
} as any
|
|
89
91
|
;(descriptor.value as any).dropCache = () => {
|
|
90
|
-
|
|
92
|
+
logger.log(`${methodSignature} @memo.dropCache()`)
|
|
91
93
|
cache.clear()
|
|
92
94
|
}
|
|
93
95
|
|
package/src/error/error.model.ts
CHANGED
|
@@ -43,6 +43,13 @@ export interface HttpErrorData extends ErrorData {
|
|
|
43
43
|
*/
|
|
44
44
|
httpStatusCode: number
|
|
45
45
|
|
|
46
|
+
/**
|
|
47
|
+
* @example
|
|
48
|
+
*
|
|
49
|
+
* GET /api/some-endpoint
|
|
50
|
+
*/
|
|
51
|
+
// endpoint?: string
|
|
52
|
+
|
|
46
53
|
/**
|
|
47
54
|
* Set to true when the error was thrown after response headers were sent.
|
|
48
55
|
*/
|
package/src/error/tryCatch.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { _since, _stringifyAny } from '../index'
|
|
1
|
+
import { _since, _stringifyAny, CommonLogger } from '../index'
|
|
2
2
|
import { AnyFunction } from '../types'
|
|
3
3
|
|
|
4
4
|
export interface TryCatchOptions {
|
|
@@ -17,6 +17,11 @@ export interface TryCatchOptions {
|
|
|
17
17
|
* @default true
|
|
18
18
|
*/
|
|
19
19
|
logError?: boolean
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* Default to `console`
|
|
23
|
+
*/
|
|
24
|
+
logger?: CommonLogger
|
|
20
25
|
}
|
|
21
26
|
|
|
22
27
|
/**
|
|
@@ -28,10 +33,7 @@ export interface TryCatchOptions {
|
|
|
28
33
|
* @experimental
|
|
29
34
|
*/
|
|
30
35
|
export function _tryCatch<T extends AnyFunction>(fn: T, opt: TryCatchOptions = {}): T {
|
|
31
|
-
const { onError, logError, logSuccess } =
|
|
32
|
-
logError: true,
|
|
33
|
-
...opt,
|
|
34
|
-
}
|
|
36
|
+
const { onError, logError = true, logSuccess = false, logger = console } = opt
|
|
35
37
|
|
|
36
38
|
const fname = fn.name || 'anonymous'
|
|
37
39
|
|
|
@@ -42,13 +44,13 @@ export function _tryCatch<T extends AnyFunction>(fn: T, opt: TryCatchOptions = {
|
|
|
42
44
|
const r = await fn.apply(this, args)
|
|
43
45
|
|
|
44
46
|
if (logSuccess) {
|
|
45
|
-
|
|
47
|
+
logger.log(`tryCatch.${fname} succeeded in ${_since(started)}`)
|
|
46
48
|
}
|
|
47
49
|
|
|
48
50
|
return r
|
|
49
51
|
} catch (err) {
|
|
50
52
|
if (logError) {
|
|
51
|
-
|
|
53
|
+
logger.warn(
|
|
52
54
|
`tryCatch.${fname} error in ${_since(started)}:\n${_stringifyAny(err, {
|
|
53
55
|
includeErrorData: true,
|
|
54
56
|
})}`,
|