Add security:refresh

doc/7/controllers/security/refresh/index.md

@@ -0,0 +1,35 @@
+---
+code: true
+type: page
+title: refresh
+---
+
+# refresh
+
+Forces an immediate [reindexation](https://www.elastic.co/guide/en/elasticsearch/reference/7.4/docs-refresh.html) of the provided security collection.
+
+The available security collections are: `users`, `profiles`, `roles`.
+
+When writing or deleting documents in Kuzzle, the changes need to be indexed before being reflected in the search results.
+By default, this operation can take up to 1 second.
+
+::: warning
+Forcing immediate refreshes comes with performance costs, and should only performed when absolutely necessary.
+:::
+
+
+```js
+refresh(collection);
+```
+
+## Arguments
+
+- `collection`: collection name to refresh
+
+## Resolves
+
+Resolves when the refresh has been done.
+
+## Usage
+
+<<< ./snippets/refresh.js

doc/7/controllers/security/refresh/snippets/refresh.js

@@ -0,0 +1,6 @@
+try {
+  await kuzzle.security.refresh('users');
+  console.log('Success');
+} catch (e) {
+  console.error(e);
+}

doc/7/controllers/security/refresh/snippets/refresh.test.yml

@@ -0,0 +1,5 @@
+name: security#refresh
+description: Refreshes security collection
+hooks:
+template: default
+expected: Success

src/controllers/Security.js

@@ -376,6 +376,13 @@ class SecurityController extends BaseController {
       .then(response => response.result.hits.map(hit => new Role(this.kuzzle, hit._id, hit._source.controllers)));
   }
 
+  refresh(collection) {
+    return this.query({
+      collection,
+      action: 'refresh'
+    });
+  }
+
   replaceUser (_id, body, options = {}) {
     const request = {
       _id,

test/controllers/security.test.js

@@ -909,6 +909,25 @@ describe('Security Controller', () => {
     });
   });
 
+  describe('refresh', () => {
+    it('should call security/refresh query and return a Promise', () => {
+      kuzzle.query.resolves(null);
+
+      return kuzzle.security.refresh('collection')
+        .then(res => {
+          should(kuzzle.query)
+            .be.calledOnce()
+            .be.calledWith({
+              controller: 'security',
+              action: 'refresh',
+              collection: 'collection'
+            });
+
+          should(res).be.Null();
+        });
+    });
+  });
+
   describe('replaceUser', () => {
     it('should call security/replaceUser query with the user content and return a Promise which resolves a User object', () => {
       kuzzle.query.resolves({