Merge pull request #1 from comwrap/starter-kit-2

Update to Adobe Integration started kit v.2 and fix compartibility issues

Author: nuzil

INSTALL.md

@@ -59,8 +59,8 @@ aio console workspace select
 
 Sync your local application with the App Builder project using the following command:
 ```bash
-aio app use
-# Choose the option 'm' (merge) 
+aio app use --merge
+# Choose the option 'm' (merge) to merge configurations
 ```
 
 ### Deploy
@@ -138,7 +138,7 @@ Hubspot is an integrated system and to connect Adobe Commerce with Hubspot you n
 
 ### Configuration
 
-Go to Data Management -> Integrations and create a new App.
+Go to Data Management -> Data Integration and create a new App.
 
 Inside of the created app you can switch to "Auth" tab and receive an Access Token.
 
@@ -156,6 +156,16 @@ COMMERCE_HUBSPOT_CONTACT_ID_FIELD=
 
 It's an Adobe Commerce customer custom attribute code, which will be used to save Hubspot Customer ID, so in case if customer already being exported to Hubspot, system will perform Update and not Create action
 
+For Full Data Synchronization, please also define: 
+
+```
+// Adobe Commerce Group ID for customers. (1 - General Group)
+HUBSPOT_FULL_IMPORT_CONTACT_GROUP_ID=1
+// Adobe Commerce Website Code to import 
+HUBSPOT_FULL_IMPORT_CONTACT_WEBSITE=
+```
+
+
 ### Hubspot -> Adobe Commerce sync
 
 Part of the tion HubSpot integration involves enabling the synchronization of changes made in HubSpot back to Adobe Commerce.

README.md

@@ -44,3 +44,8 @@ For more information pls go to
 
 Api Mesh file for configuration you can find at mesh.json file.
 
+## Trouble shooting
+
+### The Backoffice Customer Sync event returns a 400 error. 
+
+If you encounter a 400 response code for the event be-observer.customer_update, please validate your customer's required fields. Since every setup can vary, ensure that your required fields match across the Adobe Commerce Customer & Customer Address, actions/customer/external/updated/schema.json Schema, and HubSpot Workflows script.

actions/auth.js

@@ -0,0 +1,99 @@
+/*
+Copyright 2024 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+const { Core } = require('@adobe/aio-sdk')
+const logger = Core.Logger('auth', { level: 'info' })
+/**
+ *
+ * @param {object} params - Environment params from the IO Runtime request
+ * @param {Array} expected - expected keys inside the params
+ * @returns {Array} - returns the missing params
+ */
+function checkIfMissing (params, expected) {
+  return expected.filter(value => !params[value]).map(key => {
+    return {
+      error: true,
+      message: `Missing ${key} in params`,
+      key
+    }
+  })
+}
+
+/**
+ *
+ * @param {object} params - Environment params from the IO Runtime request
+ * @param {Array} expected - list of keys
+ * @throws {Error} - throws error if the params are missing
+ */
+function validateParams (params, expected) {
+  // check if missing
+  const validated = checkIfMissing(params, expected)
+  if (validated.length > 0) {
+    throw new Error(`Expected parameters are missing ${validated.map(value => value.key).join(', ')}`)
+  }
+}
+
+/**
+ * This function returns the auth object based on the params
+ * @param {object} params - Environment params from the IO Runtime request
+ * @returns {object} - returns the auth object for the request
+ * @throws {Error} - throws error if the params are missing
+ */
+function fromParams (params) {
+  // `aio app dev` compatibility: inputs mapped to undefined env vars come as $<input_name> in dev mode, but as '' in prod mode
+  if (params.COMMERCE_CONSUMER_KEY && params.COMMERCE_CONSUMER_KEY !== '$COMMERCE_CONSUMER_KEY') {
+    logger.info('Commerce client is using Commerce OAuth1 authentication')
+    validateParams(params,
+      ['COMMERCE_CONSUMER_KEY', 'COMMERCE_CONSUMER_SECRET', 'COMMERCE_ACCESS_TOKEN', 'COMMERCE_ACCESS_TOKEN_SECRET'])
+    const { COMMERCE_CONSUMER_KEY: consumerKey, COMMERCE_CONSUMER_SECRET: consumerSecret, COMMERCE_ACCESS_TOKEN: accessToken, COMMERCE_ACCESS_TOKEN_SECRET: accessTokenSecret } = params
+    return {
+      commerceOAuth1: {
+        consumerKey,
+        consumerSecret,
+        accessToken,
+        accessTokenSecret
+      }
+    }
+  }
+
+  // `aio app dev` compatibility: inputs mapped to undefined env vars come as $<input_name> in dev mode, but as '' in prod mode
+  if (params.OAUTH_CLIENT_ID && params.OAUTH_CLIENT_ID !== '$OAUTH_CLIENT_ID') {
+    logger.info('Commerce client is using IMS OAuth authentication')
+    validateParams(params,
+      ['OAUTH_CLIENT_ID', 'OAUTH_CLIENT_SECRET', 'OAUTH_SCOPES'])
+    const { OAUTH_CLIENT_ID: clientId, OAUTH_CLIENT_SECRET: clientSecret, OAUTH_SCOPES: scopes } = params
+
+    const imsProps = {
+      clientId,
+      clientSecret,
+      scopes
+    }
+    if (params.OAUTH_HOST) {
+      return {
+        ims: {
+          ...imsProps,
+          host: params.OAUTH_HOST
+        }
+      }
+    }
+    return {
+      ims: imsProps
+    }
+  }
+
+  throw new Error('Unknown auth type, supported IMS OAuth or Commerce OAuth1. Please review documented auth types')
+}
+
+module.exports = {
+  validateParams,
+  fromParams
+}

