Log file id and event

[jburel]

As soon as the log file is created, an event with the id of the file should be posted to notify the client.
Currently no notification in place, so the client waits for the import to be completed to request the log file linked to the image. This implies that the image was returned, which might not be the case if an error occurred.
This also implies that a large number of calls has to be made in order to retrieve a log file per image.

[cblackburn]

This change isn't trivial and so may not be suitable for FS demo 4.2. The import log registration (when the OriginalFile id is first known) takes place on the repo side. Notifications from here are not yet passed back to the client. If they were then a trivial solution, ​importlog-notification could be used. However, the whole issue of notifications needs to be addressed possibly as part of import workflow refactoring, which would also allow more information to be logged in the first place. In the shorter term, it might be possible to somehow obtain the Fileset or OriginalFile ids elsewhere within the workflow - for notification and improved log information - but this would need to be investigated.

[jburel]

import refactoring is scheduled for demo 4.2. Finishing mockup with Gus then ready to go.

[cblackburn]

It isn't easily possible to notify as soon as the log file is created with the current workflow but ​this branch adds the Fileset ID to the notifications. This still means if the import fails very early there may be no access to the log even if it has been created, but it does mean the ID is available to the client.

The whole of the logging and notification system for FS needs reworking but that falls outwith this ticket.

[jamoore]

Colin: is this something I should take into account with the import-set-api branch? I.e. do we need a getter for the original file and we go ahead and create it even if some other phase of the import fails?

[cblackburn]

Josh: I think we need to need to have the log file available as early as possible and that might mean doing something like you suggest. But at the moment I'm not sure how useful the information in the log file actually is. So having the OriginalFile id or Fileset id available to Insight is good for demos but we definitely need to look at revising the logging process.

[jburel]

I have modified the code. I will have the filesetID when the upload is complete, I will do with that for the first round.

[cblackburn]

Jean-Marie: do you want me to open a PR or will you just cherry-pick the commit from my branch?

[jburel]

I could cherry-pick but I will need to check who is listening for that event first to see what I can do with it.

[jburel]

Moved from sprint FS demo 4.2

[jburel]

see ​https://github.com/openmicroscopy/openmicroscopy/pull/1209