framework,api,server,ui: improve error messaging

[shwstppr]

Description

Framework level improvements for for contextual and localized API error messages

Design spec: Error Message Consistency, Customization, and Localization Framework

Types of changes

• Breaking change (fix or feature that would cause existing functionality to change)
• New feature (non-breaking change which adds functionality)
• Bug fix (non-breaking change which fixes an issue)
• Enhancement (improves an existing feature and functionality)
• Cleanup (Code refactoring and cleanup, that may add test cases)
• Build/CI
• Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

• Major
• Minor

Bug Severity

• BLOCKER
• Critical
• Major
• Minor
• Trivial

Screenshots (if appropriate):

Refined error message with additional context for admin

User facing error, with localization

Example API response

{
    "deployvirtualmachineresponse": {
        "uuidList": [],
        "errorcode": 535,
        "cserrorcode": 9999,
        "errortext": "Unable to deploy Instance because allocating 1 more Instance would exceed the Account limits. Current: 2, Reserved: 0, Limit: 2. Release unused resources, then retry.",
        "errortextkey": "vm.deploy.resourcelimit.exceeded.account",
        "errormetadata": {
            "resourceRequested": "1",
            "resourceTypeDisplay": "Instance",
            "resourceOwnerType": "Account",
            "resourceAmount": "2",
            "resourceReserved": "0",
            "resourceLimit": "2"
        }
    }
}

How Has This Been Tested?

How did you try to break this feature and the system with this change?

[codecov]

Codecov Report

❌ Patch coverage is 60.61538% with 128 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.69%. Comparing base (8e933b7) to head (d8bc647).

Files with missing lines	Patch %	Lines
...pache/cloudstack/context/ErrorMessageResolver.java	82.73%	13 Missing and 16 partials ⚠️
.../src/main/java/com/cloud/vm/UserVmManagerImpl.java	11.53%	21 Missing and 2 partials ⚠️
...ava/org/apache/cloudstack/context/CallContext.java	26.92%	17 Missing and 2 partials ⚠️
.../cloud/resourcelimit/ResourceLimitManagerImpl.java	0.00%	17 Missing ⚠️
...he/cloudstack/api/command/user/vm/DeployVMCmd.java	0.00%	10 Missing ⚠️
.../org/apache/cloudstack/api/ServerApiException.java	0.00%	7 Missing ⚠️
...c/main/java/com/cloud/user/AccountManagerImpl.java	50.00%	4 Missing and 3 partials ⚠️
...m/cloud/utils/exception/CloudRuntimeException.java	53.84%	6 Missing ⚠️
...rc/main/java/com/cloud/configuration/Resource.java	86.36%	3 Missing ⚠️
...loudstack/api/command/user/vm/BaseDeployVMCmd.java	0.00%	2 Missing ⚠️
... and 4 more

Additional details and impacted files

@@             Coverage Diff              @@
##               4.22   #12336      +/-   ##
============================================
+ Coverage     17.67%   17.69%   +0.02%     
- Complexity    15792    15830      +38     
============================================
  Files          5922     5923       +1     
  Lines        533167   533454     +287     
  Branches      65210    65251      +41     
============================================
+ Hits          94246    94416     +170     
- Misses       428276   428372      +96     
- Partials      10645    10666      +21     

Flag	Coverage Δ
uitests	3.69% <ø> (+<0.01%)	⬆️
unittests	18.77% <60.61%> (+0.02%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[github-actions]

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

[github-actions]

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

[shwstppr]

@blueorangutan package

[blueorangutan]

@shwstppr a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

[blueorangutan]

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 16743

[github-actions]

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

[shwstppr]

@blueorangutan package

[blueorangutan]

@shwstppr a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

[blueorangutan]

Packaging result [SF]: ✖️ el8 ✖️ el9 ✔️ debian ✖️ suse15. SL-JID 18238