Add PHP quote service

.env

@@ -37,6 +37,9 @@ PAYMENT_SERVICE_ADDR=paymentservice:${PAYMENT_SERVICE_PORT}
 PRODUCT_CATALOG_SERVICE_PORT=3550
 PRODUCT_CATALOG_SERVICE_ADDR=productcatalogservice:${PRODUCT_CATALOG_SERVICE_PORT}
 
+QUOTE_SERVICE_PORT=8090
+QUOTE_SERVICE_ADDR=quoteservice:${QUOTE_SERVICE_PORT}
+
 RECOMMENDATION_SERVICE_PORT=9001
 RECOMMENDATION_SERVICE_ADDR=recommendationservice:${RECOMMENDATION_SERVICE_PORT}
 

.gitignore

@@ -31,4 +31,5 @@ build
 src/frontend/protos
 next-env.d.ts
 src/frontend/cypress/videos
-src/frontend/cypress/screenshots
+src/frontend/cypress/screenshots
+vendor/

docker-compose.yml

@@ -294,6 +294,28 @@ services:
  - otelcol
  logging: *logging
 
+ quoteservice:
+ image: ${IMAGE_NAME}:${IMAGE_VERSION}-quoteservice
+ container_name: quoteservice
+ build:
+ context: ./
+ dockerfile: ./src/quoteservice/Dockerfile
+ ports:
+ # remove localhost port b4 merging
+ - "${QUOTE_SERVICE_PORT}:${QUOTE_SERVICE_PORT}"
+ environment:
+ # OTEL_EXPORTER_OTLP_TRACES_ENDPOINT # Not working for PHP
+ - QUOTE_SERVICE_PORT
+ - OTEL_SERVICE_NAME=quoteservice
+ - OTEL_EXPORTER_OTLP_ENDPOINT=otelcol:4317
+ - OTEL_TRACES_SAMPLER=parentbased_always_on
+ - OTEL_TRACES_EXPORTER=otlp
+ - OTEL_EXPORTER_OTLP_TRACES_PROTOCOL=grpc
+ - OTEL_PHP_TRACES_PROCESSOR=simple
+ depends_on:
+ - otelcol
+ logging: *logging
+
  # RecommendationService
  recommendationservice:
  image: ${IMAGE_NAME}:${IMAGE_VERSION}-recommendationservice
@@ -333,6 +355,7 @@ services:
  - "${SHIPPING_SERVICE_PORT}"
  environment:
  - SHIPPING_SERVICE_PORT
+ - QUOTE_SERVICE_ADDR
  - OTEL_EXPORTER_OTLP_TRACES_ENDPOINT
  - OTEL_SERVICE_NAME=shippingservice
  depends_on:

src/quoteservice/.dockerignore

@@ -0,0 +1,4 @@
+.dockerignore
+.idea
+Dockerfile
+vendor

src/quoteservice/.gitignore

