Preview action on domain object composed of viewable domain objects

[jordan-bonecutter]

I'm working on moving to the new(er) API in version 1. In the old API, if I wanted to preview a domain object representing a view which was composed of other domain obejcts, I could do the following:

openmct.$injector.get('objectService').getObjects([key])
  .then((objs) => {
    const preview = objs[key].getCapability('action').getActions({ key: 'mct-preview-action' })[0]
    action.perform()
 })

With the new API, I'm assuming I would do something like:

const obj = await openmct.objects.get(key)
const actions = await openmct.actions.get([obj])
actions.applicableActions.preview.callBack()

But this code only works for some domain objects, and I'm really not sure why. When it doesn't work I get the following errors in the console:

vue.min.js:6 TypeError: Cannot read property 'filter' of undefined
    at selectedLayoutItems (DisplayLayout.vue:169)
    at or.get (vue.min.js:6)
    at or.evaluate (vue.min.js:6)
    at s.selectedLayoutItems (vue.min.js:6)
    at s.<anonymous> (DisplayLayout.vue?a8b1:2)
    at s.e._render (vue.min.js:6)
    at s.i (vue.min.js:6)
    at or.get (vue.min.js:6)
    at new or (vue.min.js:6)
    at vue.min.js:6
vue.min.js:6 TypeError: Cannot read property 'forEach' of undefined
    at s.initializeItems (DisplayLayout.vue:482)
    at s.n [as initializeItems] (vue.min.js:6)
    at s.mounted (DisplayLayout.vue:207)
    at fe (vue.min.js:6)
    at Object.insert (vue.min.js:6)
    at w (vue.min.js:6)
    at We.__patch__ (vue.min.js:6)
    at We.e._update (vue.min.js:6)
    at We.i (vue.min.js:6)
    at or.get (vue.min.js:6)

I suspect it's because I'm not providing a view but I'm having trouble finding documentation on this feature. Any ideas?

[jvigliotta]

Hi @jordan-bonecutter!

I believe you could do something like this:

import PreviewAction fom "@/ui/preview/PreviewAction.js";

const previewAction = new PreviewAction(openmct);
const objectPath = await openmct.objects.getOriginalPath(domainObject.identifier);
previewAction.invoke(objectPath);

We're going to be updating PreviewAction soon so that it will reuse any components that are already in the DOM (to enhance performance), but that should be a backward compatible change.

[jordan-bonecutter]

The version my project uses lacks the getAction method. I'll attempt updating.

[akhenry]

Ah, ok, that was changed in an update last year. As a temporary workaround to get you unblocked you could try:

const objectPath = await openmct.objects.getOriginalPath(key);
const previewAction = openmct.actions._allActions['preview'];

previewAction.invoke(objectPath);

That's obviously relying on a private member variable and will break at some point, but hopefully it will get you unstuck until you can upgrade.

[jordan-bonecutter]

That worked! I'll add a note, we'll hopefully be upgrading to v2 soon. Thanks for all the help!

[jordan-bonecutter]

Out of curisosity, what was wrong with the code I provided above (if it's obvious)

[jvigliotta]

@jordan-bonecutter off the top of my head, not sure exactly why it was working for some objects and not others, but we've moved away from Angular injector and it's considered legacy code at this point (along with getCapability and objectService), we've removed that functionality from the latest releases. I believe we have some guidance on how to handle some of the more common "gotcha's" when upgrading from Legacy code, I will look for that and see if we can get a post up on the Discussions board with more information.