Locally FAIR Data

[qqmyers]

What this PR does / why we need it: Implements the functionality described in "Locally FAIR" Data: Restricting Data Visibility in Dataverse Installations, allowing the visibility and accessibility of published collections and their published datasets/datafiles to be limited to specific groups.

Which issue(s) this PR closes:

• Closes none
• relates to Project: Locally FAIR Data dataverse-pm#426

Special notes for your reviewer: https://docs.google.com/document/d/1PPmPsAX8sbQYYdrU5s0Xc2d9YXw_5ROwkKaajT194P4/edit?usp=sharing and https://docs.google.com/document/d/1KBqRIkhRdJWCSs6wIRrnreJNLqWJoISIlqOZmDSTI9Q/edit?usp=sharing are additional resources.

Suggestions on how to test this: There are IT tests. For the UI, a superuser can add a user/group from the Collection/General Info pane and, once that's done, only the selected users should see new content in the collection. Reindexing would make existing published items disappear from search for unauthenticated users.

Does this PR introduce a user interface change? If mockups are available, please link/include them here: See "Locally FAIR" Data, slide 6

Is there a release notes update needed for this change?: inc.

Additional documentation:

Entry point for docs: https://dataverse-guide--12319.org.readthedocs.build/en/12319/user/dataverse-management.html#locally-fair

[pdurbin]

Just a quick review for now about tests. I'll start diving in.

[pdurbin]

and https://docs.google.com/document/d/1KBqRIkhRdJWCSs6wIRrnreJNLqWJoISIlqOZmDSTI9Q/edit?usp=sharing are additional resources

@qqmyers I requested access to this one. It's currently private.

[pdurbin]

@DieuwertjeBloemen and @wshahn agree with me that Locally FAIR shouldn't be so high up and prominent in the User Guide. See https://dataverse.zulipchat.com/#narrow/channel/446770-docs/topic/where.20to.20put.20Locally.20FAIR.20docs/near/601213586

[pdurbin]

I moved it in 21d82ef.

[pdurbin]

We plan to add to the API changelog something that changed as of this PR. Here's the issue to track this:

• Add to API changelog the change having to do with canDownloadFile #12472

[yesilms]

We plan to add to the API changelog something that changed as of this PR. Here's the issue to track this:

• Add to API changelog the change having to do with canDownloadFile #12472

Hi @pdurbin
This new Locally FAIR functionality is a great fit for our organizational needs. We would like to know when this feature will be production-ready. Do you have any guess or plans?
Thanks...

[pdurbin]

@yesilms good to hear! I don't have any guesses please do try the feature and create new issues if you find any problems!

Also, here's a related umbrella issue:

• Project: Locally FAIR Data dataverse-pm#426

[yesilms]

@yesilms good to hear! I don't have any guesses please do try the feature and create new issues if you find any problems!

Also, here's a related umbrella issue:

• Project: Locally FAIR Data dataverse-pm#426

Will do. We already deployed in our test environment and will run a PoC on the Locally FAIR instance.
Thanks for the information.

[qqmyers]

FWIW: As far as we know, Locally FAIR is production-ready in that it has no known issues and should work as advertised. Aside from the fact that the code is new and therefore could have bugs we didn't catch in testing, the key point about experimental, as pointed out in https://guides.dataverse.org/en/latest/user/dataverse-management.html#why-is-locally-fair-support-experimental, is that admins need to be trained not to do things that would expose data. That blurb also points out that there are various ways, e.g. from bulk metrics, that some Locally FAIR content exists (storage is being used, downloads are happening) that may make the current functionality unsuitable for some use cases. FWIW: I think there is support for fixing any bugs that might be found and we may also try (TBD) to add more automated checking to make sure the other settings on a Locally FAIR collection are consistent/won't expose the Locally FAIR content.