Feat(funnel): allow pluginRequest to trigger events

doc/2/guides/develop-on-kuzzle/event-system/index.md

@@ -187,3 +187,25 @@ await app.trigger('app-name/file-available', fileUrl);
 ::: warning
 If an internal event is triggered, the payload must be the same as the original event.
 :::
+
+**Events can be triggered** with SDK and controllers actions.
+
+::: warning
+By default, actions executed through the embedded SDK or controllers won't trigger any events and thus no pipe or hooks will be called.
+:::
+
+This behaviour is set in order to prevent an infinite loop in which a pipe calls a controller generating an event calling this same pipe again and again. 
+
+It is nonetheless possible to pass the flag `allowTrigggerEvents` to the options parameters of the controller to allow events firing :
+
+```ts
+await this.sdk.document.create(
+              "index",
+              'collection',
+              {
+                contentOfDocument: 'CREATED VIA CONTROLLER',
+              },
+              _idOfDocument,
+              { allowTriggerEvents: true },
+            );
+```

lib/api/funnel.js

@@ -753,6 +753,9 @@ class Funnel {
    */
   async executePluginRequest(request) {
     try {
+      if (request.input.allowTriggerEvents) {
+        return await this.processRequest(request);
+      }
       return await doAction(this.getController(request), request);
     } catch (e) {
       this.handleErrorDump(e);

lib/api/request/requestInput.ts

@@ -32,6 +32,7 @@ const _body = "body\u200b";
 const _headers = "headers\u200b";
 const _controller = "controller\u200b";
 const _action = "action\u200b";
+const _allowTriggerEvents = "allowTriggerEvents\u200b";
 
 // any property not listed here will be copied into
 // RequestInput.args
@@ -155,6 +156,7 @@ export class RequestInput {
     this[_body] = null;
     this[_controller] = null;
     this[_action] = null;
+    this[_allowTriggerEvents] = null;
 
     // default value to null for former "resources" to avoid breaking
     this.args = {};
@@ -181,6 +183,7 @@ export class RequestInput {
     this.body = data.body;
     this.controller = data.controller;
     this.action = data.action;
+    this.allowTriggerEvents = data.allowTriggerEvents;
   }
 
   /**
@@ -263,7 +266,12 @@ export class RequestInput {
       this[_action] = assert.assertString("action", str);
     }
   }
-
+  get allowTriggerEvents(): boolean | undefined {
+    return this[_allowTriggerEvents];
+  }
+  set allowTriggerEvents(bool: boolean) {
+    this[_allowTriggerEvents] = bool === true ? true : undefined;
+  }
   /**
    * Request body.
    * In Http it's the request body parsed.

test/api/funnel/executePluginRequest.test.js

@@ -2,7 +2,6 @@
 
 const should = require("should");
 const sinon = require("sinon");
-
 const KuzzleMock = require("../../mocks/kuzzle.mock");
 const { MockNativeController } = require("../../mocks/controller.mock");
 const FunnelController = require("../../../lib/api/funnel");
@@ -102,4 +101,31 @@ describe("funnel.executePluginRequest", () => {
         done(e);
       });
   });
+
+  it("should trigger pipes if allowTriggerEvent is enabled", async () => {
+    const request = new Request({
+      controller: "testme",
+      action: "succeed",
+      allowTriggerEvents: true,
+    });
+
+    return funnel.executePluginRequest(request).then((response) => {
+      should(response).be.exactly(request);
+      should(kuzzle.pipe).calledWith("testme:beforeSucceed");
+      should(kuzzle.pipe).calledWith("testme:afterSucceed");
+    });
+  });
+
+  it("should not trigger pipes if allowTriggerEvent is disabled", async () => {
+    const request = new Request({
+      controller: "testme",
+      action: "succeed",
+    });
+
+    return funnel.executePluginRequest(request).then((response) => {
+      should(response).be.exactly(request);
+      should(kuzzle.pipe).not.calledWith("testme:beforeSucceed");
+      should(kuzzle.pipe).not.calledWith("testme:afterSucceed");
+    });
+  });
 });