Add type annotations to LogItem
This commit is contained in:
RMidhunSuresh
parent
97ec680af2
commit
db792ab5a9
1 changed files with 270 additions and 0 deletions
270
src/logging/LogItem.ts
Normal file
270
src/logging/LogItem.ts
Normal file
|
|
@ -0,0 +1,270 @@
|
||||||
|
/*
|
||||||
|
Copyright 2020 Bruno Windels <bruno@windels.cloud>
|
||||||
|
Copyright 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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import {BaseLogger} from "./BaseLogger";
|
||||||
|
import {LogLevel, LogFilter} from "./LogFilter.js";
|
||||||
|
|
||||||
|
type LogItemValues = {l: string; [key: string]: unknown};
|
||||||
|
export type LabelOrValues = string | LogItemValues;
|
||||||
|
export type FilterCreator = ((filter: LogFilter, item: LogItem) => LogFilter) | null;
|
||||||
|
export type LogCallback = (item: LogItem) => Promise<unknown> | undefined;
|
||||||
|
|
||||||
|
export class LogItem {
|
||||||
|
public start: number;
|
||||||
|
public logLevel: LogLevel;
|
||||||
|
public error: Error | null;
|
||||||
|
public end: number | null;
|
||||||
|
private _values: LogItemValues;
|
||||||
|
private _logger: BaseLogger;
|
||||||
|
private _filterCreator: FilterCreator;
|
||||||
|
private _children: Array<LogItem> | null;
|
||||||
|
|
||||||
|
constructor(labelOrValues: LabelOrValues, logLevel: LogLevel, filterCreator: FilterCreator, logger: BaseLogger) {
|
||||||
|
this._logger = logger;
|
||||||
|
this.start = logger._now();
|
||||||
|
this.end = null;
|
||||||
|
// (l)abel
|
||||||
|
this._values = typeof labelOrValues === "string" ? {l: labelOrValues} : labelOrValues;
|
||||||
|
this.error = null;
|
||||||
|
this.logLevel = logLevel;
|
||||||
|
this._children = null;
|
||||||
|
this._filterCreator = filterCreator;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** start a new root log item and run it detached mode, see BaseLogger.runDetached */
|
||||||
|
runDetached(labelOrValues: LabelOrValues, callback: LogCallback, logLevel: LogLevel, filterCreator: FilterCreator) {
|
||||||
|
return this._logger.runDetached(labelOrValues, callback, logLevel, filterCreator);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** start a new detached root log item and log a reference to it from this item */
|
||||||
|
wrapDetached(labelOrValues: LabelOrValues, callback: LogCallback, logLevel: LogLevel, filterCreator: FilterCreator) {
|
||||||
|
this.refDetached(this.runDetached(labelOrValues, callback, logLevel, filterCreator));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** logs a reference to a different log item, usually obtained from runDetached.
|
||||||
|
This is useful if the referenced operation can't be awaited. */
|
||||||
|
refDetached(logItem: LogItem, logLevel: LogLevel | null = null) {
|
||||||
|
logItem.ensureRefId();
|
||||||
|
return this.log({ref: logItem._values.refId}, logLevel);
|
||||||
|
}
|
||||||
|
|
||||||
|
ensureRefId() {
|
||||||
|
if (!this._values.refId) {
|
||||||
|
this.set("refId", this._logger._createRefId());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a new child item and runs it in `callback`.
|
||||||
|
*/
|
||||||
|
wrap(labelOrValues: LabelOrValues, callback: LogCallback, logLevel: LogLevel | null = null, filterCreator: FilterCreator = null) {
|
||||||
|
const item = this.child(labelOrValues, logLevel, filterCreator);
|
||||||
|
return item.run(callback);
|
||||||
|
}
|
||||||
|
|
||||||
|
get duration() {
|
||||||
|
if (this.end) {
|
||||||
|
return this.end - this.start;
|
||||||
|
} else {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
durationWithoutType(type) {
|
||||||
|
return this.duration - this.durationOfType(type);
|
||||||
|
}
|
||||||
|
|
||||||
|
durationOfType(type) {
|
||||||
|
if (this._values.t === type) {
|
||||||
|
return this.duration;
|
||||||
|
} else if (this._children) {
|
||||||
|
return this._children.reduce((sum, c) => {
|
||||||
|
return sum + c.durationOfType(type);
|
||||||
|
}, 0);
|
||||||
|
} else {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a new child item that finishes immediately
|
||||||
|
* and can hence not be modified anymore.
|
||||||
|
*
|
||||||
|
* Hence, the child item is not returned.
|
||||||
|
*/
|
||||||
|
log(labelOrValues: LabelOrValues, logLevel: LogLevel | null = null) {
|
||||||
|
const item = this.child(labelOrValues, logLevel, null);
|
||||||
|
item.end = item.start;
|
||||||
|
}
|
||||||
|
|
||||||
|
set(key, value) {
|
||||||
|
if(typeof key === "object") {
|
||||||
|
const values = key;
|
||||||
|
Object.assign(this._values, values);
|
||||||
|
} else {
|
||||||
|
this._values[key] = value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
serialize(filter: LogFilter, parentStartTime: number | null = null, forced: boolean) {
|
||||||
|
if (this._filterCreator) {
|
||||||
|
try {
|
||||||
|
filter = this._filterCreator(new LogFilter(filter), this);
|
||||||
|
} catch (err) {
|
||||||
|
console.error("Error creating log filter", err);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
interface Item {
|
||||||
|
s: number;
|
||||||
|
d: number | null;
|
||||||
|
v: LogItemValues;
|
||||||
|
l: LogLevel;
|
||||||
|
e?: {
|
||||||
|
stack: string | undefined;
|
||||||
|
name: string;
|
||||||
|
message: string;
|
||||||
|
};
|
||||||
|
f?: boolean;
|
||||||
|
c?: Array<Item>;
|
||||||
|
};
|
||||||
|
let children: Array<Item> | null = null;
|
||||||
|
if (this._children !== null) {
|
||||||
|
children = this._children.reduce((array: Array<Item>, c) => {
|
||||||
|
const s = c.serialize(filter, this.start, false);
|
||||||
|
if (s) {
|
||||||
|
if (array === null) {
|
||||||
|
array = [];
|
||||||
|
}
|
||||||
|
array.push(s);
|
||||||
|
}
|
||||||
|
return array;
|
||||||
|
}, null);
|
||||||
|
}
|
||||||
|
if (filter && !filter.filter(this, children)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
// in (v)alues, (l)abel and (t)ype are also reserved.
|
||||||
|
const item: Item = {
|
||||||
|
// (s)tart
|
||||||
|
s: parentStartTime === null ? this.start : this.start - parentStartTime,
|
||||||
|
// (d)uration
|
||||||
|
d: this.duration,
|
||||||
|
// (v)alues
|
||||||
|
v: this._values,
|
||||||
|
// (l)evel
|
||||||
|
l: this.logLevel
|
||||||
|
};
|
||||||
|
if (this.error) {
|
||||||
|
// (e)rror
|
||||||
|
item.e = {
|
||||||
|
stack: this.error.stack,
|
||||||
|
name: this.error.name,
|
||||||
|
message: this.error.message.split("\n")[0]
|
||||||
|
};
|
||||||
|
}
|
||||||
|
if (forced) {
|
||||||
|
item.f = true; //(f)orced
|
||||||
|
}
|
||||||
|
if (children) {
|
||||||
|
// (c)hildren
|
||||||
|
item.c = children;
|
||||||
|
}
|
||||||
|
return item;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* You probably want to use `wrap` instead of this.
|
||||||
|
*
|
||||||
|
* Runs a callback passing this log item,
|
||||||
|
* recording the timing and any error.
|
||||||
|
*
|
||||||
|
* callback can return a Promise.
|
||||||
|
*
|
||||||
|
* Should only be called once.
|
||||||
|
*
|
||||||
|
* @param {Function} callback [description]
|
||||||
|
* @return {[type]} [description]
|
||||||
|
*/
|
||||||
|
run(callback: LogCallback) {
|
||||||
|
if (this.end !== null) {
|
||||||
|
console.trace("log item is finished, additional logs will likely not be recorded");
|
||||||
|
}
|
||||||
|
let result;
|
||||||
|
try {
|
||||||
|
result = callback(this);
|
||||||
|
if (result instanceof Promise) {
|
||||||
|
return result.then(promiseResult => {
|
||||||
|
this.finish();
|
||||||
|
return promiseResult;
|
||||||
|
}, err => {
|
||||||
|
throw this.catch(err);
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
this.finish();
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
} catch (err) {
|
||||||
|
throw this.catch(err);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* finished the item, recording the end time. After finishing, an item can't be modified anymore as it will be persisted.
|
||||||
|
* @internal shouldn't typically be called by hand. allows to force finish if a promise is still running when closing the app
|
||||||
|
*/
|
||||||
|
finish() {
|
||||||
|
if (this.end === null) {
|
||||||
|
if (this._children !== null) {
|
||||||
|
for(const c of this._children) {
|
||||||
|
c.finish();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
this.end = this._logger._now();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// expose log level without needing import everywhere
|
||||||
|
get level() {
|
||||||
|
return LogLevel;
|
||||||
|
}
|
||||||
|
|
||||||
|
catch(err: Error) {
|
||||||
|
this.error = err;
|
||||||
|
this.logLevel = LogLevel.Error;
|
||||||
|
this.finish();
|
||||||
|
return err;
|
||||||
|
}
|
||||||
|
|
||||||
|
child(labelOrValues: LabelOrValues, logLevel: LogLevel | null, filterCreator: FilterCreator) {
|
||||||
|
if (this.end !== null) {
|
||||||
|
console.trace("log item is finished, additional logs will likely not be recorded");
|
||||||
|
}
|
||||||
|
if (!logLevel) {
|
||||||
|
logLevel = this.logLevel || LogLevel.Info;
|
||||||
|
}
|
||||||
|
const item = new LogItem(labelOrValues, logLevel, filterCreator, this._logger);
|
||||||
|
if (this._children === null) {
|
||||||
|
this._children = [];
|
||||||
|
}
|
||||||
|
this._children.push(item);
|
||||||
|
return item;
|
||||||
|
}
|
||||||
|
|
||||||
|
get logger() {
|
||||||
|
return this._logger;
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in a new issue