chore: move exit code mapping to a central location

[PeterSchafer]

Pull Request Submission Checklist

• Follows CONTRIBUTING guidelines
• Commit messages
  are release-note ready, emphasizing
  what was changed, not how.
• Includes detailed description of changes
• Contains risk assessment (Low | Medium | High)
• Highlights breaking API changes (if applicable)
• Links to automated tests covering new functionality
• Includes manual testing instructions (if necessary)
• Updates relevant GitBook documentation (PR link: ___)
• Includes product update to be announced in the next stable release notes

What does this PR do?

This PR centralizes the mapping from errors to exit codes. This enables to consistently map errors no matter if they are part of the dataflow or returned from an extension.

Where should the reviewer start?

How should this be manually tested?

What's the product update that needs to be communicated to CLI users?

N/A

Risk assessment (Low | Medium | High)?

Medium, as it alters the flow of errors and exit codes. Looking into additional tests to reduce the risk more.

[thisislawatts]

suggestion: How about using a static map, this would be something we could easily migrate out to configuration at a later date:

// errorCatalogToExitCodeMap centralizes the relationship between catalog errors and CLI exit codes.
var errorCatalogToExitCodeMap = map[string]int{
	code.NewUnsupportedProjectError("").ErrorCode: constants.SNYK_EXIT_CODE_UNSUPPORTED_PROJECTS,
    // Add new mappings here
}

var MapErrorCatalogToExitCode func(err *snyk_errors.Error, defaultValue int) int = mapErrorToExitCode

func mapErrorToExitCode(err *snyk_errors.Error, defaultValue int) int {
	if exitCode, internalExists := errorCatalogToExitCodeMap[err.ErrorCode]; internalExists {
		return exitCode
	}

	return defaultValue
}

[thisislawatts]

I discovered the Comma Ok pattern

Sometimes you need to distinguish a missing entry from a zero value. Is there an entry for "UTC" or is that 0 because it's not in the map at all? You can discriminate with a form of multiple assignment.

var seconds int
var ok bool
seconds, ok = timeZone[tz]

For obvious reasons this is called the “comma ok” idiom. In this example, if tz is present, seconds will be set appropriately and ok will be true; if not, seconds will be set to zero and ok will be false. Here's a function that puts it together with a nice error report:

func offset(tz string) int {
    if seconds, ok := timeZone[tz]; ok {
        return seconds
    }
    log.Println("unknown time zone:", tz)
    return 0
}

Source: https://go.dev/doc/effective_go

[github-actions]

	Warnings
⚠️	There are multiple commits on your branch, please squash them locally before merging!

Generated by 🚫 dangerJS against d8fed82