refactor: replace promises with async/await

BREAKING CHANGE: Some functions that used to throw synchronously for things like bad parameters now reject the promise.
In many cases users may not have to do anything assuming the calls already happened within a promise chain, but in rare cases this may need some refactoring of error handling cases.

Author: TimBeyer

lib/create-contentful-api.js

@@ -105,14 +105,17 @@ export default function createContentfulApi ({ http, getGlobalOptions }) {
    *   accessToken: '<content_delivery_api_key>'
    * })
    * // returns the space object with the above <space-id>
-   * client.getSpace()
-   * .then((space) => console.log(space))
-   * .catch(console.error)
+   * const space = await client.getSpace()
+   * console.log(space)
    */
-  function getSpace () {
+  async function getSpace () {
     switchToSpace(http)
-    return http.get('')
-      .then((response) => wrapSpace(response.data), errorHandler)
+    try {
+      const response = await http.get('')
+      return wrapSpace(response.data)
+    } catch (error) {
+      errorHandler(error)
+    }
   }
 
   /**
@@ -128,14 +131,18 @@ export default function createContentfulApi ({ http, getGlobalOptions }) {
    *   accessToken: '<content_delivery_api_key>'
    * })
    *
-   * client.getContentType('<content_type_id>')
-   * .then((contentType) => console.log(contentType))
-   * .catch(console.error)
+   * const contentType = await client.getContentType('<content_type_id>')
+   * console.log(contentType)
    */
-  function getContentType (id) {
+  async function getContentType (id) {
     switchToEnvironment(http)
-    return http.get('content_types/' + id)
-      .then((response) => wrapContentType(response.data), errorHandler)
+
+    try {
+      const response = await http.get(`content_types/${id}`)
+      return wrapContentType(response.data)
+    } catch (error) {
+      errorHandler(error)
+    }
   }
 
   /**
@@ -151,14 +158,17 @@ export default function createContentfulApi ({ http, getGlobalOptions }) {
    *   accessToken: '<content_delivery_api_key>'
    * })
    *
-   * client.getContentTypes()
-   * .then((response) => console.log(response.items))
-   * .catch(console.error)
+   * const response = await client.getContentTypes()
+   * console.log(response.items)
    */
-  function getContentTypes (query = {}) {
+  async function getContentTypes (query = {}) {
     switchToEnvironment(http)
-    return http.get('content_types', createRequestConfig({ query: query }))
-      .then((response) => wrapContentTypeCollection(response.data), errorHandler)
+    try {
+      const response = await http.get('content_types', createRequestConfig({ query: query }))
+      return wrapContentTypeCollection(response.data)
+    } catch (error) {
+      errorHandler(error)
+    }
   }
 
   /**
@@ -175,22 +185,24 @@ export default function createContentfulApi ({ http, getGlobalOptions }) {
    *   accessToken: '<content_delivery_api_key>'
    * })
    *
-   * client.getEntry('<entry_id>')
-   * .then((entry) => console.log(entry))
-   * .catch(console.error)
+   * const entry = await client.getEntry('<entry_id>')
+   * console.log(entry)
    */
-  function getEntry (id, query = {}) {
+  async function getEntry (id, query = {}) {
     if (!id) {
-      return Promise.reject(notFoundError(id))
+      throw notFoundError(id)
     }
 
-    return this.getEntries({ 'sys.id': id, ...query })
-      .then((response) => {
-        if (response.items.length > 0) {
-          return wrapEntry(response.items[0])
-        }
+    try {
+      const response = await this.getEntries({ 'sys.id': id, ...query })
+      if (response.items.length > 0) {
+        return wrapEntry(response.items[0])
+      } else {
         throw notFoundError(id)
-      }, errorHandler)
+      }
+    } catch (error) {
+      errorHandler(error)
+    }
   }
 
   /**
@@ -206,16 +218,20 @@ export default function createContentfulApi ({ http, getGlobalOptions }) {
    *   accessToken: '<content_delivery_api_key>'
    * })
    *
-   * client.getEntries()
-   * .then((response) => console.log(response.items))
-   * .catch(console.error)
+   * const response = await client.getEntries()
+   * .console.log(response.items)
    */
-  function getEntries (query = {}) {
+  async function getEntries (query = {}) {
     switchToEnvironment(http)
     const { resolveLinks, removeUnresolved } = getGlobalOptions(query)
     normalizeSelect(query)
-    return http.get('entries', createRequestConfig({ query: query }))
-      .then((response) => wrapEntryCollection(response.data, { resolveLinks, removeUnresolved }), errorHandler)
+
+    try {
+      const response = await http.get('entries', createRequestConfig({ query: query }))
+      return wrapEntryCollection(response.data, { resolveLinks, removeUnresolved })
+    } catch (error) {
+      errorHandler(error)
+    }
   }
   /**
    * Gets an Asset
@@ -231,15 +247,19 @@ export default function createContentfulApi ({ http, getGlobalOptions }) {
    *   accessToken: '<content_delivery_api_key>'
    * })
    *
-   * client.getAsset('<asset_id>')
-   * .then((asset) => console.log(asset))
-   * .catch(console.error)
+   * const asset = await client.getAsset('<asset_id>')
+   * console.log(asset)
    */
-  function getAsset (id, query = {}) {
+  async function getAsset (id, query = {}) {
     switchToEnvironment(http)
     normalizeSelect(query)
-    return http.get('assets/' + id, createRequestConfig({ query: query }))
-      .then((response) => wrapAsset(response.data), errorHandler)
+
+    try {
+      const response = await http.get(`assets/${id}`, createRequestConfig({ query: query }))
+      return wrapAsset(response.data)
+    } catch (error) {
+      errorHandler(error)
+    }
   }
 
   /**
@@ -255,15 +275,19 @@ export default function createContentfulApi ({ http, getGlobalOptions }) {
    *   accessToken: '<content_delivery_api_key>'
    * })
    *
-   * client.getAssets()
-   * .then((response) => console.log(response.items))
-   * .catch(console.error)
+   * const response = await client.getAssets()
+   * console.log(response.items)
    */
-  function getAssets (query = {}) {
+  async function getAssets (query = {}) {
     switchToEnvironment(http)
     normalizeSelect(query)
-    return http.get('assets', createRequestConfig({ query: query }))
-      .then((response) => wrapAssetCollection(response.data), errorHandler)
+
+    try {
+      const response = await http.get('assets', createRequestConfig({ query: query }))
+      return wrapAssetCollection(response.data)
+    } catch (error) {
+      errorHandler(error)
+    }
   }
 
   /**
@@ -279,14 +303,18 @@ export default function createContentfulApi ({ http, getGlobalOptions }) {
    *   accessToken: '<content_delivery_api_key>'
    * })
    *
-   * client.getLocales()
-   * .then((response) => console.log(response.items))
-   * .catch(console.error)
+   * const response = await client.getLocales()
+   * console.log(response.items)
    */
-  function getLocales (query = {}) {
+  async function getLocales (query = {}) {
     switchToEnvironment(http)
-    return http.get('locales', createRequestConfig({ query: query }))
-      .then((response) => wrapLocaleCollection(response.data), errorHandler)
+
+    try {
+      const response = await http.get('locales', createRequestConfig({ query: query }))
+      return wrapLocaleCollection(response.data)
+    } catch (error) {
+      errorHandler(error)
+    }
   }
 
   /**
@@ -313,17 +341,16 @@ export default function createContentfulApi ({ http, getGlobalOptions }) {
    *   accessToken: '<content_delivery_api_key>'
    * })
    *
-   * client.sync({
+   * const response = await client.sync({
    *   initial: true
    * })
-   * .then((response) => console.log({
+   * console.log({
    *   entries: response.entries,
    *   assets: response.assets,
    *   nextSyncToken: response.nextSyncToken
-   * }))
-   * .catch(console.error)
+   * })
    */
-  function sync (query = {}, options = { paginate: true }) {
+  async function sync (query = {}, options = { paginate: true }) {
     const { resolveLinks, removeUnresolved } = getGlobalOptions(query)
     switchToEnvironment(http)
     return pagedSync(http, query, { resolveLinks, removeUnresolved, ...options })

lib/paged-sync.js

@@ -43,7 +43,7 @@ import mixinStringifySafe from './mixins/stringify-safe'
  * @param {boolean} [options.paginate = true] - If further sync pages should automatically be crawled
  * @return {Promise<SyncCollection>}
  */
-export default function pagedSync (http, query, options = {}) {
+export default async function pagedSync (http, query, options = {}) {
   if (!query || (!query.initial && !query.nextSyncToken && !query.nextPageToken)) {
     throw new Error('Please provide one of `initial`, `nextSyncToken` or `nextPageToken` parameters for syncing')
   }
@@ -64,27 +64,23 @@ export default function pagedSync (http, query, options = {}) {
     paginate
   }
 
-  return getSyncPage(http, [], query, syncOptions)
-    .then((response) => {
-      // clones response.items used in includes because we don't want these to be mutated
-      if (resolveLinks) {
-        response.items = resolveResponse(response, { removeUnresolved, itemEntryPoints: ['fields'] })
-      }
-      // maps response items again after getters are attached
-      const mappedResponseItems = mapResponseItems(response.items)
+  const response = await getSyncPage(http, [], query, syncOptions)
+  // clones response.items used in includes because we don't want these to be mutated
+  if (resolveLinks) {
+    response.items = resolveResponse(response, { removeUnresolved, itemEntryPoints: ['fields'] })
+  }
+  // maps response items again after getters are attached
+  const mappedResponseItems = mapResponseItems(response.items)
 
-      if (response.nextSyncToken) {
-        mappedResponseItems.nextSyncToken = response.nextSyncToken
-      }
+  if (response.nextSyncToken) {
+    mappedResponseItems.nextSyncToken = response.nextSyncToken
+  }
 
-      if (response.nextPageToken) {
-        mappedResponseItems.nextPageToken = response.nextPageToken
-      }
+  if (response.nextPageToken) {
+    mappedResponseItems.nextPageToken = response.nextPageToken
+  }
 
-      return freezeSys(mixinStringifySafe(toPlainObject(mappedResponseItems)))
-    }, (error) => {
-      throw error
-    })
+  return freezeSys(mixinStringifySafe(toPlainObject(mappedResponseItems)))
 }
 
 /**
@@ -125,7 +121,7 @@ function mapResponseItems (items) {
  * @param {boolean} [options.paginate = true] - If further sync pages should automatically be crawled
  * @return {Promise<{items: Array, nextSyncToken: string}>}
  */
-function getSyncPage (http, items, query, { paginate }) {
+async function getSyncPage (http, items, query, { paginate }) {
   if (query.nextSyncToken) {
     query.sync_token = query.nextSyncToken
     delete query.nextSyncToken
@@ -143,29 +139,27 @@ function getSyncPage (http, items, query, { paginate }) {
     delete query.limit
   }
 
-  return http.get('sync', createRequestConfig({ query: query }))
-    .then((response) => {
-      const data = response.data || {}
-      items = items.concat(data.items || [])
-      if (data.nextPageUrl) {
-        if (paginate) {
-          delete query.initial
-          query.sync_token = getToken(data.nextPageUrl)
-          return getSyncPage(http, items, query, { paginate })
-        }
-        return {
-          items: items,
-          nextPageToken: getToken(data.nextPageUrl)
-        }
-      } else if (data.nextSyncUrl) {
-        return {
-          items: items,
-          nextSyncToken: getToken(data.nextSyncUrl)
-        }
-      } else {
-        return { items: [] }
-      }
-    })
+  const response = await http.get('sync', createRequestConfig({ query: query }))
+  const data = response.data || {}
+  items = items.concat(data.items || [])
+  if (data.nextPageUrl) {
+    if (paginate) {
+      delete query.initial
+      query.sync_token = getToken(data.nextPageUrl)
+      return getSyncPage(http, items, query, { paginate })
+    }
+    return {
+      items: items,
+      nextPageToken: getToken(data.nextPageUrl)
+    }
+  } else if (data.nextSyncUrl) {
+    return {
+      items: items,
+      nextSyncToken: getToken(data.nextSyncUrl)
+    }
+  } else {
+    return { items: [] }
+  }
 }
 
 /**

package.json

@@ -108,6 +108,7 @@
     "karma-webpack": "^4.0.2",
     "mkdirp": "^1.0.3",
     "nodemon": "^2.0.2",
+    "regenerator-runtime": "^0.13.7",
     "require-all": "^3.0.0",
     "rimraf": "^3.0.0",
     "selenium-webdriver": "^4.0.0-alpha.5",

test/e2e/index.js

@@ -24,14 +24,12 @@ const driver = new Builder()
   .usingServer(`http://${process.env.SAUCE_USERNAME}:${process.env.SAUCE_ACCESS_KEY}@ondemand.saucelabs.com/wd/hub`)
   .build()
 
-initServer((server) => {
+initServer(async (server) => {
   driver.get('http://localhost:3000')
 
   const h1 = driver.findElement(By.tagName('h1'))
 
   driver.wait(until.elementTextIs(h1, 'Success'), 30000)
-  driver.quit()
-    .then(() => {
-      server.close()
-    })
+  await driver.quit()
+  server.close()
 })