goharbor/harbor

Cannot Sort Projects by repo_count or owner_name

Open

#18,329 opened on Mar 9, 2023

View on GitHub
 (5 comments) (0 reactions) (1 assignee)Go (28,490 stars) (5,235 forks)batch import
area/uigood first issuekind/requirement

Description

If you are reporting a problem, please make sure the following information are provided:

Expected behavior and actual behavior: I expect that when I use the API and add repo_count or owner_name to the sort parameter the results will be sorted on this parameter.

Steps to reproduce the problem:

Using your own demo site api.

import requests

def get_sorted_values(key):
    j = requests.get(f"https://demo.goharbor.io/api/v2.0/projects?page=1&page_size=100&sort={key}&with_detail=true").json()

    return [x[key] for x in j]

keys = ['repo_count','owner_name','chart_count','creation_time','name','owner_id','project_id','update_time']

for key in keys:
    print(key, get_sorted_values(key))

# repo_count [1, 0, 0, 3, 3, 1, 1]
# owner_name ['admin', 'gxr', 'admin', 'srini', 'srini', 'hoachvbnd', 'admin']
# chart_count [0, 0, 0, 0, 0, 0, 0]
# creation_time ['2023-03-09T05:00:36.132Z', '2023-03-09T06:03:49.190Z', '2023-03-09T07:24:36.972Z', '2023-03-09T08:06:22.627Z', '2023-03-09T13:57:47.875Z', '2023-03-09T14:50:57.258Z', '2023-03-09T15:42:38.237Z']
# name ['demo', 'gxr', 'library', 'operator12', 'operator7', 'test_harhor', 'zk-test']
# owner_id [1, 1, 1, 3, 3, 5, 14]
# project_id [1, 3, 7, 8, 12, 13, 14]
# update_time ['2023-03-09T05:00:36.132Z', '2023-03-09T06:03:49.190Z', '2023-03-09T07:24:36.972Z', '2023-03-09T08:06:22.627Z', '2023-03-09T13:57:47.875Z', '2023-03-09T14:50:57.258Z', '2023-03-09T15:42:38.237Z']

Versions: Please specify the versions of following systems.

  • harbor version: [2.7.0]

Contributor guide

Tech stack
gorest api
Domain
backendapi
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Go knowledgeREST API understanding
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue demonstrates that sorting by 'repo count' and 'owner name' does not work. Look at the Harbor API handler for listing projects, likely in 'src/core/api/project.go' or similar. Check how the 'sort' parameter is parsed and applied to the database query. Consider if the fields are missing from the sorting allowed list or if there is a bug in the query builder. Review the comments in the issue for any additional clues.