nestjs-logtime-decorator
Version:
Typescript decorator to log the duration of a method, for NestJs.
143 lines (142 loc) • 6.66 kB
JavaScript
;
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.MeasureTime = exports.MeasureTimeAsync = void 0;
var common_1 = require("@nestjs/common");
function getContextString(context, requestArgs, response) {
return context
.map(function (c) {
switch (c.from) {
case 'Request':
return "".concat(c.key, ": ").concat(requestArgs[0][c.key]);
case 'Response':
return "".concat(c.key, ": ").concat(response[c.key]);
default:
throw new Error("Invalid context from: ".concat(c.from));
}
})
.join(', ');
}
/**
* Log the time a method takes to execute.
*/
function logTime(options, args, responseBody, timeLabel, isError, startTime, target) {
var contextStr = getContextString(options.context, args, responseBody);
common_1.Logger.log("".concat(contextStr ? "[".concat(contextStr, "]") : '', " ").concat(timeLabel, " ").concat(isError ? '(error) ' : '', "took ").concat(Date.now() - startTime, "ms"), target.constructor.name);
}
/**
* Decorator to log the time an async method takes to execute.
* Only work on methods of a class.
* Always place it AFTER the @Get, @Post, @Put, @Delete, etc. decorators.
*/
function MeasureTimeAsync(options) {
if (options === void 0) { options = {
context: []
}; }
return function (target, propertyKey, descriptor) {
var original = descriptor.value;
var timeLabel = propertyKey;
descriptor.value = function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i] = arguments[_i];
}
return __awaiter(this, void 0, void 0, function () {
var startTime, responseBody, isError, e_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
startTime = Date.now();
responseBody = '';
isError = false;
_a.label = 1;
case 1:
_a.trys.push([1, 3, 4, 5]);
return [4 /*yield*/, (original === null || original === void 0 ? void 0 : original.apply(this, args))];
case 2:
responseBody = _a.sent();
return [3 /*break*/, 5];
case 3:
e_1 = _a.sent();
isError = true;
throw e_1;
case 4:
logTime(options, args, responseBody, timeLabel, isError, startTime, target);
return [7 /*endfinally*/];
case 5: return [2 /*return*/, responseBody];
}
});
});
};
};
}
exports.MeasureTimeAsync = MeasureTimeAsync;
/**
* Decorator to log the time a sync method takes to execute.
* Only work on methods of a class.
* Always place it AFTER the @Get, @Post, @Put, @Delete, etc. decorators.
*/
function MeasureTime(options) {
if (options === void 0) { options = {
context: []
}; }
return function (target, propertyKey, descriptor) {
var original = descriptor.value;
var timeLabel = propertyKey;
descriptor.value = function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i] = arguments[_i];
}
var startTime = Date.now();
var responseBody = '';
var isError = false;
try {
responseBody = original === null || original === void 0 ? void 0 : original.apply(this, args);
}
catch (e) {
isError = true;
throw e;
}
finally {
logTime(options, args, responseBody, timeLabel, isError, startTime, target);
}
};
};
}
exports.MeasureTime = MeasureTime;