Inconsistency between PMI web UI and projects.eclipse.org API

I stumbled over the following inconsistency for the technology.set project:

The projects.eclipse.org API reports:

curl -sSL https://projects.eclipse.org/api/projects/technology.set | jq '.[].gitlab_repos'
[
  {
    "url": "https://gitlab.eclipse.org/eclipse/set/set"
  }
]

but in the PMI WebUI, there is no entry in the GitLab section:

https://projects.eclipse.org/projects/technology.set/edit

The gitlab_repos field is not even show in the PMI WebUI. Could this be a relict from a time when individual GitLab repos could still be defined individually instead of just the GitLab group field?

How can this be fixed?

added API Bug projects.eclipse.org team:webdev labels

assigned to @epoirier

added prioritymedium label

added severitynormal label

Hi @fgurr, looking into the code and this seems to be the old gitlab_repos field in deed which is no longer being displayed in the Edit form of projects. I can simply remove gitlab_repos from the response.

I created the following MR to use the Gitlab Group field for the gitlab_only param and remove the gitlab_repos element from the endpoint.

https://gitlab.eclipse.org/eclipsefdn/it/websites/drupal/pmi/-/merge_requests/69

Adapting the API to remove the gitlab_repos field is probably the right move.

As a first step, I would also remove the entry from the DB manually and double check if it's still set for any other project.

@malowe Can you confirm that we don't use this property in sync script? I assume that information was there for the transition and we should be fine to remove it but still want you to confirm.

We don't use it in the sync script but it is mapped, so we should remove it first before removing it from the API as we hadn't set that to nullable. It is also mapped in our Java code and would crash every call that interacted with projects in our APIs if it was missing. Please give us some time to roll out those changes before removal.

@malowe can you add who will working on this item as an assignee and let me know once the task is complete on your end? I'll wait until you're done to merge my MR.

Thanks.

We'll need to roll this out to any API that uses projects, as well as the GL sync script to be safe. This will probably be a couple of weeks to finish overall.

If my memory serves me right, we kept the old property to facilitate our shift to the new field.

This was our contingency; in the event the sync script encountered a glitch, we could roll it back to a prior version, and it would function as it previously did.

Yet, it appears we overlooked the step of revisiting and removing this once we were certain everything was functioning correctly.

I also empathize with @malowe's reservations about deleting properties from active APIs because of the possible disruptions it might cause.

As Martin is in the process of eliminating this from our Java project, I believe the optimal approach for us would be to release a patch ensuring the gitlab_repos property is always empty to avoid further confusion with this outdated data. I am concerned that some clients may start to use this deprecated property in the future thinking it's valid data.

@epoirier @malowe,

Do you have any concerns with this proposal?

Do you have any concerns with this proposal?

None from me! As long as it's an empty array, the current code will continue to work as is

It's worth mentioning that @wbeaton made this request today: eclipsefdn/it/api/eclipsefdn-api-common#68 (moved)

I am thinking we could re-purpose this deprecated property in the future to provide a list of GitLab repos.

It might be worthwhile to move forward for now with my proposal to make sure that the property always returns an empty array and populate it once we have a solution for fetching this missing data.

This way, Martin will not need to make any changes to our Java projects...

mentioned in issue eclipsefdn/it/api/eclipsefdn-api-common#69 (closed)

assigned to @malowe

The gitlab_repos item from the projects api is now returning an empty array on production

https://projects.eclipse.org/api/projects

Let me know if there's anything else.

Thanks.

unassigned @epoirier

LGTM. Thanks.

closed