You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nlpcraft.apache.org by ar...@apache.org on 2021/05/17 20:44:51 UTC
[incubator-nlpcraft] branch NLPCRAFT-319 updated: Code review.
This is an automated email from the ASF dual-hosted git repository.
aradzinski pushed a commit to branch NLPCRAFT-319
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft.git
The following commit(s) were added to refs/heads/NLPCRAFT-319 by this push:
new 0f50a21 Code review.
0f50a21 is described below
commit 0f50a21bf1ae4922cafc7511105cd2624a1f0c67
Author: Aaron Radzinzski <ar...@datalingvo.com>
AuthorDate: Mon May 17 13:44:38 2021 -0700
Code review.
---
.../main/scala/org/apache/nlpcraft/common/util/NCUtils.scala | 8 ++------
.../nlpcraft/model/tools/embedded/NCEmbeddedResult.java | 12 ++++--------
.../nlpcraft/model/tools/test/NCTestClientBuilder.java | 12 +++++++++---
.../org/apache/nlpcraft/model/tools/test/NCTestResult.java | 8 +++++++-
.../nlpcraft/probe/mgrs/nlp/NCProbeEnrichmentManager.scala | 4 ++--
.../org/apache/nlpcraft/server/rest/NCBasicRestApi.scala | 3 +--
.../scala/org/apache/nlpcraft/server/sql/NCSqlManager.scala | 3 +--
nlpcraft/src/main/scala/org/apache/nlpcraft/utils/README.md | 2 --
8 files changed, 26 insertions(+), 26 deletions(-)
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/common/util/NCUtils.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/common/util/NCUtils.scala
index 2b3131a..4e2e7bd 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/common/util/NCUtils.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/common/util/NCUtils.scala
@@ -1161,8 +1161,7 @@ object NCUtils extends LazyLogging {
Base64.encodeBase64String(arr.toByteArray)
}
catch {
- // TODO: text.
- case e: Exception ⇒ throw new NCE("Error compressing data", e)
+ case e: Exception ⇒ throw new NCE("Error during data compression.", e)
}
}
@@ -1177,8 +1176,7 @@ object NCUtils extends LazyLogging {
try
IOUtils.toString(new GIS(new ByteArrayInputStream(Base64.decodeBase64(zipStr))), Charset.defaultCharset())
catch {
- // TODO: text.
- case e: Exception ⇒ throw new NCE("Error decompressing data", e)
+ case e: Exception ⇒ throw new NCE("Error during data decompression.", e)
}
/**
@@ -1700,7 +1698,6 @@ object NCUtils extends LazyLogging {
try
GSON.fromJson(json, classOf[java.util.HashMap[String, Object]])
catch {
- // TODO: text
case e: Exception ⇒ throw new NCE(s"Cannot deserialize JSON to map: '$json'", e)
}
}
@@ -1716,7 +1713,6 @@ object NCUtils extends LazyLogging {
try
GSON.getAdapter(classOf[JsonElement]).fromJson(json).getAsJsonObject.get(field).getAsBoolean
catch {
- // TODO: text
case e: Exception ⇒ throw new NCE(s"Cannot deserialize JSON to map: '$json'", e)
}
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/embedded/NCEmbeddedResult.java b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/embedded/NCEmbeddedResult.java
index 8d20981..e18d2f6 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/embedded/NCEmbeddedResult.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/embedded/NCEmbeddedResult.java
@@ -19,7 +19,6 @@ package org.apache.nlpcraft.model.tools.embedded;
import org.apache.nlpcraft.model.*;
-import java.util.Map;
import java.util.function.*;
/**
@@ -32,7 +31,7 @@ import java.util.function.*;
* @see NCResult
* @see NCEmbeddedProbe
*/
-public interface NCEmbeddedResult {
+public interface NCEmbeddedResult extends NCMetadata {
/**
* Gets the ID of the model that produced this result. Note that embedded probe can host more than one
* data model hence this parameter is important to distinguish to which model this result belongs.
@@ -70,9 +69,6 @@ public interface NCEmbeddedResult {
*/
String getBody();
- // TODO:
- Map<String, Object> getMeta();
-
/**
* Gets optional result type. Note that either both result body and type are set or
* error message and error code are set, but not both pairs.
@@ -178,11 +174,11 @@ public interface NCEmbeddedResult {
String getProbeId();
/**
- * Gets request processing log holder as JSON string.
+ * Gets request processing log as JSON string.
*
- * @return Request processing log holder as JSON string.
+ * @return Request processing log as JSON string.
*/
- String getLogHolderJson();
+ String getLogJson();
/**
* Gets ID of the intent that was matched against the input sentence. Only set if result was
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/test/NCTestClientBuilder.java b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/test/NCTestClientBuilder.java
index ef09c1f..434a773 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/test/NCTestClientBuilder.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/test/NCTestClientBuilder.java
@@ -287,12 +287,18 @@ public class NCTestClientBuilder {
return resBody;
}
- // TODO:
+ /**
+ *
+ * @return
+ */
public Map<String, Object> getResultMeta() {
return resMeta;
}
- // TODO:
+ /**
+ *
+ * @param resMeta
+ */
public void setResultMeta(Map<String, Object> resMeta) {
this.resMeta = resMeta;
}
@@ -649,7 +655,7 @@ public class NCTestClientBuilder {
res.getBody() != null ?
"json".equals(res.getType()) ? gson.toJson(res.getBody()) : res.getBody() :
null,
- res.getMeta(),
+ res.getMetadata(),
res.getErrorMessage(),
res.getIntentId(),
System.currentTimeMillis() - now
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/test/NCTestResult.java b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/test/NCTestResult.java
index 8dd8570..130388b 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/test/NCTestResult.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/test/NCTestResult.java
@@ -63,7 +63,13 @@ public interface NCTestResult {
*/
Optional<String> getResultType();
- // TODO:
+ /**
+ * Gets optional execution result metadata. Only provided if processing succeeded.
+ *
+ * @return Optional execution result metadata.
+ * @see #isFailed()
+ * @see #isOk()
+ */
Optional<Map<String, Object>> getResultMeta();
/**
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/probe/mgrs/nlp/NCProbeEnrichmentManager.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/probe/mgrs/nlp/NCProbeEnrichmentManager.scala
index e2d949a..c0c7a21 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/probe/mgrs/nlp/NCProbeEnrichmentManager.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/probe/mgrs/nlp/NCProbeEnrichmentManager.scala
@@ -329,12 +329,12 @@ object NCProbeEnrichmentManager extends NCService with NCOpenCensusModelStats {
override val getOriginalText: String = txt
override val getUserId: Long = usrId
override val getBody: String = msg.dataOpt[String]("resBody").orNull
- override val getMeta: JavaMeta = msg.dataOpt[JavaMeta]("resMeta").orNull
+ override val getMetadata: JavaMeta = msg.dataOpt[JavaMeta]("resMeta").orNull
override val getType: String = msg.dataOpt[String]("resType").orNull
override val getErrorMessage: String = msg.dataOpt[String]("error").orNull
override val getErrorCode: Int = msg.dataOpt[Int]("errorCode").getOrElse(0)
override def getProbeId: String = Config.id
- override def getLogHolderJson: String = log.orNull
+ override def getLogJson: String = log.orNull
override def getIntentId: String = intentId.orNull
}
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/server/rest/NCBasicRestApi.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/server/rest/NCBasicRestApi.scala
index c80c0ac..4d9750b 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/server/rest/NCBasicRestApi.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/server/rest/NCBasicRestApi.scala
@@ -146,8 +146,7 @@ class NCBasicRestApi extends NCRestApi with LazyLogging with NCOpenCensusTrace w
try
JS_MAPPER.writeValueAsString(o)
catch {
- // TODO: text
- case e: JsonProcessingException ⇒ throw new NCE("Serialization error", e)
+ case e: JsonProcessingException ⇒ throw new NCE(s"JSON serialization error for: $o", e)
}
/**
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/server/sql/NCSqlManager.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/server/sql/NCSqlManager.scala
index 3ef2551..50ef05d 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/server/sql/NCSqlManager.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/server/sql/NCSqlManager.scala
@@ -82,8 +82,7 @@ object NCSqlManager extends NCService with NCIgniteInstance {
try
if (m != null) U.compress(JS_MAPPER.writeValueAsString(m)) else null
catch {
- // TODO: text
- case e: JsonProcessingException ⇒ throw new NCE("Serialization error", e)
+ case e: JsonProcessingException ⇒ throw new NCE(s"JSON serialization error for: $m", e)
}
}
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/utils/README.md b/nlpcraft/src/main/scala/org/apache/nlpcraft/utils/README.md
index 36ad1e9..69334bf 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/utils/README.md
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/utils/README.md
@@ -15,8 +15,6 @@
limitations under the License.
-->
-TODO: add here that we need it for tests (examples).
-
<img src="https://nlpcraft.apache.org/images/nlpcraft_logo_black.gif" height="80px">
<br>