Refactor: Make Error logging more user friendly for `project` commands #424

rizul2108 · 2025-04-17T05:32:37Z

Overview

This PR introduces a cleaner, more reliable, and consistent approach to error handling across the Harbor CLI. It standardizes parsing and reporting API errors, making the CLI more user-friendly and developer-maintainable.

Key Changes

Added ParseHarborError utility
- Centralized error parsing logic using reflection to extract the Payload from Harbor API responses.
- Produces clean and readable error messages for projects
Replaced Run with RunE across commands
- Enables direct error returns from command handlers.
- Ensures all errors are parsed through the new ParseHarborError function for consistent logging.
Code cleanup and simplification
- Removed redundant lines and unused logs.
- Improved flow readability and reduced clutter in error blocks.
Some Errors are not documented in some of the API requests by harbor so they gave response like below

Error: failed to get project logs: response status code does not match any response statuses defined for this endpoint in the swagger spec (status 404): {}

So added a new func CheckProject which calls API headProject to check if project exists

Motivation

Prior CLI behavior often exposed raw Go structs or verbose pointers in error logs.
This refactor ensures a consistent and user-friendly experience across project sub-commands.
Simplifies future debugging and maintenance.

Error Output Before vs After

Before:

rizul@rizu:~/OSS/harbor-cli$ ./bin/harbor-cli project delete debugcod
Error: failed to delete some projects: Error: [DELETE /projects/{project_name_or_id}][404] deleteProjectNotFound  &{Errors:[0xc00037e080]}

rizul@rizu:~/OSS/harbor-cli$ ./bin/harbor-cli project view debugcod
ERRO failed to get project: response status code does not match any response statuses defined for this endpoint in the swagger spec (status 404): {}

After:

rizul@rizu:~/OSS/harbor-cli$ ./bin/harbor-cli project delete debugcod
Error: failed to delete some projects: project debugcod not found

rizul@rizu:~/OSS/harbor-cli$ ./bin/harbor-cli project view debugcod
Error: Project debugcod does not exist

Related Issues

Fix #316
Fix #253
Fix #262
Fix #431
Fix #436
Fix #440

Signed-off-by: Rizul Gupta <[email protected]>

rizul2108 · 2025-04-17T07:12:38Z

@bupd, are the logs okay when using the verbose flag, or should I reduce them?

Copilot

Pull Request Overview

This PR refactors the Harbor CLI error handling for project-related commands to make error logging more user friendly and consistent. Key changes include:

Introducing a centralized error parsing utility (ParseHarborError) and a new CheckProject function.
Replacing Run with RunE in commands to allow direct error returns and streamlined error handling.
Cleaning up code structure and logging for project operations such as view, list, delete, and create.

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
pkg/utils/error.go	Added ParseHarborError to centralize error parsing logic
pkg/api/project_handler.go	Updated DeleteProject parameter (using useProjectName)
cmd/harbor/root/project/view.go	Replaced Run with RunE and integrated CheckProject for existence check
cmd/harbor/root/project/search.go	Updated error handling in project search command
cmd/harbor/root/project/logs.go	Enhanced existence check and improved debug logging in logs command
cmd/harbor/root/project/list.go	Improved pagination logging and error handling in project listing
cmd/harbor/root/project/delete.go	Refined delete command with concurrent deletion and detailed reporting
cmd/harbor/root/project/create.go	Streamlined project creation with interactive prompt and flag handling
cmd/harbor/root/cmd.go	Updated logger configuration to respect verbose mode settings

Comments suppressed due to low confidence (1)

cmd/harbor/root/project/create.go:35

[nitpick] Consider using a lower-case variable name (projectName) for local variables to follow Go naming conventions.

var ProjectName string

cmd/harbor/root/project/view.go

cmd/harbor/root/project/create.go

Co-authored-by: Copilot <[email protected]> Signed-off-by: Rizul Gupta <[email protected]>

Signed-off-by: Rizul Gupta <[email protected]>

bupd

@rizul2108 great job on the verbose logging.

But yet we recieve multiple error messages
instead of having multiple error messages can we have a single user frienldy message with a single specific reason.

Instead of

❯ ./bin/harbor-dev project list
ERRO Error fetching project page                   error="current-credential-name is not set in config file"
Error: failed to get projects list: Error: current-credential-name is not set in config file
~/s/code/OSS/harbor-cli/prss fix-project-error
❯ ./bin/harbor-dev project list -v
DEBU[2025-04-22T05:18:02+05:30] Starting project list command
DEBU[2025-04-22T05:18:02+05:30] Using list all projects function
DEBU[2025-04-22T05:18:02+05:30] Fetching projects...
DEBU[2025-04-22T05:18:02+05:30] Page size is 0, will fetch all pages
DEBU[2025-04-22T05:18:02+05:30] Fetching next page of projects                page=1 page_size=100
ERRO[2025-04-22T05:18:02+05:30] Error fetching project page                   error="current-credential-name is not set in config file"
Error: failed to get projects list: Error: current-credential-name is not set in config file

We should have

Error: credentials not found, please login

error messages should be simple and concise

