Merge branch 'master' into gh-3078

.eslintrc.js

@@ -36,7 +36,7 @@ const config = {
           singleline: { delimiter: 'semi', requireLast: false }
         }],
         '@stylistic/array-bracket-spacing': ['error', 'always', { singleValue: false }],
-        '@stylistic/object-curly-spacing': ['error', 'always', { arraysInObjects: false, objectsInObjects: false }],
+        '@stylistic/object-curly-spacing': 'off',
         '@stylistic/new-parens': ['error', 'never'],
         '@stylistic/quote-props': [ 'error', 'as-needed' ],
         '@stylistic/arrow-parens': [ 'error', 'as-needed' ],

.github/workflows/ci.yaml

@@ -31,6 +31,12 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: '3.10'
+        cache: pip
+    - name: install python packages
+      run: |
+        python -m pip install --upgrade pip
+        pip install packaging xvfbwrapper
+        pip install -r requirements.txt
     - name: install node
       uses: actions/setup-node@v4
       with:
@@ -43,15 +49,8 @@ jobs:
       with:
         path: |
           ~/.npm
-          ~/.nocache/pip
-          ${{ env.pythonLocation }}
-        key: ${{ runner.os }}-build-${{ env.pythonLocation }}-${{ env.cache-name }}-${{
-          hashFiles('package-lock.json') }}-${{ hashFiles('requirements.txt') }}
-    - name: install python packages
-      run: |
-        python -m pip install --upgrade pip
-        pip install packaging xvfbwrapper
-        pip install -r requirements.txt
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('package-lock.json')
+          }}-${{ hashFiles('requirements.txt') }}
     - name: install node packages
       run: npm install
 
@@ -130,6 +129,12 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: '3.10'
+        cache: pip
+    - name: install python packages
+      run: |
+        python -m pip install --upgrade pip
+        pip install packaging xvfbwrapper
+        pip install -r requirements.txt
     - name: Cache python/node dependencies
       id: cache
       uses: actions/cache@v4
@@ -138,15 +143,8 @@ jobs:
       with:
         path: |
           ~/.npm
-          ~/.nocache/pip
-          ${{ env.pythonLocation }}
-        key: ${{ runner.os }}-build-${{ env.pythonLocation }}-${{ env.cache-name }}-${{
-          hashFiles('package-lock.json') }}-${{ hashFiles('requirements.txt') }}
-    - name: install python packages
-      run: |
-        python -m pip install --upgrade pip
-        pip install packaging xvfbwrapper
-        pip install -r requirements.txt
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('package-lock.json')
+          }}-${{ hashFiles('requirements.txt') }}
 
     - name: install ${{ matrix.client }}
       run: |
@@ -221,6 +219,12 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: '3.10'
+        cache: pip
+    - name: install python packages
+      run: |
+        python -m pip install --upgrade pip
+        pip install packaging xvfbwrapper
+        pip install -r requirements.txt
     - name: install node
       uses: actions/setup-node@v4
       with:
@@ -233,15 +237,8 @@ jobs:
       with:
         path: |
           ~/.npm
-          ~/.nocache/pip
-          ${{ env.pythonLocation }}
-        key: ${{ runner.os }}-build-${{ env.pythonLocation }}-${{ env.cache-name }}-${{
-          hashFiles('package-lock.json') }}-${{ hashFiles('requirements.txt') }}
-    - name: install python packages
-      run: |
-        python -m pip install --upgrade pip
-        pip install packaging xvfbwrapper
-        pip install -r requirements.txt
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('package-lock.json')
+          }}-${{ hashFiles('requirements.txt') }}
     - name: install node packages
       run: npm install
 
@@ -274,6 +271,12 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: '3.10'
+        cache: pip
+    - name: install python packages
+      run: |
+        python -m pip install --upgrade pip
+        pip install packaging xvfbwrapper
+        pip install -r requirements.txt
     - name: fetch test artifacts
       uses: actions/download-artifact@v4
       with:

.github/workflows/src/ci.yaml

