Merge pull request #2455 from Accenture/task/2454-prevent-upserts-with-keys-that-exceed-the-maximum-length

JoernBerkefeld · web-flow · commit 81012fc3e11f · 2026-02-04T22:25:00.000+01:00
task/2454: show error during deploy if the key of an item exceed the max length
diff --git a/lib/metadataTypes/MetadataType.js b/lib/metadataTypes/MetadataType.js
@@ -753,6 +753,19 @@ class MetadataType {
         return false;
     }
 
+    /**
+     * helper for {@link MetadataType.upsert} to enforce max key length
+     *
+     * @param {string} metadataKey key of metadata
+     */
+    static enforceMaxKeyLength(metadataKey) {
+        if (this.definition.maxKeyLength && metadataKey.length > this.definition.maxKeyLength) {
+            throw new Error(
+                `key exceeds maximum length of ${this.definition.maxKeyLength} characters for this type`
+            );
+        }
+    }
+
     /**
      * MetadataType upsert, after retrieving from target and comparing to check if create or update operation is needed.
      *
@@ -774,6 +787,7 @@ class MetadataType {
                 // preDeployTasks parsing
                 let deployableMetadata;
                 try {
+                    this.enforceMaxKeyLength(metadataKey);
                     metadataMap[metadataKey] = await this.validation(
                         'deploy',
                         metadataMap[metadataKey],
diff --git a/test/mockRoot/deploy/testInstance/testBU/asset/block/testExisting_asset_html-matchNamFail.asset-block-meta.html b/test/mockRoot/deploy/testInstance/testBU/asset/block/testExisting_asset_html-matchNamFail.asset-block-meta.html
diff --git a/test/mockRoot/deploy/testInstance/testBU/asset/block/testExisting_asset_html-matchNamFail.asset-block-meta.json b/test/mockRoot/deploy/testInstance/testBU/asset/block/testExisting_asset_html-matchNamFail.asset-block-meta.json
@@ -1,5 +1,5 @@
 {
-    "customerKey": "testExisting_asset_htmlblock-matchName-fail",
+    "customerKey": "testExisting_asset_html-matchNamFail",
     "assetType": {
         "name": "htmlblock",
         "displayName": "HTML Block"
diff --git a/test/mockRoot/deploy/testInstance/testBU/asset/block/testExisting_asset_html-matchName.asset-block-meta.html b/test/mockRoot/deploy/testInstance/testBU/asset/block/testExisting_asset_html-matchName.asset-block-meta.html
diff --git a/test/mockRoot/deploy/testInstance/testBU/asset/block/testExisting_asset_html-matchName.asset-block-meta.json b/test/mockRoot/deploy/testInstance/testBU/asset/block/testExisting_asset_html-matchName.asset-block-meta.json
@@ -1,5 +1,5 @@
 {
-    "customerKey": "testExisting_asset_htmlblock-matchName",
+    "customerKey": "testExisting_asset_html-matchName",
     "assetType": {
         "name": "htmlblock",
         "displayName": "HTML Block"
diff --git a/test/mockRoot/deploy/testInstance/testBU/asset/block/testExisting_asset_html-matchNameAdd.asset-block-meta.html b/test/mockRoot/deploy/testInstance/testBU/asset/block/testExisting_asset_html-matchNameAdd.asset-block-meta.html
diff --git a/test/mockRoot/deploy/testInstance/testBU/asset/block/testExisting_asset_html-matchNameAdd.asset-block-meta.json b/test/mockRoot/deploy/testInstance/testBU/asset/block/testExisting_asset_html-matchNameAdd.asset-block-meta.json
@@ -1,13 +1,13 @@
 {
-    "customerKey": "testExisting_asset_htmlblock-matchName-create",
+    "customerKey": "testExisting_asset_html-matchNameAdd",
     "assetType": {
         "name": "htmlblock",
         "displayName": "HTML Block"
     },
     "fileProperties": {
-        "fileName": "testExisting_htmlblock_matchName-create"
+        "fileName": "testExisting_asset_html-matchNameAdd"
     },
-    "name": "testExisting_htmlblock_matchName-create",
+    "name": "testExisting_asset_html-matchNameAdd",
     "owner": {
         "email": "joern.berkefeld@accenture.com",
         "name": "Jörn Berkefeld (ASGR)"
diff --git a/test/resources/9999999/asset/v1/content/assets/1295064/patch-response.json b/test/resources/9999999/asset/v1/content/assets/1295064/patch-response.json
@@ -1,6 +1,6 @@
 {
     "id": 1295064,
-    "customerKey": "testExisting_asset_htmlblock-matchName",
+    "customerKey": "testExisting_asset_html-matchName",
     "objectID": "26fdf503-eeed-49eb-b428-cb3b4bc2ba48",
     "assetType": {
         "id": 196,
diff --git a/test/type.asset.test.js b/test/type.asset.test.js
@@ -443,7 +443,7 @@ describe('type: asset', () => {
             const deployResult = await handler.deploy(
                 'testInstance/testBU',
                 ['asset'],
-                ['testExisting_asset_htmlblock-matchName']
+                ['testExisting_asset_html-matchName']
             );
             // THEN
             assert.equal(process.exitCode, 0, 'deploy should not have thrown an error');
@@ -464,8 +464,8 @@ describe('type: asset', () => {
             );
             assert.equal(
                 upsertCallout?.customerKey,
-                'testExisting_asset_htmlblock-matchName',
-                'customerKey should be testExisting_asset_htmlblock-matchName'
+                'testExisting_asset_html-matchName',
+                'customerKey should be testExisting_asset_html-matchName'
             );
             assert.equal(
                 upsertCallout?.id,
@@ -487,7 +487,7 @@ describe('type: asset', () => {
             const deployResult = await handler.deploy(
                 'testInstance/testBU',
                 ['asset'],
-                ['testExisting_asset_htmlblock-matchName-fail']
+                ['testExisting_asset_html-matchNamFail']
             );
             // THEN
             assert.equal(process.exitCode, 1, 'deploy should have thrown an error');
@@ -518,7 +518,7 @@ describe('type: asset', () => {
             const deployResult = await handler.deploy(
                 'testInstance/testBU',
                 ['asset'],
-                ['testExisting_asset_htmlblock-matchName-create']
+                ['testExisting_asset_html-matchNameAdd']
             );
             // THEN
             assert.equal(process.exitCode, 0, 'deploy should not have thrown an error');
@@ -535,8 +535,8 @@ describe('type: asset', () => {
             const upsertCallout = testUtils.getRestCallout('post', '/asset/v1/content/assets/');
             assert.equal(
                 upsertCallout?.customerKey,
-                'testExisting_asset_htmlblock-matchName-create',
-                'asset.customerKey should be testExisting_asset_htmlblock-matchName-create'
+                'testExisting_asset_html-matchNameAdd',
+                'asset.customerKey should be testExisting_asset_html-matchNameAdd'
             );
             assert.equal(
                 upsertCallout?.id,

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "customerKey": "testExisting_asset_htmlblock-matchName-fail",`
	`2`	`+ "customerKey": "testExisting_asset_html-matchNamFail",`
`3`	`3`	`"assetType": {`
`4`	`4`	`"name": "htmlblock",`
`5`	`5`	`"displayName": "HTML Block"`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"id": 1295064,`
`3`		`- "customerKey": "testExisting_asset_htmlblock-matchName",`
	`3`	`+ "customerKey": "testExisting_asset_html-matchName",`
`4`	`4`	`"objectID": "26fdf503-eeed-49eb-b428-cb3b4bc2ba48",`
`5`	`5`	`"assetType": {`
`6`	`6`	`"id": 196,`