[recommendation] rename recommendationservice to recommendation (#1865)

Author: puckpuck

.env

@@ -117,9 +117,9 @@ QUOTE_ADDR=http://quote:${QUOTE_PORT}
 QUOTE_DOCKERFILE=./src/quote/Dockerfile
 
 # Recommendation Service
-RECOMMENDATION_SERVICE_PORT=9001
-RECOMMENDATION_SERVICE_ADDR=recommendationservice:${RECOMMENDATION_SERVICE_PORT}
-RECOMMENDATION_SERVICE_DOCKERFILE=./src/recommendationservice/Dockerfile
+RECOMMENDATION_PORT=9001
+RECOMMENDATION_ADDR=recommendation:${RECOMMENDATION_PORT}
+RECOMMENDATION_DOCKERFILE=./src/recommendation/Dockerfile
 
 # Shipping Service
 SHIPPING_PORT=50050

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

@@ -115,8 +115,8 @@ jobs:
             tag_suffix: quote
             context: ./
             setup-qemu: true
-          - file: ./src/recommendationservice/Dockerfile
-            tag_suffix: recommendationservice
+          - file: ./src/recommendation/Dockerfile
+            tag_suffix: recommendation
             context: ./
             setup-qemu: true
           - file: ./src/shipping/Dockerfile

.licenserc.json

@@ -51,8 +51,8 @@
         "src/react-native-app/android/.gradle/",
         "src/react-native-app/.expo/",
         "src/react-native-app/expo-env.d.ts",
-        "src/recommendationservice/demo_pb2.py",
-        "src/recommendationservice/demo_pb2_grpc.py",
+        "src/recommendation/demo_pb2.py",
+        "src/recommendation/demo_pb2_grpc.py",
         "internal/tools/"
     ]
   }

CHANGELOG.md