@@ -15,6 +15,7 @@ _anchors:
     uses: actions/setup-python@v5
     with:
       python-version: '3.10'
+      cache: 'pip'
   install_node: &install_node
     name: install node
     uses: actions/setup-node@v4
@@ -29,9 +30,7 @@ _anchors:
     with:
       path: |
         ~/.npm
-        ~/.nocache/pip
-        ${{ env.pythonLocation }}
-      key: ${{ runner.os }}-build-${{ env.pythonLocation }}-${{ env.cache-name }}-${{ hashFiles('package-lock.json') }}-${{ hashFiles('requirements.txt') }}
+      key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('package-lock.json') }}-${{ hashFiles('requirements.txt') }}
   install_python_packages: &install_python_packages
     name: install python packages
     run: |
@@ -63,9 +62,9 @@ jobs:
       if: github.event.head_commit.message == env.version && !startsWith(github.ref, 'refs/tags/')
 
     - *install_python
+    - *install_python_packages
     - *install_node
     - *cache
-    - *install_python_packages
     - *install_node_packages
     - name: set slow/legacy/beta flags
       run: ./util/action-flags
@@ -133,8 +132,8 @@ jobs:
       with:
         name: build-artifacts
     - *install_python
-    - *cache
     - *install_python_packages
+    - *cache
 
     - name: install ${{ matrix.client }}
       run: |
@@ -200,9 +199,9 @@ jobs:
       with:
         name: build-artifacts
     - *install_python
+    - *install_python_packages
     - *install_node
     - *cache
-    - *install_python_packages
     - *install_node_packages
 
     - run: npm run release
@@ -230,6 +229,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - *install_python
+    - *install_python_packages
     - name: fetch test artifacts
       uses: actions/download-artifact@v4
       with:

content/ZoteroPane.ts

@@ -127,7 +127,7 @@ class ZoteroPane {
         const items = zp.getSelectedItems()
         toClipboard(await Translators.queueJob({
           translatorID,
-          displayOptions: {},
+          displayOptions: { worker: true },
           scope: { type: 'items', items },
         }))
       }
