Fix the edge case when the value of a fieldMap key in ingestDocument is empty string (opensearch-project#1257)

Signed-off-by: Chloe Gao <[email protected]>
Signed-off-by: yeonghyeonKo <[email protected]>

Author: chloewqg

CHANGELOG.md

@@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ### Enhancements
 
 ### Bug Fixes
+- Add validations to prevent empty input_text_field and input_image_field in TextImageEmbeddingProcessor ([#1257](https://github.com/opensearch-project/neural-search/pull/1257))
 
 ### Infrastructure
 

src/main/java/org/opensearch/neuralsearch/processor/TextImageEmbeddingProcessor.java

@@ -183,8 +183,26 @@ Map<String, String> buildMapWithKnnKeyAndOriginalValue(final IngestDocument inge
             if (!sourceAndMetadataMap.containsKey(originalKey)) {
                 continue;
             }
-            if (!(sourceAndMetadataMap.get(originalKey) instanceof String)) {
-                throw new IllegalArgumentException("Unsupported format of the field in the document, value must be a string");
+
+            Object metaValue = sourceAndMetadataMap.get(originalKey);
+            if (Objects.isNull(metaValue)) {
+                throw new IllegalArgumentException(
+                    String.format(
+                        Locale.getDefault(),
+                        "Unsupported format of the field in the document, %s value must be a non-empty string. Currently it is null",
+                        originalKey
+                    )
+                );
+            } else if ((metaValue instanceof String) == false || Objects.isNull(metaValue) || StringUtils.isBlank((String) metaValue)) {
+                throw new IllegalArgumentException(
+                    String.format(
+                        Locale.getDefault(),
+                        "Unsupported format of the field in the document, %s value must be a non-empty string. Currently it is '%s'. Type is %s",
+                        originalKey,
+                        metaValue,
+                        metaValue.getClass()
+                    )
+                );
             }
             mapWithKnnKeys.put(originalKey, (String) sourceAndMetadataMap.get(originalKey));
         }

src/test/java/org/opensearch/neuralsearch/processor/TextImageEmbeddingProcessorTests.java

@@ -22,6 +22,7 @@
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 import java.util.function.BiConsumer;
 import java.util.function.Supplier;
@@ -323,31 +324,76 @@ public void testExecute_MLClientAccessorThrowFail_handlerFailure() {
     }
 
     public void testExecute_mapHasNonStringValue_throwIllegalArgumentException() {
-        Map<String, String> map1 = ImmutableMap.of("test1", "test2");
-        Map<String, Double> map2 = ImmutableMap.of("test3", 209.3D);
         Map<String, Object> sourceAndMetadata = new HashMap<>();
-        sourceAndMetadata.put("key1", map1);
-        sourceAndMetadata.put("my_text_field", map2);
+        sourceAndMetadata.put("key1", "test2");
+        sourceAndMetadata.put("my_text_field", 209.3D);
         sourceAndMetadata.put(IndexFieldMapper.NAME, "my_index");
         IngestDocument ingestDocument = new IngestDocument(sourceAndMetadata, new HashMap<>());
         TextImageEmbeddingProcessor processor = createInstance(false);
         BiConsumer handler = mock(BiConsumer.class);
         processor.execute(ingestDocument, handler);
-        verify(handler).accept(isNull(), any(IllegalArgumentException.class));
+
+        ArgumentCaptor<Throwable> argumentCaptor = ArgumentCaptor.forClass(Throwable.class);
+        verify(handler).accept(isNull(), argumentCaptor.capture());
+
+        Throwable capturedException = argumentCaptor.getValue();
+        assertTrue(capturedException instanceof IllegalArgumentException);
+        final String desiredExceptionMessage = String.format(
+            Locale.getDefault(),
+            "Unsupported format of the field in the document, %s value must be a non-empty string. Currently it is '%s'. Type is %s",
+            "my_text_field",
+            209.3D,
+            Double.class
+        );
+        assertEquals(desiredExceptionMessage, capturedException.getMessage());
     }
 
     public void testExecute_mapHasEmptyStringValue_throwIllegalArgumentException() {
-        Map<String, String> map1 = ImmutableMap.of("test1", "test2");
-        Map<String, String> map2 = ImmutableMap.of("test3", "   ");
         Map<String, Object> sourceAndMetadata = new HashMap<>();
-        sourceAndMetadata.put("key1", map1);
-        sourceAndMetadata.put("my_text_field", map2);
+        sourceAndMetadata.put("key1", "test2");
+        sourceAndMetadata.put("my_text_field", "");
         sourceAndMetadata.put(IndexFieldMapper.NAME, "my_index");
         IngestDocument ingestDocument = new IngestDocument(sourceAndMetadata, new HashMap<>());
         TextImageEmbeddingProcessor processor = createInstance(false);
         BiConsumer handler = mock(BiConsumer.class);
         processor.execute(ingestDocument, handler);
-        verify(handler).accept(isNull(), any(IllegalArgumentException.class));
+
+        ArgumentCaptor<Throwable> argumentCaptor = ArgumentCaptor.forClass(Throwable.class);
+        verify(handler).accept(isNull(), argumentCaptor.capture());
+
+        Throwable capturedException = argumentCaptor.getValue();
+        assertTrue(capturedException instanceof IllegalArgumentException);
+        final String desiredExceptionMessage = String.format(
+            Locale.getDefault(),
+            "Unsupported format of the field in the document, %s value must be a non-empty string. Currently it is '%s'. Type is %s",
+            "my_text_field",
+            "",
+            "".getClass()
+        );
+        assertEquals(desiredExceptionMessage, capturedException.getMessage());
+    }
+
+    public void testExecute_mapHasNullValue_throwIllegalArgumentException() {
+        Map<String, Object> sourceAndMetadata = new HashMap<>();
+        sourceAndMetadata.put("key1", "test2");
+        sourceAndMetadata.put("my_text_field", null);
+        sourceAndMetadata.put(IndexFieldMapper.NAME, "my_index");
+        IngestDocument ingestDocument = new IngestDocument(sourceAndMetadata, new HashMap<>());
+        TextImageEmbeddingProcessor processor = createInstance(false);
+        BiConsumer handler = mock(BiConsumer.class);
+        processor.execute(ingestDocument, handler);
+
+        ArgumentCaptor<Throwable> argumentCaptor = ArgumentCaptor.forClass(Throwable.class);
+        verify(handler).accept(isNull(), argumentCaptor.capture());
+
+        Throwable capturedException = argumentCaptor.getValue();
+        assertTrue(capturedException instanceof IllegalArgumentException);
+        final String desiredExceptionMessage = String.format(
+            Locale.getDefault(),
+            "Unsupported format of the field in the document, %s value must be a non-empty string. Currently it is null",
+            "my_text_field"
+        );
+        assertEquals(desiredExceptionMessage, capturedException.getMessage());
     }
 
     public void testExecute_hybridTypeInput_successful() throws Exception {