#2454: show error during deploy if the key of an item exceed the max length

Author: JoernBerkefeld

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],