Complex logic

[stephenwf]

Most of Madoc is fairly straight forward - displaying and showing different components. However there are a few very complex areas that will be recorded here. This is mostly a technical reference.

Can a user submit an annotation?

This is a question that both the frontend and back ask.

Available data

1. The user identifier
2. The Manifest task (global)
3. The Canvas task (global)
4. The Canvas user tasks (per user)
5. Site configuration

Factors

• If user has an existing canvas user task (4) and it's status (0, 1, 2, 3)
• If the Manifest task (2) is already complete
• If the Canvas task (3) is already complete
• Max contributors reached (defined in 5, overwritten in 3)
• If the users existing canvas task as expired (4, status -1)

Related files

• useContinueSubmission()
• site-manifest-tasks route
• Resource claims API
• Claim utilities

Steps to reduce complexity

• Review and document the rules
• Create diagrams to describe the flow (simple + full)
• Ensure that the reasons for why a user can or cannot contribute are part of the consolidated code for the UI.
• Consolidate all code for answering the question of if the user can make a contribution to one place used by both the frontend and backend