actions/customer/commerce-customer-api-client.js

@@ -10,7 +10,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-const { getCommerceOauthClient } = require('../oauth1a')
+const { getClient } = require('../oauth1a')
 const { Core } = require('@adobe/aio-sdk')
 const logger = Core.Logger('commerce-consumer-api-client', { level: 'info' })
 
@@ -19,20 +19,14 @@ const logger = Core.Logger('commerce-consumer-api-client', { level: 'info' })
  *
  * @returns {object} - API response object
  * @param {string} baseUrl - Adobe commerce rest api base url
- * @param {string} consumerKey - Adobe commerce integration consumer key
- * @param {string} consumerSecret - Adobe commerce integration consumer secret
- * @param {string} accessToken - Adobe commerce integration access token
- * @param {string} accessTokenSecret - Adobe commerce integration access token secret
+ * @param {object} params - Environment params from the IO Runtime request
  * @param {object} data - Adobe commerce api payload
  */
-async function createCustomer (baseUrl, consumerKey, consumerSecret, accessToken, accessTokenSecret, data) {
-  const client = getCommerceOauthClient(
+async function createCustomer (baseUrl, params, data) {
+  const client = getClient(
     {
       url: baseUrl,
-      consumerKey,
-      consumerSecret,
-      accessToken,
-      accessTokenSecret
+      params
     },
     logger
   )
@@ -50,20 +44,14 @@ async function createCustomer (baseUrl, consumerKey, consumerSecret, accessToken
  *
  * @returns {object} - API response object
  * @param {string} baseUrl - Adobe commerce rest api base url
- * @param {string} consumerKey - Adobe commerce integration consumer key
- * @param {string} consumerSecret - Adobe commerce integration consumer secret
- * @param {string} accessToken - Adobe commerce integration access token
- * @param {string} accessTokenSecret - Adobe commerce integration access token secret
+ * @param {object} params - Environment params from the IO Runtime request
  * @param {object} data - Adobe commerce api payload
  */
-async function importCustomerBatch (baseUrl, consumerKey, consumerSecret, accessToken, accessTokenSecret, data) {
-  const client = getCommerceOauthClient(
+async function importCustomerBatch (baseUrl, params, data) {
+  const client = getClient(
     {
       url: baseUrl,
-      consumerKey,
-      consumerSecret,
-      accessToken,
-      accessTokenSecret
+      params
     },
     logger
   )
@@ -91,24 +79,17 @@ async function importCustomerBatch (baseUrl, consumerKey, consumerSecret, access
  *
  * @returns {object} - API response object
  * @param {string} baseUrl - Adobe commerce rest api base url
- * @param {string} consumerKey - Adobe commerce integration consumer key
- * @param {string} consumerSecret - Adobe commerce integration consumer secret
- * @param {string} accessToken - Adobe commerce integration access token
- * @param {string} accessTokenSecret - Adobe commerce integration access token secret
+ * @param {object} params - Environment params from the IO Runtime request
  * @param {object} data - Adobe commerce api payload
  */
-async function updateCustomer (baseUrl, consumerKey, consumerSecret, accessToken, accessTokenSecret, data) {
-  const client = getCommerceOauthClient(
+async function updateCustomer (baseUrl, params, data) {
+  const client = getClient(
     {
       url: baseUrl,
-      consumerKey,
-      consumerSecret,
-      accessToken,
-      accessTokenSecret
+      params
     },
     logger
   )
-
   return await client.put(
       `customers/${data.customer.id}`,
       JSON.stringify(data),
@@ -122,20 +103,14 @@ async function updateCustomer (baseUrl, consumerKey, consumerSecret, accessToken
  *
  * @returns {object} - API response object
  * @param {string} baseUrl - Adobe commerce rest api base url
- * @param {string} consumerKey - Adobe commerce integration consumer key
- * @param {string} consumerSecret - Adobe commerce integration consumer secret
- * @param {string} accessToken - Adobe commerce integration access token
- * @param {string} accessTokenSecret - Adobe commerce integration access token secret
+ * @param {object} params - Environment params from the IO Runtime request
  * @param {number} id - Id
  */
-async function deleteCustomer (baseUrl, consumerKey, consumerSecret, accessToken, accessTokenSecret, id) {
-  const client = getCommerceOauthClient(
+async function deleteCustomer (baseUrl, params, id) {
+  const client = getClient(
     {
       url: baseUrl,
-      consumerKey,
-      consumerSecret,
-      accessToken,
-      accessTokenSecret
+      params
     },
     logger
   )
@@ -147,20 +122,14 @@ async function deleteCustomer (baseUrl, consumerKey, consumerSecret, accessToken
  *
  * @returns {object} - API response object
  * @param {string} baseUrl - Adobe commerce rest api base url
- * @param {string} consumerKey - Adobe commerce integration consumer key
- * @param {string} consumerSecret - Adobe commerce integration consumer secret
- * @param {string} accessToken - Adobe commerce integration access token
- * @param {string} accessTokenSecret - Adobe commerce integration access token secret
+ * @param {string} params - Environment params from the IO Runtime request
  * @param {object} customerId - Adobe commerce customer ID
  */
-async function getCustomer (baseUrl, consumerKey, consumerSecret, accessToken, accessTokenSecret, customerId) {
-  const client = getCommerceOauthClient(
+async function getCustomer (baseUrl, params, customerId) {
+  const client = getClient(
     {
       url: baseUrl,
-      consumerKey,
-      consumerSecret,
-      accessToken,
-      accessTokenSecret
+      params
     },
     logger
   )
@@ -176,26 +145,17 @@ async function getCustomer (baseUrl, consumerKey, consumerSecret, accessToken, a
  *
  * @returns {object} - API response object
  * @param {string} baseUrl - Adobe commerce rest api base url
- * @param {string} consumerKey - Adobe commerce integration consumer key
- * @param {string} consumerSecret - Adobe commerce integration consumer secret
- * @param {string} accessToken - Adobe commerce integration access token
- * @param {string} accessTokenSecret - Adobe commerce integration access token secret
+ * @param {string} params - Environment params from the IO Runtime request
  * @param {string} searchCriteria - Adobe commerce search criteria
  */
 async function getCustomerBySearchCriteria (
   baseUrl,
-  consumerKey,
-  consumerSecret,
-  accessToken,
-  accessTokenSecret,
+  params,
   searchCriteria) {
-  const client = getCommerceOauthClient(
+  const client = getClient(
     {
       url: baseUrl,
-      consumerKey,
-      consumerSecret,
-      accessToken,
-      accessTokenSecret
+      params
     },
     logger
   )
@@ -211,7 +171,7 @@ module.exports = {
   createCustomer,
   updateCustomer,
   deleteCustomer,
+  importCustomerBatch,
   getCustomer,
-  getCustomerBySearchCriteria,
-  importCustomerBatch
+  getCustomerBySearchCriteria
 }

actions/customer/commerce/actions.config.yaml

@@ -3,12 +3,12 @@ consumer:
   web: 'no'
   runtime: nodejs:20
   inputs:
-   LOG_LEVEL: debug
-   COMMERCE_HUBSPOT_CONTACT_ID_FIELD: $COMMERCE_HUBSPOT_CONTACT_ID_FIELD
-   HUBSPOT_ACCESS_TOKEN: $HUBSPOT_ACCESS_TOKEN
+    LOG_LEVEL: debug
+    COMMERCE_HUBSPOT_CONTACT_ID_FIELD: $COMMERCE_HUBSPOT_CONTACT_ID_FIELD
+    HUBSPOT_ACCESS_TOKEN: $HUBSPOT_ACCESS_TOKEN
   annotations:
-   require-adobe-auth: true
-   final: true
+    require-adobe-auth: true
+    final: true
 created:
   function: created/index.js
   web: 'no'

actions/customer/commerce/created/index.js

@@ -44,18 +44,17 @@ async function main (params) {
     const transformedData = transformData(params.data)
 
     logger.debug(`Preprocess data: ${stringParameters(params)}`)
-    const preProcessed = await preProcess(params, transformedData)
+    const preProcessed = preProcess(params, transformedData)
 
     logger.debug(`Start sending data: ${JSON.stringify(params)}`)
     const result = await sendData(params, transformedData, preProcessed)
-    logger.debug(`Result from HubSpot request: ${JSON.stringify(result)}`)
     if (!result.success) {
       logger.error(`Send data failed: ${result.message}`)
       return actionErrorResponse(result.statusCode, result.message)
     }
 
     logger.debug(`Postprocess data: ${stringParameters(params)}`)
-    await postProcess(params, result)
+    postProcess(params, transformedData, preProcessed, result)
 
     logger.debug('Process finished successfully')
     return actionSuccessResponse('Customer created successfully')

actions/customer/commerce/created/post.js

@@ -24,10 +24,7 @@ async function postProcess (params, result) {
   try {
     const response = await updateCustomer(
       params.COMMERCE_BASE_URL,
-      params.COMMERCE_CONSUMER_KEY,
-      params.COMMERCE_CONSUMER_SECRET,
-      params.COMMERCE_ACCESS_TOKEN,
-      params.COMMERCE_ACCESS_TOKEN_SECRET,
+      params,
       {
         customer: {
           id: params.data.id,

actions/customer/commerce/updated/index.js

@@ -44,11 +44,10 @@ async function main (params) {
     const transformedData = transformData(params.data)
 
     logger.debug(`Preprocess data: ${stringParameters(params)}`)
-    const preProcessed = await preProcess(params, transformedData)
-    logger.debug(`Preprocess data result: ${JSON.stringify(preProcessed)}`)
+    const preProcessed = preProcess(params, transformedData)
 
     logger.debug(`Start sending data: ${JSON.stringify(params)}`)
-    const result = await sendData(params, preProcessed)
+    const result = await sendData(params, transformedData, preProcessed)
     if (!result.success) {
       logger.error(`Send data failed: ${result.message}`)
       return actionErrorResponse(result.statusCode, result.message)