summaryrefslogtreecommitdiffstats
path: root/comm/chat/protocols/matrix/lib/matrix-sdk/logger.js
diff options
context:
space:
mode:
Diffstat (limited to 'comm/chat/protocols/matrix/lib/matrix-sdk/logger.js')
-rw-r--r--comm/chat/protocols/matrix/lib/matrix-sdk/logger.js80
1 files changed, 80 insertions, 0 deletions
diff --git a/comm/chat/protocols/matrix/lib/matrix-sdk/logger.js b/comm/chat/protocols/matrix/lib/matrix-sdk/logger.js
new file mode 100644
index 0000000000..5946410754
--- /dev/null
+++ b/comm/chat/protocols/matrix/lib/matrix-sdk/logger.js
@@ -0,0 +1,80 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+ value: true
+});
+exports.logger = void 0;
+var _loglevel = _interopRequireDefault(require("loglevel"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/*
+Copyright 2018 André Jaenisch
+Copyright 2019, 2021 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// This is to demonstrate, that you can use any namespace you want.
+// Namespaces allow you to turn on/off the logging for specific parts of the
+// application.
+// An idea would be to control this via an environment variable (on Node.js).
+// See https://www.npmjs.com/package/debug to see how this could be implemented
+// Part of #332 is introducing a logging library in the first place.
+const DEFAULT_NAMESPACE = "matrix";
+
+// because rageshakes in react-sdk hijack the console log, also at module load time,
+// initializing the logger here races with the initialization of rageshakes.
+// to avoid the issue, we override the methodFactory of loglevel that binds to the
+// console methods at initialization time by a factory that looks up the console methods
+// when logging so we always get the current value of console methods.
+_loglevel.default.methodFactory = function (methodName, logLevel, loggerName) {
+ return function (...args) {
+ /* eslint-disable @typescript-eslint/no-invalid-this */
+ if (this.prefix) {
+ args.unshift(this.prefix);
+ }
+ /* eslint-enable @typescript-eslint/no-invalid-this */
+ const supportedByConsole = methodName === "error" || methodName === "warn" || methodName === "trace" || methodName === "info";
+ /* eslint-disable no-console */
+ if (supportedByConsole) {
+ return console[methodName](...args);
+ } else {
+ return console.log(...args);
+ }
+ /* eslint-enable no-console */
+ };
+};
+
+/**
+ * Drop-in replacement for `console` using {@link https://www.npmjs.com/package/loglevel|loglevel}.
+ * Can be tailored down to specific use cases if needed.
+ */
+const logger = _loglevel.default.getLogger(DEFAULT_NAMESPACE);
+exports.logger = logger;
+logger.setLevel(_loglevel.default.levels.DEBUG, false);
+function extendLogger(logger) {
+ logger.withPrefix = function (prefix) {
+ const existingPrefix = this.prefix || "";
+ return getPrefixedLogger(existingPrefix + prefix);
+ };
+}
+extendLogger(logger);
+function getPrefixedLogger(prefix) {
+ const prefixLogger = _loglevel.default.getLogger(`${DEFAULT_NAMESPACE}-${prefix}`);
+ if (prefixLogger.prefix !== prefix) {
+ // Only do this setup work the first time through, as loggers are saved by name.
+ extendLogger(prefixLogger);
+ prefixLogger.prefix = prefix;
+ prefixLogger.setLevel(_loglevel.default.levels.DEBUG, false);
+ }
+ return prefixLogger;
+} \ No newline at end of file