@squiz/optimization-utils 4.7.0 → 4.8.0

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export * from './retries/Retries';
 export * from './object/getProperty';
 export * from './metadata/CopyReflection';
 export * from './measurement/performance';
+export * from './logging/Log';
 export * from './data-structures/Result';
 export * from './change-tracker/ChangeTracker';
 export * from './array/chunkify';

package/dist/index.js

@@ -19,6 +19,7 @@ __exportStar(require("./retries/Retries"), exports);
 __exportStar(require("./object/getProperty"), exports);
 __exportStar(require("./metadata/CopyReflection"), exports);
 __exportStar(require("./measurement/performance"), exports);
+__exportStar(require("./logging/Log"), exports);
 __exportStar(require("./data-structures/Result"), exports);
 __exportStar(require("./change-tracker/ChangeTracker"), exports);
 __exportStar(require("./array/chunkify"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gEAA8C;AAC9C,oDAAkC;AAClC,uDAAqC;AACrC,4DAA0C;AAC1C,4DAA0C;AAC1C,2DAAyC;AACzC,iEAA+C;AAC/C,mDAAiC;AACjC,iDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gEAA8C;AAC9C,oDAAkC;AAClC,uDAAqC;AACrC,4DAA0C;AAC1C,4DAA0C;AAC1C,gDAA8B;AAC9B,2DAAyC;AACzC,iEAA+C;AAC/C,mDAAiC;AACjC,iDAA+B"}

package/dist/logging/Log.d.ts

@@ -0,0 +1,18 @@
+import { Logger } from '@squiz/optimization-logger';
+type MetadataCallback = (...args: Array<any>) => Record<string, unknown>;
+type ErrorCallback = (error: unknown) => Record<string, unknown>;
+type SuccessCallback = (result: any, ...args: Array<any>) => Record<string, unknown>;
+export type LogOptions = {
+    before?: string;
+    success?: string;
+    error?: string;
+    metadata?: MetadataCallback;
+    errorMetadata?: ErrorCallback;
+    successMetadata?: SuccessCallback;
+    loggingLevel?: keyof Logger;
+    loggingSuccessLevel?: keyof Logger;
+    loggingErrorLevel?: keyof Logger;
+    loggingResultFailureAsError?: boolean;
+};
+export declare function Log(options: LogOptions): MethodDecorator;
+export {};

package/dist/logging/Log.js

@@ -0,0 +1,98 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Log = Log;
+const node_util_1 = __importDefault(require("node:util"));
+const inversify_1 = require("inversify");
+const optimization_logger_1 = require("@squiz/optimization-logger");
+const data_structures_1 = require("../data-structures");
+const CopyReflection_1 = require("../metadata/CopyReflection");
+function _log(callback, { args, logOptions, propertyKey, }, logger) {
+    const defaultError = 'Error while executing the method';
+    const metadata = logOptions.metadata?.(...args);
+    const loggingLevel = logOptions.loggingLevel ?? 'debug';
+    const successLoggingLevel = logOptions.loggingSuccessLevel ?? 'debug';
+    const errorLoggingLevel = logOptions.loggingErrorLevel ?? 'error';
+    const method = propertyKey;
+    const logError = (resultOrError) => {
+        const isResultFailure = resultOrError instanceof data_structures_1.Result && resultOrError.isFailure();
+        if (isResultFailure && !logOptions.loggingResultFailureAsError) {
+            return;
+        }
+        const error = isResultFailure ? resultOrError.error : resultOrError;
+        const errorMetadata = logOptions.errorMetadata?.(error);
+        logger[errorLoggingLevel]({
+            message: logOptions.error ?? defaultError,
+            error,
+            method,
+            ...metadata,
+            ...errorMetadata,
+        });
+    };
+    const logAfter = (v) => {
+        if (v instanceof data_structures_1.Result && v.isFailure()) {
+            logError(v);
+        }
+        else if (logOptions.success) {
+            const successMetadata = logOptions.successMetadata?.(v, ...args);
+            logger[successLoggingLevel]({
+                message: logOptions.success,
+                method,
+                ...metadata,
+                ...successMetadata,
+            });
+        }
+    };
+    if (logOptions.before) {
+        logger[loggingLevel]({
+            message: logOptions.before,
+            method,
+            ...metadata,
+        });
+    }
+    let result;
+    try {
+        result = callback();
+        if (!node_util_1.default.types.isPromise(result)) {
+            logAfter(result);
+            return result;
+        }
+    }
+    catch (e) {
+        logError(e);
+        throw e;
+    }
+    return result
+        .catch((e) => {
+        logError(e);
+        throw e;
+    })
+        .then((v) => {
+        logAfter(v);
+        return v;
+    });
+}
+function Log(options) {
+    return function (target, propertyKey, descriptor) {
+        const originalMethod = descriptor.value;
+        const injection = (0, inversify_1.inject)(optimization_logger_1.Logger);
+        const loggerSymbol = Symbol('logger');
+        if (!Reflect.has(target, loggerSymbol)) {
+            injection(target, loggerSymbol);
+        }
+        descriptor.value = function (...args) {
+            const logger = this[loggerSymbol] || (0, optimization_logger_1.createLogger)();
+            return _log(() => {
+                return originalMethod.apply(this, args);
+            }, {
+                logOptions: options,
+                propertyKey,
+                args,
+            }, logger);
+        };
+        CopyReflection_1.CopyReflection.copyPropertyMetadata(originalMethod, descriptor.value, propertyKey);
+    };
+}
+//# sourceMappingURL=Log.js.map

package/dist/logging/Log.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Log.js","sourceRoot":"","sources":["../../src/logging/Log.ts"],"names":[],"mappings":";;;;;AA0HA,kBAkCC;AA5JD,0DAA6B;AAC7B,yCAAmC;AACnC,oEAAkE;AAClE,wDAA4C;AAC5C,+DAA4D;AAY5D,SAAS,IAAI,CACX,QAA8B,EAC9B,EACE,IAAI,EACJ,UAAU,EACV,WAAW,GAKZ,EACD,MAAc;IAEd,MAAM,YAAY,GAAG,kCAAkC,CAAC;IACxD,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;IAChD,MAAM,YAAY,GAAG,UAAU,CAAC,YAAY,IAAI,OAAO,CAAC;IACxD,MAAM,mBAAmB,GAAG,UAAU,CAAC,mBAAmB,IAAI,OAAO,CAAC;IACtE,MAAM,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,IAAI,OAAO,CAAC;IAElE,MAAM,MAAM,GAAG,WAAW,CAAC;IAE3B,MAAM,QAAQ,GAAG,CAAC,aAAuB,EAAQ,EAAE;QACjD,MAAM,eAAe,GACnB,aAAa,YAAY,wBAAM,IAAI,aAAa,CAAC,SAAS,EAAE,CAAC;QAE/D,IAAI,eAAe,IAAI,CAAC,UAAU,CAAC,2BAA2B,EAAE,CAAC;YAC/D,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,eAAe,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC;QAEpE,MAAM,aAAa,GAAG,UAAU,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,CAAC;QAExD,MAAM,CAAC,iBAAiB,CAAC,CAAC;YACxB,OAAO,EAAE,UAAU,CAAC,KAAK,IAAI,YAAY;YACzC,KAAK;YACL,MAAM;YACN,GAAG,QAAQ;YACX,GAAG,aAAa;SACjB,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,CAAC,CAAU,EAAQ,EAAE;QACpC,IAAI,CAAC,YAAY,wBAAM,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC;YACzC,QAAQ,CAAC,CAAC,CAAC,CAAC;QACd,CAAC;aAAM,IAAI,UAAU,CAAC,OAAO,EAAE,CAAC;YAC9B,MAAM,eAAe,GAAG,UAAU,CAAC,eAAe,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;YAEjE,MAAM,CAAC,mBAAmB,CAAC,CAAC;gBAC1B,OAAO,EAAE,UAAU,CAAC,OAAO;gBAC3B,MAAM;gBACN,GAAG,QAAQ;gBACX,GAAG,eAAe;aACnB,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;IAEF,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;QACtB,MAAM,CAAC,YAAY,CAAC,CAAC;YACnB,OAAO,EAAE,UAAU,CAAC,MAAM;YAC1B,MAAM;YACN,GAAG,QAAQ;SACZ,CAAC,CAAC;IACL,CAAC;IAED,IAAI,MAAsB,CAAC;IAE3B,IAAI,CAAC;QACH,MAAM,GAAG,QAAQ,EAAE,CAAC;QAEpB,IAAI,CAAC,mBAAI,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;YAClC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAEjB,OAAO,MAAM,CAAC;QAChB,CAAC;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,QAAQ,CAAC,CAAC,CAAC,CAAC;QAEZ,MAAM,CAAC,CAAC;IACV,CAAC;IAED,OAAO,MAAM;SACV,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;QACX,QAAQ,CAAC,CAAC,CAAC,CAAC;QAEZ,MAAM,CAAC,CAAC;IACV,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;QACV,QAAQ,CAAC,CAAC,CAAC,CAAC;QACZ,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;AACP,CAAC;AAeD,SAAgB,GAAG,CAAC,OAAmB;IACrC,OAAO,UAAU,MAAM,EAAE,WAAW,EAAE,UAA8B;QAClE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,MAAM,SAAS,GAAG,IAAA,kBAAM,EAAC,4BAAM,CAAC,CAAC;QACjC,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;QAEtC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,CAAC;YACvC,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QAClC,CAAC;QAED,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAoB;YAClD,MAAM,MAAM,GACT,IAAmC,CAAC,YAAY,CAAC,IAAI,IAAA,kCAAY,GAAE,CAAC;YAEvE,OAAO,IAAI,CACT,GAAG,EAAE;gBACH,OAAO,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC1C,CAAC,EACD;gBACE,UAAU,EAAE,OAAO;gBACnB,WAAW;gBACX,IAAI;aACL,EACD,MAAM,CACP,CAAC;QACJ,CAAC,CAAC;QAEF,+BAAc,CAAC,oBAAoB,CACjC,cAAc,EACd,UAAU,CAAC,KAAK,EAChB,WAAW,CACZ,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/optimization-utils",
-  "version": "4.7.0",
+  "version": "4.8.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",