Fix generic events on search queries

doc/2/api/essentials/error-codes/core/index.md

@@ -20,6 +20,7 @@ description: error codes definitions
 | core.fatal.service_unavailable<br/><pre>0x00000002</pre> | [ExternalServiceError](/core/2/api/essentials/error-handling#externalserviceerror) <pre>(500)</pre> | An external service is unavailable |
 | core.fatal.service_timeout<br/><pre>0x00000003</pre> | [InternalError](/core/2/api/essentials/error-handling#internalerror) <pre>(500)</pre> | Service initialization timeout |
 | core.fatal.unreadable_log_dir<br/><pre>0x00000004</pre> | [InternalError](/core/2/api/essentials/error-handling#internalerror) <pre>(500)</pre> | Cannot read the content of the log directory |
+| core.fatal.assertion_failed<br/><pre>0x00000005</pre> | [InternalError](/core/2/api/essentials/error-handling#internalerror) <pre>(500)</pre> | A runtime assertion has failed. Please contact support. |
 
 ---
 

doc/2/plugins/guides/events/generic-document-events/index.md

@@ -23,6 +23,12 @@ As with other API events, generic ones are triggered before and after documents
 
 All generic events share the same payload signature, and pipes plugged to them must resolve to the updated (or not) array of documents received in their parameters.
 
+::: info
+
+"before" actions are only triggered on queries asking for specific documents. API routes such as `search`, `deleteByQuery` or `updateByQuery` cannot trigger "before" events, they only trigger "after" ones.
+
+:::
+
 ---
 
 ## generic:document:afterDelete
@@ -153,6 +159,7 @@ class PipePlugin {
 
 - [document:update](/core/2/api/controllers/document/update)
 - [document:mUpdate](/core/2/api/controllers/document/m-update)
+- [document:updateByQuery](/core/2/api/controllers/document/update-by-query)
 
 ---
 

lib/api/documentExtractor.js

@@ -21,7 +21,10 @@
 
 'use strict';
 
-const assertionError = require('../kerror').wrap('api', 'assert');
+const kerror = require('../kerror');
+
+const assertionError = kerror.wrap('api', 'assert');
+
 const extractors = ([
   {
     methods: {
@@ -154,7 +157,27 @@ const extractors = ([
         return request;
       }
     },
-    targets: ['mCreate', 'mCreateOrReplace', 'mReplace', 'mUpdate']
+    targets: ['mCreate', 'mCreateOrReplace', 'mReplace', 'mUpdate', 'updateByQuery']
+  },
+  {
+    methods: {
+      extractFromRequest: null, // not eligible for search queries
+      extractFromResult: request => {
+        return request.result.hits || request.result.documents;
+      },
+      insertInRequest: null, // not eligible for search queries
+      insertInResult: (documents, request) => {
+        if (request.input.action === 'search') {
+          request.result.hits = documents;
+        }
+        else if (request.input.action === 'deleteByQuery') {
+          request.result.documents = documents;
+        }
+
+        return request;
+      },
+    },
+    targets: ['search', 'deleteByQuery'],
   },
   {
     methods: {
@@ -170,7 +193,7 @@ const extractors = ([
         return request;
       }
     },
-    targets: ['create', 'createOrReplace', 'replace', 'update', '_default']
+    targets: ['create', 'createOrReplace', 'replace', 'update']
   }
 ]).reduce((acc, extractor) => {
   extractor.targets.forEach(target => {
@@ -183,9 +206,20 @@ class DocumentExtractor {
   constructor(request) {
     this.request = request;
 
-    const extractor = extractors[request.input.action] || extractors._default;
-    this.extractMethod = extractor[request.result ? 'extractFromResult' : 'extractFromRequest'];
-    this.insertMethod = extractor[request.result ? 'insertInResult' : 'insertInRequest'];
+    const extractor = extractors[request.input.action];
+
+    if (extractor === undefined) {
+      throw kerror.get('core', 'fatal', 'assertion_failed', `no generic documents extractor for ${request.input.action}`);
+    }
+
+    if (request.result) {
+      this.extractMethod = extractor.extractFromResult;
+      this.insertMethod = extractor.insertInResult;
+    }
+    else {
+      this.extractMethod = extractor.extractFromRequest;
+      this.insertMethod = extractor.insertInRequest;
+    }
   }
 
   extract() {

lib/api/funnel.js

@@ -486,10 +486,9 @@ class Funnel {
       return request;
     }
 
-    const
-      alias = this.documentEventAliases.mirrorList[action],
-      event = `${this.documentEventAliases.namespace}:${prefix}${capitalize(alias)}`,
-      extractor = new DocumentExtractor(request);
+    const alias = this.documentEventAliases.mirrorList[action];
+    const event = `${this.documentEventAliases.namespace}:${prefix}${capitalize(alias)}`;
+    const extractor = new DocumentExtractor(request);
 
     const documents = await this.kuzzle.pipe(event, extractor.extract(), request);
 

lib/config/documentEventAliases.js

@@ -29,5 +29,5 @@ module.exports = {
     'write': ['create', 'createOrReplace', 'mCreate', 'mCreateOrReplace', 'mReplace', 'replace']
   },
   namespace: 'generic:document',
-  notBefore: ['search', 'deleteByQuery']
+  notBefore: ['search', 'deleteByQuery', 'updateByQuery'],
 };

lib/kerror/codes/core.json

@@ -27,8 +27,13 @@
           "code": 4,
           "message": "Cannot read log directory '%s' : %s.",
           "class": "InternalError"
+        },
+        "assertion_failed": {
+          "description": "A runtime assertion has failed. Please contact support.",
+          "code": 5,
+          "message": "Runtime assertion failed: %s",
+          "class": "InternalError"
         }
-
       }
     },
     "realtime": {