iframe-proxy

erikbocks · 2026-04-23T14:49:03Z

Description

PR #12502 introduced a generic method to retrieve untranslated UUIDs received as command parameters, without having to query the database during the command processing workflow. A validation using UUID.parseString was included before storing them in the context to ensure that they were valid UUIDs. However, it was previously possible to set the UUID of some entities to values that are not valid UUIDs, which got broken by this validation.

This PR removes the validation in order to support back the usage of arbitrary values as resource UUIDs.

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

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

After changing the code, I built it with Maven and validated that no error occurred during the build. The unit tests were not skipped for the build process.

After installing the packages with the changes to my environment, I created a account with nonuuidvalue as its UUID. Then, I listed the registered accounts with the listAccounts API. With this, I validated that the error from parsing the id attribute value was fixed.

listAccounts API result

(all-in-one) 🐋 > list accounts id=nonuuidvalue details=min
{
  "account": [
    {
      "accounttype": 0,
      "apikeyaccess": "INHERIT",
      "created": "2026-04-23T14:37:52+0000",
      "domain": "ROOT",
      "domainid": "ee564f54-13df-11f1-9489-464a3dd4490d",
      "domainpath": "ROOT",
      "groups": [],
      "id": "nonuuidvalue",
      "isdefault": false,
      "name": "b",
      "roleid": "fe5eecbe-13e1-11f1-9dfe-464a3dd4490d",
      "rolename": "User",
      "roletype": "User",
      "secondarystoragetotal": 0,
      "state": "disabled",
      "user": [
        {
          "account": "b",
          "accountid": "nonuuidvalue",
          "accounttype": 0,
          "created": "2026-04-23T14:37:55+0000",
          "domain": "ROOT",
          "domainid": "ee564f54-13df-11f1-9489-464a3dd4490d",
          "email": "b",
          "firstname": "b",
          "id": "b164a13c-0dcd-4604-b06e-954ec1ca452a",
          "is2faenabled": false,
          "is2famandated": false,
          "iscallerchilddomain": false,
          "isdefault": false,
          "lastname": "b",
          "roleid": "fe5eecbe-13e1-11f1-9dfe-464a3dd4490d",
          "rolename": "User",
          "roletype": "User",
          "state": "enabled",
          "username": "b",
          "usersource": "native"
        }
      ]
    }
  ],
  "count": 1
}

I also validated that the UUID obtention for events description was not affected by the changes. In order to test this, I disabled two different accounts: the one with the nonuuidvalue value as UUID, and an account that I created for this test. After inspecting the events, it was possible to validate that the resources' UUIDs were still being displayed correctly.

Events description

MariaDB [cloud]> select type, state, description, account_id from event where type = "ACCOUNT.DISABLE" and state = "Scheduled";
+-----------------+-----------+-----------------------------------------------------------------+------------+
| type            | state     | description                                                     | account_id |
+-----------------+-----------+-----------------------------------------------------------------+------------+
| ACCOUNT.DISABLE | Scheduled | Disabling Account with ID: a4ae3004-19b6-4152-9a1a-4d18f24410da |          6 |
| ACCOUNT.DISABLE | Scheduled | Disabling Account with ID: nonuuidvalue                         |          5 |
+-----------------+-----------+-----------------------------------------------------------------+------------+

codecov · 2026-04-23T14:59:44Z

Copilot

Pull request overview

This PR restores compatibility with resources whose stored “UUID” identifiers are not RFC-compliant UUID strings by removing strict UUID parsing/validation from the API parameter translation workflow and by treating stored UUIDs as opaque strings in the call context.

Changes:

Stop parsing/validating resource UUIDs with UUID.fromString(...) during parameter translation; store raw identifier strings instead.
Change CallContext API-resource UUID storage from UUID to String, and simplify BaseCmd#getResourceUuid() accordingly.
Update affected unit tests to use String UUIDs when populating CallContext.

Reviewed changes

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

Show a summary per file

