@nxtwebmasters/nxt-smart-logger
Version:
A configurable smart logger for web apps that supports server and Google Tag Manager (GTM) logging with user/session context.
289 lines (277 loc) • 13 kB
JavaScript
import { v4 } from 'uuid';
/******************************************************************************
Copyright (c) Microsoft Corporation.
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
***************************************************************************** */
/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
var __assign = function() {
__assign = Object.assign || function __assign(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
function __awaiter(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());
});
}
function __generator(thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
return g.next = verb(0), g["throw"] = verb(1), g["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 };
}
}
function __spreadArray(to, from, pack) {
if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
if (ar || !(i in from)) {
if (!ar) ar = Array.prototype.slice.call(from, 0, i);
ar[i] = from[i];
}
}
return to.concat(ar || Array.prototype.slice.call(from));
}
typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
var e = new Error(message);
return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
};
// src/ConsoleInterceptor.ts
var ConsoleInterceptor = /** @class */ (function () {
function ConsoleInterceptor(options) {
if (options === void 0) { options = {}; }
var _a, _b, _c;
this.logQueue = [];
this.logger = {};
this.defaultSessionId = v4();
this.generateTraceId = function () { return v4(); };
this.persistentContext = {};
this.persistentTags = [];
this.batchSize = options.batchSize || 5;
this.flushInterval = options.flushInterval || 5000;
this.enableGTM = (_a = options.enableGTM) !== null && _a !== void 0 ? _a : true;
this.enableServer = (_b = options.enableServer) !== null && _b !== void 0 ? _b : true;
this.contextProvider = options.contextProvider || (function () { return ({}); });
this.serverLogger = options.serverLogger || null;
this.customLevels = (((_c = options.filterLevels) === null || _c === void 0 ? void 0 : _c.length)
? ['log', 'error', 'warn', 'info', 'debug'].filter(function (lvl) { return options.filterLevels.includes(lvl); })
: ['log', 'error', 'warn', 'info', 'debug']).concat(options.customLevels || []);
if (options.generateTraceId) {
this.generateTraceId = options.generateTraceId;
}
this.originalConsole = {
log: console.log,
error: console.error,
warn: console.warn,
info: console.info,
debug: console.debug
};
this.overrideConsole();
this.setupFlushInterval();
this.setupCustomLogger();
}
ConsoleInterceptor.prototype.overrideConsole = function () {
var _this = this;
var _loop_1 = function (level) {
console[level] = function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i] = arguments[_i];
}
_this.originalConsole[level].apply(console, args);
_this.enqueueLog(level, args);
};
};
for (var _i = 0, _a = ['log', 'error', 'warn', 'info', 'debug']; _i < _a.length; _i++) {
var level = _a[_i];
_loop_1(level);
}
};
ConsoleInterceptor.prototype.setupCustomLogger = function () {
var _this = this;
var _loop_2 = function (level) {
this_1.logger[level] = function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i] = arguments[_i];
}
if (_this.originalConsole[level]) {
_this.originalConsole[level].apply(console, args);
}
_this.enqueueLog(level, args);
};
};
var this_1 = this;
for (var _i = 0, _a = this.customLevels; _i < _a.length; _i++) {
var level = _a[_i];
_loop_2(level);
}
this.logger.withTags = function (tags) {
return Object.fromEntries(_this.customLevels.map(function (level) { return [
level,
function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i] = arguments[_i];
}
_this.enqueueLog(level, args, tags);
}
]; }));
};
this.logger.withContext = function (extraContext) {
return Object.fromEntries(_this.customLevels.map(function (level) { return [
level,
function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i] = arguments[_i];
}
_this.enqueueLog(level, args, undefined, extraContext);
}
]; }));
};
this.logger.withMeta = function (extraMeta) {
return Object.fromEntries(_this.customLevels.map(function (level) { return [
level,
function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i] = arguments[_i];
}
_this.enqueueLog(level, args, undefined, undefined, extraMeta);
}
]; }));
};
this.logger.withAll = function (_a) {
var context = _a.context, tags = _a.tags, meta = _a.meta;
return Object.fromEntries(_this.customLevels.map(function (level) { return [
level,
function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i] = arguments[_i];
}
_this.enqueueLog(level, args, tags, context, meta);
}
]; }));
};
};
ConsoleInterceptor.prototype.setContext = function (ctx) {
this.persistentContext = __assign(__assign({}, this.persistentContext), ctx);
};
ConsoleInterceptor.prototype.clearContext = function () {
this.persistentContext = {};
};
ConsoleInterceptor.prototype.clearTags = function () {
this.persistentTags = [];
};
ConsoleInterceptor.prototype.getLogger = function () {
return this.logger;
};
ConsoleInterceptor.prototype.enqueueLog = function (level, args, tags, extraContext, extraMeta) {
if (extraContext === void 0) { extraContext = {}; }
if (extraMeta === void 0) { extraMeta = {}; }
var dynamicContext = this.contextProvider();
var context = __assign(__assign(__assign({}, this.persistentContext), dynamicContext), extraContext);
var sessionId = context.sessionId || this.defaultSessionId;
var traceId = context.traceId || this.generateTraceId();
var meta = __assign({ url: window.location.href, userAgent: navigator.userAgent, sessionId: sessionId, traceId: traceId }, extraMeta);
var data = null;
var messageParts = [];
for (var _i = 0, args_1 = args; _i < args_1.length; _i++) {
var arg = args_1[_i];
if (typeof arg === 'object' && arg !== null) {
data = __assign(__assign({}, data), arg);
messageParts.push(JSON.stringify(arg));
}
else {
messageParts.push(String(arg));
}
}
var log = {
level: level,
timestamp: new Date().toISOString(),
message: messageParts.join(' '),
tags: tags || this.persistentTags,
context: context,
meta: meta,
data: data
};
this.logQueue.push(log);
if (this.enableGTM && window.dataLayer) {
window.dataLayer.push({ event: 'console_log', log: log });
}
if (this.logQueue.length >= this.batchSize) {
this.flushLogs();
}
};
ConsoleInterceptor.prototype.setupFlushInterval = function () {
var _this = this;
setInterval(function () { return _this.flushLogs(); }, this.flushInterval);
};
ConsoleInterceptor.prototype.flushLogs = function () {
return __awaiter(this, void 0, void 0, function () {
var logsToSend;
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
if (!this.enableServer || !this.serverLogger || this.logQueue.length === 0)
return [2 /*return*/];
logsToSend = __spreadArray([], this.logQueue, true);
this.logQueue = [];
_b.label = 1;
case 1:
_b.trys.push([1, 3, , 4]);
return [4 /*yield*/, this.serverLogger(logsToSend)];
case 2:
_b.sent();
return [3 /*break*/, 4];
case 3:
_b.sent();
(_a = this.logQueue).unshift.apply(_a, logsToSend);
return [3 /*break*/, 4];
case 4: return [2 /*return*/];
}
});
});
};
return ConsoleInterceptor;
}());
export { ConsoleInterceptor };
//# sourceMappingURL=index.js.map