From 925963bca897817133db861e76ab266fa7f93335 Mon Sep 17 00:00:00 2001
From: Anqi <anqi.wang@vesoft.com>
Date: Wed, 20 Dec 2023 15:48:02 +0800
Subject: [PATCH] add comment for config assert

---
 .../scala/com/vesoft/exchange/common/config/Configs.scala  | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/exchange-common/src/main/scala/com/vesoft/exchange/common/config/Configs.scala b/exchange-common/src/main/scala/com/vesoft/exchange/common/config/Configs.scala
index 525606a..7819c45 100644
--- a/exchange-common/src/main/scala/com/vesoft/exchange/common/config/Configs.scala
+++ b/exchange-common/src/main/scala/com/vesoft/exchange/common/config/Configs.scala
@@ -94,7 +94,7 @@ case class DataBaseConfigEntry(graphAddress: List[String],
   * @param password
   */
 case class UserConfigEntry(user: String, password: String) {
-  require(user.trim.nonEmpty && password.trim.nonEmpty)
+  require(user.trim.nonEmpty && password.trim.nonEmpty, "user and password cannot be empty.")
 
   override def toString: String =
     s"UserConfigEntry{user:$user, password:xxxxx}"
@@ -132,7 +132,8 @@ case class ExecutionConfigEntry(timeout: Int, retry: Int, interval: Int) {
   * @param errorMaxSize
   */
 case class ErrorConfigEntry(errorPath: String, errorMaxSize: Int) {
-  require(errorPath.trim.nonEmpty && errorMaxSize > 0)
+  require(errorPath.trim.nonEmpty && errorMaxSize >= 0,
+          "errorPath cannot be empty, and error maxSize cannot be less than 0")
 
   override def toString: String =
     s"ErrorConfigEntry:{errorPath:$errorPath, errorMaxSize:$errorMaxSize}"
@@ -145,7 +146,7 @@ case class ErrorConfigEntry(errorPath: String, errorMaxSize: Int) {
   * @param timeout
   */
 case class RateConfigEntry(limit: Int, timeout: Int) {
-  require(limit > 0 && timeout > 0)
+  require(limit > 0, "rate limit must be larger than 0")
 
   override def toString: String = s"RateConfigEntry:{limit:$limit, timeout:$timeout}"
 }