add Private URL feature #3111

pdurbin · 2016-05-10T20:22:28Z

First, please read the Business Requirements Document (BRD): https://docs.google.com/document/d/1FT47QkZKcmjSgRnePaJO2g1nzcotLyN3Yb2ORvBr6cs/edit?usp=sharing

Then, please read the Private URL design document, which explains edge cases and expected behavior: https://github.com/IQSS/dataverse/blob/b62959884ad8deb06a7135e485517672eb3c6fdf/doc/Architecture/privateurl.md

Four API endpoints have been added and documented at https://github.com/IQSS/dataverse/blob/b62959884ad8deb06a7135e485517672eb3c6fdf/doc/sphinx-guides/source/api/native-api.rst and they should be tested along with the more GUI-oriented descriptions above:

List all the role assignments at the given dataset
Create a Private URL (must be able to manage dataset permissions)
Get a Private URL from a dataset (if available)
Delete a Private URL from a dataset (if it exists)

In order to deploy this code you must run the sql script provided: https://github.com/IQSS/dataverse/blob/b62959884ad8deb06a7135e485517672eb3c6fdf/scripts/database/upgrades/privateurl.sql

@posixeleni has been waiting for me to create a branch in the main repo before documenting the Private URL feature in the User Guide so please pass the pull request to her after testing is complete. Update: this was done in #3138.

@scolapasta @michbarsinai I'm still wondering if we should use a ":" or not in the RoleAssignee identifier. Please see my comments and javadoc at

dataverse/src/main/java/edu/harvard/iq/dataverse/privateurl/PrivateUrlUtil.java

Line 27 in 9480a63

