Merge branch 'master' into add-grunt-cli

package.json

@@ -1,7 +1,7 @@
 {
   "name": "sphere-node-sdk",
   "description": "Officially supported Node.js SDK library for working with the SPHERE.IO HTTP API, with OAuth2 support.",
-  "version": "1.16.0",
+  "version": "1.17.2",
   "homepage": "https://github.com/sphereio/sphere-node-sdk",
   "author": {
     "name": "Nicola Molinari",
@@ -28,7 +28,8 @@
   "dependencies": {
     "debug": "2.1.x",
     "jsondiffpatch": "0.1.31",
-    "request": "2.54.x"
+    "request": "2.54.x",
+    "sphere-node-utils": "^0.8.4"
   },
   "peerDependencies": {
     "bluebird": ">=2.3.0",

src/coffee/client.coffee

@@ -1,6 +1,7 @@
-_ = require 'underscore'
-Rest = require './connect/rest'
-TaskQueue = require './task-queue'
+_                        = require 'underscore'
+Rest                     = require './connect/rest'
+TaskQueue                = require './task-queue'
+RepeaterTaskQueue        = require '../lib/repeater-task-queue'
 CartDiscountService      = require './services/cart-discounts'
 CartService              = require './services/carts'
 CategoryService          = require './services/categories'
@@ -76,6 +77,11 @@ ALL_SERVICES = [
 # Every request is internally pushed in a queue which automatically starts resolving promises (requests)
 # and will process concurrently some of them based on the `maxParallel` parameter. You can set this parameter by calling {::setMaxParallel}.
 #
+# ### RepeaterTaskQueue
+# To repeat request on case of some errors. It's possible to use custom repeater by passing it to constructor.
+# Also it's possible to turn off by passing `enableRepeater = false` flag.
+# There is a default repeater if constructor parameter is empty.
+#
 # ```coffeescript
 # client = new SphereClient # a TaskQueue is internally initialized at this point with maxParallel of 20
 # client.setMaxParallel 5
@@ -220,9 +226,11 @@ class SphereClient
   #
   # options - An {Object} to configure the client
   constructor: (options = {}) ->
-
     # Private: instance of a {TaskQueue}
-    @_task = options.task or new TaskQueue
+    if options.enableRepeater? and !options.enableRepeater
+      @_task = new TaskQueue
+    else
+      @_task = options.task or new RepeaterTaskQueue {}, {}
 
     # Private: instance of a {Rest}
     @_rest = options.rest or new Rest _.defaults options, {user_agent: 'sphere-node-sdk'}

src/coffee/connect/oauth2.coffee

@@ -49,7 +49,7 @@ class OAuth2
       host: host
       protocol: protocol
       accessTokenUrl: opts.accessTokenUrl or '/oauth/token'
-      timeout: opts.timeout or 20000
+      timeout: opts.timeout or 60000
       rejectUnauthorized: rejectUnauthorized
       userAgent: userAgent
 

src/coffee/repeater-task-queue.coffee

@@ -0,0 +1,77 @@
+{ Repeater } = require 'sphere-node-utils'
+Promise = require 'bluebird'
+TaskQueue = require './task-queue'
+_ = require 'underscore'
+
+# Response messages which will be handled by `RepeaterTaskQueue`
+retryKeywords = [
+  'ETIMEDOUT'
+  'socket hang up'
+  'write EPROTO'
+  'Retry later'
+  'I am the LoadBalancer of'
+  'Gateway Timeout'
+  'Bad Gateway'
+  'EAI_AGAIN'
+  'ESOCKETTIMEDOUT'
+  'Oops. This shouldn\'t happen'
+  'InternalServerError: Undefined'
+  'Temporary overloading'
+  'read ECONNRESET'
+  'getaddrinfo ENOTFOUND'
+  'Cannot commit on stream id'
+]
+
+# Public: A `RepeaterTaskQueue` adds request repeater on particular response errors
+#
+# `RepeaterTaskQueue` receives two objects as parameter.
+# First object overriding `maxParallel` value of `TaskQueue`
+# Second object contains information about the count of attempts, timeout, timeout type and retry keywords.
+# There are 2 types of `timeoutType`:
+# - `c`: constant delay
+# - `v`: variable delay (grows with attempts count with a random component)
+# It's possible to customize default list of handled error messages. To do this just pass new array to `retryKeywords`
+#
+#  Examples
+#
+#   task = new RepeaterTaskQueue { maxParallel: 30 }, { attempts: 50, timeout: 200, timeoutType: 'v', retryKeywords: ['test1', 'test2'] }
+class RepeaterTaskQueue extends TaskQueue
+
+
+  constructor: (options, repeaterOptions) ->
+    super options
+    repeaterOptions = _.defaults repeaterOptions,
+      attempts: 50
+      timeout: 200
+      timeoutType: 'v'
+      retryKeywords: retryKeywords
+    @repeaterOptions = repeaterOptions
+
+
+  _startTask: (task) =>
+    @_activeCount += 1
+    repeater = new Repeater(@repeaterOptions)
+    toRepeat = repeater.execute task.fn, (err) =>
+      if @_shouldRetry(err)
+        return Promise.resolve()
+      else
+        Promise.reject err
+    toRepeat.then (res) ->
+      task.resolve res
+      return
+    .catch (err) ->
+      task.reject err
+      return
+    .finally =>
+      @_activeCount -= 1
+      @_maybeExecute()
+    .done()
+
+
+  _shouldRetry: (error) ->
+    return error?.code?.toString().startsWith('5') or
+        error?.statusCode?.toString().startsWith('5') or
+        @repeaterOptions.retryKeywords.some (keyword) ->
+          JSON.stringify(error).toUpperCase().includes(keyword.toUpperCase())
+
+module.exports = RepeaterTaskQueue

src/coffee/sync/utils/inventory.coffee

@@ -52,7 +52,6 @@ class InventoryUtils extends BaseUtils
   #
   # diff - {Object} The result of diff from `jsondiffpatch`
   # old_obj - {Object} The existing inventory
-  # new_obj - {Object} The new inventory
   #
   # Returns {Array} The list of actions, or empty if there are none
   actionsMapCustom: (diff, old_obj, new_obj) =>
@@ -61,6 +60,10 @@ class InventoryUtils extends BaseUtils
       return actions
 
     # if custom is new in itself it's placed in an array we need to unwrap
+    if Array.isArray(diff.custom)
+      diff.custom = diff.custom[0]
+
+    # if custom's type is new it's placed in an array we need to unwrap
     if diff.custom.type
       diff.custom.type = diff.custom.type[0] || diff.custom.type
 
@@ -69,8 +72,8 @@ class InventoryUtils extends BaseUtils
         action: 'setCustomType'
         type:
           typeId: 'type',
-          id: if Array.isArray(diff.custom.type.id) then @getDeltaValue(diff.custom.type.id) else new_obj.custom.type.id
-        fields: if Array.isArray(diff.custom.fields) then @getDeltaValue(diff.custom.fields) else new_obj.custom.fields
+          id: if Array.isArray(diff.custom.type.id) then @getDeltaValue(diff.custom.type.id) else diff.custom.type.id
+        fields: if Array.isArray(diff.custom.fields) then @getDeltaValue(diff.custom.fields) else diff.custom.fields
     else if diff.custom.fields
       customFieldsActions = Object.keys(diff.custom.fields).map((name) =>
         {

src/spec/client/client.spec.coffee

@@ -77,6 +77,26 @@ describe 'SphereClient', ->
     expect(=> @client.setMaxParallel(0)).toThrow new Error 'MaxParallel must be a number between 1 and 100'
     expect(=> @client.setMaxParallel(101)).toThrow new Error 'MaxParallel must be a number between 1 and 100'
 
+  it 'should not repeat request on error if repeater is disabled',(done) ->
+    client =  new SphereClient {config: Config, enableRepeater: false}
+    callsMap = {
+      0: { statusCode: 500, message: 'ETIMEDOUT' }
+      1: { statusCode: 500, message: 'ETIMEDOUT' }
+      2: { statusCode: 200, message: 'success' }
+    }
+    callCount = 0
+    spyOn(client._rest, 'GET').andCallFake (resource, callback) ->
+      currentCall = callsMap[callCount]
+      callCount++
+      statusCode = currentCall.statusCode
+      message = currentCall.message
+      callback(null, { statusCode }, { message })
+
+    client.products.fetch()
+    .catch (err) ->
+      expect(client._rest.GET.calls.length).toEqual 1
+      expect(err.body.message).toEqual 'ETIMEDOUT'
+      done()
 
   _.each [
     {name: 'cartDiscounts', className: 'CartDiscountService', blacklist: []}

src/spec/connect/oauth2.spec.coffee

@@ -10,7 +10,7 @@ describe 'OAuth2', ->
     expect(oa._options.host).toBe 'auth.sphere.io'
     expect(oa._options.protocol).toBe 'https'
     expect(oa._options.accessTokenUrl).toBe '/oauth/token'
-    expect(oa._options.timeout).toBe 20000
+    expect(oa._options.timeout).toBe 60000
     expect(oa._options.rejectUnauthorized).toBe true
 
   it 'should throw error if no credentials are given', ->

src/spec/integration/inventories-sync.spec.coffee

@@ -101,6 +101,7 @@ describe 'Integration Inventories Sync', ->
       expect(result.body.expectedDelivery).not.toBeDefined()
       done()
     .catch (error) -> done(_.prettify(error))
+  , 60000
 
   describe 'custom type and field handling', (done) ->
     customType = undefined

src/spec/integration/orders-sync.spec.coffee

@@ -63,6 +63,8 @@ describe 'Integration Orders Sync', ->
       expect(orderUpdated.shipmentState).toBe orderNew.shipmentState
       done()
     .catch (error) -> done(_.prettify(error))
+  , 60000
+
 
   it 'should sync returnInfo', (done) ->
     orderNew = _.deepClone @order
@@ -87,6 +89,7 @@ describe 'Integration Orders Sync', ->
       expect(orderUpdated.returnInfo[0].id).toBe orderNew.returnInfo[0].id
       done()
     .catch (error) -> done(_.prettify(error))
+  , 60000
 
   it 'should sync returnInfo (status)', (done) ->
     orderNew = _.deepClone @order
@@ -125,6 +128,7 @@ describe 'Integration Orders Sync', ->
       expect(orderUpdated2.returnInfo[0].items[0].paymentState).toEqual @orderNew2.returnInfo[0].items[0].paymentState
       done()
     .catch (error) -> done(_.prettify(error))
+  , 60000
 
   it 'should sync delivery items', (done) ->
 
@@ -148,6 +152,7 @@ describe 'Integration Orders Sync', ->
       expect(orderUpdated.shippingInfo.deliveries.length).toBe 1
       done()
     .catch (error) -> done(_.prettify(error))
+  , 60000
 
   it 'should sync parcel items of a delivery', (done) ->
     orderNew = _.deepClone @order
@@ -211,7 +216,7 @@ describe 'Integration Orders Sync', ->
       expect(parcels.length).toBe 2
       done()
     .catch (error) -> done(_.prettify(error))
-
+  , 60000
 ###
 helper methods
 ###