Merge branch 'main' into chore/award-static-analysis

chore: address lint issues

Author: scottgerring

.github/workflows/docker-compose-integration.yml

@@ -23,33 +23,8 @@ jobs:
 
     - name: Wait for services to be healthy
       run: |
-        echo "Waiting for all services to be healthy..."
-        # Wait for services with health checks to be healthy (7 services) and all services to be up
-        # Increased timeout to 10 minutes for CI environment
-        timeout 600 bash -c 'while true; do
-          echo "=== Detailed Service Status ==="
-          docker compose ps --format "table {{.Name}}\t{{.Status}}\t{{.Health}}"
-          echo "=== Unhealthy Services ==="
-          unhealthy_services=$(docker compose ps --format "{{.Name}} {{.Health}}" | grep -v healthy | grep -v "^[[:space:]]*$" || echo "")
-          if [ -n "$unhealthy_services" ]; then
-            echo "$unhealthy_services"
-            echo "=== Logs for unhealthy services ==="
-            for service in $(echo "$unhealthy_services" | awk "{print \$1}"); do
-              echo "--- Logs for $service ---"
-              docker compose logs --tail=10 "$service" || echo "No logs for $service"
-            done
-          else
-            echo "All services healthy or no health check"
-          fi
-          healthy_count=$(docker compose ps --format "{{.Health}}" | grep -c "healthy" || echo "0")
-          up_count=$(docker compose ps --format "{{.Status}}" | grep -c "Up" || echo "0")
-          echo "Progress: $healthy_count/7 healthy, $up_count services up"
-          if [ "$healthy_count" -ge 7 ] && [ "$up_count" -ge 7 ]; then
-            echo "All services are healthy!"
-            break
-          fi
-          sleep 10
-        done'
+        echo Pausing for 60s to allow services to start
+        sleep 60
         docker compose ps
       
     - name: Test dashboard endpoints
@@ -61,8 +36,7 @@ jobs:
       run: |
         # Test sticker award API with sample user data
         curl -f -X GET "http://localhost:8080/api/award/v1/users/user-001/stickers" || exit 1
-        # TODO!
-        # curl -f -X GET "http://localhost:8080/api/users/v1/health" || exit 1
+        curl -f -X GET "http://localhost:8080/api/users/v1/health" || exit 1
       
     - name: Show service logs on failure
       if: failure()

README.md

@@ -27,6 +27,8 @@ As a reference application, Stickerlandia showcases **platform adaptability** by
 
 Comprehensive documentation is available in the [docs](./docs/README.md).
 
+For deployment options and platform-specific configurations, see the [deployment guide](./docs/deploy.md).
+
 ## High-Level Architecture
 
 Stickerlandia follows a microservice architecture that can run in various configurations across different types of modern infrastructure:

docker-compose.yml

@@ -12,6 +12,28 @@ version: '3.8'
 # - Traefik Dashboard:      http://localhost:8081/dashboard/
 # - Redpanda Console:       http://localhost:8082
 #
+# 
+# Signing Up
+# ---------
+# curl -X POST http://localhost:8080/api/users/v1/register \
+#    -H "Content-Type: application/json" \
+#    -d '{
+#      "firstName": "John",
+#      "lastName": "Doe",
+#      "emailAddress": "john.doe@example.com",
+#      "password": "ValidPass123!"
+#    }'
+#
+# 
+# Logging In
+# ----------
+# curl -X POST http://localhost:8080/api/users/v1/login \
+#   -H "Content-Type:  application/x-www-form-urlencoded" \
+#   -d "grant_type=password&username=john.doe@example.com&password=ValidPass123!&client_id=user-authentication&client_secret=388D45FA-B36B-4988-BA59-B187D329C207"
+
+# 
+
+
 services:
   traefik:
     image: traefik:v3.0

docs/deploy.md

@@ -0,0 +1,24 @@
+# Deployment Targets
+
+This page describes the deployment targets Stickerlandia supports or aims to support. It aims to pull forward any and all details that may impact early-stages implementation.
+
+## Platform Overview
+
+Stickerlandia will support both serverless and container-based platforms, self-hosted, as well as in the cloud.
+
+### Serverless
+
+| Platform | Description | IaC | Messaging | Blob Storage | Database | Ingress | Ingress Features |
+|----------|-------------|-----|-----------|--------------|----------|---------|------------------|
+| AWS (Serverless) | Containers on Amazon ECS/Fargate & Lambda functions with managed services | CDK | Amazon SQS/SNS/EventBridge | Amazon S3 | Amazon RDS/DynamoDB | API Gateway | Rate limiting, CORS, JWT/OIDC validation, API keys |
+| Azure (Serverless) | Azure Container Apps & Azure Functions with managed services | Terraform | Azure Service Bus | Azure Blob Storage | Azure SQL | Azure API Management | Path routing, rate limiting, JWT/OIDC validation |
+
+### Containerised
+
+| Platform | Description | IaC | Messaging | Blob Storage | Database | Ingress | Ingress Features |
+|----------|-------------|-----|-----------|--------------|----------|---------|------------------|
+| AWS (EKS) | Kubernetes on Elastic Kubernetes Service | K8S Manifests, CDK | Apache Kafka on MSK | Amazon S3 | Amazon RDS | ALB + Ingress Controller | Path routing, SSL termination (No native OIDC) |
+| Docker-Compose | Local development environment | docker-compose.yml | Kafka | MinIO | PostgreSQL | Traefik | Path routing, SSL (No native OIDC) |
+| Kubernetes | Generic Kubernetes deployment | K8S Manifests | Kafka | MinIO | PostgreSQL | Ingress Controller | SSL termination, path routing (No native OIDC) |
+
+

sticker-award/src/main/java/com/datadoghq/stickerlandia/stickeraward/sticker/StickerImageSeeder.java

@@ -0,0 +1,91 @@
+package com.datadoghq.stickerlandia.stickeraward.sticker;
+
+import com.datadoghq.stickerlandia.stickeraward.sticker.entity.Sticker;
+import io.quarkus.runtime.StartupEvent;
+import jakarta.enterprise.context.ApplicationScoped;
+import jakarta.enterprise.event.Observes;
+import jakarta.inject.Inject;
+import jakarta.transaction.Transactional;
+import java.io.InputStream;
+import org.jboss.logging.Logger;
+
+/**
+ * Service responsible for seeding sticker images during application startup. This class loads
+ * default sticker images from the classpath and uploads them to the configured storage service,
+ * associating them with existing stickers.
+ */
+@ApplicationScoped
+public class StickerImageSeeder {
+
+    private static final Logger LOG = Logger.getLogger(StickerImageSeeder.class);
+
+    @Inject StickerImageService stickerImageService;
+
+    @Inject StickerRepository stickerRepository;
+
+    /**
+     * Handles the startup event to seed sticker images. This method is called during application
+     * startup and ensures that default sticker images are loaded and associated with existing
+     * stickers.
+     *
+     * @param ev the startup event
+     */
+    @Transactional
+    public void onStartup(@Observes StartupEvent ev) {
+        LOG.info("Starting sticker image seeding...");
+
+        try {
+            seedStickerImage("sticker-001", "/stickers/dd_icon_rgb.png", "Datadog Purple Logo");
+            seedStickerImage("sticker-002", "/stickers/dd_icon_white.png", "Datadog White Logo");
+
+            LOG.info("Sticker image seeding completed successfully");
+        } catch (Exception e) {
+            LOG.error("Failed to seed sticker images", e);
+        }
+    }
+
+    private void seedStickerImage(String stickerId, String resourcePath, String description) {
+        // Check if sticker exists and doesn't already have an image
+        Sticker sticker = Sticker.findById(stickerId);
+        if (sticker == null) {
+            LOG.warnf("Sticker %s not found, skipping image seeding", stickerId);
+            return;
+        }
+
+        if (sticker.getImageKey() != null && !sticker.getImageKey().isEmpty()) {
+            LOG.infof(
+                    "Sticker %s already has image key %s, skipping",
+                    stickerId, sticker.getImageKey());
+            return;
+        }
+
+        try {
+            // Load image from resources
+            InputStream imageStream = getClass().getResourceAsStream(resourcePath);
+            if (imageStream == null) {
+                LOG.errorf("Could not find image resource: %s", resourcePath);
+                return;
+            }
+
+            // Get file size for upload
+            byte[] imageData = imageStream.readAllBytes();
+            imageStream.close();
+
+            // Upload image to our storage service
+            InputStream uploadStream = getClass().getResourceAsStream(resourcePath);
+            String imageKey =
+                    stickerImageService.uploadImage(uploadStream, "image/png", imageData.length);
+            uploadStream.close();
+
+            // Update sticker with image key
+            stickerRepository.updateStickerImageKey(stickerId, imageKey);
+
+            LOG.infof(
+                    "Successfully seeded image for sticker %s with key %s (%s)",
+                    stickerId, imageKey, description);
+
+        } catch (Exception e) {
+            LOG.errorf(e, "Failed to seed image for sticker %s from %s", stickerId, resourcePath);
+        }
+    }
+}