blob: 53ca7208b16c837fb18036765ad9ae550a1ba7c3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
"use strict";
const EXPORTED_SYMBOLS = ["Log"];
const StdLog = ChromeUtils.import("resource://gre/modules/Log.jsm", {}).Log;
const PREF_LOG_LEVEL = "marionette.log.level";
/**
* Shorthand for accessing the Marionette logging repository.
*
* Using this class to retrieve the `Log.jsm` repository for
* Marionette will ensure the logger is set up correctly with the
* appropriate stdout dumper and with the correct log level.
*
* Unlike `Log.jsm` this logger is E10s safe, meaning repository
* configuration is communicated across processes.
*/
class Log {
/**
* Obtain the `Marionette` logger.
*
* The returned {@link Logger} instance is shared among all
* callers in the same process.
*
* @return {Logger}
*/
static get() {
let logger = StdLog.repository.getLogger("Marionette");
if (logger.ownAppenders.length == 0) {
logger.addAppender(new StdLog.DumpAppender());
logger.manageLevelFromPref(PREF_LOG_LEVEL);
}
return logger;
}
/**
* Obtain a logger that logs all messages with a prefix.
*
* Unlike {@link LoggerRepository.getLoggerWithMessagePrefix()}
* this function will ensure invoke {@link #get()} first to ensure
* the logger has been properly set up.
*
* This returns a new object with a prototype chain that chains
* up the original {@link Logger} instance. The new prototype has
* log functions that prefix `prefix` to each message.
*
* @param {string} prefix
* String to prefix each logged message with.
*
* @return {Proxy.<Logger>}
*/
static getWithPrefix(prefix) {
this.get();
return StdLog.repository.getLoggerWithMessagePrefix(
"Marionette",
`[${prefix}] `
);
}
}
this.Log = Log;
|
