Use Optional to check null, and avoid NPE. (spring-projects#4063)

Fixes spring-projects#4063

Auto-cherry-pick to 1.0.x

Signed-off-by: Mengqi Xu <[email protected]>
Signed-off-by: 家娃 <[email protected]>

Author: remeio

spring-ai-model/src/main/java/org/springframework/ai/embedding/observation/DefaultEmbeddingModelObservationConvention.java

@@ -18,14 +18,20 @@
 
 import io.micrometer.common.KeyValue;
 import io.micrometer.common.KeyValues;
-
+import org.springframework.ai.chat.metadata.Usage;
+import org.springframework.ai.embedding.EmbeddingOptions;
+import org.springframework.ai.embedding.EmbeddingResponse;
+import org.springframework.ai.embedding.EmbeddingResponseMetadata;
 import org.springframework.util.StringUtils;
 
+import java.util.Optional;
+
 /**
  * Default conventions to populate observations for embedding model operations.
  *
  * @author Thomas Vitale
  * @author Soby Chacko
+ * @author Mengqi Xu
  * @since 1.0.0
  */
 public class DefaultEmbeddingModelObservationConvention implements EmbeddingModelObservationConvention {
@@ -45,11 +51,11 @@ public String getName() {
 
 	@Override
 	public String getContextualName(EmbeddingModelObservationContext context) {
-		if (StringUtils.hasText(context.getRequest().getOptions().getModel())) {
-			return "%s %s".formatted(context.getOperationMetadata().operationType(),
-					context.getRequest().getOptions().getModel());
-		}
-		return context.getOperationMetadata().operationType();
+		return Optional.ofNullable(context.getRequest().getOptions())
+			.map(EmbeddingOptions::getModel)
+			.filter(StringUtils::hasText)
+			.map(model -> "%s %s".formatted(context.getOperationMetadata().operationType(), model))
+			.orElseGet(() -> context.getOperationMetadata().operationType());
 	}
 
 	@Override
@@ -69,20 +75,22 @@ protected KeyValue aiProvider(EmbeddingModelObservationContext context) {
 	}
 
 	protected KeyValue requestModel(EmbeddingModelObservationContext context) {
-		if (StringUtils.hasText(context.getRequest().getOptions().getModel())) {
-			return KeyValue.of(EmbeddingModelObservationDocumentation.LowCardinalityKeyNames.REQUEST_MODEL,
-					context.getRequest().getOptions().getModel());
-		}
-		return REQUEST_MODEL_NONE;
+		return Optional.ofNullable(context.getRequest().getOptions())
+			.map(EmbeddingOptions::getModel)
+			.filter(StringUtils::hasText)
+			.map(model -> KeyValue.of(EmbeddingModelObservationDocumentation.LowCardinalityKeyNames.REQUEST_MODEL,
+					model))
+			.orElse(REQUEST_MODEL_NONE);
 	}
 
 	protected KeyValue responseModel(EmbeddingModelObservationContext context) {
-		if (context.getResponse() != null && context.getResponse().getMetadata() != null
-				&& StringUtils.hasText(context.getResponse().getMetadata().getModel())) {
-			return KeyValue.of(EmbeddingModelObservationDocumentation.LowCardinalityKeyNames.RESPONSE_MODEL,
-					context.getResponse().getMetadata().getModel());
-		}
-		return RESPONSE_MODEL_NONE;
+		return Optional.ofNullable(context.getResponse())
+			.map(EmbeddingResponse::getMetadata)
+			.map(EmbeddingResponseMetadata::getModel)
+			.filter(StringUtils::hasText)
+			.map(model -> KeyValue.of(EmbeddingModelObservationDocumentation.LowCardinalityKeyNames.RESPONSE_MODEL,
+					model))
+			.orElse(RESPONSE_MODEL_NONE);
 	}
 
 	@Override
@@ -99,36 +107,36 @@ public KeyValues getHighCardinalityKeyValues(EmbeddingModelObservationContext co
 	// Request
 
 	protected KeyValues requestEmbeddingDimension(KeyValues keyValues, EmbeddingModelObservationContext context) {
-		if (context.getRequest().getOptions().getDimensions() != null) {
-			return keyValues
+		return Optional.ofNullable(context.getRequest().getOptions())
+			.map(EmbeddingOptions::getDimensions)
+			.map(dimensions -> keyValues
 				.and(EmbeddingModelObservationDocumentation.HighCardinalityKeyNames.REQUEST_EMBEDDING_DIMENSIONS
-					.asString(), String.valueOf(context.getRequest().getOptions().getDimensions()));
-		}
-		return keyValues;
+					.asString(), String.valueOf(dimensions)))
+			.orElse(keyValues);
 	}
 
 	// Response
 
 	protected KeyValues usageInputTokens(KeyValues keyValues, EmbeddingModelObservationContext context) {
-		if (context.getResponse() != null && context.getResponse().getMetadata() != null
-				&& context.getResponse().getMetadata().getUsage() != null
-				&& context.getResponse().getMetadata().getUsage().getPromptTokens() != null) {
-			return keyValues.and(
+		return Optional.ofNullable(context.getResponse())
+			.map(EmbeddingResponse::getMetadata)
+			.map(EmbeddingResponseMetadata::getUsage)
+			.map(Usage::getPromptTokens)
+			.map(promptTokens -> keyValues.and(
 					EmbeddingModelObservationDocumentation.HighCardinalityKeyNames.USAGE_INPUT_TOKENS.asString(),
-					String.valueOf(context.getResponse().getMetadata().getUsage().getPromptTokens()));
-		}
-		return keyValues;
+					String.valueOf(promptTokens)))
+			.orElse(keyValues);
 	}
 
 	protected KeyValues usageTotalTokens(KeyValues keyValues, EmbeddingModelObservationContext context) {
-		if (context.getResponse() != null && context.getResponse().getMetadata() != null
-				&& context.getResponse().getMetadata().getUsage() != null
-				&& context.getResponse().getMetadata().getUsage().getTotalTokens() != null) {
-			return keyValues.and(
+		return Optional.ofNullable(context.getResponse())
+			.map(EmbeddingResponse::getMetadata)
+			.map(EmbeddingResponseMetadata::getUsage)
+			.map(Usage::getTotalTokens)
+			.map(totalTokens -> keyValues.and(
 					EmbeddingModelObservationDocumentation.HighCardinalityKeyNames.USAGE_TOTAL_TOKENS.asString(),
-					String.valueOf(context.getResponse().getMetadata().getUsage().getTotalTokens()));
-		}
-		return keyValues;
+					String.valueOf(totalTokens)))
+			.orElse(keyValues);
 	}
 
 }