Disabled Data functionality

[konki-vienna]

When adding require('sketch/dom').getSelectedDocument() to the code of a Data Plugin, the Data Plugin part of that plugin gets disabled (through Sketch) without the possibility to enable it again (through the user).

Environment: Sketch Version 54, Mac OS Mojave (v. 10.14.3)
How to reproduce:

1. Create a Sketch Data Plugin
2. Add the code let document = require('sketch/dom').getSelectedDocument() to the data related JS file.
3. Build the plugin
4. Open Sketch
5. Go to Sketch > Preferences > Data and scroll to the specific Data Plugin line - the plugin is disbaled (see screenshot attached).
   

[mathieudutour]

Where exactly are you adding it?

[konki-vienna]

I was adding it outside onStartup():

const sketch = require('sketch')
const { DataSupplier } = sketch
const util = require('util')

let document = require('sketch/dom').getSelectedDocument()

export function onStartup () {
  // To register the plugin, uncomment the relevant type:
  DataSupplier.registerDataSupplier('public.text', 'data_test', 'SupplyData')
  // DataSupplier.registerDataSupplier('public.image', 'data_test', 'SupplyData')
}

export function onShutdown () {
  // Deregister the plugin
  DataSupplier.deregisterDataSuppliers()
}

export function onSupplyData (context) {
  let dataKey = context.data.key
  const items = util.toArray(context.data.items).map(sketch.fromNative)
  items.forEach((item, index) => {
    let data = Math.random().toString()
    DataSupplier.supplyDataAtIndex(dataKey, data, index)
  })
}

but when I add it to/inside onStartup() everything seems to be fine. 🤦‍♂️
Probably this is the right place to put it, right?

const sketch = require('sketch')
const { DataSupplier } = sketch
const util = require('util')

export function onStartup () {
  let document = require('sketch/dom').getSelectedDocument()
  // To register the plugin, uncomment the relevant type:
  DataSupplier.registerDataSupplier('public.text', 'data_test', 'SupplyData')
  // DataSupplier.registerDataSupplier('public.image', 'data_test', 'SupplyData')
}

export function onShutdown () {
  // Deregister the plugin
  DataSupplier.deregisterDataSuppliers()
}

export function onSupplyData (context) {
  let dataKey = context.data.key
  const items = util.toArray(context.data.items).map(sketch.fromNative)
  items.forEach((item, index) => {
    let data = Math.random().toString()
    DataSupplier.supplyDataAtIndex(dataKey, data, index)
  })
}

Or do I have to add it to onSupplyData?

[mathieudutour]

Yeah it might do something funky outside onStartup because you don’t know when it will be run.
Even onStartup might not have a document.

[konki-vienna]

So better put it inside onSupplyData?

[mathieudutour]

Yeah, better put it in the function where you need it :)

[konki-vienna]

Yes, thank you!
PS.: I guess you (and not me) close the issue then - I do not know what the protocol here is...

[konki-vienna]

Ah, one last question: Would there have been any way to get some debug-info here (regarding the disabled Data-plugin part). I was looking into the MacOs Console (filtered for Sketch), but there is so much going on when Sketch starts that I did not see anything which looked connected...

[mathieudutour]

It's actually a bug that getSelectedDocument throws an error when there is no document so I'll fix that!