Code Cleanup and review alignments

Author: nuzil

.gitignore

@@ -41,4 +41,8 @@ coverage
 # logs folder for aio-run-detached
 logs
 
-adobe-api/mesh/mesh.json
+adobe-api/mesh/mesh.json
+server.js
+test-placeholder-handler.js
+key.pem
+cert.pem

INSTALL.md

@@ -9,28 +9,29 @@
 
 ### Create a new project
 
-Go to console.adobe.io and create a new project from template: "App Builder"
+Go to https://developer.adobe.com/console and create a new project from template: "App Builder"
 
 To required environment add: 
 
 * I/O Management API with OAuth Server-to-Server
 * I/O Events
 
 
-### Adobe Api Mesh (Optional)
+### Adobe API Mesh (Optional)
 
-1. Add "Api Mesh" service to your environment.
+1. Add "API Mesh" service to your environment.
 2. Rename file `adobe-api/mesh/mesh.json.dist` into `adobe-api/mesh/mesh.json`.
 3. Change required options inside `adobe-api/mesh/mesh.json`.
     * AC-URL (This should be your Adobe Commerce system's base URL to GQL Endpoint)
 
-3. Provision Mesh by using this file with `aio api-mesh create adobe-api/mesh/mesh.json`.
+4. Provision Mesh by using this file with `aio api-mesh create adobe-api/mesh/mesh.json`.
 
 ## Installation
 
 1. Clone the repository
 2. Run `npm install` to install the dependencies
 3. Go to [Project](https://developer.adobe.com/console), select Environment and click on "Download All" button.
+4. Copy the env.dist file into .env file. `cp env.dist .env`
 4. Execute `aio app use <path-to-file>` with file you just downloaded. (Merge files if you already have .env file)
 5. Edit `.env` file with your project details.
 Set following variables: 
@@ -39,8 +40,25 @@ Set following variables:
 AC_GRAPHQL_URL= // Your GraphQL URL 
 AC_DEFAULT_STORE_CODE= // Default Adobe Commerce Store Code
 AC_ENVIRONMENT_ID= // Your Environment ID for Catalog Service if used (optional)
+COMMERCE_BASE_URL= // Commerce instance REST API Url
 ```
 
+> [!NOTE]
+> When configuring the `COMMERCE_BASE_URL` environment variable, the format differs between PaaS and SaaS:
+>
+> For PaaS (On-Premise/Cloud):
+>
+> - Must include your base site URL + `/rest/` suffix
+> - Example: `https://[environment-name].us-4.magentosite.cloud/rest/`
+>
+> For SaaS:
+>
+> - Must be the REST API endpoint provided by Adobe Commerce
+> - Example: `https://na1-sandbox.api.commerce.adobe.com/[tenant-id]/`
+>
+> Make sure to use your actual environment name or tenant ID in the URL. The examples above use placeholder values.
+
+
 6. Configure Adobe Commerce Authorization
 
 In env.dist file you will find set of Auth parameters.

README.md

@@ -4,7 +4,7 @@ Feed Generator is a service that simplifies the process of generating product fe
 
 ## Installation
 
-Module compartible with both Adobe Commerce SaaS and PaaS.
+Module compatible with both Adobe Commerce SaaS and PaaS.
 
 Please see [INSTALL.md](INSTALL.md) for more details.
 
@@ -191,22 +191,22 @@ For that go to Settings and click on clean the cache button.
 
 #### Fixed Variables
 
-Header and Footer currently have a support to variables (Only 1 actualy)
+Header and Footer currently have a support to variables (Only 1 actually)
 
 `{{DATA}}` - Current Date/Time - will be in format 2024-10-21T14:45:30.123Z
 
 ### Dynamic variables
 
 Variables are defined using double curly braces (`{{ }}`) and correspond to fields in the Adobe Commerce GraphQL product output. For example, `{{sku}}` will be replaced with the product's SKU.
 
-##### Additonal parameters
+##### Additional parameters
 
 ###### Repeating Tags with `count`
 
 When a variable corresponds to an array, you can use the `count` property to repeat the XML tag for each element in the array. For instance, using `count=5` will generate up to 5 tags, each containing a different value from the array.
 
 ```xml
-<g:brand>{{manufacturer count="5"}}</g:brand>
+<image>{{media_gallery.url count="2"}}</image>
 ```
 
 ##### Selecting Specific Array Elements with `index`
@@ -226,28 +226,51 @@ To select a specific element from an array, use the `index` property. This will
 Add attributes.value is an Array of attributes, to get specific attribute, you can use "code" parameter and define attribute with which code you want to use.
 
 
-#### Example 
+#### Example for Google Feed
+
+##### Header
+```xml
+<?xml version="1.0"?>
+<rss xmlns:g="http://base.google.com/ns/1.0" version="2.0">
+<channel>
+```
+
+##### Body (PaaS)
 
 ```xml
 <item>
   <g:id>{{sku}}</g:id>
   <title>{{name}}</title>
   <description>{{description.html}}</description>
-  <link>https://www.native-instruments.com/{{detail_page}}</link>
+  <link>https://www.URL.com/{{detail_page}}</link>
   <g:image_link>{{image.url}}</g:image_link>
   <g:condition>new</g:condition>
   <g:price>{{price_range.maximum_price.final_price.value}} {{price_range.maximum_price.final_price.currency}}</g:price>
-  <g:availability>In Stock</g:availability>
-  <g:google_product_category><![CDATA[Arts &amp; Entertainment &gt; Hobbies &amp; Creative Arts &gt; Musical Instruments &gt; Electronic Musical Instruments]]></g:google_product_category>
-  <g:identifier_exists>true</g:identifier_exists>
   <g:product_type index=2>{{categories.name}}</g:product_type>
-  <g:sale_price>{{price_range.minimum_price.final_price.value}}</g:sale_price>
-  <g:brand count=5>{{manufacturer}}</g:brand>
   <g:mpn>{{sku}}</g:mpn>
   <g:additional_image_link><![CDATA[{{image.url}}?width=350&height=350&fit=crop]]></g:additional_image_link>
 </item>
 ```
 
+
+##### Body (SaaS)
+```xml
+<item>
+  <sku>{{sku}}</sku>
+  <weight>{{SimpleProduct||weight}}</weight>
+  <image>{{media_gallery.url count="2"}}</image>
+  <color>{{attributes.value code='color'}}</color>
+  <price>{{SimpleProduct||price_range.maximum_price.final_price.value}}</price>
+</item>
+```
+
+##### Footer
+```xml
+</channel>
+</rss>
+```
+
+
 ## Technical Module implementation
 
 Delete Feed - deleting current feed from the database and from all schedules
@@ -285,7 +308,7 @@ Regenerate Feed - will trigger the event “generate.feed” for a particular fe
 
 * `getAllStores` - get all Adobe Commerce Stores by API
 
-* `generateByCron` - trigger feed generation by OpenWisk alarms. 
+* `generateByCron` - trigger feed generation by OpenWhisk alarms. 
 
 * `getConfig` - receive public module configs. Currently only return type of authorization (ims vs oauth). 
 
@@ -306,8 +329,8 @@ Action is running every 30 minutes and checking by feed settings if it have to b
   Edit / Create New Feed form will contain form to save new Feed.
 
   Current elements: 
-  * Feed Format - select - JSON | XML
-  * Feed Item: Big text field to have XML | JSON there with feed item body
+  * Feed Format - select - XML
+  * Feed Item: Big text field to have XML there with feed item body
   * Feed Header
   * Feed Footer
   * Store View - select with list of available store views on Adobe Commerce (websites also have to be there, but it is not possible to select them)

e2e/generic.e2e.test.js e2e/getConfig.e2e.test.jse2e/generic.e2e.test.js renamed to e2e/getConfig.e2e.test.js

@@ -4,20 +4,16 @@
 
 const { Config } = require('@adobe/aio-sdk').Core
 const fs = require('fs')
-const fetch = require('node-fetch')
 
 // get action url
 const namespace = Config.get('runtime.namespace')
 const hostname = Config.get('cna.hostname') || 'adobeioruntime.net'
-const packagejson = JSON.parse(fs.readFileSync('package.json').toString())
 const runtimePackage = 'feed-generator'
-const actionUrl = `https://${namespace}.${hostname}/api/v1/web/${runtimePackage}/generic`
+const actionUrl = `https://${namespace}.${hostname}/api/v1/web/${runtimePackage}/getConfig`
 
 // The deployed actions are secured with the `require-adobe-auth` annotation.
 // If the authorization header is missing, Adobe I/O Runtime returns with a 401 before the action is executed.
 test('returns a 401 when missing Authorization header', async () => {
   const res = await fetch(actionUrl)
-  expect(res).toEqual(expect.objectContaining({
-    status: 401
-  }))
+  expect(res.status).toBe(401)
 })

e2e/publish-events.e2e.test.js

@@ -1,7 +1,3 @@
-/* 
-* <license header>
-*/
-
 /* This file exposes some common utilities for your actions */
 
 const { handlePlaceholder } = require('./utils/placeholderHandler');

src/commerce-backend-ui-1/actions/utils.js

@@ -42,16 +42,16 @@ async function generateFeed(uuid, params) {
                 "expiration": "2023-03-03T12:58:47.000Z",
                 "value": {
                     "created_at": "2023-03-02T12:58:47.770Z",
-                    "feedBody": "<item>\n  <g:id>{{sku}}</g:id>\n  <title>{{name}}</title>\n  <description>{{description}}</description>\n <g:image_link>{{images.url count='2'}}</g:image_link>\n <price>{{SimpleProductView||price.final.amount.value}} {{SimpleProductView||price.final.amount.currency}}</price>\n  <weight>{{attributes.value code='weight'}}</weight>\n </item>",
+                    "feedBody": "<item>\n  <g:id>{{sku}}</g:id>\n  <title>{{SimpleProduct||weight}}</title>\n  \n <g:image_link>{{image.url count='2'}}</g:image_link>\n </item>",
                     "feedFooter": "</items>",
                     "feedHeader": "<items>",
                     "feedName": "Test XML",
                     "feed_type": "xml",
                     "generated_at": "",
                     "status": "pending",
-                    "store_code": "default||main_website_store||base",
-                    "searchQuery": "basebal",
-                    "filterQuery": "{\n   \"attribute\": \"price\",\n   \"range\": {\n     \"from\": 10,\n     \"to\": 100\n   }\n}"
+                    "store_code": "de||main_website_store||base",
+                    "searchQuery": "Motiv",
+//                    "filterQuery": "{\n   \"attribute\": \"price\",\n   \"range\": {\n     \"from\": 10,\n     \"to\": 100\n   }\n}"
                 }
             }
         }

src/commerce-backend-ui-1/actions/utils/generation.js

@@ -106,34 +106,23 @@ const handleNoProperties = (placeholder, item, feed, type) => {
 
 const handleCategories = (placeholder, item, feed, type) => {
 
-  // const logger = Core.Logger('main', {level: 'info'})
-
   // eslint-disable-next-line no-unused-vars
   const [dataKey, placeholderProperties] = extractFromPlaceholder(placeholder);
 
-  // logger.error("handleCategories START");
-
   let placeholderParts = dataKey.split(".");
 
   if (placeholderParts[0] !== 'categories') {
     return null;
   }
 
-  // logger.error("item " + JSON.stringify(item));
-  // logger.error("placeholderParts " + JSON.stringify(placeholderParts));
-  // logger.error("placeholderParts0 " + JSON.stringify(placeholderParts[0]));
-
   let value = "";
   let itemCounter = 0;
   for (let placeholderPart of placeholderParts) {
 
-    // logger.error("placeholderPart " + JSON.stringify(placeholderPart));
     if (value.toString() === "") { 
 
-      // logger.error("item[placeholderPart] " + JSON.stringify(item[placeholderPart]));
       if (itemCounter === 0) {
 
-        // logger.error("item[placeholderPart] VALUE " + JSON.stringify(item[placeholderPart][0]));
         /**
          * @ToDo Consider to use index as a property for define position of the value in the array if there are multiple values
          * Example: 
@@ -152,12 +141,9 @@ const handleCategories = (placeholder, item, feed, type) => {
           value = item[placeholderPart][0];
         // }
       } else {
-        // logger.error("item[placeholderPart] VALUE itemCounter > 0" + JSON.stringify(item[placeholderPart]));
         value = item[placeholderPart]  
       }
     } else { 
-      // logger.error("value[placeholderPart] " + JSON.stringify(value[placeholderPart]));
-      // logger.error("value " + JSON.stringify(value));
       value = value[placeholderPart];
     }
     itemCounter++;

src/commerce-backend-ui-1/actions/utils/placeholderHandler.js

@@ -16,7 +16,7 @@ runtimeManifest:
           inputs:
             LOG_LEVEL: debug
           annotations:
-            require-adobe-auth: false
+            require-adobe-auth: true
             final: true
     feed-generator:
       license: Apache-2.0
@@ -36,7 +36,6 @@ runtimeManifest:
         COMMERCE_CONSUMER_SECRET: $COMMERCE_CONSUMER_SECRET
         COMMERCE_ACCESS_TOKEN: $COMMERCE_ACCESS_TOKEN
         COMMERCE_ACCESS_TOKEN_SECRET: $COMMERCE_ACCESS_TOKEN_SECRET
-        COMMERCE_HUBSPOT_CONTACT_ID_FIELD: $COMMERCE_HUBSPOT_CONTACT_ID_FIELD
         AC_ENVIRONMENT_ID: $AC_ENVIRONMENT_ID
         providerId: $FEED_GENERATOR_PROVIDER_ID
         eventCode: feed.generate
@@ -107,7 +106,7 @@ runtimeManifest:
           web: 'yes'
           runtime: nodejs:22
           annotations:
-            require-adobe-auth: true
+            require-adobe-auth: false
             final: true
         getGqlSchema:
           function: actions/magentoActions/getGqlSchema.js

src/commerce-backend-ui-1/ext.config.yaml

@@ -1,3 +1 @@
-<!-- <license header> -->
-
 404