feat: Edit group info

[fhennig]

resolves #2258

preview URL: https://feat-2258-edit-group-info.loculus.org

Summary

This PR adds a new backend API endpoint PUT /group/<groupId> as well as a group edit button to the group details view in the UI. Only group members can edit the group. All group info can be edited (except the group ID).

Screenshot

PR Checklist

• All necessary documentation has been adapted.
  • Warn users that if they change group name they will change ENA center name
• The implemented feature is covered by an appropriate test:
  • Manual tests:
    • 1. make an account, 2. create group, 3. submit sequences, 4. change everything in group, 5. see if we can still revise, etc.
    • In staging, change everything for grubaugh lab and see if it causes issues, e.g. also adding new sequences and seeing if ENA is happy: @anna-parker and @corneliusroemer should do this
  • Automatic tests:
    • Add end-to-end tests for the manual scenario
• Thought about potential security implications:
  • Ensure id can't be changed
  • We never use group name anywhere for anything security relevant
  • Ensure only group members can change group info

[corneliusroemer]

Looks great. Good start!

[chaoran-chen]

Nice code outlines and great to see the small docs and script improvements! If you create small PRs, I think that we can already merge them.

[fhennig]

I'm done with the API part of the change, next is the UI.

I've also made a small change to the gradle build; next time I'll split it into a separate PR (just like the script changes).

[corneliusroemer]

Not blocking but there seems to be quite some probably unnecessary repetition of the group fields - already from the legacy code, but now the duplication becomes more noticeable

We could make an issue to cleanup later, it's not necessarily pressing, just a bit of code smell (not your fault by the way, legacy)

[corneliusroemer]

Cool! I tested and it works, you could record a quick Screencast to showcase :)

[fhennig]

I've refactored the field mapping a bit, but I don't have an idea for how to completely get rid of a mapping function from form data to NewGroup -- my Typescript skills aren't good enough for that yet and ChatGPT didn't have a good idea either 😄

For the repetitive form inputs, I'd say it's fine for now. It's repetitive but simple to deal with. I am of course happy to change it if you have a concrete suggestion what to do.

[fengelniederhammer]

I quickly looked over the code. Looks good from my side. But it would be good if someone has a closer look.

[fhennig]

@corneliusroemer I think this is a good point: "Warn users that if they change group name they will change ENA center name" -- How should we do this? Maybe we can even add a little note to the edit UI if the group name is edited (some text in yellow next to the edit field maybe?)

Regarding "group ID can't be changed" -- This is the definition of the endpoint:

    @Operation(description = "Edit a group. Only users part of the group can edit it. The updated group is returned.")
    @ResponseStatus(HttpStatus.OK)
    @PutMapping("/groups/{groupId}", produces = [MediaType.APPLICATION_JSON_VALUE])
    fun editGroup(
        @HiddenParam authenticatedUser: AuthenticatedUser,
        @Parameter(
            description = "The id of the group to edit.",
        ) @PathVariable groupId: Int,
        @Parameter(description = "Updated group properties.")
        @RequestBody
        group: NewGroup,
    ): Group = groupManagementDatabaseService.updateGroup(groupId, group, authenticatedUser)

The ID is part of the path and not part of the NewGroup, so I would say that's sufficient? By definition the ID can't be changed.

For "Ensure only group members can change group info" I will add another backend unit test.

[corneliusroemer]

This is where we use group info in cached ways:

• ENA submission: group info used for project creation, currently not updated, see Propagate group edits to ENA projects #2939
• Ingest: Only sets group name of ingest group, never uses it
• Prepro: Never uses any group info apparently, even though group id is in data returned from prepro AFAICT

Backend tests:

• Check that get-released-data gets updated group info after group update, see TODOs: this actually fails, will look into it -- See test(backend): Test that updated group info ends up in released data #2943
• Superuser can edit
• Non-group member can't edit

Website tests:

• Optional: Jest react component tests: e.g. like this for group form: https://claude.site/artifacts/61c32144-b3ef-4977-a0ca-d55160d0158e or this: https://chatgpt.com/share/66fe6665-1190-8005-8dd4-b5446308ca2f
• Playwright E2E tests: We discussed that one should add an E2E test for group editing with playwright, I showed @fhennig how to set up playwright

Manual tests:

• On staging: edit a bunch of groups and see what happens: needs PR on pathoplexus pointing at this PR commit hash, and also point loculus deployments at PP PR hash

Loculus docs updates:

• Mention that groups can be edited somewhere appropriate -- 2d15399

Pathoplexus docs updates:

• Mention where appropriate -- docs: document group edit feature pathoplexus/pathoplexus#241

[fhennig]

hey @corneliusroemer do you want to have a look at the playwright test I wrote?

[fhennig]

I also have a PR ready for the Pathoplexus doc changes but I don't have commit permissions there yet pathoplexus/pathoplexus#241

[corneliusroemer]

Good stuff, I think all the checkboxes are ticked now!

[corneliusroemer]

Woops - E2E still fails it seems

[corneliusroemer]

E2E test no longer works it seems
https://github.com/loculus-project/loculus/actions/runs/11384438057/job/31672159380?pr=2854#step:21:41

[fhennig]

damn!

[corneliusroemer]

Now tests look good!