Skip to content
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

5457-provide dataset/version/filemetadata to External tools #5465

Conversation

qqmyers
Copy link
Member

@qqmyers qqmyers commented Jan 14, 2019

New Contributors

Welcome! New contributors should at least glance at CONTRIBUTING.md, especially the section on pull requests where we encourage you to reach out to other developers before you start coding. Also, please note that we measure code coverage and prefer you write unit tests. Pull requests can still be reviewed without tests or completion of the checklist outlined below. Thanks!

Related Issues

Pull Request Checklist

@coveralls
Copy link

coveralls commented Jan 14, 2019

Coverage Status

Coverage increased (+0.003%) to 17.583% when pulling 60f9b10 on QualitativeDataRepository:5457-External_tools_can't_see_the_dataset_context into be044e2 on IQSS:develop.

@@ -235,6 +235,10 @@ public void explore(GuestbookResponse guestbookResponse, FileMetadata fmd, Exter
dataFile = guestbookResponse.getDataFile();
}
}
//For tools to get the dataset and datasetversion ids, we need a full DataFile object (not a findCheapAndEasy() copy)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@qqmyers this looks fine but have you seen any performance issue here? If so, we could right some helper method like doesExternalToolNeedDataset(externalTool). But if there's trivial performance impact, not worth it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@scolapasta - I think it's trivial - this is only called during tool launch and it is then a lookup of one datafile object. I didn't see any obvious delay launching a tool and I think the main concerns previously have been for cases where many datafiles were being looked up, e.g. when scanning through the list in a dataset...

Copy link
Contributor

@scolapasta scolapasta Jan 17, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, great. That is what I assumed as well, and why I had already moved to QA. :)

API_TOKEN("apiToken");
API_TOKEN("apiToken"),
DATASET_ID("datasetId"),
DATASET_VERSION("datasetVersion");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@qqmyers can you please add these two new reserved words (datasetId and datasetVersion) to the list of possibilities? The current list can be found at http://guides.dataverse.org/en/4.10.1/installation/external-tools.html

Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy to see the doc update in 60f9b10. Thanks, @qqmyers !

@kcondon kcondon merged commit 43722f5 into IQSS:develop Jan 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants