Add Contributor Request/Response Workflow and Events UI #3528

thinknoack · 2025-07-28T18:34:32Z

Adds EVENTS for managing contributor access to datasets. Allows users to formally request contributor status, and provides dataset administrators with a dedicated UI to view, accept, or deny these requests. All actions are tracked and displayed in a new, unified events log on the dataset and admins get a log in their account notifications.

Actual contributor Roles/Perms are TODO - this PR just handles events resolvers and event related UI

Key Work & Changes

New Contributor Request Workflow
Request Contributor Button: allows users who do not have permissions to a dataset to formally request contributor access.
New GraphQL mutations are used to log these requests as events.
Admin UI: The DatasetEvents component can now managing these requests
Events & Notifications System
New Event Types: contributorRequest and contributorResponse
The DatasetEvents component has been refactored
Detailed Event Items component is responsible for displaying each event
New CSS added for events UI and actions.
tests have been adjusted for various issues related to updates. additional tests needed.

codecov · 2025-07-28T18:37:06Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.32%. Comparing base (9aa4c81) to head (1ea7a13).
⚠️ Report is 80 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff             @@
##           master    #3528       +/-   ##
===========================================
+ Coverage   44.57%   71.32%   +26.75%     
===========================================
  Files         620       51      -569     
  Lines       31685     1960    -29725     
  Branches     1485        0     -1485     
===========================================
- Hits        14123     1398    -12725     
+ Misses      17423      562    -16861     
+ Partials      139        0      -139

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

nellh

It'd be good to try to break things like this up into smaller PRs in the future, this could probably be several component PRs and an API change one. Most of it is looking pretty good and working. Made a few recommendations. It looks intentional that the notification status buttons are failing, that is fine to save for another PR.

packages/openneuro-app/src/scripts/dataset/mutations/request-contributor-status.tsx

nellh · 2025-08-04T14:55:31Z

packages/openneuro-server/src/graphql/schema.ts

    # Notes associated with the event
    note: String
+    # top-level datasetId field
+    datasetId: ID


This seems to duplicate the datasetId from the parent in the model. Why does it need a second copy of it?

i was thinking that we might have various places outside of dataset that we are querying for events. The new notifications resolver queries for DatasetEvent objects by userID. Outside of a dataset- datasetId is the only way for the frontend to know which dataset an event belongs to. Does that make sense to do here?

nellh · 2025-08-05T16:25:07Z

packages/openneuro-app/src/scripts/users/user-notification-accordion-actions.tsx

+      await updateNotificationStatus({
+        variables: {
+          datasetEventId: id,
+          status: backendStatus,
+        },
+      })


Ran into 400 error, Cannot query field "updateNotificationStatus" on type "Mutation". on triggering this.

yes, I put that on hold, and have a question about how to store that data on a user if many users will share the same notification.

this has been updated in #3548

nellh · 2025-08-05T16:36:28Z

packages/openneuro-app/src/scripts/dataset/components/dataset-event-item.tsx

+        setTimeout(() => {
+          setUpdatedNote("")
+          if (editingNoteId === event.id) {
+            startEditingNote(null, "")
+          }
+        }, 50)


Is setTimeout necessary here?

not really. I was trying to account for a slow refetchEvents where there could be what feels like two "renders" in the UI. I don't imagine it to ever be an issue and when I remove it locally it is pretty unnoticeable. I will remove it.

nellh · 2025-08-05T16:38:37Z

packages/openneuro-app/src/scripts/dataset/components/dataset-event-list.tsx

+interface ProcessedDatasetEvent {
+  id: string
+  note: string
+  timestamp: string
+  user: {
+    id: string
+    name: string
+    email: string
+    orcid: string
+  }
+  event: {
+    type: string
+    requestId?: string
+    status?: string
+  }
+  success: boolean
+  hasBeenRespondedTo?: boolean
+  responseStatus?: string
+}


The event type seems to be defined a few times. It would be good to unify these and import the shared type.

packages/openneuro-app/src/scripts/dataset/mutations/dataset-events.tsx

nellh · 2025-08-05T16:42:22Z

packages/openneuro-app/src/scripts/dataset/mutations/dataset-events.tsx

+  const processedEvents = useMemo(() => {
+    const responsesMap = new Map()
+    rawEvents.forEach((event) => {
+      if (event.event.type === "contributorResponse" && event.event.requestId) {
+        responsesMap.set(event.event.requestId, event)
+      }
+    })
+
+    const enrichedEvents = rawEvents.map((event) => {
+      if (event.event.type === "contributorRequest") {
+        const response = responsesMap.get(event.id)
+        if (response) {
+          return {
+            ...event,
+            hasBeenRespondedTo: true,
+            responseStatus: response.event.status,
+          }
+        }
+      }
+      return event
+    })
+    return enrichedEvents
+  }, [rawEvents])


This step could be done on the API side instead. If the client needs this, the API should just return it or provide an option for it.

moved to the backend

nellh · 2025-08-05T16:45:01Z

packages/openneuro-app/src/scripts/dataset/mutations/request-contributor-status.tsx

+  // Determine if the current user already has any permissions (read, write, admin)
+  // If they do, the button should not be displayed.
+  const hasPermissions = datasetPermissions?.some((p) =>
+    p.user.id === currentUserId &&
+    (p.level === "admin" || p.level === "rw" || p.level === "read")
+  )


We should check if the user is a contributor, rather than if they have permissions.

I added a perm check for the dataset.contributors array. needs to be reviewed once that field is added.

…vents.tsx add back erroneous removal of sentry Co-authored-by: Nell Hardcastle <[email protected]>

… - needs hook up with #3510(or future update) and datacite.yml

…ts by adding a new UserNotificationStatus model and updating resolvers to populate the status field.

…on-ui

…d code into new dir

…on-ui

Feature/datacite mutation

…m / writing them to the datacite.yml file

…ntributor-onUser Feature/ mutations for event adding contributors and accept/deny adding contributors

App/Contributor tests

Feature/datacite mutation UI

…nt-status

Feat(api) add a user specific virtual notification status to dataset events

adding new events for contributorRequest and contributorResponse

fca641a

thinknoack marked this pull request as draft July 28, 2025 18:35

thinknoack changed the title ~~adding new events for contributorRequest and contributorResponse~~ WIP adding new events for contributorRequest and contributorResponse Jul 28, 2025

thinknoack added 9 commits July 28, 2025 14:54

update to user notifications tab. TODO - filter by user specific status

fe7aca2

updates to user notification tab/view. various resolver changes

de8a768

adding comments I removed

09dd158

adding comments I removed

20c27b2

adding comments I removed

0718006

refactor into components

9a7d549

Merge branch 'master' into feature/request-contrib-role

32534f1

lint and test updates

1b289d7

adding button styling for contrib request button

a3ed21e

thinknoack changed the title ~~WIP adding new events for contributorRequest and contributorResponse~~ Add Contributor Request/Response Workflow and Events UI Jul 31, 2025

thinknoack added 3 commits July 31, 2025 15:43

minor test update

c5a57a9

remove comment

d07aa13

remove unused var

5393faa

thinknoack requested a review from nellh August 1, 2025 18:01

nellh requested changes Aug 5, 2025

View reviewed changes

thinknoack and others added 6 commits August 11, 2025 00:16

Update packages/openneuro-app/src/scripts/dataset/mutations/dataset-e…

ce92a03

…vents.tsx add back erroneous removal of sentry Co-authored-by: Nell Hardcastle <[email protected]>

remove setTimeout from processContributorRequest

2dee014

consolidated event types into file

03434de

move processedEvent enrichment to backend

ff8884a

remove general perm check to check for orcid id in contributors array…

f2d2728

… - needs hook up with #3510(or future update) and datacite.yml

lint type fixes

f5293fe

thinknoack requested a review from nellh August 11, 2025 20:28

thinknoack marked this pull request as ready for review August 11, 2025 20:28

thinknoack self-assigned this Aug 13, 2025

thinknoack added 2 commits August 19, 2025 11:30

Merge branch 'master' into feature/request-contrib-role

6abbb23

feat: Add a user-specific virtual notification status to dataset even…

8d9e564

…ts by adding a new UserNotificationStatus model and updating resolvers to populate the status field.

thinknoack and others added 26 commits September 15, 2025 17:28

Merge branch 'feature/datacite-mutation' into feature/datacite-mutati…

5f08cd9

…on-ui

update is admin hook to run outside of jsx, move contributor files an…

bd404a1

…d code into new dir

update lints

8c6b4ed

update lints

61a07f5

Merge branch 'feature/datacite-mutation' into feature/datacite-mutati…

626d3d9

…on-ui

test updates

0948621

update tests

dbeff55

Merge branch 'feature/datacite-mutation' into feature/datacite-mutati…

03378b7

…on-ui

update test to use contributor vs author

5146c15

remove comments

d862772

remove comments

485b049

updates after review

d68cbdc

Merge branch 'feature/datacite-mutation' into feature/datacite-mutati…

ea19cdd

…on-ui

Merge pull request #3575 from OpenNeuroOrg/feature/datacite-mutation

57252e7

Feature/datacite mutation

adding additional ui test

fb93188

adding save test for contrib form row

c46cbac

addign mutation for createContributorCitationEvent

042f5dd

mutations for creating contributor-datacite events and processing the…

a6808ce

…m / writing them to the datacite.yml file

unused var

42103f3

lint/test updates for api

2c37d57

update comments

8b1475c

Merge pull request #3589 from OpenNeuroOrg/feature/user-event-flow-co…

fb5f5d8

…ntributor-onUser Feature/ mutations for event adding contributors and accept/deny adding contributors

Merge pull request #3578 from OpenNeuroOrg/app-contributor-tests

6aa33cd

App/Contributor tests

Merge pull request #3576 from OpenNeuroOrg/feature/datacite-mutation-ui

d05bd93

Feature/datacite mutation UI

Merge branch 'feature/request-contrib-role' into feat/api-profile-eve…

17d4e15

…nt-status

Merge pull request #3548 from OpenNeuroOrg/feat/api-profile-event-status

d04f236

Feat(api) add a user specific virtual notification status to dataset events

nellh approved these changes Oct 1, 2025

View reviewed changes

Merge branch 'master' into feature/request-contrib-role

1ea7a13

nellh merged commit d768026 into master Oct 1, 2025
10 of 13 checks passed

nellh deleted the feature/request-contrib-role branch October 1, 2025 21:07

Add Contributor Request/Response Workflow and Events UI #3528

Add Contributor Request/Response Workflow and Events UI #3528

Uh oh!

Conversation

thinknoack commented Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

nellh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thinknoack Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thinknoack Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

thinknoack commented Jul 28, 2025 •

edited

Loading

codecov bot commented Jul 28, 2025 •

edited

Loading

thinknoack Aug 11, 2025 •

edited

Loading

thinknoack Aug 11, 2025 •

edited

Loading