Use componentIds instead of componentName in FE/BE handshake

[suejung-sentry]

For the Codecov "Components" feature, our frontend/backend handshake currently relies on component names in the list filters api to get a filtered list of components. We should adjust this to be based on componentIds instead since "name" is optional. Also, we can fix the backend (filter_components_by_name_or_id) to be only based on componentIds in that case.

Background is here

[suejung-sentry]

Some background from Slack here:

RE: "Components" (display) name vs. id
It appears the source of this bug is because the customer specified component_ids but not names in their codecov.yml.
Here's what our docs say about these fields:

component_management:
  individual_components:
    - component_id: module_emotions  # this is an identifier that should not be changed
      name: emotions  # this is a display name, and can be changed freely

In attached screenshot, the dropdown displays and passes to the backend the name if exists, otherwise component_id . But, the filtering on the backend only matches by name not also the id fallback.
I plan to make it so the backend accepts the filter values as EITHER component_id OR name. Does this sound okay to folks?
Is there an intentional reason we used name as the identifier in these flows instead of id in the first place? Is name even serving any separate purpose at this point?

Suejung Shin
Today at 9:35 AM
Not sure who on engineering side may have insight into that also, maybe
@Jerry Feng
knows?

Jerry Feng
Today at 9:46 AM
I'm guessing because we want to show the name in the UI by design, so we populate the names in the dropdown from the API. I suppose naturally then the filter would take in a list of names since the api provides a list of names as options (via the dropdown).

customer specified component_ids but not names in their codecov.yml.

Didn't know that name is optional 😮 , What does the frontend display if the component has no name?

I plan to make it so the backend accepts the filter values as EITHER component_id OR name. Does this sound okay to folks?

Makes sense to me, though I would say we should have had frontend pass in only IDs and backend only accept IDs as filters, but idk how much work it would be to do that
🥔
1
:bufo-ok:
1

Suejung Shin
Today at 9:49 AM

What does the frontend display if the component has no name?

It falls back to id or the string "default_component" here

Makes sense to me, though I would say we should have had frontend pass in only IDs and backend only accept IDs as filters, but idk how much work it would be to do that

Awesome sounds good! I'll look into how hard this would be and if too tangled, just go for the either/or approach.
Thanks so much!