Merge branch 'master' into gh-3078

content/ajv.ts

@@ -1,6 +1,6 @@
 // 2020 for prefixItems
 import AJV from 'ajv/dist/2020'
-import { discard, log } from './logger/simple'
+import { discard, log } from './logger'
 
 const options = {
   strict: false,

content/auto-export.ts

@@ -1,7 +1,7 @@
 Components.utils.import('resource://gre/modules/FileUtils.jsm')
 declare const FileUtils: any
 
-import { log } from './logger/simple'
+import { log } from './logger'
 
 import { Shim } from './os'
 import * as client from './client'
@@ -275,7 +275,6 @@ const queue = new class TaskQueue {
   }
 
   private async runAsync(path: string) {
-    log.debug('3065: scheduling', path)
     await Zotero.BetterBibTeX.ready
 
     const ae = AutoExport.get(path)
@@ -665,7 +664,6 @@ export const AutoExport = new class $AutoExport { // eslint-disable-line @typesc
   }
 
   public get(path: string): Job {
-    log.debug('3065: autoexport.get', path, blink.first(this.db, { where: { path }}))
     return blink.first(this.db, { where: { path }})
   }
 

content/better-bibtex.ts

@@ -458,7 +458,6 @@ $Patcher$.schedule(Zotero.Translate.Export.prototype, 'translate', original => f
   }
 
   const displayOptions = this._displayOptions || {}
-  log.debug('3065: displayOptions =', this._displayOptions)
 
   if (this.location) {
     if (displayOptions.exportFileData) { // when exporting file data, the user was asked to pick a directory rather than a file

content/clean_pane_persist.ts

@@ -1,4 +1,4 @@
-import { log } from './logger/simple'
+import { log } from './logger'
 
 import { is7 } from './client'
 export function clean_pane_persist(): void {

content/db/cache.ts

@@ -1,4 +1,4 @@
-import { log } from '../logger/simple'
+import { log } from '../logger'
 import { stringify } from '../stringify'
 
 import { is7, worker } from '../client'
@@ -364,9 +364,6 @@ class ZoteroSerialized {
       return true
     })
 
-    log.debug('3065: purge', purge.size)
-    log.debug('3065: fill', fill.length)
-
     let rejected = await allSettled([...purge].map(id => store.delete(id)))
     await touched.clear()
     await tx.commit()

content/flash.ts

@@ -1,4 +1,4 @@
-import { log } from './logger/simple'
+import { log } from './logger'
 
 const seconds = 1000
 

content/item-export-format.ts

@@ -2,7 +2,7 @@ import { Shim } from './os'
 import { is7 } from './client'
 const $OS = is7 ? Shim : OS
 
-import { log } from './logger/simple'
+import { log } from './logger'
 import { getItemsAsync } from './get-items-async'
 import type { Attachment, RegularItem, Item, Note } from '../gen/typings/serialized-item'
 export type Serialized = RegularItem | Attachment | Item

content/key-manager/chinese.ts

@@ -1,7 +1,7 @@
 import { Preference } from '../prefs'
 import { Events } from '../events'
 // import { CJK } from '../text'
-import { discard } from '../logger/simple'
+import { discard } from '../logger'
 
 declare const ChromeUtils: any
 

content/logger.ts

@@ -1,72 +1,109 @@
-/* eslint-disable @typescript-eslint/no-empty-function, no-restricted-syntax */
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-unsafe-return, @typescript-eslint/no-empty-function, no-restricted-syntax */
 
-import type { Translators as Translator } from '../typings/translators'
-declare const TranslationWorker: { job: Translator.Worker.Job }
-import { $dump, run } from './logger/simple'
+declare const Zotero: any
 
-import { stringify } from './stringify'
-import { worker } from './client'
+import * as client from './client'
+const version = require('./../gen/version.js')
+export const run = `<${version} ${client.run}>`
 
-function toString(obj): string {
-  try {
-    if (typeof obj === 'string') return obj
-    return stringify(obj, 0)
-  }
-  catch (err) {
-    return stringify(err, 0)
-  }
+declare const dump: (msg: string) => void
+
+export const discard = {
+  log(): void {},
+  error(): void {},
+  warn(): void {},
+  debug(): void {},
+  info(): void {},
+  clear(): void {},
+  dir(): void {},
+  table(): void {},
 }
 
-export const log = new class Logger {
-  protected timestamp: number
-  public prefix = ''
+function stringifyXPCOM(obj): string {
+  if (!obj.QueryInterface) return ''
+  if (obj.message) return `[XPCOM error ${ obj.message }]`
+  if (obj.name) return `[XPCOM object ${ obj.name }]`
+  return '[XPCOM object]'
+}
 
-  private format({ error = false }, msg) {
-    if (Array.isArray(msg)) msg = msg.map(toString).join(' ')
+function stringifyError(obj) {
+  if (obj instanceof Error) return `[error: ${ obj.message || '<unspecified error>' }\n${ obj.stack }]`
+  // guess it is an errorevent
+  if (obj.error instanceof Error && obj.message) return `[errorevent: ${ obj.message } ${ stringifyError(obj.error) }]`
+  if (typeof ErrorEvent !== 'undefined' && obj instanceof ErrorEvent) return `[errorevent: ${ obj.message || '<unspecified errorevent>' }]`
+  return ''
+}
 
-    let prefix = ''
-    if (worker) {
-      prefix += ' worker'
-      if (typeof TranslationWorker !== 'undefined') prefix += `:${ TranslationWorker.job.translator }`
+function replacer() {
+  const seen = new WeakSet
+  return (key, value) => {
+    if (typeof value === 'object' && value !== null) {
+      if (seen.has(value)) return '[Circular]'
+      seen.add(value)
     }
 
-    if (error) prefix += ' error:'
+    if (value === null) return value
+    if (value instanceof Set) return [...value]
+    if (value instanceof Map) return Object.fromEntries(value)
 
-    return `{better-bibtex ${run} ${ this.prefix }${ prefix }} ${ msg }`
-  }
+    switch (typeof value) {
+      case 'string':
+      case 'number':
+      case 'boolean':
+        return value
 
-  public get enabled(): boolean {
-    return (
-      (typeof TranslationWorker !== 'undefined' && TranslationWorker.job.debugEnabled)
-      || !Zotero
-      || Zotero.Debug?.enabled
-      || Zotero.Prefs?.get('debug.store')
-    ) as boolean
-  }
+      case 'object':
+        return stringifyXPCOM(value) || stringifyError(value) || value
+    }
 
-  public debug(...msg) {
-    Zotero.debug(this.format({}, msg))
+    if (Array.isArray(value)) return value
+
+    return undefined
   }
+}
 
-  public info(msg: string) {
-    Zotero.debug(this.format({}, msg))
+function to_s(obj: any): string {
+  if (typeof obj === 'string') return obj
+  return JSON.stringify(obj, replacer(), 2)
+}
+
+export function format(...msg): void {
+  msg.map(to_s).join(' ')
+}
+
+export const log = new class {
+  public prefix = ''
+
+  #prefix(error?: any) {
+    return `{${ error ? 'error: ' : '' }${ client.worker ? 'worker: ' : '' }${this.prefix}better-bibtex: ${run}} `
   }
 
-  public error(...msg) {
-    Zotero.debug(this.format({ error: true }, msg))
+  public debug(...msg): void {
+    Zotero.debug(`${this.#prefix()}${format(...msg)}\n`)
   }
 
-  public status({ error = false }, ...msg) {
-    if (error || this.enabled) Zotero.debug(this.format({ error }, msg))
+  public info(...msg): void {
+    Zotero.debug(`${this.#prefix()}${format(...msg)}\n`)
   }
 
-  public async timed(msg: string, code: () => void | Promise<void>) {
-    const start = Date.now()
-    await code()
-    this.debug(msg, 'took', Date.now() - start, 'ms')
+  public error(...msg): void {
+    Zotero.debug(`${this.#prefix(true)}${format(...msg)}\n`)
   }
 
-  public dump(msg: string) {
-    $dump(msg)
+  public dump(msg: string, error?: Error): void {
+    if (error) {
+      dump(`${this.#prefix(error)}${format(msg, error)}\n`)
+    }
+    else {
+      dump(`${this.#prefix()}${format(msg)}\n`)
+    }
   }
 }
+
+export function $dump(msg: string, error?: Error): void {
+  log.dump(msg, error)
+}
+
+export function trace(msg: string, mode = ''): void {
+  dump(`trace${ mode }\t${ Date.now() }\t${ msg }\n`)
+}

content/monkey-patch.ts

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-unsafe-function-type, prefer-rest-params, @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-unsafe-return, @typescript-eslint/no-shadow */
 
 export type Trampoline = Function & { disabled?: boolean }
-// import { log } from './logger/simple'
+// import { log } from './logger'
 
 type Patch = {
   object: any

content/translators.ts

@@ -43,7 +43,7 @@ declare const ZOTERO_CONFIG: any
 import type { Translators as Translator } from '../typings/translators'
 import { Preference } from './prefs'
 import { affects, Preferences } from '../gen/preferences/meta'
-import { log } from './logger/simple'
+import { log } from './logger'
 import { flash } from './flash'
 import { Events } from './events'
 import { Pinger } from './ping'
@@ -248,7 +248,6 @@ export const Translators = new class { // eslint-disable-line @typescript-eslint
       exportPath: job.path || undefined,
       exportDir: job.path ? $OS.Path.dirname(job.path) : undefined,
     }
-    log.debug('3065: tr.displayOptions =', displayOptions)
 
     if (job.translate) {
       // fake out the stuff that complete expects to be set by .translate