@@ -414,7 +414,7 @@ class ZoteroPane {
       try {
         return await Translators.queueJob({
           translatorID: Translators.bySlug.BetterBibTeXJSON.translatorID,
-          displayOptions: { exportNotes: true, dropAttachments: true, Normalize: true },
+          displayOptions: { worker: true, exportNotes: true, dropAttachments: true, Normalize: true },
           scope,
           timeout: 40,
         })

content/auto-export.ts

@@ -305,6 +305,7 @@ const queue = new class TaskQueue {
         useJournalAbbreviation: ae.useJournalAbbreviation,
         biblatexAPA: ae.biblatexAPA || false,
         biblatexChicago: ae.biblatexChicago || false,
+        worker: true,
       }
 
       const jobs: ExportJob[] = [{

content/better-bibtex.ts

@@ -498,7 +498,7 @@ $Patcher$.schedule(Zotero.Translate.Export.prototype, 'translate', original => f
   if (useWorker) {
     return Translators.queueJob({
       translatorID,
-      displayOptions,
+      displayOptions: {...displayOptions, worker: true},
       translate: this,
       scope: { ...this._export, getter: this._itemGetter },
       path: this.location?.path,

content/cayw/formatter.ts

@@ -285,6 +285,7 @@ export const Formatter = new class { // eslint-disable-line @typescript-eslint/n
     const displayOptions = {
       exportNotes: [ 'yes', 'y', 'true' ].includes((options.exportNotes || '').toLowerCase()),
       useJournalAbbreviation: [ 'yes', 'y', 'true' ].includes((options.useJournalAbbreviation || '').toLowerCase()),
+      worker: !options.worker || [ 'yes', 'y', 'true' ].includes((options.worker || '').toLowerCase()),
     }
 
     return await Translators.queueJob({ translatorID, displayOptions, scope: { type: 'items', items }})

content/json-rpc.ts

@@ -495,7 +495,7 @@ class NSItem {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-return
     return await Translators.queueJob({
       translatorID: Translators.getTranslatorId(translator),
-      displayOptions: {},
+      displayOptions: { worker: true },
       scope: { type: 'items', items: await getItemsAsync(found.map(key => key.itemID)) }, // eslint-disable-line @typescript-eslint/no-unsafe-return
     })
   }
@@ -537,7 +537,7 @@ class NSItem {
       // I need the cleanup BCJ does
       const csl = JSON.parse(await Translators.queueJob({
         translatorID: Translators.getTranslatorId('Better CSL JSON'),
-        displayOptions: { custom: true },
+        displayOptions: { worker: true, custom: true },
         scope: { type: 'items', items },
       }))
 

content/logger.ts

@@ -67,8 +67,8 @@ function to_s(obj: any): string {
   return JSON.stringify(obj, replacer(), 2)
 }
 
-export function format(...msg): void {
-  msg.map(to_s).join(' ')
+export function format(...msg): string {
+  return msg.map(to_s).join(' ')
 }
 
 export const log = new class {

content/translators.ts

@@ -4,6 +4,7 @@ import { Shim } from './os'
 import * as client from './client'
 const $OS = client.is7 ? Shim : OS
 import merge from 'lodash.merge'
+import { pick } from './object'
 import { Cache } from './db/cache'
 import { Serializer } from './item-export-format'
 
@@ -224,25 +225,14 @@ export const Translators = new class { // eslint-disable-line @typescript-eslint
   }
 
   public async queueJob(job: ExportJob): Promise<string> {
-    return await this.queue.add(async () => {
-      const translator = this.byId[job.translatorID]
-      const displayOptions = this.displayOptions(job.translatorID, job.displayOptions)
-      if (typeof translator?.displayOptions.worker === 'boolean' && displayOptions.worker) {
-        return await this.exportItemsByWorker(job)
-      }
-      else {
-        return await this.exportItems(job)
-      }
-    })
+    return await this.queue.add(() => this.exportItems(job))
   }
 
   private async exportItemsByWorker(job: ExportJob): Promise<string> {
-    // trace('exportItemsByWorker: requested')
     if (job.path && job.canceled) return ''
     await Zotero.BetterBibTeX.ready
     if (job.path && job.canceled) return ''
 
-    // trace('exportItemsByWorker: preparing')
     const displayOptions = {
       ...this.displayOptions(job.translatorID, job.displayOptions),
       exportPath: job.path || undefined,
@@ -372,9 +362,7 @@ export const Translators = new class { // eslint-disable-line @typescript-eslint
         },
       })
 
-      // trace('exportItemsByWorker: starting cache completion')
       await Cache.ZoteroSerialized.fill(items, this.serializer)
-      // trace('exportItemsByWorker: cache completion completed')
 
       config.data.items = items.map(item => item.id)
       prepare.update()
@@ -391,7 +379,6 @@ export const Translators = new class { // eslint-disable-line @typescript-eslint
 
       prepare.done()
 
-      // trace('exportItemsByWorker: prepare finished')
       this.worker.postMessage({ kind: 'start', config })
 
       if (typeof job.timeout === 'number') {
@@ -413,13 +400,15 @@ export const Translators = new class { // eslint-disable-line @typescript-eslint
   }
 
   public displayOptions(translatorID: string, displayOptions: any): any {
-    return merge({}, this.byId[translatorID]?.displayOptions || {}, displayOptions)
+    const defaults = this.byId[translatorID]?.displayOptions || {}
+    return pick(merge({}, defaults, displayOptions), Object.keys(defaults))
   }
 
-  private async exportItems(job: ExportJob): Promise<string> {
+  public async exportItems(job: ExportJob): Promise<string> {
     await Zotero.BetterBibTeX.ready
 
     const displayOptions = this.displayOptions(job.translatorID, job.displayOptions)
+    if (displayOptions.worker) return await this.exportItemsByWorker(job)
 
     const translation = new Zotero.Translate.Export