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

Try renaming submissionId to id for input #3711

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Conversation

theosanderson
Copy link
Member

@theosanderson theosanderson commented Feb 18, 2025

resolves #2404

preview URL: https://submissionid2id.loculus.org/

Summary

Asking users to supply a metadata file with a "submissionId" for each sequence is confusing. The ID here is actually likely to be the user's own sample ID, as used in their FASTA file. "SubmissionID" implies an association specifically with the Loculus submission - maybe an ID for submission that you get from Loculus.

Here we rename this input field to a bare id, and also adjust the templates accordingly. We have back-compatibility that also supports submissionId (we can potentially remove that after a while).

This does not rename the field downstream. After submission this name does make more sense, it distinguishes the name that Loculus assigned (the accession) from the one the user used at submission (the submissionId)

PR Checklist

  • All necessary documentation has been adapted. TODO MORE OF THIS
  • The implemented feature is covered by an appropriate test.

@theosanderson theosanderson added preview Triggers a deployment to argocd format_me Triggers github_actions to format website code on PR labels Feb 18, 2025
@@ -150,8 +151,8 @@ function getAccessionInputField(): InputField {

function getSubmissionIdInputField(): InputField {
return {
name: SUBMISSION_ID_FIELD,
displayName: 'Submission ID',
name: SUBMISSION_ID_INPUT_FIELD,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't add the _INPUT part to this field name - why did you think of doing that? Other fields are also inputs possibly, and the don't have this.

@fhennig
Copy link
Contributor

fhennig commented Feb 24, 2025

Looks all very sensible, nice!

I would like to have two more backend tests:

  • A test that shows that the old submissionId submitting still works
  • A test that shows that it's not possible to submit a file with both id and submissionId

If that's there and tests are green I think I would approve.

EDIT: Oh yes, probably also some docs. - submissionID is mentioned in the docs.

@fhennig fhennig removed the preview Triggers a deployment to argocd label Feb 28, 2025
@fhennig
Copy link
Contributor

fhennig commented Feb 28, 2025

I've removed the preview label here for now, feel free to add it back! Just a bit many small PRs going on at the moment (I created a lot of them 😬 )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
format_me Triggers github_actions to format website code on PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change submissionId to id in terms of what we expect at submission
2 participants