Merge branch 'develop' into feature/refactor-storefront-query-builder

Christian Ewald · web-flow · commit 3c37a3c99d12 · 2020-04-09T18:22:43.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,11 +17,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Varnish Cache with autoinvalidation by Cache tags as addon - @Fifciu
 - Add `resetPasswordUsingResetToken` to `magento1` platform - @cewald (#415)
 - Update to `storefront-query-builder` version `1.0.0` - @cewald (#429)
+- Add `composeError` in './magento2/o2m.js' - @flancer64 (#422)
+- Explicit data extraction from 'Error' objects - @flancer64 (#424)
 
 ### Fixed
 - add es7 support for map url module and fixed default index for es config - @gibkigonzo
 - Add correct paths for production build - @cewald (#407)
 - Fix MSI default stock id value
+- Add outputFormatter to response from cache - @gibkigonzo (#428)
+
+
+## [1.11.1] - 2020.03.17
+
+### Added
+- Add save address on place order - @lucasqm (#394)
+- Add ElasticSearch client support for HTTP authentication - @cewald (#397)
+- Add error handling for catalog and add header 'X-VS-Cache-Tags' to response - @gibkigonzo
+
+### Fixed
+- Add fallback for `sourcePriceInclTax` and `finalPriceInclTax` in `magento1` platform - @cewald (#398)
+- Add default ES index to config and update `getStockList` - @gibkigonzo (#405)
+- Makes elastic-stock extension compatible with both ES5 and ES7. Allows for stock fetch of configurable children that is set as "Not Visible Individually" - @didkan (#410)
+
 
 ## [1.11.0] - 2019.12.20
 
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "vue-storefront-api",
-  "version": "1.11.0",
+  "version": "1.11.1",
   "private": true,
   "description": "vue-storefront API and data services",
   "main": "dist",
diff --git a/src/api/catalog.ts b/src/api/catalog.ts
@@ -6,8 +6,9 @@ import cache from '../lib/cache-instance'
 import { sha3_224 } from 'js-sha3'
 import AttributeService from './attribute/service'
 import bodybuilder from 'bodybuilder'
-import { elasticsearch, SearchQuery } from 'storefront-query-builder'
 import loadCustomFilters from '../helpers/loadCustomFilters'
+import { elasticsearch, SearchQuery } from 'storefront-query-builder'
+import { apiError } from '../lib/util'
 
 function _cacheStorageHandler (config, result, hash, tags) {
   if (config.server.useOutputCache && cache) {
@@ -111,64 +112,55 @@ export default ({config, db}) => async function (req, res, body) {
       body: requestBody,
       json: true,
       auth: auth
-    }, (_err, _res, _resBody) => { // TODO: add caching layer to speed up SSR? How to invalidate products (checksum on the response BEFORE processing it)
-      if (_resBody && _resBody.hits && _resBody.hits.hits) { // we're signing up all objects returned to the client to be able to validate them when (for example order)
-        const factory = new ProcessorFactory(config)
-        const tagsArray = []
-        if (config.server.useOutputCache && cache) {
-          const tagPrefix = entityType[0].toUpperCase() // first letter of entity name: P, T, A ...
-          tagsArray.push(entityType)
-          _resBody.hits.hits.map(item => {
-            if (item._source.id) { // has common identifier
-              tagsArray.push(`${tagPrefix}${item._source.id}`)
-            }
-          })
-        }
-
-        let resultProcessor = factory.getAdapter(entityType, indexName, req, res)
-
-        if (!resultProcessor) { resultProcessor = factory.getAdapter('default', indexName, req, res) } // get the default processor
-        if (entityType === 'product') {
-          resultProcessor.process(_resBody.hits.hits, groupId).then(async (result) => {
-            _resBody.hits.hits = result
-            if (config.get('varnish.enabled')) {
-              // Add tags to cache, so we can display them in response headers then
-              _cacheStorageHandler(config, {
-                ..._resBody,
-                tags: tagsArray
-              }, reqHash, tagsArray)
-            } else {
-              _cacheStorageHandler(config, _resBody, reqHash, tagsArray)
-            }
-            if (_resBody.aggregations && config.entities.attribute.loadByAttributeMetadata) {
-              const attributeListParam = AttributeService.transformAggsToAttributeListParam(_resBody.aggregations)
-              // find attribute list
-              const attributeList = await AttributeService.list(attributeListParam, config, indexName)
-              _resBody.attribute_metadata = attributeList.map(AttributeService.transformToMetadata)
-            }
-            res.json(_outputFormatter(_resBody, responseFormat));
-          }).catch((err) => {
-            console.error(err)
-          })
-        } else {
-          resultProcessor.process(_resBody.hits.hits).then((result) => {
-            _resBody.hits.hits = result
-            if (config.get('varnish.enabled')) {
-              // Add tags to cache, so we can display them in response headers then
-              _cacheStorageHandler(config, {
-                ..._resBody,
-                tags: tagsArray
-              }, reqHash, tagsArray)
-            } else {
-              _cacheStorageHandler(config, _resBody, reqHash, tagsArray)
-            }
-            res.json(_outputFormatter(_resBody, responseFormat));
-          }).catch((err) => {
-            console.error(err)
-          })
+    }, async (_err, _res, _resBody) => { // TODO: add caching layer to speed up SSR? How to invalidate products (checksum on the response BEFORE processing it)
+      if (_err || _resBody.error) {
+        apiError(res, _err || _resBody.error);
+        return
+      }
+      try {
+        if (_resBody && _resBody.hits && _resBody.hits.hits) { // we're signing up all objects returned to the client to be able to validate them when (for example order)
+          const factory = new ProcessorFactory(config)
+          const tagsArray = []
+          if (config.server.useOutputCache && cache) {
+            const tagPrefix = entityType[0].toUpperCase() // first letter of entity name: P, T, A ...
+            tagsArray.push(entityType)
+            _resBody.hits.hits.map(item => {
+              if (item._source.id) { // has common identifier
+                tagsArray.push(`${tagPrefix}${item._source.id}`)
+              }
+            })
+            const cacheTags = tagsArray.join(' ')
+            res.setHeader('X-VS-Cache-Tags', cacheTags)
+          }
+
+          let resultProcessor = factory.getAdapter(entityType, indexName, req, res)
+
+          if (!resultProcessor) { resultProcessor = factory.getAdapter('default', indexName, req, res) } // get the default processor
+
+          const productGroupId = entityType === 'product' ? groupId : undefined
+          const result = await resultProcessor.process(_resBody.hits.hits, productGroupId)
+          _resBody.hits.hits = result
+          if (entityType === 'product' && _resBody.aggregations && config.entities.attribute.loadByAttributeMetadata) {
+            const attributeListParam = AttributeService.transformAggsToAttributeListParam(_resBody.aggregations)
+            // find attribute list
+            const attributeList = await AttributeService.list(attributeListParam, config, indexName)
+            _resBody.attribute_metadata = attributeList.map(AttributeService.transformToMetadata)
+          }
+          if (config.get('varnish.enabled')) {
+            // Add tags to cache, so we can display them in response headers then
+            _cacheStorageHandler(config, {
+              ..._resBody,
+              tags: tagsArray
+            }, reqHash, tagsArray)
+          } else {
+            _cacheStorageHandler(config, _resBody, reqHash, tagsArray)
+          }
+          res.json(_outputFormatter(_resBody, responseFormat));
+        } else { // no cache storage if no results from Elastic
+          res.json(_resBody);
         }
-      } else { // no cache storage if no results from Elastic
-        res.json(_resBody);
+      } catch (err) {
+        apiError(res, err);
       }
     });
   }
@@ -184,7 +176,7 @@ export default ({config, db}) => async function (req, res, body) {
           res.setHeader('X-VS-Cache-Tag', tagsHeader)
           delete output.tags
         }
-        res.json(output)
+        res.json(_outputFormatter(output, responseFormat));
         console.log(`cache hit [${req.url}], cached request: ${Date.now() - s}ms`)
       } else {
         res.setHeader('X-VS-Cache', 'Miss')
diff --git a/src/lib/util.js b/src/lib/util.js
@@ -78,15 +78,22 @@ export function apiStatus (res, result = 'OK', code = 200, meta = null) {
   return result;
 }
 
-/**  Creates a api error status Express Response object.
- *  @param {express.Response} res  Express HTTP Response
- *  @param {number} [code=200]    Status code to send on success
- *  @param {json} [result='OK']    Text message or result information object
+/**
+ *  Creates an error for API status of Express Response object.
+ *
+ *  @param {express.Response} res   Express HTTP Response
+ *  @param {object|string} error    Error object or error message
+ *  @return {json} [result='OK']    Text message or result information object
  */
-export function apiError (res, errorObj, code = 500) {
-  const result = errorObj.message ? errorObj.message : (errorObj.errorMessage ? errorObj.errorMessage : errorObj);
-  const resultCode = errorObj.code ? errorObj.code : code;
-  return apiStatus(res, result, resultCode)
+export function apiError (res, error) {
+  let errorCode = error.code || error.status || 500;
+  let errorMessage = error.errorMessage || error;
+  if (error instanceof Error) {
+    // Class 'Error' is not serializable with JSON.stringify, extract data explicitly.
+    errorCode = error.code || errorCode;
+    errorMessage = error.message;
+  }
+  return apiStatus(res, errorMessage, errorCode);
 }
 
 export function encryptToken (textToken, secret) {
diff --git a/src/platform/magento2/o2m.js b/src/platform/magento2/o2m.js
@@ -34,9 +34,36 @@ function processSingleOrder (orderData, config, job, done, logger = console) {
   const THREAD_ID = 'ORD:' + (job ? job.id : 1) + ' - '; // job id
   let currentStep = 1;
 
+  /**
+   * Internal function to compose Error object using messages about other errors.
+   *
+   * 'Error' constructor should contain one message object only.
+   * (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/Error)
+   *
+   * @param {string} message Main error message.
+   * @param {string|array|object} errors Additional error message or error object or array of array objects.
+   * @return {Error}
+   */
+  function composeError (message, errors) {
+    if (typeof errors === 'string') {
+      message = message + ' ' + errors;
+    } else if (Array.isArray(errors)) {
+      // case with array of validation errors (ajv.ErrorObject - node_modules/ajv/lib/ajv.d.ts)
+      errors.forEach((item) => {
+        const part = (typeof item === 'string') ? item : (item.message || '');
+        message = (message + ' ' + part).trim();
+      });
+    } else if (errors && (errors.message || errors.errorMessage)) {
+      // I don't know possible structure of an 'errors' in this case, so I take 'apiError()' from 'src/lib/util.js'
+      // we should use debugger to inspect this case in more details and modify code.
+      message = message + ' ' + (errors.message || errors.errorMessage);
+    }
+    return new Error(message.trim());
+  }
+
   if (!validate(orderData)) { // schema validation of upcoming order
     logger.error(THREAD_ID + ' Order validation error!', validate.errors);
-    done(new Error('Error while validating order object', validate.errors));
+    done(composeError('Error while validating order object.', validate.errors));
 
     if (job) job.progress(currentStep++, TOTAL_STEPS);
     return;
@@ -248,28 +275,28 @@ function processSingleOrder (orderData, config, job, done, logger = console) {
                 })
               }).catch(err => {
                 logger.error('Error placing an order', err, typeof err)
-                if (job) job.attempts(6).backoff({ delay: 30 * 1000, type: 'fixed' }).save()
-                return done(new Error('Error placing an order', err));
+                if (job) job.attempts(6).backoff({delay: 30 * 1000, type: 'fixed'}).save()
+                return done(composeError('Error placing an order.', err));
               })
             }).catch((errors) => {
               logger.error('Error while adding shipping address', errors)
               if (job) job.attempts(3).backoff({ delay: 60 * 1000, type: 'fixed' }).save()
-              return done(new Error('Error while adding shipping address', errors));
+              return done(composeError('Error while adding shipping address.', errors));
             })
           }).catch((errors) => {
             logger.error('Error while adding billing address', errors)
             if (job) job.attempts(3).backoff({ delay: 60 * 1000, type: 'fixed' }).save()
-            return done(new Error('Error while adding billing address', errors));
+            return done(composeError('Error while adding billing address.', errors));
           })
         }).catch((errors) => {
           logger.error('Error while synchronizing country list', errors)
           if (job) job.attempts(3).backoff({ delay: 30 * 1000, type: 'fixed' }).save()
-          return done(new Error('Error while syncing country list', errors));
+          return done(composeError('Error while syncing country list.', errors));
         })
       }).catch((errors) => {
         logger.error('Error while adding products', errors)
         if (job) job.attempts(3).backoff({ delay: 30 * 1000, type: 'fixed' }).save()
-        return done(new Error('Error while adding products', errors));
+        return done(composeError('Error while adding products.', errors));
       })
     })
   }
@@ -291,7 +318,7 @@ function processSingleOrder (orderData, config, job, done, logger = console) {
         //      })
       }).catch(error => {
         logger.info(error)
-        return done(new Error('Error while adding products', error));
+        return done(composeError('Error while adding products.', error));
       }) // TODO: assign the guest cart with user at last?
     } else {
       logger.info(THREAD_ID + '< Using cartId provided with the order', cartId)

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "vue-storefront-api",`
`3`		`- "version": "1.11.0",`
	`3`	`+ "version": "1.11.1",`
`4`	`4`	`"private": true,`
`5`	`5`	`"description": "vue-storefront API and data services",`
`6`	`6`	`"main": "dist",`