2021-02-12 13:04:05 +01:00
|
|
|
/*
|
|
|
|
Copyright 2020 Bruno Windels <bruno@windels.cloud>
|
2021-03-01 15:01:43 +01:00
|
|
|
Copyright 2021 The Matrix.org Foundation C.I.C.
|
2021-02-12 13:04:05 +01:00
|
|
|
|
|
|
|
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.
|
|
|
|
*/
|
|
|
|
|
|
|
|
import {LogItem} from "./LogItem.js";
|
2021-02-16 15:07:17 +01:00
|
|
|
import {LogLevel, LogFilter} from "./LogFilter.js";
|
2021-11-09 08:30:37 +01:00
|
|
|
import {Platform} from "../platform/web/Platform.js";
|
2021-02-12 13:04:05 +01:00
|
|
|
|
|
|
|
export class BaseLogger {
|
2021-11-09 08:30:37 +01:00
|
|
|
protected _openItems: Set<LogItem>;
|
|
|
|
protected _platform: Platform;
|
|
|
|
|
2021-02-12 18:55:37 +01:00
|
|
|
constructor({platform}) {
|
2021-02-12 13:04:05 +01:00
|
|
|
this._openItems = new Set();
|
|
|
|
this._platform = platform;
|
2021-02-16 11:37:48 +01:00
|
|
|
}
|
|
|
|
|
2021-02-18 19:46:40 +01:00
|
|
|
log(labelOrValues, logLevel = LogLevel.Info) {
|
2021-02-23 15:27:55 +01:00
|
|
|
const item = new LogItem(labelOrValues, logLevel, null, this);
|
2021-02-18 19:46:40 +01:00
|
|
|
item._end = item._start;
|
2021-03-01 15:01:43 +01:00
|
|
|
this._persistItem(item, null, false);
|
2021-02-18 19:46:40 +01:00
|
|
|
}
|
|
|
|
|
2021-02-23 19:23:12 +01:00
|
|
|
/** if item is a log item, wrap the callback in a child of it, otherwise start a new root log item. */
|
2021-02-23 15:27:55 +01:00
|
|
|
wrapOrRun(item, labelOrValues, callback, logLevel = null, filterCreator = null) {
|
|
|
|
if (item) {
|
|
|
|
return item.wrap(labelOrValues, callback, logLevel, filterCreator);
|
|
|
|
} else {
|
|
|
|
return this.run(labelOrValues, callback, logLevel, filterCreator);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-02-23 19:23:12 +01:00
|
|
|
/** run a callback in detached mode,
|
|
|
|
where the (async) result or errors are not propagated but still logged.
|
|
|
|
Useful to pair with LogItem.refDetached.
|
|
|
|
|
|
|
|
@return {LogItem} the log item added, useful to pass to LogItem.refDetached */
|
2021-02-23 15:27:55 +01:00
|
|
|
runDetached(labelOrValues, callback, logLevel = null, filterCreator = null) {
|
|
|
|
if (logLevel === null) {
|
|
|
|
logLevel = LogLevel.Info;
|
|
|
|
}
|
|
|
|
const item = new LogItem(labelOrValues, logLevel, null, this);
|
|
|
|
this._run(item, callback, logLevel, filterCreator, false /* don't throw, nobody is awaiting */);
|
|
|
|
return item;
|
|
|
|
}
|
|
|
|
|
2021-02-23 19:23:12 +01:00
|
|
|
/** run a callback wrapped in a log operation.
|
|
|
|
Errors and duration are transparently logged, also for async operations.
|
|
|
|
Whatever the callback returns is returned here. */
|
2021-02-23 15:27:55 +01:00
|
|
|
run(labelOrValues, callback, logLevel = null, filterCreator = null) {
|
|
|
|
if (logLevel === null) {
|
|
|
|
logLevel = LogLevel.Info;
|
|
|
|
}
|
|
|
|
const item = new LogItem(labelOrValues, logLevel, null, this);
|
|
|
|
return this._run(item, callback, logLevel, filterCreator, true);
|
|
|
|
}
|
|
|
|
|
|
|
|
_run(item, callback, logLevel, filterCreator, shouldThrow) {
|
2021-02-12 18:36:04 +01:00
|
|
|
this._openItems.add(item);
|
2021-02-12 13:04:05 +01:00
|
|
|
|
|
|
|
const finishItem = () => {
|
2021-02-16 15:07:17 +01:00
|
|
|
let filter = new LogFilter();
|
|
|
|
if (filterCreator) {
|
2021-02-16 18:36:41 +01:00
|
|
|
try {
|
2021-02-18 19:46:40 +01:00
|
|
|
filter = filterCreator(filter, item);
|
2021-02-16 18:36:41 +01:00
|
|
|
} catch (err) {
|
|
|
|
console.error("Error while creating log filter", err);
|
|
|
|
}
|
2021-02-16 15:07:17 +01:00
|
|
|
} else {
|
|
|
|
// if not filter is specified, filter out anything lower than the initial log level
|
|
|
|
filter = filter.minLevel(logLevel);
|
|
|
|
}
|
2021-02-16 18:30:23 +01:00
|
|
|
try {
|
2021-03-01 15:01:43 +01:00
|
|
|
this._persistItem(item, filter, false);
|
2021-02-16 18:30:23 +01:00
|
|
|
} catch (err) {
|
2021-03-01 15:01:43 +01:00
|
|
|
console.error("Could not persist log item", err);
|
2021-02-12 14:05:51 +01:00
|
|
|
}
|
2021-02-12 18:36:04 +01:00
|
|
|
this._openItems.delete(item);
|
2021-02-12 13:04:05 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
try {
|
|
|
|
const result = item.run(callback);
|
|
|
|
if (result instanceof Promise) {
|
|
|
|
return result.then(promiseResult => {
|
|
|
|
finishItem();
|
|
|
|
return promiseResult;
|
|
|
|
}, err => {
|
|
|
|
finishItem();
|
2021-02-23 15:27:55 +01:00
|
|
|
if (shouldThrow) {
|
|
|
|
throw err;
|
|
|
|
}
|
2021-02-12 13:04:05 +01:00
|
|
|
});
|
|
|
|
} else {
|
|
|
|
finishItem();
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
} catch (err) {
|
|
|
|
finishItem();
|
2021-02-23 15:27:55 +01:00
|
|
|
if (shouldThrow) {
|
|
|
|
throw err;
|
|
|
|
}
|
2021-02-12 13:04:05 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-02-12 14:05:51 +01:00
|
|
|
_finishOpenItems() {
|
|
|
|
for (const openItem of this._openItems) {
|
|
|
|
openItem.finish();
|
2021-02-16 18:30:23 +01:00
|
|
|
try {
|
2021-02-16 19:53:37 +01:00
|
|
|
// for now, serialize with an all-permitting filter
|
|
|
|
// as the createFilter function would get a distorted image anyway
|
|
|
|
// about the duration of the item, etc ...
|
2021-03-01 15:01:43 +01:00
|
|
|
// true for force finish
|
|
|
|
this._persistItem(openItem, new LogFilter(), true);
|
2021-02-16 18:30:23 +01:00
|
|
|
} catch (err) {
|
2021-02-16 18:36:41 +01:00
|
|
|
console.error("Could not serialize log item", err);
|
2021-02-12 14:05:51 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
this._openItems.clear();
|
|
|
|
}
|
|
|
|
|
|
|
|
_persistItem() {
|
2021-02-12 13:04:05 +01:00
|
|
|
throw new Error("not implemented");
|
|
|
|
}
|
|
|
|
|
|
|
|
async export() {
|
|
|
|
throw new Error("not implemented");
|
|
|
|
}
|
2021-02-12 16:08:07 +01:00
|
|
|
|
2021-02-12 14:05:51 +01:00
|
|
|
// expose log level without needing
|
|
|
|
get level() {
|
|
|
|
return LogLevel;
|
|
|
|
}
|
2021-02-23 15:27:55 +01:00
|
|
|
|
|
|
|
_now() {
|
|
|
|
return this._platform.clock.now();
|
|
|
|
}
|
2021-02-24 10:14:14 +01:00
|
|
|
|
|
|
|
_createRefId() {
|
|
|
|
return Math.round(this._platform.random() * Number.MAX_SAFE_INTEGER);
|
|
|
|
}
|
2021-02-12 13:04:05 +01:00
|
|
|
}
|