Added invalid nickname error for conversations (#615)

* Added string's length checks to the Contracts class * Add the usage of the string's length checks for the ConversationImpl nickname * Changed minimum nickname length from 1 to 2 * Fixed the throwIfNullOrTooShort method of Contracts * Update Conversation.ts --------- Co-authored-by: Japou Pou <[email protected]>
microsoft · Feb 22, 2023 · 5076d93 · 5076d93
1 parent 82b4eb8
commit 5076d93
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/src/sdk/Contracts.ts b/src/sdk/Contracts.ts
@@ -26,6 +26,23 @@ export class Contracts {
         }
     }
 
+    public static throwIfNullOrTooLong(param: string, name: string, maxLength: number): void {
+        Contracts.throwIfNullOrUndefined(param, name);
+
+        if (("" + param).length > maxLength) {
+            throw new Error("throwIfNullOrTooLong:" + name + " (more than " + maxLength.toString() + " characters)");
+        }
+    }
+
+
+    public static throwIfNullOrTooShort(param: string, name: string, minLength: number): void {
+        Contracts.throwIfNullOrUndefined(param, name);
+
+        if (("" + param).length < minLength) {
+            throw new Error("throwIfNullOrTooShort:" + name + " (less than " + minLength.toString() + " characters)");
+        }
+    }
+
     public static throwIfDisposed(isDisposed: boolean): void {
         if (isDisposed) {
             throw new Error("the object is already disposed");

diff --git a/src/sdk/Transcription/Conversation.ts b/src/sdk/Transcription/Conversation.ts
@@ -202,9 +202,11 @@ export class ConversationImpl extends Conversation implements IDisposable {
             // TODO: specify the regex required. Nicknames must be unique or get the duplicate nickname error
             // TODO: check what the max length is and if a truncation is required or if the service handles it without an error
             let hostNickname: string = speechConfig.getProperty(PropertyId[PropertyId.ConversationTranslator_Name]);
-            if (hostNickname === undefined || hostNickname === null || hostNickname.length <= 1 || hostNickname.length > 50) {
+            if (hostNickname === undefined || hostNickname === null) {
                 hostNickname = "Host";
             }
+            Contracts.throwIfNullOrTooLong(hostNickname, "nickname", 50);
+            Contracts.throwIfNullOrTooShort(hostNickname, "nickname", 2);
             speechConfig.setProperty(PropertyId[PropertyId.ConversationTranslator_Name], hostNickname);
 
         } else {