File	Description
server/src/main/java/com/cloud/api/dispatch/ParamProcessWorker.java	Stores raw resource identifier strings in `CallContext` during UUID→ID translation (removes `UUID.fromString` parsing).
api/src/main/java/org/apache/cloudstack/context/CallContext.java	Changes `apiResourcesUuids` map value type from `UUID` to `String` and updates getter/setter signatures.
api/src/main/java/org/apache/cloudstack/api/BaseCmd.java	Simplifies `getResourceUuid()` to return the raw string from `CallContext` (removes UUID conversion/validation).
api/src/test/java/org/apache/cloudstack/api/command/user/network/routing/DeleteRoutingFirewallRuleCmdTest.java	Updates test to store a string UUID in `CallContext`.
api/src/test/java/org/apache/cloudstack/api/command/test/UpdateConditionCmdTest.java	Updates test to store a string UUID in `CallContext`.
api/src/test/java/org/apache/cloudstack/api/command/test/CreateSnapshotCmdTest.java	Updates test to store a string UUID in `CallContext`.
api/src/test/java/org/apache/cloudstack/api/command/admin/volume/UnmanageVolumeCmdTest.java	Updates test to store a string UUID in `CallContext`.
api/src/test/java/org/apache/cloudstack/api/command/admin/storage/DownloadImageStoreObjectCmdTest.java	Updates test to store a string UUID in `CallContext`.
api/src/test/java/org/apache/cloudstack/api/command/admin/network/bgp/UpdateBgpPeerCmdTest.java	Updates test to store a string UUID in `CallContext`.
api/src/test/java/org/apache/cloudstack/api/command/admin/network/bgp/ReleaseDedicatedBgpPeerCmdTest.java	Updates test to store a string UUID in `CallContext`.
api/src/test/java/org/apache/cloudstack/api/command/admin/network/bgp/DeleteBgpPeerCmdTest.java	Updates test to store a string UUID in `CallContext`.
api/src/test/java/org/apache/cloudstack/api/command/admin/network/bgp/DedicateBgpPeerCmdTest.java	Updates test to store a string UUID in `CallContext`.
api/src/test/java/org/apache/cloudstack/api/command/admin/network/bgp/CreateBgpPeerCmdTest.java	Updates test to store a string UUID in `CallContext`.
api/src/test/java/org/apache/cloudstack/api/command/admin/network/bgp/ChangeBgpPeersForVpcCmdTest.java	Updates test to store a string UUID in `CallContext`.
api/src/test/java/org/apache/cloudstack/api/command/admin/network/bgp/ChangeBgpPeersForNetworkCmdTest.java	Updates test to store a string UUID in `CallContext`.
api/src/test/java/org/apache/cloudstack/api/command/admin/network/UpdateIpv4SubnetForZoneCmdTest.java	Updates test to store a string UUID in `CallContext`.
api/src/test/java/org/apache/cloudstack/api/command/admin/network/ReleaseDedicatedIpv4SubnetForZoneCmdTest.java	Updates test to store a string UUID in `CallContext`.
api/src/test/java/org/apache/cloudstack/api/command/admin/network/DeleteIpv4SubnetForZoneCmdTest.java	Updates test to store a string UUID in `CallContext`.
api/src/test/java/org/apache/cloudstack/api/command/admin/network/DeleteIpv4SubnetForGuestNetworkCmdTest.java	Updates test to store a string UUID in `CallContext`.
api/src/test/java/org/apache/cloudstack/api/command/admin/network/DedicateIpv4SubnetForZoneCmdTest.java	Updates test to store a string UUID in `CallContext`.
api/src/test/java/org/apache/cloudstack/api/command/admin/network/CreateIpv4SubnetForZoneCmdTest.java	Updates test to store a string UUID in `CallContext`.
api/src/test/java/org/apache/cloudstack/api/command/admin/network/CreateIpv4SubnetForGuestNetworkCmdTest.java	Updates test to store a string UUID in `CallContext`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-23T17:19:31Z

+                CallContext.current().putApiResourceUuid(annotation.name(), uuid);
                CallContext.current().putContextParameter(entity, uuid);


The change to store raw String UUIDs (including non-RFC UUID values) in CallContext is not covered by unit tests. Please add/extend a ParamProcessWorkerTest case that exercises translateUuidToInternalId with a non-UUID resource identifier (e.g., an entity whose Identity#getUuid returns a non-UUID string) and asserts that parameter processing completes and the value is available via BaseCmd#getResourceUuid/CallContext#getApiResourceUuid.

Suggested change

CallContext.current().putApiResourceUuid(annotation.name(), uuid);

CallContext.current().putContextParameter(entity, uuid);

String entityUuid = uuid;

if (objVO instanceof Identity) {

entityUuid = ((Identity)objVO).getUuid();

}

CallContext.current().putApiResourceUuid(annotation.name(), entityUuid);

CallContext.current().putContextParameter(entity, internalId);

winterhazel · 2026-04-23T20:08:47Z

@blueorangutan package

blueorangutan · 2026-04-23T20:10:04Z

@winterhazel a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-04-23T20:55:12Z

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

weizhouapache · 2026-04-23T21:18:32Z

weizhouapache

code lgtm

erikbocks added 2 commits April 23, 2026 10:48

Remove UUID parse from param processing workflow

2311f4f

Fix tests

d22ba7b

boring-cyborg Bot added the component:api label Apr 23, 2026

erikbocks requested review from DaanHoogland and weizhouapache April 23, 2026 14:49

sureshanaparti requested a review from Copilot April 23, 2026 17:15

Copilot started reviewing on behalf of sureshanaparti April 23, 2026 17:15 View session

Copilot AI reviewed Apr 23, 2026

View reviewed changes

winterhazel added this to the 4.23.0 milestone Apr 23, 2026

bernardodemarco approved these changes Apr 23, 2026

View reviewed changes

weizhouapache approved these changes Apr 23, 2026

View reviewed changes

Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove UUID parse from param processing workflow#13065

Remove UUID parse from param processing workflow#13065
erikbocks wants to merge 2 commits intoapache:mainfrom
scclouds:remove-uuid-parse

erikbocks commented Apr 23, 2026

Uh oh!

codecov Bot commented Apr 23, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 23, 2026

Uh oh!

winterhazel commented Apr 23, 2026

Uh oh!

blueorangutan commented Apr 23, 2026

Uh oh!

blueorangutan commented Apr 23, 2026

Uh oh!

weizhouapache commented Apr 23, 2026

Uh oh!

weizhouapache left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

		CallContext.current().putApiResourceUuid(annotation.name(), uuid);
		CallContext.current().putContextParameter(entity, uuid);

-                CallContext.current().putApiResourceUuid(annotation.name(), uuid);
-                CallContext.current().putContextParameter(entity, uuid);
+                String entityUuid = uuid;
+                if (objVO instanceof Identity) {
+                    entityUuid = ((Identity)objVO).getUuid();
+                }
+                CallContext.current().putApiResourceUuid(annotation.name(), entityUuid);
+                CallContext.current().putContextParameter(entity, internalId);

Sunbelt Computer Software

PL/B Language Development and Support

Conversation

erikbocks commented Apr 23, 2026

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

Uh oh!

codecov Bot commented Apr 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

Uh oh!

winterhazel commented Apr 23, 2026

Uh oh!

blueorangutan commented Apr 23, 2026

Uh oh!

blueorangutan commented Apr 23, 2026

Uh oh!

weizhouapache commented Apr 23, 2026

Uh oh!

weizhouapache left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

codecov Bot commented Apr 23, 2026 •

edited

Loading