Add method to run webhook test (#181)

* feat(webhooks): Add a method for webhook test

* test(webhook): Add test webhook tests

* chore: bump package version and add changelog

* chore: correct semver-minor bump

CHANGELOG.md

@@ -1,3 +1,7 @@
+1.3.0 / 2021/07/15
+===================
+- Added new method `.test()` to the `WebhookClient` class
+
 1.2.6 / 2021/06/21
 ===================
 - Added gracefully parameter for abort run function

package.json

@@ -1,6 +1,6 @@
 {
     "name": "apify-client",
-    "version": "1.2.6",
+    "version": "1.3.0",
     "description": "Apify API client for JavaScript",
     "main": "src/index.js",
     "keywords": [

src/resource_clients/webhook.js

@@ -1,6 +1,11 @@
 const ow = require('ow').default;
 const ResourceClient = require('../base/resource_client');
 const WebhookDispatchCollectionClient = require('./webhook_dispatch_collection');
+const {
+    pluckData,
+    parseDateFields,
+    catchNotFoundOrThrow,
+} = require('../utils');
 
 /**
  * @hideconstructor
@@ -42,6 +47,25 @@ class WebhookClient extends ResourceClient {
         return this._delete();
     }
 
+    /**
+     * https://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook
+     * @return {Promise<WebhookDispatch>}
+     */
+    async test() {
+        const request = {
+            url: this._url('test'),
+            method: 'POST',
+            params: this._params(),
+        };
+
+        try {
+            const response = await this.httpClient.call(request);
+            return parseDateFields(pluckData(response.data));
+        } catch (err) {
+            return catchNotFoundOrThrow(err);
+        }
+    }
+
     /**
      * https://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection
      * @return {WebhookDispatchCollectionClient}

test/mock_server/routes/webhooks.js

@@ -9,6 +9,7 @@ const ROUTES = [
     { id: 'get-webhook', method: 'GET', path: '/:webhookId' },
     { id: 'update-webhook', method: 'PUT', path: '/:webhookId' },
     { id: 'delete-webhook', method: 'DELETE', path: '/:webhookId' },
+    { id: 'test-webhook', method: 'POST', path: '/:webhookId/test' },
     { id: 'list-dispatches', method: 'GET', path: '/:webhookId/dispatches' },
 
 ];

test/webhooks.test.js

@@ -117,6 +117,18 @@ describe('Webhook methods', () => {
             validateRequest({}, { webhookId });
         });
 
+        test('test() works', async () => {
+            const webhookId = 'webhook_test_id';
+
+            const res = await client.webhook(webhookId).test();
+            expect(res.id).toEqual('test-webhook');
+            validateRequest({}, { webhookId });
+
+            const browserRes = await page.evaluate((id) => client.webhook(id).test(), webhookId);
+            expect(browserRes).toEqual(res);
+            validateRequest({}, { webhookId });
+        });
+
         test('listDispatches() works', async () => {
             const webhookId = 'webhook_id';
             const opts = {