feat: add onProgress support to autoRetrieve

Author: vdvleon

README.md

@@ -96,5 +96,5 @@ for (let workplace of workplaces) {
 * reports
   * [`reports.bookings.enquire({venueId, type, start, end, task})`](docs/reports.md#bookingsenquirevenueid-type-start-end-task)
   * [`reports.bookings.retrieve({venueId, type, jobId})`](docs/reports.md#bookingsretrievevenueid-type-jobid)
-  * [`bookingReferrers.enquire({start, end, autoResolve})`](docs/reports.md#bookingreferrersenquirestart-end-autoresolve)
+  * [`bookingReferrers.enquire({start, end, autoResolve, onProgress})`](docs/reports.md#bookingreferrersenquirestart-end-autoresolve-onprogress)
   * [`bookingReferrers.retrieve({jobId})`](docs/reports.md#bookingreferrersretrievejobid)

docs/reports.md

@@ -52,21 +52,25 @@ const data = await deskbookers.reports.bookings.retrieve({
 
 ## Booking referrers
 
-### `bookingReferrers.enquire({start, end, autoRetrieve})`
+### `bookingReferrers.enquire({start, end, autoRetrieve, onProgress})`
 
 Get booking referrers report for a given date range.
 
 #### Params
 
-| Name         | Type   | Required | Description                              |
-| ------------ | ------ | -------- | ---------------------------------------- |
-| start        | string | No       | Only consider data after this start date |
-| end          | string | No       | Only consider data untul this end date   |
-| autoRetrieve | bool   | No       | Auto retrieve the result of the report and return everything as a promise (enabled by default) |
+| Name         | Type     | Required | Description                                      |
+| ------------ | -------- | -------- | ------------------------------------------------ |
+| start        | string   | No       | Only consider data after this start date         |
+| end          | string   | No       | Only consider data untul this end date           |
+| onProgress   | callback | No       | Get updates about latest state of the report job |
+| autoRetrieve | bool     | No       | Auto retrieve the result of the report and return everything as a promise (enabled by default) |
 
 ```js
 const data = await deskbookers.reports.bookingReferrers.enquire({
-  start: '2017-09-01'
+  start: '2017-09-01',
+  onProgress: ({ jobInfo, logs }) => {
+    console.log(jobInfo.progress)
+  }
 })
 console.log(data.url) // URL to download the report
 ```

src/resources/reports/BookingReferrers.js

@@ -17,9 +17,10 @@ export default class BookingReferrers extends Resource {
    * @param {date} start
    * @param {date} end
    * @param {bool} autoRetrieve
+   * @param {callback} onProgress
    * @return {Promise<Object>} Promise resolving with object with info about the end result
    */
-  async enquire ({ start, end, autoRetrieve = true } = {}) {
+  async enquire ({ start, end, autoRetrieve = true, onProgress = null } = {}) {
     let jobInfo = await this.request({
       method: 'POST',
       path: this.endpoint,
@@ -34,6 +35,11 @@ export default class BookingReferrers extends Resource {
       do {
         await wait(AUTO_RETRIEVE_TIMEOUT)
         job = await this.retrieve({ jobId: get(job, 'jobInfo.id') })
+
+        if (onProgress) {
+          onProgress(job)
+        }
+
       } while (!isFinalState(get(job, 'jobInfo.state')))
     }
 

test/reports.js

@@ -65,10 +65,15 @@ test('enquire an auto resolving booking referrers report', async t => {
   const deskbookers = await client(true)
   t.truthy(deskbookers.session)
 
+  let progress = 0
   const data = await deskbookers.reports.bookingReferrers.enquire({
     start: '2017-09-01',
-    end: '2017-09-02'
+    end: '2017-09-02',
+    onProgress: (job) => {
+      progress++
+    }
   })
+  t.truthy(progress)
   t.truthy(data.url)
   t.truthy(data.jobInfo)
   t.truthy(data.jobInfo.id)