[Feature Branch] Analysis Discussion Section - Phase 1

[JmScherer]

Checklist before requesting a review

• I have performed a self-review of my code.
• My code follows the style guidelines enforced by static analysis tools.
• If it is a core feature, I have added thorough tests.
• My changes generate no new warnings.
• New and existing unit tests pass locally with my changes.
• Will this be part of a product update? If yes, please write one phrase about this update.

Pull Request Details

https://www.wrike.com/open.htm?id=1206929278
https://www.wrike.com/open.htm?id=1206933589

Changes made:

Analysis Discussion Section

Adds a new discussion to the Analysis. This section allows for users to post plaintext to be seen in an analysis. This allows for users to share thoughts/opinions/outlook on an analysis. They also have the ability to edit and delete posts that they made within the discussion section.

• Adds a whole new section called Discussion to every analysis in Rosalution.
• Modifies the RosalutionHeader.vue to include the new section
• Adds frontend components to manage the discussion section in vue
  • DiscussionSection.vue is the parent container the contains a collection of discussion posts
  • DiscussionPost.vue is the child component which displays the contents of each individual post
• New analysis.js model functions to handle the interaction between the front and back end
  • These functions handle Add, Edit, and Delete discussion posts
• This section includes a unique interface to add a discussion post and have it show up in the section
  • New Discussion button opens a field that allows free text to be entered into Rosalution
• Adds a context menu for a user to select an action for a discussion post
• Ensures that the user can only perform these actions on discussions they posted
  • The user authorization object was changed to always include the client_id to match which posts are made by the user
• Adds backend routes that handle how discussion posts are interacted with:
  • @router.get("/{analysis_name}/discussions")
  • @router.post("/{analysis_name}/discussions")
  • @router.put("/{analysis_name}/discussions/{discussion_post_id}")
  • @router.delete("/{analysis_name}/discussions/{discussion_post_id}")
• Adds new collection functions inside analysis_collection.py to handle mongo interactions
• Adds relevant testing including system tests for ensuring this functionality works as intended

---

To Review:

• Static Analysis by Reviewer
• Add, Edit, and Delete a discussion post
  To check this run the following commands:

  # From the root of Rosalution
  docker compose down
  docker system prune -a --volumes
  
  docker compose up --build

  • Go to: https://local.rosalution.cgds/rosalution/
  • Login with researcher
  • Click on CPAM0002
  • Scroll down to the Discussion section
  • Click on New Discussion button
  • Enter some text in the field and click Publish
  • Find your new post in the Discussion Section and click the ... and then click Edit
  • Enter new text and click Save
  • Find the same post and click the ... and then click Delete
  • Click Delete in the confirmation menu
  • Ensure that the post was removed from the Discussion section by refreshing the page
• Bonus: System Tests cover other cases such as canceling the actions, but give it a try to ensure it works
• All Github Actions checks have passed.

---

Discussion Section as researcher

Adding a new discussion post

Added Discussion Post

Edit Discussion Post through context menu

Editing a Discussion Post In-place

Edited post in the discussion section

Deleting a Discussion Post through context menu

Discussion Post Delete Confirmation

Discussion Post Deleted from the Section

[SeriousHorncat]

Doing the review in multiple steps. Just did a step through validation of the feature.

1. Leaving a post as a 'researcher' user
   
2. Editing a post as a 'researcher' user
   
3. A developer responding to a researchers
   
4. Researcher deleting their post due to not having time for this deep of a discussion
   

[SeriousHorncat]

I just did a first pass; Checking a few things and will a more thorough static analysis tomorrow. So excited for this to make it into main soon!

[fatimarabab]

The Discussion Section and Post components are working as expected. Everything looks great! Going to try running system tests next, before approving.

[fatimarabab]

One of the system tests is failing for me - rosalution.analysis.cy.js

[fatimarabab]

One of the system tests is failing for me - rosalution.analysis.cy.js

This needs to be refactored in a separate branch as it is unrelated to this PR. This Wrike Ticket was created for this and added to Rosalution>Backlog>Technical Debt - https://www.wrike.com/open.htm?id=1299739145

[fatimarabab]

Looks good to go!