Feat/add structured error logging

[Ja4V8s28Ck]

Description

• Added structured logging via the error middleware and respective testcases has been refactored.
• Fixed a bug where calling the delete endpoint with a non-existent user ID will not return USER_NOT_FOUND, rather it returns INTERNAL_SERVER_ERROR. ( I have added it as the last commit so that it can be cherry picked as a new PR, incase a need arise. )
• One more thing I noted, with the recent fix where the viper properly overrides the .env file with the existing config.yaml, there is a testcase in

  go-rest-api-boilerplate/internal/config/config_test.go

  Lines 650 to 666 in 96aaf12

  	func TestLoadConfig_ErrorPaths(t *testing.T) {
  	t.Run("unmarshal error with invalid config structure", func(t *testing.T) {
  	viper.Reset()
  	tempDir := t.TempDir()
  	invalidYAML := `
  	app:
  	name: 123
  	environment: [this, should, not, be, an, array]
  	database:
  	port: "not_a_number"
  	`
  	path := createTempConfigFile(t, tempDir, "invalid.yaml", invalidYAML)
  	_, err := LoadConfig(path)
  	assert.Error(t, err)
  	})

  which fails if there is a .env with a DATABASE_PORT value populated. So if uses with custom DATABASE_PORT in .env file will notice that, this test is failing.

Type of Change

• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How Has This Been Tested?

• Unit tests
• Integration tests
• Manual testing
• Postman/API testing

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[vahiiiid]

Codecov Report

❌ Patch coverage is 21.29630% with 85 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
internal/errors/errors.go 0.00% 71 Missing ⚠️
internal/errors/middleware.go 0.00% 9 Missing ⚠️
internal/user/handler.go 87.50% 2 Missing and 1 partial ⚠️
internal/user/service.go 0.00% 1 Missing and 1 partial ⚠️
📢 Thoughts on this report? Let us know!

@Ja4V8s28Ck
We need to write the test in case we don't decrease the codecov of the current status
So please try to write tests for those lines that are not covered at much as possible 🙂

[vahiiiid]

@Ja4V8s28Ck

I removed the commit with the 404 fixing of the delete user since it's fixed in the other PR
I rebased with the main
I added tests for the new error package with some small changes and updated the README

Please have a look
Thanks for the clean PR 🙏

[Ja4V8s28Ck]

@Ja4V8s28Ck

I removed the commit with the 404 fixing of the delete user since it's fixed in the other PR I rebased with the main I added tests for the new error package with some small changes and updated the README

Please have a look Thanks for the clean PR 🙏

Thanks for polishing the PR into a better one. 🙏