Merge pull request #55 from dockersamples/add-description-field

Add description field

Author: mikesir87

demo/sdlc-e2e/demo.patch

@@ -1,17 +1,5 @@
-diff --git a/src/services/ProductService.js b/src/services/ProductService.js
-index 85b9ecb..629bea9 100644
---- a/src/services/ProductService.js
-+++ b/src/services/ProductService.js
-@@ -49,7 +49,6 @@ async function createProduct(product) {
-     action: "product_created",
-     id: newProductId,
-     name: product.name,
--    upc: product.upc,
-     price: product.price,
-   });
- 
 diff --git a/Dockerfile b/Dockerfile
-index 0577738..38d57d9 100644
+index 0577738..4932dda 100644
 --- a/Dockerfile
 +++ b/Dockerfile
 @@ -5,7 +5,7 @@
@@ -23,18 +11,15 @@ index 0577738..38d57d9 100644
 
  # Setup a non-root user to run the app
  WORKDIR /usr/local/app
-@@ -23,9 +23,9 @@ COPY --chown=appuser:appuser package.json package-lock.json ./
+@@ -23,7 +23,7 @@ COPY --chown=appuser:appuser package.json package-lock.json ./
  # and automatically restart the app.
  ###########################################################
  FROM base AS dev
 -ENV NODE_ENV=development
 +ENV NODE_ENV development
  RUN npm install
--CMD ["yarn", "dev-container"]
-+CMD ["npm", "run", "dev-container"]
- 
+ CMD ["yarn", "dev-container"]
 
- ###########################################################
 @@ -35,10 +35,10 @@ CMD ["yarn", "dev-container"]
  # installs only the production dependencies.
  ###########################################################
@@ -49,16 +34,17 @@ index 0577738..38d57d9 100644
 -CMD [ "node", "src/index.js" ]
 \ No newline at end of file
 +CMD node src/index.js
+\ No newline at end of file
 diff --git a/package-lock.json b/package-lock.json
-index d3706f8..0a0c834 100644
+index d3706f8..d0158a8 100644
 --- a/package-lock.json
 +++ b/package-lock.json
 @@ -10,7 +10,7 @@
        "dependencies": {
          "@aws-sdk/client-s3": "^3.651.1",
          "dotenv": "^16.4.5",
 -        "express": "^4.21.1",
-+        "express": "4.17.1",
++        "express": "^4.17.1",
          "kafkajs": "^2.2.4",
          "multer": "^1.4.5-lts.1",
          "node-fetch": "v2",
@@ -850,15 +836,27 @@ index d3706f8..0a0c834 100644
        "engines": {
          "node": ">=0.6"
 diff --git a/package.json b/package.json
-index 8438638..14bdcf1 100644
+index 8438638..9fa06d2 100644
 --- a/package.json
 +++ b/package.json
 @@ -16,7 +16,7 @@
    "dependencies": {
      "@aws-sdk/client-s3": "^3.651.1",
      "dotenv": "^16.4.5",
 -    "express": "^4.21.1",
-+    "express": "4.17.1",
++    "express": "^4.17.1",
      "kafkajs": "^2.2.4",
      "multer": "^1.4.5-lts.1",
      "node-fetch": "v2",
+diff --git a/src/services/ProductService.js b/src/services/ProductService.js
+index 31eaed7..a212fd8 100644
+--- a/src/services/ProductService.js
++++ b/src/services/ProductService.js
+@@ -49,7 +49,6 @@ async function createProduct(product) {
+     action: "product_created",
+     id: newProductId,
+     name: product.name,
+-    upc: product.upc,
+     price: product.price,
+     description: product.description,
+   });

dev/db/1-create-schema.sql

@@ -1,6 +1,7 @@
 CREATE TABLE products (
   id SERIAL PRIMARY KEY,
   name VARCHAR(255) NOT NULL,
+  description TEXT,
   upc VARCHAR(12) NOT NULL UNIQUE,
   price DECIMAL(10, 2) NOT NULL,
   has_image BOOLEAN NOT NULL DEFAULT FALSE

dev/webapp/src/App.jsx

@@ -1,6 +1,7 @@
 import { useCallback, useEffect, useState } from "react";
 import "./App.css";
 import { ProductRow } from "./ProductRow";
+import sampleProducts from "./sample-products.json";
 
 function App() {
   const [catalog, setCatalog] = useState(null);
@@ -21,11 +22,18 @@ function App() {
 
   const createProduct = useCallback(() => {
     const body = {
-      name: "New Product",
-      price: 100,
+      price: 100 + Math.floor(Math.random() * 100),
       upc: 100000000000 + catalog.length + 1,
     };
 
+    if (catalog.length < sampleProducts.length) {
+      body.name = sampleProducts[catalog.length].name;
+      body.description = sampleProducts[catalog.length].description;
+    } else {
+      body.name = `New Product #${catalog.length + 1}`;
+      body.description = "A fancy description for an awesome product";
+    }
+
     fetch("/api/products", {
       method: "POST",
       headers: { "Content-Type": "application/json" },
@@ -57,6 +65,7 @@ function App() {
                 <tr>
                   <th>ID</th>
                   <th>Name</th>
+                  <th>Description</th>
                   <th>Price</th>
                   <th>UPC</th>
                   <th>Inventory</th>

dev/webapp/src/ProductRow.jsx

@@ -33,6 +33,7 @@ export function ProductRow({ product, onChange }) {
     <tr>
       <td>{product.id}</td>
       <td>{product.name}</td>
+      <td>{product.description}</td>
       <td>{product.price}</td>
       <td>{product.upc}</td>
       <td>

dev/webapp/src/sample-products.json

@@ -0,0 +1,22 @@
+[
+  {
+    "name": "Stellaris Dream Weaver",
+    "description": "Capture the cosmos in your sleep. The Stellaris Dream Weaver uses subtle sonic frequencies and bioluminescent patterns to gently guide you into a deeply restful and vividly imaginative dream state.  Features adjustable intensity levels and a calming lavender scent."
+  },
+  {
+    "name": "Chronos Pocket Watch",
+    "description": "A beautifully crafted antique pocket watch that doesn't tell time… exactly.  The Chronos Pocket Watch subtly alters your perception of time, allowing you to savor moments longer and feel less rushed. (Note: Results may vary.  Not recommended for time-sensitive activities.)"
+  },
+  {
+    "name": "Lumina Bloom Terrarium",
+    "description": "Bring a miniature, self-sustaining ecosystem to your desk. The Lumina Bloom Terrarium houses a variety of bioluminescent mosses and tiny, glowing fungi, creating a mesmerizing display that changes subtly throughout the day. Requires minimal maintenance."
+  },
+  {
+    "name": "EchoStone Meditation Bracelet",
+    "description": "Connect with your inner peace. The EchoStone Meditation Bracelet vibrates with a unique, personalized resonance, helping you center your thoughts and release tension.  Choose from a range of gemstone combinations for different vibrational effects."
+  },
+  {
+    "name": " Aetheria Sensory Quill",
+    "description": "Unlock your creativity with the Aetheria Sensory Quill. This elegant writing instrument responds to your emotions, subtly altering its texture and ink flow to reflect your mood.  Perfect for writers, artists, and anyone seeking a deeper connection to their creativity."
+  }
+]

src/services/ProductService.js

@@ -40,8 +40,8 @@ async function createProduct(product) {
     throw new Error("Product with this UPC already exists");
 
   const result = await client.query(
-    "INSERT INTO products (name, upc, price) VALUES ($1, $2, $3) RETURNING id",
-    [product.name, product.upc, product.price],
+    "INSERT INTO products (name, upc, price, description) VALUES ($1, $2, $3, $4) RETURNING id",
+    [product.name, product.upc, product.price, product.description],
   );
   const newProductId = result.rows[0].id;
 
@@ -51,6 +51,7 @@ async function createProduct(product) {
     name: product.name,
     upc: product.upc,
     price: product.price,
+    description: product.description,
   });
 
   return {

test/integration/productCreation.integration.spec.js

@@ -50,17 +50,20 @@ describe("Product creation", () => {
   it("should publish and return a product when creating a product", async () => {
     const product = await productService.createProduct({
       name: "Test Product",
+      description: "Test product description",
       price: 100,
       upc: "100000000001",
     });
 
     expect(product.id).toBeDefined();
     expect(product.name).toBe("Test Product");
     expect(product.price).toBe(100);
+    expect(product.description).toBe("Test product description");
 
     const retrievedProduct = await productService.getProductById(product.id);
     expect(retrievedProduct.id).toBe(product.id);
     expect(retrievedProduct.name).toBe(product.name);
+    expect(retrievedProduct.description).toBe(product.description);
     expect(retrievedProduct.inventory).toEqual({
       error: true,
       message: "Failed to get inventory",
@@ -70,12 +73,16 @@ describe("Product creation", () => {
   it("should publish a Kafka message when creating a product", async () => {
     createdProduct = await productService.createProduct({
       name: "Kafka publishing test",
+      description: "Kafka publishing test description",
       price: 100,
       upc: "100000000002",
     });
 
     expect(createdProduct.id).toBeDefined();
     expect(createdProduct.name).toBe("Kafka publishing test");
+    expect(createdProduct.description).toBe(
+      "Kafka publishing test description",
+    );
     expect(createdProduct.price).toBe(100);
     expect(createdProduct.upc).toBe("100000000002");
 
@@ -88,6 +95,7 @@ describe("Product creation", () => {
   it("should upload a file correctly", async () => {
     createdProduct = await productService.createProduct({
       name: "Kafka publishing test",
+      description: "Kafka publishing test description",
       price: 100,
       upc: "100000000004",
     });
@@ -123,13 +131,15 @@ describe("Product creation", () => {
   it("doesn't allow duplicate UPCs", async () => {
     await productService.createProduct({
       name: "Kafka publishing test",
+      description: "Kafka publishing test description",
       price: 100,
       upc: "100000000003",
     });
 
     await expect(
       productService.createProduct({
         name: "Kafka publishing test",
+        description: "Kafka publishing test description",
         price: 100,
         upc: "100000000003",
       }),