@@ -0,0 +1,7 @@
+.idea/
+.vscode/
+/coverage/
+/vendor/
+/logs/*
+!/logs/README.md
+.phpunit.result.cache

src/quoteservice/Dockerfile

@@ -0,0 +1,26 @@
+FROM composer:2.4.1 AS build
+
+WORKDIR /tmp/
+COPY ./src/quoteservice/composer.json .
+
+RUN composer install \
+ --ignore-platform-reqs \
+ --no-interaction \
+ --no-plugins \
+ --no-scripts \
+ --prefer-dist
+
+FROM php:8.1-apache-buster
+
+# install GRPC (required for the OTel exporter)
+RUN apt-get -y update && apt install -y --no-install-recommends zlib1g-dev && \
+ pecl install grpc && \
+ docker-php-ext-enable grpc
+
+WORKDIR /var/www
+COPY --from=build /tmp/vendor/ /var/www/vendor/
+COPY ./src/quoteservice/ /var/www
+
+EXPOSE 8090
+
+ENTRYPOINT ["php", "-S", "0.0.0.0:8090", "-t", "public"]

src/quoteservice/app/dependencies.php

@@ -0,0 +1,29 @@
+<?php
+declare(strict_types=1);
+
+use App\Application\Settings\SettingsInterface;
+use DI\ContainerBuilder;
+use Monolog\Handler\StreamHandler;
+use Monolog\Logger;
+use Monolog\Processor\UidProcessor;
+use Psr\Container\ContainerInterface;
+use Psr\Log\LoggerInterface;
+
+return function (ContainerBuilder $containerBuilder) {
+ $containerBuilder->addDefinitions([
+ LoggerInterface::class => function (ContainerInterface $c) {
+ $settings = $c->get(SettingsInterface::class);
+
+ $loggerSettings = $settings->get('logger');
+ $logger = new Logger($loggerSettings['name']);
+
+ $processor = new UidProcessor();
+ $logger->pushProcessor($processor);
+
+ $handler = new StreamHandler($loggerSettings['path'], $loggerSettings['level']);
+ $logger->pushHandler($handler);
+
+ return $logger;
+ },
+ ]);
+};

src/quoteservice/app/routes.php

@@ -0,0 +1,27 @@
+<?php
+declare(strict_types=1);
+
+use OpenTelemetry\API\Trace\AbstractSpan;
+use Psr\Http\Message\ResponseInterface as Response;
+use Psr\Http\Message\ServerRequestInterface as Request;
+use Slim\App;
+
+return function (App $app) {
+ $app->get('/getquote', function (Request $request, Response $response) {
+ $span = AbstractSpan::getCurrent();
+
+ # do the math here
+ $data = ['quote' => 32.50];
+
+ $span->addEvent('Received get quote request, processing it.');
+ $span->setAttribute('app.quote.cost.total', $data['quote']);
+
+ $payload = json_encode($data);
+ $response->getBody()->write($payload);
+
+ $span->addEvent('Quote processed, response sent back');
+
+ return $response
+ ->withHeader('Content-Type', 'application/json');
+ });
+};

src/quoteservice/app/settings.php

@@ -0,0 +1,25 @@
+<?php
+declare(strict_types=1);
+
+use App\Application\Settings\Settings;
+use App\Application\Settings\SettingsInterface;
+use DI\ContainerBuilder;
+use Monolog\Logger;
+
+return function (ContainerBuilder $containerBuilder) {
+ // Global Settings Object
+ $containerBuilder->addDefinitions([
+ SettingsInterface::class => function () {
+ return new Settings([
+ 'displayErrorDetails' => true, // Should be set to false in production
+ 'logError' => false,
+ 'logErrorDetails' => false,
+ 'logger' => [
+ 'name' => 'slim-app',
+ 'path' => 'php://stdout',
+ 'level' => Logger::DEBUG,
+ ],
+ ]);
+ }
+ ]);
+};

src/quoteservice/composer.json

@@ -0,0 +1,26 @@
+{
+ "name": "openteletry-demo/quoteservice",
+ "description": "Quote Service part of OpenTelemetry Demo",
+ "license": "Apache-2.0",
+ "require": {
+ "php": "^7.4 || ^8.1",
+ "ext-json": "*",
+ "monolog/monolog": "^2.3",
+ "open-telemetry/opentelemetry": "dev-main",
+ "guzzlehttp/guzzle": "*",
+ "php-di/php-di": "^6.3",
+ "php-di/slim-bridge": "^3.2",
+ "php-http/guzzle7-adapter": "*",
+ "slim/psr7": "^1.5",
+ "slim/slim": "^4.9"
+ },
+ "autoload": {
+ "psr-4": {
+ "App\\": "src/"
+ }
+ },
+ "scripts": {
+ "start": "php -S localhost:8080 -t public",
+ "test": "phpunit"
+ }
+}

src/quoteservice/public/index.php

@@ -0,0 +1,98 @@
+<?php
+declare(strict_types=1);
+
+use DI\Bridge\Slim\Bridge;
+use DI\ContainerBuilder;
+use GuzzleHttp\Client;
+use GuzzleHttp\HandlerStack;
+use GuzzleHttp\Promise\PromiseInterface;
+use OpenTelemetry\API\Trace\Propagation\TraceContextPropagator;
+use OpenTelemetry\API\Trace\SpanKind;
+use OpenTelemetry\API\Trace\StatusCode;
+use OpenTelemetry\Context\Context;
+use OpenTelemetry\SDK\Trace\Tracer;
+use OpenTelemetry\SDK\Trace\TracerProviderFactory;
+use OpenTelemetry\SDK\Common\Util\ShutdownHandler;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface as Response;
+use Psr\Http\Message\ServerRequestInterface as Request;
+use Psr\Http\Server\RequestHandlerInterface as RequestHandler;
+use Slim\Factory\AppFactory;
+use Slim\Factory\ServerRequestCreatorFactory;
+use Slim\Routing\RouteContext;
+
+require __DIR__ . '/../vendor/autoload.php';
+
+// Instantiate PHP-DI ContainerBuilder
+$containerBuilder = new ContainerBuilder();
+
+// Set up settings
+$settings = require __DIR__ . '/../app/settings.php';
+$settings($containerBuilder);
+
+// Set up dependencies
+$dependencies = require __DIR__ . '/../app/dependencies.php';
+$dependencies($containerBuilder);
+
+// Add OTel
+$tracerProvider = (new TracerProviderFactory('quoteservice'))->create();
+ShutdownHandler::register([$tracerProvider, 'shutdown']);
+$tracer = $tracerProvider->getTracer('io.opentelemetry.contrib.php');
+
+$containerBuilder->addDefinitions([
+ Tracer::class => $tracer
+]);
+
+// Build PHP-DI Container instance
+$container = $containerBuilder->build();
+
+// Instantiate the app
+AppFactory::setContainer($container);
+$app = Bridge::create($container);
+$callableResolver = $app->getCallableResolver();
+
+// Register middleware
+//middleware starts root span based on route pattern, sets status from http code
+$app->add(function (Request $request, RequestHandler $handler) use ($tracer) {
+ $parent = TraceContextPropagator::getInstance()->extract($request->getHeaders());
+ $routeContext = RouteContext::fromRequest($request);
+ $route = $routeContext->getRoute();
+ $root = $tracer->spanBuilder($route->getPattern())
+ ->setStartTimestamp((int) ($request->getServerParams()['REQUEST_TIME_FLOAT'] * 1e9))
+ ->setParent($parent)
+ ->setSpanKind(SpanKind::KIND_SERVER)
+ ->startSpan();
+ $scope = $root->activate();
+
+ try {
+ $response = $handler->handle($request);
+ $root->setStatus($response->getStatusCode() < 500 ? StatusCode::STATUS_OK : StatusCode::STATUS_ERROR);
+ } finally {
+ $root->end();
+ $scope->detach();
+ }
+
+ return $response;
+});
+$app->addRoutingMiddleware();
+
+// Register routes
+$routes = require __DIR__ . '/../app/routes.php';
+$routes($app);
+
+// Create Request object from globals
+$serverRequestCreator = ServerRequestCreatorFactory::create();
+$request = $serverRequestCreator->createServerRequestFromGlobals();
+
+// Create Error Handler
+$responseFactory = $app->getResponseFactory();
+
+// Add Body Parsing Middleware
+$app->addBodyParsingMiddleware();
+
+// Add Error Middleware
+$errorMiddleware = $app->addErrorMiddleware(true, true, true);
+
+// Run App
+$app->run();
+$tracerProvider->shutdown();

src/quoteservice/src/Application/Settings/Settings.php

@@ -0,0 +1,22 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Application\Settings;
+
+class Settings implements SettingsInterface
+{
+ private array $settings;
+
+ public function __construct(array $settings)
+ {
+ $this->settings = $settings;
+ }
+
+ /**
+ * @return mixed
+ */
+ public function get(string $key = '')
+ {
+ return (empty($key)) ? $this->settings : $this->settings[$key];
+ }
+}

src/quoteservice/src/Application/Settings/SettingsInterface.php

@@ -0,0 +1,13 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Application\Settings;
+
+interface SettingsInterface
+{
+ /**
+ * @param string $key
+ * @return mixed
+ */
+ public function get(string $key = '');
+}