cmd/harbor/root/cmd.go

cmd/harbor/root/project/create.go

Co-authored-by: Prasanth Baskar <[email protected]> Signed-off-by: Rizul Gupta <[email protected]>

Signed-off-by: Rizul Gupta <[email protected]>

Copilot

Pull Request Overview

This PR refactors error handling for Harbor CLI project commands to provide clearer, consistent, and more user‐friendly error messages.

Centralized error parsing via the new ParseHarborError utility
Updated command implementations to use RunE and proper error returns
Enhanced logging and refined project existence checks and deletion concurrency

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
pkg/views/project/create/view.go	Refactored to return errors instead of calling log.Fatal
pkg/utils/error.go	Introduced ParseHarborError for centralized error message parsing
pkg/utils/client.go	Updated error message with a login hint
pkg/api/project_handler.go	Modified flag handling for project deletion
cmd/harbor/root/project/view.go	Refactored project view command with existence check and error returns
cmd/harbor/root/project/search.go	Improved error handling in search command
cmd/harbor/root/project/logs.go	Updated logs command with enhanced debug logging and error returns
cmd/harbor/root/project/list.go	Added pagination debug logs and refined project listing
cmd/harbor/root/project/delete.go	Enabled batch deletion with concurrency and detailed outcome reporting
cmd/harbor/root/project/create.go	Supported both flag-based and interactive project creation
cmd/harbor/root/cmd.go	Streamlined logrus formatter initialization

Comments suppressed due to low confidence (1)

cmd/harbor/root/project/logs.go:75

The symbol 'auditLog' is used but not defined or imported; ensure the correct package name or import is provided to resolve this error.

auditLog.LogsProject(resp.Payload)

cmd/harbor/root/project/view.go

Signed-off-by: Rizul Gupta <[email protected]>

Copilot

Pull Request Overview

This PR refactors error logging and handling across the Harbor CLI to improve user friendliness and consistency. Key changes include introducing a centralized error parser (ParseHarborError), replacing Run with RunE in multiple commands, and enhancing prompt functions to return errors.

Reviewed Changes

Copilot reviewed 25 out of 25 changed files in this pull request and generated 2 comments.

File	Description
pkg/prompt/prompt.go	Updated GetProjectNameFromUser signature to return an error alongside the value.
pkg/api/project_handler.go	Adjusted parameters for DeleteProject and added CheckProject for project checks.
cmd/harbor/root/* (various commands)	Replaced Run with RunE and improved prompt error handling and logging.

cmd/harbor/root/project/view.go

cmd/harbor/root/tag/immutable/list.go

Co-authored-by: Copilot <[email protected]> Signed-off-by: Rizul Gupta <[email protected]>

Signed-off-by: Rizul Gupta <[email protected]>

…nto fix-project-error

Signed-off-by: Rizul Gupta <[email protected]> lint fix Signed-off-by: Rizul Gupta <[email protected]>

rizul2108 · 2025-04-24T06:02:52Z

@bupd this PR is ready for review

Copilot

Pull Request Overview

This PR refactors error handling in the Harbor CLI to improve user output and consistency. Key changes include centralizing error parsing via ParseHarborError, transitioning commands to use RunE for direct error returns, and adding a new CheckProject function to validate project existence before further processing.

Reviewed Changes

Copilot reviewed 25 out of 25 changed files in this pull request and generated 2 comments.

File	Description
pkg/prompt/prompt.go	Updated GetProjectNameFromUser to return errors along with the name.
pkg/api/project_handler.go	Adjusted project deletion to use a flag inversion for resource naming.
cmd/harbor/root/*	Refactored various commands to adopt RunE and standardized error logging and handling.

cmd/harbor/root/project/view.go

cmd/harbor/root/artifact/view.go

Co-authored-by: Copilot <[email protected]> Signed-off-by: Rizul Gupta <[email protected]>

Signed-off-by: Rizul Gupta <[email protected]>

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

rizul2108 · 2025-04-28T10:04:16Z

@bupd ready for review

fix error logging in project command

36899d4

Signed-off-by: Rizul Gupta <[email protected]>

rizul2108 changed the title ~~Refactor: Harbor Error Parsing and Make Error logging more user friendly for project commands~~ Refactor: Make Error logging more user friendly for project commands Apr 17, 2025

rizul2108 added 5 commits April 17, 2025 11:54

add logrus debug for verbose flag

866f608

Signed-off-by: Rizul Gupta <[email protected]>

lint fixes

f85b49c

Signed-off-by: Rizul Gupta <[email protected]>

code fixes

2ef1569

Signed-off-by: Rizul Gupta <[email protected]>

add verbose for list cmd

2bbefbd

Signed-off-by: Rizul Gupta <[email protected]>

add verbose for llogs cmd

e9b9dda

Signed-off-by: Rizul Gupta <[email protected]>

rizul2108 requested review from Copilot and bupd April 17, 2025 07:12

Copilot AI reviewed Apr 17, 2025

View reviewed changes

cmd/harbor/root/project/view.go Outdated Show resolved Hide resolved

cmd/harbor/root/project/create.go Outdated Show resolved Hide resolved

rizul2108 and others added 2 commits April 17, 2025 12:45

Update cmd/harbor/root/project/create.go

30044d2

Co-authored-by: Copilot <[email protected]> Signed-off-by: Rizul Gupta <[email protected]>

fix project create

33bddaf

Signed-off-by: Rizul Gupta <[email protected]>

bupd requested changes Apr 21, 2025

View reviewed changes

bupd requested changes Apr 22, 2025

View reviewed changes

cmd/harbor/root/cmd.go Outdated Show resolved Hide resolved

cmd/harbor/root/project/create.go Outdated Show resolved Hide resolved

rizul2108 and others added 2 commits April 22, 2025 10:00

Update cmd/harbor/root/project/create.go

97d10d5

Co-authored-by: Prasanth Baskar <[email protected]> Signed-off-by: Rizul Gupta <[email protected]>

implement change

ad34ac6

Signed-off-by: Rizul Gupta <[email protected]>

Vad1mo requested a review from Copilot April 22, 2025 13:52

Copilot AI reviewed Apr 22, 2025

View reviewed changes

cmd/harbor/root/project/view.go Outdated Show resolved Hide resolved

disable logrus totally for non-verbose

24ed713

Signed-off-by: Rizul Gupta <[email protected]>

rizul2108 requested a review from bupd April 23, 2025 03:10

rizul2108 mentioned this pull request Apr 23, 2025

project delete should allow only id when --project-id flag is specified #436

Open

rizul2108 added 2 commits April 23, 2025 12:43

handle prompt user aborting and deletion errors

8ba357a

Signed-off-by: Rizul Gupta <[email protected]>

fmt fix

3b3ddbc

Signed-off-by: Rizul Gupta <[email protected]>

rizul2108 requested a review from Copilot April 23, 2025 07:29

Copilot AI reviewed Apr 23, 2025

View reviewed changes

cmd/harbor/root/project/view.go Outdated Show resolved Hide resolved

cmd/harbor/root/tag/immutable/list.go Outdated Show resolved Hide resolved

rizul2108 and others added 4 commits April 23, 2025 13:01

Update cmd/harbor/root/tag/immutable/list.go

57c8480

Co-authored-by: Copilot <[email protected]> Signed-off-by: Rizul Gupta <[email protected]>

lint fix

4cd2664

Signed-off-by: Rizul Gupta <[email protected]>

Merge branch 'fix-project-error' of github.com:rizul2108/harbor-cli i…

1381c87

…nto fix-project-error

Merge branch 'main' into fix-project-error

c48c45d

lint fix

5ac73cc

Signed-off-by: Rizul Gupta <[email protected]> lint fix Signed-off-by: Rizul Gupta <[email protected]>

rizul2108 force-pushed the fix-project-error branch from 74762a6 to 5ac73cc Compare April 23, 2025 10:39

rizul2108 requested a review from Copilot April 24, 2025 08:55

Copilot AI reviewed Apr 24, 2025

View reviewed changes

cmd/harbor/root/project/view.go Outdated Show resolved Hide resolved

cmd/harbor/root/artifact/view.go Outdated Show resolved Hide resolved

rizul2108 and others added 3 commits April 24, 2025 14:27

Update cmd/harbor/root/artifact/view.go

6751b53

Co-authored-by: Copilot <[email protected]> Signed-off-by: Rizul Gupta <[email protected]>

small fixes

9257290

Signed-off-by: Rizul Gupta <[email protected]>

lint fixes

1b992f6

Signed-off-by: Rizul Gupta <[email protected]>

rizul2108 requested a review from Copilot April 28, 2025 10:02

Copilot AI reviewed Apr 28, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor: Make Error logging more user friendly for `project` commands #424

Refactor: Make Error logging more user friendly for `project` commands #424

rizul2108 commented Apr 17, 2025 •

edited

Loading

rizul2108 commented Apr 17, 2025

Copilot AI left a comment

bupd left a comment •

edited

Loading

Copilot AI left a comment

Copilot AI left a comment

rizul2108 commented Apr 24, 2025 •

edited

Loading

Copilot AI left a comment

Copilot AI left a comment

rizul2108 commented Apr 28, 2025

Refactor: Make Error logging more user friendly for project commands #424

Are you sure you want to change the base?

Refactor: Make Error logging more user friendly for project commands #424

Conversation

rizul2108 commented Apr 17, 2025 • edited Loading

Overview

Key Changes

Motivation

Error Output Before vs After

Related Issues

rizul2108 commented Apr 17, 2025

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

bupd left a comment • edited Loading

Choose a reason for hiding this comment

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

rizul2108 commented Apr 24, 2025 • edited Loading

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Copilot AI left a comment

Choose a reason for hiding this comment

rizul2108 commented Apr 28, 2025

Refactor: Make Error logging more user friendly for `project` commands #424

Refactor: Make Error logging more user friendly for `project` commands #424

rizul2108 commented Apr 17, 2025 •

edited

Loading

bupd left a comment •

edited

Loading

rizul2108 commented Apr 24, 2025 •

edited

Loading