Add a Product Review service with GenAI-powered summaries (#2663)

* added skeleton version of the product review service

* added mysql database for the product review service

* added LLM with tool call to fetch product reviews

* added product reviews and summaries for each product

* updated LLM service to return pre-generated product summary

* added llm, mysql, and product-reviews to build pipeline

* changed how the product review service returns summaries

* added feature flags for LLM service

* added metrics to product review service

* added tests for the product review service

* added new services to docker-compose.minimal.yml

* added product review, llm, and mysql services to k8s manifest

* fixed mysql port in k8s manifest

* updated versions of new services

* updated README for the LLM service

* added product reviews to UI

* updated product review UI

* added product review summary to product page

* cleaned up visualization of product reviews

* fixed product review score percentage calculation

* added Cypress tests for product reviews

* updated changelog, removed temporary images, and updated loadgen

* restore kubernetes manifest to current state

* reverting changes to kubernetes/opentelemetry-demo.yaml

* updated product review service to use postgres instead of mysql

* updated product review service to use structured outputs

* build(deps): bump jvm (#2679)

Bumps the gradle-production-dependencies group with 1 update in the /src/fraud-detection directory: jvm.


Updates `jvm` from 2.2.20 to 2.2.21

---
updated-dependencies:
- dependency-name: jvm
  dependency-version: 2.2.21
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: gradle-production-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* resolved markdown lint errors and disabled the llmInaccurateResponse feature flag

* resolved protobufcheck and sanitycheck issues

* resolving licensecheck issues

* updated product reviews to include interactive AI component

* updated product review service to add AI assistant capabilities

* updated frontend to use new Product AI Assistant

* added tool call to AI assistant to fetch product info

* Processes all tool calls in a loop

* Add license

* updated mock LLM logic to match product review service updates

* Add line break

* build(deps): bump github/codeql-action (#2698)

Bumps the actions-production-dependencies group with 1 update in the / directory: [github/codeql-action](https://github.com/github/codeql-action).


Updates `github/codeql-action` from 4.31.0 to 4.31.1
- [Release notes](https://github.com/github/codeql-action/releases)
- [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
- [Commits](github/codeql-action@4e94bd1...5fe9434)

---
updated-dependencies:
- dependency-name: github/codeql-action
  dependency-version: 4.31.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: actions-production-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* updated product review service so feature flags work with real OpenAI API

* Add line break

* Fix tracetests

* Fix yamllint

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Juliano Costa <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Juliano Costa <[email protected]>

Author: 3 people

.env

@@ -116,6 +116,11 @@ PRODUCT_CATALOG_PORT=3550
 PRODUCT_CATALOG_ADDR=product-catalog:${PRODUCT_CATALOG_PORT}
 PRODUCT_CATALOG_DOCKERFILE=./src/product-catalog/Dockerfile
 
+# Product Reviews Service
+PRODUCT_REVIEWS_PORT=3551
+PRODUCT_REVIEWS_ADDR=product-reviews:${PRODUCT_REVIEWS_PORT}
+PRODUCT_REVIEWS_DOCKERFILE=./src/product-reviews/Dockerfile
+
 # Quote Service
 QUOTE_PORT=8090
 QUOTE_ADDR=http://quote:${QUOTE_PORT}
@@ -150,6 +155,17 @@ KAFKA_HOST=kafka
 KAFKA_ADDR=${KAFKA_HOST}:${KAFKA_PORT}
 KAFKA_DOCKERFILE=./src/kafka/Dockerfile
 
+# LLM service
+LLM_DOCKERFILE=./src/llm/Dockerfile
+LLM_HOST=llm
+LLM_PORT=8000
+
+# Mock LLM - to use a real OpenAI API-compatible LLM,
+# configure the .env.override file
+LLM_BASE_URL=http://${LLM_HOST}:${LLM_PORT}/v1
+LLM_MODEL=astronomy-llm
+OPENAI_API_KEY=dummy
+
 # Valkey
 VALKEY_PORT=6379
 VALKEY_ADDR=valkey-cart:${VALKEY_PORT}

.env.override

@@ -1,2 +1,12 @@
 # DO NOT PUSH CHANGES OF THIS FILE TO opentelemetry/opentelemetry-demo
 # PLACE YOUR .env ENVIRONMENT VARIABLES OVERRIDES IN THIS FILE
+
+
+# To use a real OpenAI API-compatible LLM,
+# set the appropriate values for the target LLM
+# Required permissions:
+# [Models and Model capabilities]
+
+#LLM_BASE_URL=https://api.openai.com/v1
+#LLM_MODEL=gpt-4o-mini
+#OPENAI_API_KEY=<replace with API key>

.github/workflows/checks.yml

@@ -14,7 +14,7 @@ permissions:
 
 jobs:
   build_images:
-    permissions: # required by the reusable workflow
+    permissions:  # required by the reusable workflow
       contents: read
       packages: write
     uses: ./.github/workflows/component-build-images.yml

.github/workflows/component-build-images.yml

@@ -106,6 +106,10 @@ jobs:
             tag_suffix: kafka
             context: ./
             setup-qemu: true
+          - file: ./src/llm/Dockerfile
+            tag_suffix: llm
+            context: ./
+            setup-qemu: true
           - file: ./src/load-generator/Dockerfile
             tag_suffix: load-generator
             context: ./
@@ -126,6 +130,10 @@ jobs:
             tag_suffix: product-catalog
             context: ./
             setup-qemu: true
+          - file: ./src/product-reviews/Dockerfile
+            tag_suffix: product-reviews
+            context: ./
+            setup-qemu: true
           - file: ./src/quote/Dockerfile
             tag_suffix: quote
             context: ./

.licenserc.json

@@ -47,6 +47,8 @@
         "src/checkout/genproto/",
         "src/flagd-ui/assets/vendor/",
         "src/product-catalog/genproto/",
+        "src/product-reviews/demo_pb2.py",
+        "src/product-reviews/demo_pb2_grpc.py",
         "src/react-native-app/ios/Pods/",
         "src/react-native-app/ios/build/",
         "src/react-native-app/android/app/build/",

CHANGELOG.md

@@ -15,6 +15,8 @@ the release.
   ([#2615](https://github.com/open-telemetry/opentelemetry-demo/pull/2615))
 * [frontend] Fix navigation and cart math
   ([#2660](https://github.com/open-telemetry/opentelemetry-demo/pull/2660))
+* [feat] Add Product Review service with AI-generated summaries
+  ([#2663](https://github.com/open-telemetry/opentelemetry-demo/pull/2663))
 * [chore] Upgrade OpenFeature and add fix deprecation warnings for dependency
   injection
   ([#2644](https://github.com/open-telemetry/opentelemetry-demo/pull/2644))

docker-compose-tests.yml

@@ -45,6 +45,7 @@ services:
       - FRONTEND_ADDR
       - PAYMENT_ADDR
       - PRODUCT_CATALOG_ADDR
+      - PRODUCT_REVIEWS_ADDR
       - RECOMMENDATION_ADDR
       - SHIPPING_ADDR
       - KAFKA_ADDR
@@ -73,10 +74,14 @@ services:
         condition: service_started
       frontend:
         condition: service_started
+      llm:
+        condition: service_started
       payment:
         condition: service_started
       product-catalog:
         condition: service_started
+      product-reviews:
+        condition: service_started
       quote:
         condition: service_started
       recommendation:

docker-compose.minimal.yml

@@ -430,6 +430,47 @@ services:
         condition: service_started
     logging: *logging
 
+  # Product reviews service
+  product-reviews:
+    image: ${IMAGE_NAME}:${DEMO_VERSION}-product-reviews
+    container_name: product-reviews
+    build:
+      context: ./
+      dockerfile: ${PRODUCT_REVIEWS_DOCKERFILE}
+      cache_from:
+        - ${IMAGE_NAME}:${IMAGE_VERSION}-product-reviews
+    deploy:
+      resources:
+        limits:
+          memory: 500M
+    restart: unless-stopped
+    ports:
+      - "${PRODUCT_REVIEWS_PORT}"
+    environment:
+      - PRODUCT_REVIEWS_PORT
+      - OTEL_PYTHON_LOG_CORRELATION=true
+      - OTEL_EXPORTER_OTLP_ENDPOINT
+      - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+      - OTEL_RESOURCE_ATTRIBUTES
+      - OTEL_SERVICE_NAME=product-reviews
+      - OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=true
+      - PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python
+      - DB_CONNECTION_STRING=host=${POSTGRES_HOST} user=otelu password=otelp dbname=${POSTGRES_DB}
+      - LLM_BASE_URL
+      - OPENAI_API_KEY
+      - LLM_MODEL
+      - PRODUCT_CATALOG_ADDR
+    depends_on:
+      product-catalog:
+        condition: service_started
+      llm:
+        condition: service_started
+      postgresql:
+        condition: service_started
+      otel-collector:
+        condition: service_started
+    logging: *logging
+
   # Quote service
   quote:
     image: ${IMAGE_NAME}:${DEMO_VERSION}-quote
@@ -559,6 +600,27 @@ services:
     logging:
       *logging
 
+  # LLM used by Product Review service
+  llm:
+    image: ${IMAGE_NAME}:${DEMO_VERSION}-llm
+    container_name: llm
+    build:
+      context: ./
+      dockerfile: ${LLM_DOCKERFILE}
+      cache_from:
+        - ${IMAGE_NAME}:${IMAGE_VERSION}-llm
+    deploy:
+      resources:
+        limits:
+          memory: 50M
+    restart: unless-stopped
+    environment:
+      - FLAGD_HOST
+      - FLAGD_PORT
+    ports:
+      - "${LLM_PORT}"
+    logging: *logging
+
   # Valkey used by Cart service
   valkey-cart:
     image: ${VALKEY_IMAGE}

docker-compose.yml

@@ -288,6 +288,7 @@ services:
       - CHECKOUT_ADDR
       - CURRENCY_ADDR
       - PRODUCT_CATALOG_ADDR
+      - PRODUCT_REVIEWS_ADDR
       - RECOMMENDATION_ADDR
       - SHIPPING_ADDR
       - OTEL_EXPORTER_OTLP_ENDPOINT
@@ -511,6 +512,51 @@ services:
         condition: service_started
     logging: *logging
 
+  # Product reviews service
+  product-reviews:
+    image: ${IMAGE_NAME}:${DEMO_VERSION}-product-reviews
+    container_name: product-reviews
+    build:
+      context: ./
+      dockerfile: ${PRODUCT_REVIEWS_DOCKERFILE}
+      cache_from:
+        - ${IMAGE_NAME}:${IMAGE_VERSION}-product-reviews
+    deploy:
+      resources:
+        limits:
+          memory: 100M
+    restart: unless-stopped
+    ports:
+      - "${PRODUCT_REVIEWS_PORT}"
+    environment:
+      - PRODUCT_REVIEWS_PORT
+      - OTEL_PYTHON_LOG_CORRELATION=true
+      - OTEL_EXPORTER_OTLP_ENDPOINT
+      - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+      - OTEL_RESOURCE_ATTRIBUTES
+      - OTEL_SERVICE_NAME=product-reviews
+      - OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=true
+      - PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python
+      - DB_CONNECTION_STRING=host=${POSTGRES_HOST} user=otelu password=otelp dbname=${POSTGRES_DB}
+      - LLM_BASE_URL
+      - OPENAI_API_KEY
+      - LLM_MODEL
+      - PRODUCT_CATALOG_ADDR
+      - FLAGD_HOST
+      - FLAGD_PORT
+      - LLM_HOST
+      - LLM_PORT
+    depends_on:
+      product-catalog:
+        condition: service_started
+      llm:
+        condition: service_started
+      postgresql:
+        condition: service_started
+      otel-collector:
+        condition: service_started
+    logging: *logging
+
   # Quote service
   quote:
     image: ${IMAGE_NAME}:${DEMO_VERSION}-quote
@@ -704,6 +750,30 @@ services:
       retries: 10
     logging: *logging
 
+  # LLM used by Product Review service
+  llm:
+    image: ${IMAGE_NAME}:${DEMO_VERSION}-llm
+    container_name: llm
+    build:
+      context: ./
+      dockerfile: ${LLM_DOCKERFILE}
+      cache_from:
+        - ${IMAGE_NAME}:${IMAGE_VERSION}-llm
+    deploy:
+      resources:
+        limits:
+          memory: 50M
+    restart: unless-stopped
+    environment:
+      - FLAGD_HOST
+      - FLAGD_PORT
+    ports:
+      - "${LLM_PORT}"
+    depends_on:
+      flagd:
+        condition: service_started
+    logging: *logging
+
   # Postgresql used by Accounting service
   postgresql:
     image: ${IMAGE_NAME}:${DEMO_VERSION}-postgresql

docker-gen-proto.sh

@@ -54,6 +54,7 @@ if [ -z "$1" ]; then
   #gen_proto_js payment
   gen_proto_go product-catalog
   #gen_proto_php quote
+  gen_proto_python product-reviews
   gen_proto_python recommendation
   #gen_proto_rust shipping
 else