Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor and test version comments #3135

Open
theosanderson opened this issue Oct 31, 2024 · 1 comment
Open

Refactor and test version comments #3135

theosanderson opened this issue Oct 31, 2024 · 1 comment

Comments

@theosanderson
Copy link
Member

Currently versionComments are implemented in a pretty confusing way for developers:

  • versionComments can either be stored as a metadata item called versionComment or as a column called versionComment
  • For revisions the first approach is used
  • For revocations the second approach is used

Instead we should just use one approach :)

@anna-parker
Copy link
Contributor

anna-parker commented Oct 31, 2024

Just for some background I did this as a workaround because revocations have an empty originalDataColumn in SequenceEntriesTable and are not sent to preprocessing (they are filtered out in fetchUnprocessedEntriesAndUpdateToInProcessing) - so their processedDataColumn in SequenceEntriesView is always empty in the current set up. The versionComment field for revocations is therefore a special case as it is generated from user input but cannot (directly) be read from the processedDataColumn like other user-input metadata fields. As a workaround I chose to add the versionComment field in its own column and merge this column with the processedDataColumn when retrieving metadata.

Other options could be:

  • Add the revocation versionComment to the originalDataColumn instead of a custom column and again have a custom merge that handles revocations and revisions differently when we get the data from the backend e.g. in the get-released-data call. -> same level of complexity
  • Add the revocation versionComment to the originalDataColumn and send revocations to preprocessing so that the versionComment ends up in the processedDataColumn -> will probably require some prepro changes
  • Add the revocation versionComment to the originalDataColumn and update the processedDataColumn with the contents of the originalDataColumn automatically for revocations. -> I think this is the best approach I can think of

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants