feat: productbus (#81)

* feat: add productbus entry schema

* fix: schema changes

* move cs support under its route

* fix: handle 404 on unknown routes

* allow json extension, schema tweaks

* fix: formatting tweaks

* fix: allow json extension in catalog get

* handle images

* chore: fix tests

* add logs

* more logs

* more logs

* test

* get media filename from request

* test

* dont mutate execution context

* cleanup

* chore: fix postdeploy tests

* chore: cleanup

* cleanup

* fix postdeploy test

* chore: address comments

* chore: fix postdeploy test

Author: maxakuru

package-lock.json

@@ -67,5 +67,8 @@
   },
   "lint-staged": {
     "*.(js|cjs|mjs)": "eslint"
+  },
+  "dependencies": {
+    "@adobe/helix-shared-process-queue": "^3.1.1"
   }
 }

package.json

@@ -15,7 +15,7 @@ import { resolveConfig } from './utils/config.js';
 import handlers from './routes/index.js';
 
 /**
- * @param {Request} req
+ * @param {import("@cloudflare/workers-types/experimental").Request} req
  */
 async function parseData(req) {
   if (['GET', 'HEAD', 'OPTIONS'].includes(req.method)) {
@@ -40,22 +40,27 @@ async function parseData(req) {
 }
 
 /**
- * @param {import("@cloudflare/workers-types/experimental").ExecutionContext} pctx
- * @param {Request} req
+ * @param {import("@cloudflare/workers-types/experimental").ExecutionContext} eCtx
+ * @param {import("@cloudflare/workers-types/experimental").Request} req
  * @param {Env} env
  * @returns {Promise<Context>}
  */
-export async function makeContext(pctx, req, env) {
+export async function makeContext(eCtx, req, env) {
   /** @type {Context} */
   // @ts-ignore
-  const ctx = pctx;
+  const ctx = {
+    executionContext: eCtx,
+  };
   // @ts-ignore
   ctx.attributes = {};
   ctx.env = env;
   ctx.url = new URL(req.url);
   ctx.log = console;
+  const filename = ctx.url.pathname.split('/').pop() ?? '';
   ctx.info = {
+    filename,
     method: req.method.toUpperCase(),
+    extension: filename.split('.').pop(),
     headers: Object.fromEntries(
       [...req.headers.entries()]
         .map(([k, v]) => [k.toLowerCase(), v]),
@@ -67,24 +72,28 @@ export async function makeContext(pctx, req, env) {
 
 export default {
   /**
-   * @param {Request} request
+   * @param {import("@cloudflare/workers-types/experimental").Request} request
    * @param {Env} env
-   * @param {import("@cloudflare/workers-types/experimental").ExecutionContext} pctx
+   * @param {import("@cloudflare/workers-types/experimental").ExecutionContext} eCtx
    * @returns {Promise<Response>}
    */
-  async fetch(request, env, pctx) {
-    const ctx = await makeContext(pctx, request, env);
+  async fetch(request, env, eCtx) {
+    const ctx = await makeContext(eCtx, request, env);
 
     try {
       const overrides = Object.fromEntries(ctx.url.searchParams.entries());
       ctx.config = await resolveConfig(ctx, overrides);
 
-      console.debug('resolved config: ', JSON.stringify(ctx.config));
+      console.debug('resolved config: ', JSON.stringify(ctx.config, null, 2));
       if (!ctx.config) {
         return errorResponse(404, 'config not found');
       }
 
-      return await handlers[ctx.config.route](ctx, request);
+      const fn = handlers[ctx.config.route];
+      if (!fn) {
+        return errorResponse(404, 'route not found');
+      }
+      return await fn(ctx, request);
     } catch (e) {
       if (e.response) {
         return e.response;

src/index.js

@@ -16,7 +16,16 @@ import update from './update.js';
 import rotate from './rotate.js';
 
 /**
- * @type {Record<string, Record<string, (ctx: Context, req: Request) => Promise<Response>>>}
+ * @type {Record<
+ *  string,
+ *  Record<
+ *    string,
+ *    (
+ *      ctx: Context,
+ *      req: import("@cloudflare/workers-types/experimental").Request
+ *    ) => Promise<Response>
+ *  >
+ * >}
  */
 const handlers = {
   token: {
@@ -28,7 +37,7 @@ const handlers = {
 
 /**
  * @param {Context} ctx
- * @param {Request} req
+ * @param {import("@cloudflare/workers-types/experimental").Request} req
  * @returns {Promise<Response>}
  */
 export default async function handler(ctx, req) {

src/routes/auth/handler.js

@@ -44,7 +44,7 @@ export default class StorageClient {
   /**
    * Load product by SKU.
    * @param {string} sku - The SKU of the product.
-   * @returns {Promise<Product>} - A promise that resolves to the product.
+   * @returns {Promise<ProductBusEntry>} - A promise that resolves to the product.
    */
   async fetchProduct(sku) {
     const {
@@ -68,19 +68,13 @@ export default class StorageClient {
     }
 
     const productData = await object.json();
-    productData.attributeMap = Object.fromEntries((productData.attributes ?? [])
-      .map(({ name, value }) => [name, value]));
-    (productData.variants ?? []).forEach((variant) => {
-      variant.attributeMap = Object.fromEntries((variant.attributes ?? [])
-        .map(({ name, value }) => [name, value]));
-    });
-
     return productData;
   }
 
   /**
    * Save products in batches
-   * @param {Product[]} products - The products to save.
+   *
+   * @param {ProductBusEntry[]} products - The products to save.
    * @returns {Promise<Partial<BatchResult>[]>} - Resolves with an array of save results.
    */
   async saveProducts(products) {
@@ -94,7 +88,7 @@ export default class StorageClient {
 
   /**
    * Handler function to process a batch of products.
-   * @param {Product[]} batch - An array of products to save.
+   * @param {ProductBusEntry[]} batch - An array of products to save.
    * @returns {Promise<Partial<BatchResult>[]>} - Resolves with an array of save results.
    */
   async storeProductsBatch(batch) {
@@ -110,12 +104,12 @@ export default class StorageClient {
     } = this.ctx;
 
     const storePromises = batch.map(async (product) => {
-      const { sku, name, urlKey } = product;
+      const { sku, title, urlKey } = product;
       const key = `${org}/${site}/${storeCode}/${storeViewCode}/products/${sku}.json`;
       const body = JSON.stringify(product);
 
       try {
-        const customMetadata = { sku, name };
+        const customMetadata = { sku, title };
         if (urlKey) {
           customMetadata.urlKey = urlKey;
         }
@@ -130,7 +124,7 @@ export default class StorageClient {
         if (urlKey) {
           const metadataKey = `${org}/${site}/${storeCode}/${storeViewCode}/urlkeys/${urlKey}`;
           await env.CATALOG_BUCKET.put(metadataKey, '', {
-            httpMetadata: { contentType: 'application/octet-stream' },
+            httpMetadata: { contentType: 'text/plain' },
             customMetadata,
           });
         }
@@ -305,7 +299,7 @@ export default class StorageClient {
   /**
    * List all products from R2.
    * TODO: Setup pagination
-   * @returns {Promise<Product[]>} - A promise that resolves to the products.
+   * @returns {Promise<ProductBusEntry[]>} - A promise that resolves to the products.
    */
   async listAllProducts() {
     const {

src/routes/catalog/StorageClient.js

@@ -18,11 +18,11 @@ import StorageClient from './StorageClient.js';
  * @returns {Promise<Response>} - A promise that resolves to the product response.
  */
 export default async function fetch(ctx) {
+  const { sku } = ctx.config;
+
   const storage = StorageClient.fromContext(ctx);
-  const sku = ctx.url.pathname.split('/').pop();
   const product = await storage.fetchProduct(sku);
 
-  // TODO: use long ttl, add cache keys
   return new Response(JSON.stringify(product), {
     headers: { 'Content-Type': 'application/json' },
   });

src/routes/catalog/fetch.js

@@ -17,7 +17,17 @@ import update from './update.js';
 import remove from './remove.js';
 
 /**
- * @type {Record<string, Record<string, (ctx: Context, req: Request) => Promise<Response>>>}
+ * @type {Record<
+ *    string,
+ *    Record<
+ *      string,
+ *      (
+ *        ctx: Context,
+ *        req: import("@cloudflare/workers-types/experimental").Request
+ *      ) => Promise<Response>
+ *    >
+ *  >
+ * }
  */
 const handlers = {
   lookup: {
@@ -39,7 +49,7 @@ const handlers = {
 /**
  * Handles productbus requests.
  * @param {Context} ctx - The context object containing request information and utilities.
- * @param {Request} request - The request object.
+ * @param {import("@cloudflare/workers-types/experimental").Request} request - The request object.
  * @returns {Promise<Response>} - A promise that resolves to the catalog response.
  */
 export default async function handler(ctx, request) {
@@ -60,7 +70,7 @@ export default async function handler(ctx, request) {
     storeCode,
     storeViewCode,
     subRoute,
-    sku,
+    sku: sku && sku.endsWith('.json') ? sku.slice(0, -5) : sku,
   });
 
   const fn = handlers[subRoute]?.[method];

src/routes/catalog/handler.js

@@ -10,39 +10,31 @@
  * governing permissions and limitations under the License.
  */
 
-import { assertValidProduct, hasUppercase } from '../../utils/product.js';
+import { assertValidProduct } from '../../utils/product.js';
 import { errorResponse } from '../../utils/http.js';
 import StorageClient from './StorageClient.js';
 import { assertAuthorization } from '../../utils/auth.js';
-
+import { extractAndReplaceImages } from '../../utils/media.js';
 /**
  * Handles a PUT request to update a product.
  * @param {Context} ctx - The context object containing request information and utilities.
  * @returns {Promise<Response>} - A promise that resolves to the product response.
  */
 export default async function update(ctx) {
-  const { config, log, data: product } = ctx;
-
+  const { config, log, data } = ctx;
   if (config.sku === '*') {
     return errorResponse(501, 'not implemented');
   }
 
-  if (!product || typeof product !== 'object') {
-    return errorResponse(400, 'invalid product data');
-  }
-
-  if (hasUppercase(config.sku)) {
-    return errorResponse(400, 'sku must be lowercase');
-  }
+  assertValidProduct(data);
 
-  if (config.sku !== product.sku) {
+  if (config.sku !== data.sku) {
     return errorResponse(400, 'sku must match the product data');
   }
 
-  assertValidProduct(product);
-
   await assertAuthorization(ctx);
 
+  const product = await extractAndReplaceImages(ctx, data);
   const storage = StorageClient.fromContext(ctx);
   const saveResults = await storage.saveProducts([product]);
 
@@ -52,5 +44,5 @@ export default async function update(ctx) {
     timestamp: new Date().toISOString(),
   });
 
-  return new Response(JSON.stringify(saveResults), { status: 201 });
+  return new Response(JSON.stringify({ ...saveResults, product }), { status: 201 });
 }

src/routes/catalog/update.js

@@ -10,12 +10,12 @@
  * governing permissions and limitations under the License.
  */
 
-import { errorResponse, errorWithResponse, ffetch } from '../../utils/http.js';
+import { errorResponse, errorWithResponse, ffetch } from '../../../utils/http.js';
 import getProductQuery, { adapter as productAdapter } from './queries/cs-product.js';
 import getVariantsQuery, { adapter as variantsAdapter } from './queries/cs-variants.js';
 import getProductSKUQueryCore from './queries/core-product-sku.js';
 import getProductSKUQueryCS from './queries/cs-product-sku.js';
-import htmlTemplateFromContext from '../../templates/html/index.js';
+import htmlTemplateFromContext from './templates/html/index.js';
 
 /**
  * @param {string} sku

src/routes/content/adobe-commerce.js src/routes/content/adobe-commerce/index.js

@@ -10,7 +10,7 @@
  * governing permissions and limitations under the License.
  */
 
-import { gql } from '../../../utils/product.js';
+import { gql } from '../util.js';
 
 /**
  * @param {{ urlkey: string; }} param0

src/routes/content/queries/core-product-sku.js src/routes/content/adobe-commerce/queries/core-product-sku.js

@@ -10,7 +10,7 @@
  * governing permissions and limitations under the License.
  */
 
-import { gql } from '../../../utils/product.js';
+import { gql } from '../util.js';
 
 /**
  * @param {{ urlkey?: string; sku?: string; }} param0

src/routes/content/queries/core-product.js src/routes/content/adobe-commerce/queries/core-product.js

@@ -10,7 +10,7 @@
  * governing permissions and limitations under the License.
  */
 
-import { gql } from '../../../utils/product.js';
+import { gql } from '../util.js';
 
 /**
  * @param {{ urlkey: string; }} param0

src/routes/content/queries/cs-product-sku.js src/routes/content/adobe-commerce/queries/cs-product-sku.js

@@ -10,13 +10,13 @@
  * governing permissions and limitations under the License.
  */
 
-import { forceImagesHTTPS } from '../../../utils/http.js';
 import {
   gql,
   parseRating,
   parseSpecialToDate,
   sortImagesByRole,
-} from '../../../utils/product.js';
+  forceImagesHTTPS,
+} from '../util.js';
 
 function extractMinMaxPrice(data) {
   let minPrice = data.priceRange?.minimum ?? data.price;

src/routes/content/queries/cs-product.js src/routes/content/adobe-commerce/queries/cs-product.js

@@ -10,13 +10,13 @@
  * governing permissions and limitations under the License.
  */
 
-import { forceImagesHTTPS } from '../../../utils/http.js';
 import {
   gql,
   parseRating,
   parseSpecialToDate,
   sortImagesByRole,
-} from '../../../utils/product.js';
+  forceImagesHTTPS,
+} from '../util.js';
 
 /**
  * @param {Config} config