* @todo Consider using a new character such as "#" (as suggested by

@scolapasta once you have decided which version this feature will land in, we need to add the content of privateurl.sql to the official database migration script for that release. It's my understanding that the Private URL feature is slated for 4.5. Thanks, @kcondon for reminding me of this task. Update: this was done in 95570c7

RFI Checklist

1. Related Issues

Private URL To Unpublished Dataset #1012 Private URL To Unpublished Dataset
User Guide: Add section about Private URL #3138 User Guide: Add section about Private URL
Private URL -- UI Improvements #3174 Private URL -- UI Improvements
Delete Dataset: Contributor deleting a draft of a published version is not indexed. #3200 Delete Dataset: Contributor deleting a draft of a published version is not indexed
Private URL: When a contributor deletes a draft of a published dataset with privateURL defined, role is not cleared. #3201 Private URL: When a contributor deletes a draft of a published dataset with privateURL defined, role is not cleared

2. Pull Request Checklist

Functionality completed as described in BRD: https://docs.google.com/document/d/1FT47QkZKcmjSgRnePaJO2g1nzcotLyN3Yb2ORvBr6cs/edit?usp=sharing
Dependencies, risks, assumptions in BRD addressed
Unit tests completed
Deployment requirements identified (e.g., SQL scripts, indexing)
Documentation completed (see User Guide: Add section about Private URL #3138 and Private URL -- UI Improvements #3174)
All code checkins completed

3. Review Checklist

After the pull request has been submitted, fill out this section.

Code review completed or waived
Testing requirements completed
Usability testing completed or waived
Support testing completed or waived
Merged with develop branch and resolved conflicts

Requires scripts/database/upgrades/privateurl.sql

Design doc at doc/Architecture/privateurl.md

New API endpoints: doc/sphinx-guides/source/api/native-api.rst

Requires scripts/database/upgrades/privateurl.sql Design doc at doc/Architecture/privateurl.md New API endpoints: doc/sphinx-guides/source/api/native-api.rst

pdurbin · 2016-05-12T12:13:27Z

The merging of several pull requests yesterday has resulted in the message, "This branch has conflicts that must be resolved." I'm stealing this pull request back to resolve merge conflicts.

murphy:dataverse pdurbin$ git merge develop
Auto-merging src/main/webapp/dataset.xhtml
Auto-merging src/main/java/edu/harvard/iq/dataverse/search/SearchServiceBean.java
Auto-merging src/main/java/edu/harvard/iq/dataverse/RolePermissionFragment.java
CONFLICT (content): Merge conflict in src/main/java/edu/harvard/iq/dataverse/RolePermissionFragment.java
Auto-merging src/main/java/edu/harvard/iq/dataverse/ManagePermissionsPage.java
CONFLICT (content): Merge conflict in src/main/java/edu/harvard/iq/dataverse/ManagePermissionsPage.java
Auto-merging src/main/java/edu/harvard/iq/dataverse/DatasetPage.java
Auto-merging src/main/java/Bundle.properties
Automatic merge failed; fix conflicts and then commit the result.
murphy:dataverse pdurbin$

Conflicts with #3108 (3089-jsoup): src/main/java/edu/harvard/iq/dataverse/ManagePermissionsPage.java src/main/java/edu/harvard/iq/dataverse/RolePermissionFragment.java - All AssignRoleCommand constructors need privateUrlToken parameter.

pdurbin · 2016-05-12T13:55:21Z

I just merged "develop" into the branch this pull request is based on and resolved merge conflicts in dd6ceb1 which has details (nothing big). Passing to QA.

coveralls · 2016-05-12T14:17:43Z

Coverage increased (+0.5%) to 5.547% when pulling dd6ceb1 on 1012-private-url into be5b26e on develop.

kcondon · 2016-05-17T17:58:22Z

passing to Gustavo for code review

pdurbin · 2016-05-17T18:01:38Z

@scolapasta here's a comment from @michbarsinai 'Little nitpicking regarding the comment at line 37 - ":" means "built-in" rather than "user". E.g. :authenticated-users. I'm also leaning towards using some other character, maybe "#"? In fact, even "P" will do.'

- Merged 313317a from develop into dd6ceb1 - Use UtilIt.grantRoleOnDataverse from develop. - Add Javadoc `throws` warning to RoleAssigneeServiceBean.getRoleAssignee - Check for null and empty string in getRoleAssignee - Catch EJBException in AbstractApiBean.findAssign Conflicts: - src/main/java/edu/harvard/iq/dataverse/RoleAssigneeServiceBean.java - src/test/java/edu/harvard/iq/dataverse/api/UtilIT.java

coveralls · 2016-05-24T20:59:55Z

Coverage increased (+0.5%) to 5.664% when pulling 0c17116 on 1012-private-url into 313317a on develop.

Merged into 2935cde from "develop" into 0c17116 from "1012-private-url". Conflicts (accepted both, not a big deal): src/main/java/Bundle.properties

coveralls · 2016-05-31T15:18:29Z

Coverage increased (+0.5%) to 5.657% when pulling 4b64230 on 1012-private-url into 2935cde on develop.

@pdurbin

cc @pdurbin

coveralls · 2016-06-16T14:09:48Z

Coverage increased (+0.5%) to 5.657% when pulling c4c7902 on 1012-private-url into 2935cde on develop.

coveralls · 2016-06-22T18:40:23Z

Coverage increased (+0.5%) to 5.657% when pulling 95570c7 on 1012-private-url into 2935cde on develop.

coveralls · 2016-06-22T19:22:53Z

Coverage increased (+0.5%) to 5.657% when pulling 9480a63 on 1012-private-url into 2935cde on develop.

coveralls · 2016-06-27T19:58:07Z

Coverage increased (+0.5%) to 5.656% when pulling 50ae521 on 1012-private-url into 2935cde on develop.

coveralls · 2016-06-30T13:45:40Z

Coverage increased (+0.5%) to 5.658% when pulling 9816361 on 1012-private-url into 47b04ed on develop.

coveralls · 2016-07-08T14:46:16Z

Coverage increased (+0.5%) to 5.658% when pulling 4015d35 on 1012-private-url into 47b04ed on develop.

pdurbin · 2016-07-08T14:59:41Z

@kcondon found bugs #3200 and #3201 (thanks!) which I consider show stoppers so I'm pulling this out of QA.

pdurbin · 2016-07-13T19:17:36Z

@scolapasta I need a ruling on the two proposed fixes described at #3200 (comment) so I'm assigning this pull request to you for code review.

pdurbin · 2016-07-14T20:46:25Z

@scolapasta and @michbarsinai blessed the fix at 24df280 so I merged it into this pull request. Passing to QA.

coveralls · 2016-07-14T21:01:50Z

Coverage increased (+0.5%) to 5.657% when pulling dd9eb97 on 1012-private-url into dcea42d on develop.

add Private URL feature #1012

b629598

Requires scripts/database/upgrades/privateurl.sql Design doc at doc/Architecture/privateurl.md New API endpoints: doc/sphinx-guides/source/api/native-api.rst

pdurbin changed the title ~~add Private URL feature #1012~~ add Private URL feature May 10, 2016

pdurbin mentioned this pull request May 10, 2016

Private URL To Unpublished Dataset #1012

Closed

pdurbin self-assigned this May 12, 2016

pdurbin added the Status: Dev label May 12, 2016

pdurbin added Status: QA and removed Status: Dev labels May 12, 2016

pdurbin assigned kcondon and unassigned pdurbin May 12, 2016

kcondon removed the Status: QA label May 17, 2016

kcondon assigned scolapasta and unassigned kcondon May 17, 2016

pdurbin mentioned this pull request May 25, 2016

User Guide: Add section about Private URL #3138

Closed

Merge branch 'develop' into 1012-private-url #3111

4b64230

Merged into 2935cde from "develop" into 0c17116 from "1012-private-url". Conflicts (accepted both, not a big deal): src/main/java/Bundle.properties

Added documentation for Private URL #1012

c4c7902

cc @pdurbin

pdurbin added this to the 4.5 milestone Jun 22, 2016

Private URL: rename sql script to have 4.5 as target #1012

95570c7

Private URL: clarify javadoc identfier todo #1012

9480a63

pdurbin removed the Status: Dev label Jun 27, 2016

pdurbin added 2 commits June 30, 2016 09:33

add javadoc that PrivateUrlUser implements User too #1012

3a2aad3

Merge branch 'develop' into 1012-private-url

9816361

pdurbin mentioned this pull request Jul 6, 2016

#3198 add architecture doc for the MyData feature #3199

Closed

11 tasks

Private URL: add tests to exercise #3200 and #3201

4015d35

Private URL: avoid commands so Contributor can delete draft #3200 #3201

24df280

pdurbin mentioned this pull request Jul 8, 2016

Delete Dataset: Contributor deleting a draft of a published version is not indexed. #3200

Closed

pdurbin assigned pdurbin and unassigned kcondon Jul 8, 2016

pdurbin added Status: Dev and removed Status: QA labels Jul 8, 2016

pdurbin assigned scolapasta and unassigned pdurbin Jul 13, 2016

pdurbin added 2 commits July 14, 2016 16:26

Merge branch 'develop' into 1012-private-url

63f8178

Private URL tests require published root dataverse #1012

dd9eb97

pdurbin mentioned this pull request Jul 14, 2016

Private URL: When a contributor deletes a draft of a published dataset with privateURL defined, role is not cleared. #3201

Closed

pdurbin added Status: QA and removed Status: Dev labels Jul 14, 2016

pdurbin assigned kcondon and unassigned scolapasta Jul 14, 2016

kcondon merged commit 52170ba into develop Jul 18, 2016

pdurbin deleted the 1012-private-url branch July 21, 2016 20:23

mheppler removed the Status: QA label Oct 11, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add Private URL feature #3111

add Private URL feature #3111

pdurbin commented May 10, 2016 •

edited

Loading

pdurbin commented May 12, 2016 •

edited

Loading

pdurbin commented May 12, 2016

coveralls commented May 12, 2016

kcondon commented May 17, 2016

pdurbin commented May 17, 2016

coveralls commented May 24, 2016

coveralls commented May 31, 2016

coveralls commented Jun 16, 2016

coveralls commented Jun 22, 2016

coveralls commented Jun 22, 2016

coveralls commented Jun 27, 2016

coveralls commented Jun 30, 2016

coveralls commented Jul 8, 2016

pdurbin commented Jul 8, 2016

pdurbin commented Jul 13, 2016

pdurbin commented Jul 14, 2016

coveralls commented Jul 14, 2016

add Private URL feature #3111

add Private URL feature #3111

Conversation

pdurbin commented May 10, 2016 • edited Loading

RFI Checklist

1. Related Issues

2. Pull Request Checklist

3. Review Checklist

pdurbin commented May 12, 2016 • edited Loading

pdurbin commented May 12, 2016

coveralls commented May 12, 2016

kcondon commented May 17, 2016

pdurbin commented May 17, 2016

coveralls commented May 24, 2016

coveralls commented May 31, 2016

coveralls commented Jun 16, 2016

coveralls commented Jun 22, 2016

coveralls commented Jun 22, 2016

coveralls commented Jun 27, 2016

coveralls commented Jun 30, 2016

coveralls commented Jul 8, 2016

pdurbin commented Jul 8, 2016

pdurbin commented Jul 13, 2016

pdurbin commented Jul 14, 2016

coveralls commented Jul 14, 2016

pdurbin commented May 10, 2016 •

edited

Loading

pdurbin commented May 12, 2016 •

edited

Loading