Add API actions to prune payloads collection

doc/1/controllers/device/clean/index.md

@@ -0,0 +1,55 @@
+---
+code: true
+type: page
+title: clean
+description: Cleans the payload collection
+---
+
+# clean
+
+Cleans payloads according to their age and/or validity and/or to which device model they are affiliated.
+
+---
+
+## Query Syntax
+
+### HTTP
+
+```http
+URL: http://kuzzle:7512/_/device-manager/devices/_clean
+Method: DELETE
+```
+
+### Other protocols
+
+```js
+{
+  "controller": "device-manager/device",
+  "action": "clean",
+  "body": {
+    //
+  }
+}
+```
+
+### Kourou
+
+```bash
+kourou device-manager/device:clean '{
+  days: <days>,
+  valid: true|false,
+  deviceModel: "<deviceModel>"
+}'
+```
+
+---
+
+## Arguments
+
+- `days`: Specify on which period of time you want keep payloads (`default: 7`).
+- `valid`: Specify if valid, invalid or both payload should be deleted (`default: true`).
+- `deviceModel`: deviceModel name.
+
+## Response
+
+Returns the number of deleted payloads.

features/DeviceController.feature

@@ -128,3 +128,39 @@ Feature: Device Manager device controller
       | _id | "DummyTemp_attached-ayse-unlinked" |
     Then I should receive an error matching:
       | message | "Device \"DummyTemp_attached-ayse-unlinked\" is not linked to an asset" |
+
+
+  Scenario: Clean payloads collection
+    Given I successfully execute the action "collection":"truncate" with args:
+      | index      | "device-manager" |
+      | collection | "payloads"       |
+    Then I successfully receive a "dummy-temp" payload with:
+      | deviceEUI    | "12345" |
+      | register55   | 23.3    |
+      | batteryLevel | 0.8     |
+    And I successfully receive a "dummy-temp-position" payload with:
+      | deviceEUI     | "12345" |
+      | register55    | 23.3    |
+      | location.lat  | 42.2    |
+      | location.lon  | 2.42    |
+      | location.accu | 2100    |
+    And I successfully execute the action "collection":"refresh" with args:
+      | index      | "device-manager" |
+      | collection | "payloads"       |
+    Then I successfully execute the action "document":"search" with args:
+      | index      | "device-manager" |
+      | collection | "payloads"       |
+    Then I should receive a result matching:
+      | total | 2 |
+    And I successfully execute the action "device-manager/device":"clean" with args:
+      | body.days | 0 |
+      | body.valid | true |
+      | body.deviceModel | "DummyTemp" |
+    And I successfully execute the action "collection":"refresh" with args:
+      | index      | "device-manager" |
+      | collection | "payloads"       |
+    Then I successfully execute the action "document":"search" with args:
+      | index      | "device-manager" |
+      | collection | "payloads"       |
+    Then I should receive a result matching:
+      | total | 1 |

lib/controllers/CRUDController.ts

@@ -50,7 +50,7 @@ export class CRUDController extends NativeController {
    *
    * @param request
    */
-  async delete (request: KuzzleRequest) {
+  delete (request: KuzzleRequest) {
     const index = this.getIndex(request);
     const id = this.getId(request);
 

lib/controllers/DeviceController.ts

@@ -60,6 +60,10 @@ export class DeviceController extends CRUDController {
           handler: this.unlink.bind(this),
           http: [{ verb: 'delete', path: 'device-manager/:index/devices/:_id/_unlink' }]
         },
+        clean: {
+          handler: this.clean.bind(this),
+          http: [{ verb: 'delete', path: 'device-manager/devices/_clean' }]
+        },
       }
     };
   }
@@ -122,6 +126,32 @@ export class DeviceController extends CRUDController {
     await this.deviceService.unlink(device);
   }
 
+  /**
+   * Clean payload collection for a time period
+   */
+  async clean (request: KuzzleRequest) {
+    const body = this.getBody(request);
+
+    const date = new Date().setDate(new Date().getDate() - body.days || 7);
+    const filter = []
+    filter.push({
+        range: {
+          '_kuzzle_info.createdAt': {
+            lt: date
+          }
+        }
+      }, { term: { valid: body.valid || true } });
+
+    if (body.deviceModel) {
+      filter.push({ term: { deviceModel: body.deviceModel } });
+    }
+
+    return await this.as(request.context.user).bulk.deleteByQuery(
+      this.config.adminIndex,
+      'payloads',
+      { query: { bool: { filter } } });
+  }
+
   private async getDevice (deviceId: string): Promise<Device> {
     const document: any = await this.sdk.document.get(
       this.config.adminIndex,