@@ -62,6 +62,8 @@ the release.
   ([#1862](https://github.com/open-telemetry/opentelemetry-demo/pull/1862))
 * [payment] rename paymentservice to payment
   ([#1863](https://github.com/open-telemetry/opentelemetry-demo/pull/1863))
+* [recommendation] rename recommendationservice to recommendation
+  ([#1865](https://github.com/open-telemetry/opentelemetry-demo/pull/1865))
 
 ## 1.12.0
 

Makefile

@@ -140,7 +140,7 @@ docker-generate-protobuf:
 .PHONY: clean
 clean:
 	rm -rf ./src/{checkoutservice,productcatalogservice}/genproto/oteldemo/
-	rm -rf ./src/recommendationservice/{demo_pb2,demo_pb2_grpc}.py
+	rm -rf ./src/recommendation/{demo_pb2,demo_pb2_grpc}.py
 
 .PHONY: check-clean-work-tree
 check-clean-work-tree:

docker-compose-tests.yml

@@ -45,7 +45,7 @@ services:
       - FRONTEND_ADDR
       - PAYMENT_ADDR
       - PRODUCT_CATALOG_SERVICE_ADDR
-      - RECOMMENDATION_SERVICE_ADDR
+      - RECOMMENDATION_ADDR
       - SHIPPING_ADDR
       - KAFKA_SERVICE_ADDR
     extra_hosts:
@@ -79,7 +79,7 @@ services:
         condition: service_started
       quote:
         condition: service_started
-      recommendationservice:
+      recommendation:
         condition: service_started
       shipping:
         condition: service_started

docker-compose.minimal.yml

@@ -204,7 +204,7 @@ services:
       - CHECKOUT_SERVICE_ADDR
       - CURRENCY_ADDR
       - PRODUCT_CATALOG_SERVICE_ADDR
-      - RECOMMENDATION_SERVICE_ADDR
+      - RECOMMENDATION_ADDR
       - SHIPPING_ADDR
       - OTEL_EXPORTER_OTLP_ENDPOINT
       - OTEL_RESOURCE_ATTRIBUTES=${OTEL_RESOURCE_ATTRIBUTES}
@@ -229,7 +229,7 @@ services:
         condition: service_started
       quote:
         condition: service_started
-      recommendationservice:
+      recommendation:
         condition: service_started
       shipping:
         condition: service_started
@@ -435,30 +435,30 @@ services:
     logging: *logging
 
   # Recommendation service
-  recommendationservice:
-    image: ${IMAGE_NAME}:${DEMO_VERSION}-recommendationservice
+  recommendation:
+    image: ${IMAGE_NAME}:${DEMO_VERSION}-recommendation
     container_name: recommendation-service
     build:
       context: ./
-      dockerfile: ${RECOMMENDATION_SERVICE_DOCKERFILE}
+      dockerfile: ${RECOMMENDATION_DOCKERFILE}
       cache_from:
-        - ${IMAGE_NAME}:${IMAGE_VERSION}-recommendationservice
+        - ${IMAGE_NAME}:${IMAGE_VERSION}-recommendation
     deploy:
       resources:
         limits:
           memory: 50M
     restart: unless-stopped
     ports:
-      - "${RECOMMENDATION_SERVICE_PORT}"
+      - "${RECOMMENDATION_PORT}"
     environment:
       - FLAGD_HOST
-      - RECOMMENDATION_SERVICE_PORT
+      - RECOMMENDATION_PORT
       - PRODUCT_CATALOG_SERVICE_ADDR
       - OTEL_PYTHON_LOG_CORRELATION=true
       - OTEL_EXPORTER_OTLP_ENDPOINT
       - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
       - OTEL_RESOURCE_ATTRIBUTES
-      - OTEL_SERVICE_NAME=recommendationservice
+      - OTEL_SERVICE_NAME=recommendation
       - PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python
     depends_on:
       productcatalogservice:

docker-compose.yml

@@ -276,7 +276,7 @@ services:
       - CHECKOUT_SERVICE_ADDR
       - CURRENCY_ADDR
       - PRODUCT_CATALOG_SERVICE_ADDR
-      - RECOMMENDATION_SERVICE_ADDR
+      - RECOMMENDATION_ADDR
       - SHIPPING_ADDR
       - OTEL_EXPORTER_OTLP_ENDPOINT
       - OTEL_RESOURCE_ATTRIBUTES=${OTEL_RESOURCE_ATTRIBUTES}
@@ -301,7 +301,7 @@ services:
         condition: service_started
       quote:
         condition: service_started
-      recommendationservice:
+      recommendation:
         condition: service_started
       shipping:
         condition: service_started
@@ -517,31 +517,31 @@ services:
     logging: *logging
 
   # Recommendation service
-  recommendationservice:
-    image: ${IMAGE_NAME}:${DEMO_VERSION}-recommendationservice
+  recommendation:
+    image: ${IMAGE_NAME}:${DEMO_VERSION}-recommendation
     container_name: recommendation-service
     build:
       context: ./
-      dockerfile: ${RECOMMENDATION_SERVICE_DOCKERFILE}
+      dockerfile: ${RECOMMENDATION_DOCKERFILE}
       cache_from:
-        - ${IMAGE_NAME}:${IMAGE_VERSION}-recommendationservice
+        - ${IMAGE_NAME}:${IMAGE_VERSION}-recommendation
     deploy:
       resources:
         limits:
           memory: 500M               # This is high to enable supporting the recommendationCache feature flag use case
     restart: unless-stopped
     ports:
-      - "${RECOMMENDATION_SERVICE_PORT}"
+      - "${RECOMMENDATION_PORT}"
     environment:
-      - RECOMMENDATION_SERVICE_PORT
+      - RECOMMENDATION_PORT
       - PRODUCT_CATALOG_SERVICE_ADDR
       - FLAGD_HOST
       - FLAGD_PORT
       - OTEL_PYTHON_LOG_CORRELATION=true
       - OTEL_EXPORTER_OTLP_ENDPOINT
       - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
       - OTEL_RESOURCE_ATTRIBUTES
-      - OTEL_SERVICE_NAME=recommendationservice
+      - OTEL_SERVICE_NAME=recommendation
       - PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python
     depends_on:
       productcatalogservice:

docker-gen-proto.sh

@@ -31,5 +31,5 @@ gen_proto_go checkoutservice
 #gen_proto_js payment
 gen_proto_go productcatalogservice
 #gen_proto_php quote
-gen_proto_python recommendationservice
+gen_proto_python recommendation
 #gen_proto_rust shipping

ide-gen-proto.sh

@@ -76,5 +76,5 @@ gen_proto_ts react-native-app
 gen_proto_js payment
 gen_proto_go productcatalogservice
 # gen_proto_php quote
-gen_proto_python recommendationservice
+gen_proto_python recommendation
 gen_proto_rust shipping

renovate.json5

@@ -87,8 +87,8 @@
       "groupName": "quote",
     },
     {
-      "matchFileNames": ["src/recommendationservice/**"],
-      "groupName": "recommendationservice",
+      "matchFileNames": ["src/recommendation/**"],
+      "groupName": "recommendation",
     },
     {
       "matchFileNames": ["src/shipping/**"],

src/flagd/demo.flagd.json

@@ -10,7 +10,7 @@
       },
       "defaultVariant": "off"
     },
-    "recommendationServiceCacheFailure": {
+    "recommendationCacheFailure": {
       "description": "Fail recommendation service cache",
       "state": "ENABLED",
       "variants": {

src/frontend/gateways/rpc/Recommendations.gateway.ts

@@ -4,9 +4,9 @@
 import { ChannelCredentials } from '@grpc/grpc-js';
 import { ListRecommendationsResponse, RecommendationServiceClient } from '../../protos/demo';
 
-const { RECOMMENDATION_SERVICE_ADDR = '' } = process.env;
+const { RECOMMENDATION_ADDR = '' } = process.env;
 
-const client = new RecommendationServiceClient(RECOMMENDATION_SERVICE_ADDR, ChannelCredentials.createInsecure());
+const client = new RecommendationServiceClient(RECOMMENDATION_ADDR, ChannelCredentials.createInsecure());
 
 const RecommendationsGateway = () => ({
   listRecommendations(userId: string, productIds: string[]) {

src/frontend/next.config.js

@@ -18,7 +18,7 @@ const {
   CHECKOUT_SERVICE_ADDR = '',
   CURRENCY_ADDR = '',
   PRODUCT_CATALOG_SERVICE_ADDR = '',
-  RECOMMENDATION_SERVICE_ADDR = '',
+  RECOMMENDATION_ADDR = '',
   SHIPPING_ADDR = '',
   ENV_PLATFORM = '',
   OTEL_EXPORTER_OTLP_TRACES_ENDPOINT = '',
@@ -50,7 +50,7 @@ const nextConfig = {
     CHECKOUT_SERVICE_ADDR,
     CURRENCY_ADDR,
     PRODUCT_CATALOG_SERVICE_ADDR,
-    RECOMMENDATION_SERVICE_ADDR,
+    RECOMMENDATION_ADDR,
     SHIPPING_ADDR,
     OTEL_EXPORTER_OTLP_TRACES_ENDPOINT,
     NEXT_PUBLIC_PLATFORM: ENV_PLATFORM,

src/recommendationservice/Dockerfile src/recommendation/Dockerfile

@@ -13,7 +13,7 @@ RUN apt-get -qq update \
     && rm -rf /var/lib/apt/lists/*
 
 WORKDIR /usr/src/app/
-COPY ./src/recommendationservice/requirements.txt ./
+COPY ./src/recommendation/requirements.txt ./
 
 RUN pip install --upgrade pip
 RUN pip install --prefix="/reqs" -r requirements.txt
@@ -24,9 +24,9 @@ RUN pip install --prefix="/reqs" -r requirements.txt
 FROM base AS runtime
 WORKDIR /usr/src/app/
 COPY --from=builder /reqs /usr/local
-COPY ./src/recommendationservice/ ./
+COPY ./src/recommendation/ ./
 
 RUN opentelemetry-bootstrap -a install
 
-EXPOSE ${RECOMMENDATION_SERVICE_PORT}
+EXPOSE ${RECOMMENDATION_PORT}
 ENTRYPOINT [ "opentelemetry-instrument", "python", "recommendation_server.py" ]

src/recommendationservice/README.md src/recommendation/README.md

@@ -16,5 +16,5 @@ make docker-generate-protobuf
 From the root directory, run:
 
 ```sh
-docker compose build recommendationservice
+docker compose build recommendation
 ```

src/recommendationservice/demo_pb2.py src/recommendation/demo_pb2.py

@@ -75,7 +75,7 @@ def get_product_list(request_product_ids):
         request_product_ids = request_product_ids_str.split(',')
 
         # Feature flag scenario - Cache Leak
-        if check_feature_flag("recommendationServiceCacheFailure"):
+        if check_feature_flag("recommendationCacheFailure"):
             span.set_attribute("app.recommendation.cache_enabled", True)
             if random.random() < 0.5 or first_run:
                 first_run = False
@@ -123,7 +123,7 @@ def must_map_env(key: str):
 def check_feature_flag(flag_name: str):
     # Initialize OpenFeature
     client = api.get_client()
-    return client.get_boolean_value("recommendationServiceCacheFailure", False)
+    return client.get_boolean_value("recommendationCacheFailure", False)
 
 
 if __name__ == "__main__":
@@ -166,7 +166,7 @@ def check_feature_flag(flag_name: str):
     health_pb2_grpc.add_HealthServicer_to_server(service, server)
 
     # Start server
-    port = must_map_env('RECOMMENDATION_SERVICE_PORT')
+    port = must_map_env('RECOMMENDATION_PORT')
     server.add_insecure_port(f'[::]:{port}')
     server.start()
     logger.info(f'Recommendation service started, listening on port {port}')

src/recommendationservice/demo_pb2_grpc.py src/recommendation/demo_pb2_grpc.py

@@ -10,7 +10,7 @@ spec:
     type: grpc
     grpc:
       protobufFile: ../../../pb/demo.proto
-      address: ${var:RECOMMENDATION_SERVICE_ADDR}
+      address: ${var:RECOMMENDATION_ADDR}
       method: oteldemo.RecommendationService.ListRecommendations
       request: |-
         {

src/recommendationservice/genproto/Dockerfile src/recommendation/genproto/Dockerfile

@@ -8,7 +8,7 @@
 set -e
 
 # Availalble services to test
-ALL_SERVICES=("ad" "cart" "currency" "checkoutservice" "frontend" "email" "payment" "productcatalogservice" "recommendationservice" "shipping")
+ALL_SERVICES=("ad" "cart" "currency" "checkoutservice" "frontend" "email" "payment" "productcatalogservice" "recommendation" "shipping")
 
 ## Script variables
 # Will contain the list of services to test
@@ -50,8 +50,8 @@ spec:
       value: $PAYMENT_ADDR
     - key: PRODUCT_CATALOG_SERVICE_ADDR
       value: $PRODUCT_CATALOG_SERVICE_ADDR
-    - key: RECOMMENDATION_SERVICE_ADDR
-      value: $RECOMMENDATION_SERVICE_ADDR
+    - key: RECOMMENDATION_ADDR
+      value: $RECOMMENDATION_ADDR
     - key: SHIPPING_ADDR
       value: $SHIPPING_ADDR
     - key: KAFKA_SERVICE_ADDR