1664665 - Review EnigmailLog.data/getLogData and EnigmailConsole

Status: RESOLVED FIXED

(MailNews Core :: Security: OpenPGP, task, P2)

Description

[Mark Banner (:standard8)]

In looking through some of the Enigmail code that gets run on startup, I noticed that EnigmailLog.data (in log.jsm) gets initialised as an array, and appended to for every call to log a message (including processing the date object).

It is limited to 2500 messages, which is about ~350kb according to my about:memory.

It seems EnigmailLog.data was intended to be used by getLogData, but that doesn't appear to be used anywhere:

https://searchfox.org/comm-central/search?q=getLogData&path=&case=false&regexp=false

Should getLogData and EnigmailLog.data be dropped now?

Additionally, EnigmailConsole seems to be doing something similar, but with a string pipe that's limited to 32768 characters.

I think that EnigmailConsole data can be displayed on an about page, but I don't see how to get to it from within Thunderbird at the moment:

https://searchfox.org/comm-central/rev/cdb95f99696e2b0d3885bdb45b1c969820dd8d40/mail/extensions/openpgp/content/modules/protocolHandler.jsm#198

Longer term, it might be good to review Enigmail's logging and look to replace it with console.createInstance which creates a specific console instance and behaves like a normal console (this is based off Console.jsm).

Kaie/Patrick, could you advise please on what we need to keep or can get rid of for EnigmailLog/EnigmailConsole?

Comment 1

[Patrick Brunschwig]

In Enigmail, there is a dialog that allows you to display the log and save it to a file.
The console was used to display the command line calls of gpg.
But both dialogs don't exist in Thunderbird, and gpg is not called directly anymore.

Therefore, EnigmailConsole can certainly be removed entirely.

EnigmailLog is still partially in use. If you set

1. the pref "temp.openpgp.logDirectory" to a valid directory, and
2. the env var NSPR_LOG_MODULES=enigmail.js:5
   then you'll get a log file with all EnigmailLog.DEBUG() entries.

Comment 2

[Magnus Melin [:mkmelin]]

Attachment: Bug 1664665 - Remove EnigmailConsole. r=PatrickBrunschwig

Comment 3

[Magnus Melin [:mkmelin]]

Attachment: Bug 1664665 - Remove EnigmailLog.data/getLogData. r=PatrickBrunschwig

Depends on D111369

Comment 4

[Magnus Melin [:mkmelin]]

Attachment: Bug 1664665 - remove mail/extensions/openpgp/content/modules/searchCallback.jsm. r=PatrickBrunschwig

Comment 5

[Magnus Melin [:mkmelin]]

Attachment: Bug 1664665 - remove/inline mail/extensions/openpgp/content/modules/errorHandling.jsm. r=PatrickBrunschwig

This error handling is just small local methods. Moving it there means less complexity and more readability.

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/5ad8257d3c02
Remove EnigmailConsole. r=PatrickBrunschwig
https://hg.mozilla.org/comm-central/rev/438b02477534
Remove EnigmailLog.data/getLogData. r=PatrickBrunschwig
https://hg.mozilla.org/comm-central/rev/cede723c0d99
remove mail/extensions/openpgp/content/modules/searchCallback.jsm. r=PatrickBrunschwig
https://hg.mozilla.org/comm-central/rev/7ba95d2d89a7
remove/inline mail/extensions/openpgp/content/modules/errorHandling.jsm. r=PatrickBrunschwig