-
Notifications
You must be signed in to change notification settings - Fork 492
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
As a researcher, I want to enter or upload the provenance for my file so that I can provide other researchers with additional information about the history of my data. #4343
Comments
In cc09abf I stubbed out the validation that the prov file is JSON and can be parsed an a JSON object rather than a JSON array. |
In our usability testing of our Provenance mockups yesterday, we had one major piece of UI feedback that applied to this mockup: When you upload a provenance file, the "Upload Provenance File" box is still displayed and active. This led the participant to think that it was possible to upload more than one provenance file. Because he is very familiar with provenance, he was startled to think that we'd messed this up and allowed multiple file upload. An easy fix is to simply remove the file upload box once a provenance file has been uploaded, and only display it again if the user clicks the "X Remove" button. |
As of 7948579 we are storing both types of provenance data:
To be clear, this is where the two types will go after you click "Save Changes". There's still staging work to do for the UI. Clicking "Cancel" means nothing that's been staged will be persisted at all. |
Usability testing yesterday also got us feedback on some of the instructional text for this popup: Based on our participant's feedback, I recommend changing this message: "Please add any information required to accurately document the history of this data file, including how it was created and how it was transformed." TO "In addition to a bundle file, or in place of one, you may add any information required to accurately document the history of your data file, including how it was created and how it was transformed." I also recommend changing Description to Provenance Description. |
Lastly, @mheppler pointed out during usability testing that we need a "Cancel" button added to this popup modal: |
What we are building Include recommendations from testing as outlined above by @dlmurphy and ok'd by @TaniaSchlatter and @djbrooke and the following: File Upload Pg
Provenance (Edit) Popup
Provenance (Confirmation) Popup
|
When we have a better sense of the graph, it may make more sense and streamline the flow to include the Preview in a modal. |
Sorry, meant to delete a comment not close the story! |
Thank you @kcondon and @matthew-a-dunlap for coordinating on the Chrome browser issues and resolving those as merely browser CSS caching issues. Found a minor UI issue and demo'd it for Matthew on dataverse-internal...
|
This is prelim work before adding prov to the page
Here are the issues I've fixed but should be QA'ed again:
|
Fixes a bug where: - User uploads DataFile and saves it - User goes to editDatafilePage after save and uploads prov/sets entity. - Entity is not saved because editDatafilePage did not think it needed to save the context. Logic was added to save context if the page wasn't saved otherwise.
OK, tested the above fixes and they work. |
The logic in the previous commit was incorrect. Turns out the bug was due to dataFile attributes only being saved if an upload action was taking place on editDatafilePage. Now the prov code only saves the datafile if it isn't being saved by upload. Also, the provenance freeform saving was updated so that it wasn't triggering saving in unneeded cases
More fixes info:
I have addressed all the issues I am aware of at this point. We'll see what else comes up! |
All of the above are fixed. A minor note about maybe providing a curl example for create prov, showing --upload-file |
After discussion with @scolapasta and @sekmiller , it looks like one of the saving flows on the editDatasetPage is not saving with best practice and the fileMetadata is likely not in a useful state afterwards for the prov command to use and save. Its possible prov could work around this but it'd be pretty messy, I'm going to first take a look at what a SaveDataFileCommand would look like. |
Also fixed a bug where changing the entityName on its own did not save.
After talking with @landreev , I was able to arrive at a fix that did not involve digging deep into saving commands. Prov changes now trigger the full dataset update in editDatafilePage, instead of the optimized but less robust flow. When investigating this change, here are the things to look for:
I was unable to reproduce the windows prov file issues in windows 8 on IE and Chrome (Edge is not available for windows 8). While investigating I uncovered an issue on the file page where repeatedly saving the prov popup to delete and then create prov json didn't not clean up completely and caused entity saving to fail. |
Tested the above cases and all work. Mike confirmed his issue is fixed. Win browser issues appear to be caching related. Now retesting other workflows, then merge! |
The mockups supporting this user story are available here:
https://drive.google.com/file/d/1AO_L0utJwjHEBxpj5b2xNiVkOjOG545D/view
This story covers the submission and validation of a JSON file, and the submission of manually entered provenance.
The text was updated successfully, but these errors were encountered: