-
Notifications
You must be signed in to change notification settings - Fork 43
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
User API: Add missing project display name and description #3451
Conversation
3c74bce
to
81a2b94
Compare
DisplayName: pDisplay, | ||
Description: pDescr, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kantord - hey, in case the parsing above fails for some reason is it okay with you to have the default variable values here, i.e. empty strings?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you mean specifically for description? I think for description, empty string is a reasonable fallback value, but for displayName I think that using the name as a fallback value would make more sense
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also, I'm not very informed about how the BE codebase works, but as I understand the fallback logic happens at insertion time, meaning this code itself does not address existing data in the database. I guess those could be fixed using a database migration or a manual query?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm pretty sure this code is happening on the way out of the database when answering the query, not on insertion. (That's both what I would expect, and matches the pattern in the code where we're constructing a protocol buffer for output.) If we change 203 to:
pDisplay := pinfo.Name
pDescr := ""
before calling ParseMetadata
, that should be sufficient to fill in the defaults when the metadata doesn't exist in the database, without needing a backfill.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the suggestion @evankanderson , I've changed the initial values as suggested :)
This commit popukates the missing description and display name to the user API. Signed-off-by: Adolfo García Veytia (puerco) <puerco@stacklok.com>
Summary
This PR populates the missing descriptions and display names of projects included in the user API.
Fixes #3178
Change Type
Mark the type of change your PR introduces:
Testing
Outline how the changes were tested, including steps to reproduce and any relevant configurations.
Attach screenshots if helpful.
Review Checklist: