reduce comments

Author: nextinterfaces

apps/items-service/src/config.ts

@@ -26,9 +26,6 @@ export interface Config {
   database: DatabaseConfig;
 }
 
-/**
- * Load and validate configuration from environment variables
- */
 export function loadConfig(): Config {
   return {
     server: {

apps/items-service/src/controllers.ts

@@ -8,9 +8,6 @@ import { ItemsRepository } from "./database.js";
 import type { CreateItemDto, HealthResponse, ItemsListResponse } from "./models.js";
 import { json, badRequest, internalServerError, serviceUnavailable } from "./http-utils.js";
 
-/**
- * Health check controller
- */
 export class HealthController {
   constructor(
     private repository: ItemsRepository,
@@ -58,15 +55,9 @@ export class HealthController {
   }
 }
 
-/**
- * Items controller
- */
 export class ItemsController {
   constructor(private repository: ItemsRepository) {}
 
-  /**
-   * List all items
-   */
   async list(): Promise<Response> {
     const tracer = trace.getTracer("items-service");
     return await tracer.startActiveSpan("listItems", async (span) => {
@@ -88,14 +79,10 @@ export class ItemsController {
     });
   }
 
-  /**
-   * Create a new item
-   */
   async create(req: Request): Promise<Response> {
     const tracer = trace.getTracer("items-service");
     return await tracer.startActiveSpan("createItem", async (span) => {
       try {
-        // Parse and validate request body
         let body: Partial<CreateItemDto>;
         try {
           body = (await req.json()) as Partial<CreateItemDto>;
@@ -106,14 +93,12 @@ export class ItemsController {
           return badRequest("invalid json");
         }
 
-        // Validate required fields
         if (!body?.name || typeof body.name !== "string") {
           span.setStatus({ code: SpanStatusCode.ERROR, message: "Name required" });
           span.end();
           return badRequest("name required");
         }
 
-        // Create item
         const item = await this.repository.create({ name: body.name });
 
         span.setAttribute("item.id", item.id);

apps/items-service/src/database.ts

@@ -4,9 +4,7 @@ import type { DatabaseConfig } from "./config.js";
 import type { Item, CreateItemDto } from "./models.js";
 
 let sql: ReturnType<typeof postgres> | null = null;
-/**
- * Initialize database connection
- */
+
 export function initDatabase(config: DatabaseConfig): ReturnType<typeof postgres> {
   if (sql) {
     return sql;
@@ -26,19 +24,13 @@ export function initDatabase(config: DatabaseConfig): ReturnType<typeof postgres
   return sql;
 }
 
-/**
- * Get the database connection
- */
 export function getDatabase(): ReturnType<typeof postgres> {
   if (!sql) {
     throw new Error("Database not initialized. Call initDatabase first.");
   }
   return sql;
 }
 
-/**
- * Initialize database schema
- */
 export async function initSchema(): Promise<void> {
   const tracer = trace.getTracer("items-service");
   return await tracer.startActiveSpan("initDatabase", async (span) => {
@@ -51,10 +43,10 @@ export async function initSchema(): Promise<void> {
           created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
         )
       `;
-      console.log("✅ Database initialized successfully");
+      console.log("Database initialized successfully");
       span.setStatus({ code: SpanStatusCode.OK });
     } catch (error) {
-      console.error("❌ Failed to initialize database:", error);
+      console.error("Failed to initialize database:", error);
       span.recordException(error as Error);
       span.setStatus({ code: SpanStatusCode.ERROR, message: String(error) });
       throw error;
@@ -64,19 +56,13 @@ export async function initSchema(): Promise<void> {
   });
 }
 
-/**
- * Repository for items data access
- */
 export class ItemsRepository {
   private readonly db: ReturnType<typeof postgres>;
 
   constructor() {
     this.db = getDatabase();
   }
 
-  /**
-   * Get all items
-   */
   async findAll(): Promise<Item[]> {
     return await this.db<Item[]>`
       SELECT id, name 
@@ -85,9 +71,6 @@ export class ItemsRepository {
     `;
   }
 
-  /**
-   * Create a new item
-   */
   async create(dto: CreateItemDto): Promise<Item> {
     const [item] = await this.db<Item[]>`
       INSERT INTO items (name)
@@ -97,9 +80,6 @@ export class ItemsRepository {
     return item;
   }
 
-  /**
-   * Check database connection health
-   */
   async healthCheck(): Promise<boolean> {
     try {
       await this.db`SELECT 1`;

apps/items-service/src/index.ts

@@ -13,54 +13,38 @@
  * - OTEL_SERVICE_NAME              - Service name (default: items-service)
  * - OTEL_LOG_LEVEL                 - Log level (default: info)
  */
-
-// Initialize OpenTelemetry first, before any other imports
 import { initTelemetry } from "./telemetry.js";
 initTelemetry();
 
-// Import application modules
 import { loadConfig } from "./config.js";
 import { initDatabase, initSchema, ItemsRepository } from "./database.js";
 import { HealthController, ItemsController } from "./controllers.js";
 import { Router } from "./router.js";
 
-/**
- * Bootstrap and start the application
- */
 async function main() {
   try {
-    // Load configuration
     const config = loadConfig();
 
-    // Initialize database connection
     initDatabase(config.database);
     await initSchema();
 
-    // Initialize repositories
     const itemsRepository = new ItemsRepository();
-
-    // Initialize controllers
     const healthController = new HealthController(itemsRepository, config.server.commitSha);
     const itemsController = new ItemsController(itemsRepository);
-
-    // Initialize router
     const router = new Router(config.server, healthController, itemsController);
 
-    // Start HTTP server
     const server = Bun.serve({
       port: config.server.port,
       fetch: (req) => router.handle(req),
     });
 
-    // Log startup information
-    console.log(`✅ Items service listening on http://localhost:${server.port}`);
-    console.log(`📚 Swagger UI: http://localhost:${server.port}/docs`);
-    console.log(`🗄️  Database: ${config.database.host}:${config.database.port}/${config.database.database}`);
+    console.log(`Items service listening on http://localhost:${server.port}`);
+    console.log(`Swagger UI: http://localhost:${server.port}/docs`);
+    console.log(`Database: ${config.database.host}:${config.database.port}/${config.database.database}`);
   } catch (error) {
-    console.error("❌ Failed to start server:", error);
+    console.error("Failed to start server:", error);
     process.exit(1);
   }
 }
 
-// Start the application
 await main();

apps/items-service/src/openapi.ts

@@ -1,5 +1,3 @@
-// openapi.ts - OpenAPI specification for the items service
-
 export const openapi = {
   openapi: "3.0.3",
   info: { title: "items API", version: "1.0.1", description: "Simple items service built with Bun" },

apps/items-service/src/router.ts

@@ -10,23 +10,14 @@ import { openapi } from "./openapi.js";
 import { json, notFound, html } from "./http-utils.js";
 import type { ServerConfig } from "./config.js";
 
-/**
- * Route handler type
- */
 type RouteHandler = (req: Request) => Promise<Response> | Response;
 
-/**
- * Route definition
- */
 interface Route {
   method: string;
   path: string;
   handler: RouteHandler;
 }
 
-/**
- * Router class for handling HTTP requests
- */
 export class Router {
   private routes: Route[] = [];
 
@@ -38,9 +29,6 @@ export class Router {
     this.registerRoutes();
   }
 
-  /**
-   * Register all application routes
-   */
   private registerRoutes(): void {
     // Root page
     this.routes.push({
@@ -85,22 +73,15 @@ export class Router {
     });
   }
 
-  /**
-   * Find a matching route for the request
-   */
   private findRoute(method: string, path: string): Route | undefined {
     return this.routes.find((route) => route.method === method && route.path === path);
   }
 
-  /**
-   * Handle incoming HTTP request
-   */
   async handle(req: Request): Promise<Response> {
     const tracer = trace.getTracer("items-service");
     const url = new URL(req.url);
     const path = url.pathname;
 
-    // Create a span for the HTTP request
     return await tracer.startActiveSpan(`${req.method} ${path}`, async (span) => {
       try {
         span.setAttributes({

apps/items-service/src/telemetry.ts

@@ -1,4 +1,4 @@
-// telemetry.ts - OpenTelemetry configuration
+// OpenTelemetry configuration
 import { NodeSDK } from "@opentelemetry/sdk-node";
 import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
 import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
@@ -7,13 +7,12 @@ import { ATTR_SERVICE_NAME, ATTR_SERVICE_VERSION } from "@opentelemetry/semantic
 import { diag, DiagConsoleLogger, DiagLogLevel } from "@opentelemetry/api";
 
 // Configuration from environment variables
-const OTEL_ENABLED = true; //process.env.OTEL_ENABLED !== "false"; // Default to true
+const OTEL_ENABLED = process.env.OTEL_ENABLED !== "false"; // Default to true
 const OTEL_EXPORTER_OTLP_ENDPOINT = process.env.OTEL_EXPORTER_OTLP_ENDPOINT || "http://localhost:4318";
 const OTEL_SERVICE_NAME = process.env.OTEL_SERVICE_NAME || "items-service";
 const OTEL_SERVICE_VERSION = process.env.OTEL_SERVICE_VERSION || "1.0.0";
 const OTEL_LOG_LEVEL = process.env.OTEL_LOG_LEVEL || "info";
 
-// Enable OpenTelemetry diagnostic logging for debugging
 if (OTEL_LOG_LEVEL === "debug") {
   diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.DEBUG);
 } else if (OTEL_LOG_LEVEL === "verbose") {
@@ -24,7 +23,7 @@ let sdk: NodeSDK | null = null;
 
 export function initTelemetry() {
   if (!OTEL_ENABLED) {
-    console.log("📊 OpenTelemetry is disabled");
+    console.log("OpenTelemetry is disabled");
     return;
   }
 
@@ -41,7 +40,6 @@ export function initTelemetry() {
       [ATTR_SERVICE_VERSION]: OTEL_SERVICE_VERSION,
     });
 
-    // Initialize the SDK
     sdk = new NodeSDK({
       resource,
       traceExporter,
@@ -63,12 +61,11 @@ export function initTelemetry() {
       ],
     });
 
-    // Start the SDK
     sdk.start();
 
-    console.log(`📊 OpenTelemetry initialized`);
-    console.log(`   Service: ${OTEL_SERVICE_NAME} v${OTEL_SERVICE_VERSION}`);
-    console.log(`   Endpoint: ${OTEL_EXPORTER_OTLP_ENDPOINT}`);
+    console.log(`OpenTelemetry initialized`);
+    console.log(`Service: ${OTEL_SERVICE_NAME} v${OTEL_SERVICE_VERSION}`);
+    console.log(`Endpoint: ${OTEL_EXPORTER_OTLP_ENDPOINT}`);
 
     // Handle graceful shutdown
     process.on("SIGTERM", async () => {
@@ -81,17 +78,17 @@ export function initTelemetry() {
       process.exit(0);
     });
   } catch (error) {
-    console.error("❌ Failed to initialize OpenTelemetry:", error);
+    console.error("Failed to initialize OpenTelemetry:", error);
   }
 }
 
 export async function shutdownTelemetry() {
   if (sdk) {
     try {
       await sdk.shutdown();
-      console.log("📊 OpenTelemetry shut down successfully");
+      console.log("OpenTelemetry shut down successfully");
     } catch (error) {
-      console.error("❌ Error shutting down OpenTelemetry:", error);
+      console.error("Error shutting down OpenTelemetry:", error);
     }
   }
 }