Change grouptag to array to save multiple tags for a device (#536)

* Change grouptag to array to save multiple tags for a device

* Update grouptag to array in tests

* Check different chai stuff

* Update grouptag test cases

* Fix migration

* Change grouptag query

* Remove unnecessary check

* Update sketch-templater

* Update node version to 16

* Set timeout

* Return from promise

* Try calling done()

* Return again

* Use done() in beofre and after

* use chai-http

* Use done() and set headers

* Back to chakram

* Return in hooks

* Use old sketch templater

* Return from hooks

* Update sketch-templater dependency

* Update sketch templater to latest version

Author: mpfeil

.github/workflows/test.yaml

@@ -15,10 +15,10 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - name: Install Node.js 12
+      - name: Install Node.js 16
         uses: actions/[email protected]
         with:
-          node-version: 12
+          node-version: 16
 
       - name: Get yarn cache directory path
         id: yarn-cache-dir-path

package.json

@@ -22,6 +22,7 @@
     "@sensebox/eslint-config-sensebox": "^1.1.0",
     "@turf/invariant": "^6.1.2",
     "chai": "^4.3.4",
+    "chai-http": "^4.3.0",
     "chakram": "^1.5.0",
     "cheerio": "^1.0.0-rc.6",
     "csv-parse": "^4.15.4",

packages/api/lib/controllers/boxesController.js

@@ -76,7 +76,7 @@ const
  * @apiUse TTNBody
  *
  * @apiParam (RequestBody) {String} [name] the name of this senseBox.
- * @apiParam (RequestBody) {String} [grouptag] the grouptag of this senseBox. Send '' (empty string) to delete this property.
+ * @apiParam (RequestBody) {String[]} [grouptag] the grouptag(s) of this senseBox. Send [] (empty array) to delete this property.
  * @apiParam (RequestBody) {Location} [location] the new coordinates of this senseBox. Measurements will keep the reference to their correct location
  * @apiParam (RequestBody) {Sensor[]} [sensors] an array containing the sensors of this senseBox. Only use if model is unspecified
  * @apiParam (RequestBody) {MqttOption} [mqtt] settings for the MQTT integration of this senseBox
@@ -520,7 +520,7 @@ module.exports = {
     retrieveParameters([
       { predef: 'boxId', required: true },
       { name: 'name' },
-      { name: 'grouptag', dataType: 'StringWithEmpty' },
+      { name: 'grouptag', dataType: ['String'] },
       { name: 'description', dataType: 'StringWithEmpty' },
       { name: 'weblink', dataType: 'StringWithEmpty' },
       { name: 'image', dataType: 'base64Image' },
@@ -551,7 +551,7 @@ module.exports = {
     checkContentType,
     retrieveParameters([
       { name: 'name', required: true },
-      { name: 'grouptag', aliases: ['tag'] },
+      { name: 'grouptag', dataType: ['String'], aliases: ['tag'] },
       { name: 'exposure', allowedValues: Box.BOX_VALID_EXPOSURES },
       { name: 'model', allowedValues: Box.BOX_VALID_MODELS },
       { name: 'sensors', dataType: ['object'] },

packages/models/migrations/8-9_box_grouptag/8-node-update-grouptag.js

@@ -0,0 +1,59 @@
+/* eslint-disable */
+"use strict";
+
+const models = require("../../../models");
+const { mongoose, connect } = models.db;
+const moment = require("moment");
+
+const { Box } = models;
+
+const migrate = function migrate() {
+  const schemaVersion = mongoose.connection.db.collection("schemaVersion");
+
+  console.log('Starting "convert grouptag to array" migration');
+
+  return schemaVersion
+    .find({})
+    .next()
+    .then(function (latestVersion) {
+      if (latestVersion.schemaVersion !== 8) {
+        throw new Error("Unexpected schema version... Exiting!");
+      }
+
+      return Box.find({grouptag: {$exists: true}}, ['grouptag']).exec();
+    })
+    .then(function (boxes) {
+      const promises = [];
+      for (let index = 0; index < boxes.length; index++) {
+        const box = boxes[index];
+
+        const grouptags = [];
+        grouptags.push(box.grouptag);
+
+        box.set("grouptag", grouptags);
+        promises.push(box.save());
+      }
+
+      return Promise.all(promises).then(function () {
+        console.log("Migration done!");
+
+        return schemaVersion.update({}, { $inc: { schemaVersion: 1 } });
+      });
+    });
+};
+
+// Connect to db and run migration
+connect()
+  .then(function () {
+    migrate()
+      .then(function () {
+        mongoose.disconnect();
+      })
+      .catch(function (err) {
+        console.log(err);
+        mongoose.disconnect();
+      });
+  })
+  .catch(function (err) {
+    console.log(err);
+  });

packages/models/package.json

@@ -8,7 +8,7 @@
     "@grpc/grpc-js": "^1.3.7",
     "@grpc/proto-loader": "^0.6.4",
     "@sensebox/osem-protos": "^1.1.0",
-    "@sensebox/sketch-templater": "^1.10.5",
+    "@sensebox/sketch-templater": "1.11.2",
     "bcrypt": "^5.0.1",
     "bunyan": "^1.8.15",
     "config": "^3.3.6",

packages/models/src/box/box.js

@@ -65,7 +65,7 @@ const boxSchema = new Schema({
     enum: ['unknown', 'indoor', 'outdoor', 'mobile']
   },
   grouptag: {
-    type: String,
+    type: [String], // Default value for array is [] (empty array)
     trim: true,
     required: false
   },
@@ -880,7 +880,7 @@ boxSchema.methods.updateBox = function updateBox (args) {
   // only grouptag, description and weblink can removed through setting them to empty string ('')
   for (const prop of ['name', 'exposure', 'grouptag', 'description', 'weblink', 'image', 'integrations.mqtt', 'integrations.ttn', 'model', 'useAuth']) {
     if (typeof args[prop] !== 'undefined') {
-      box.set(prop, (args[prop] === '' ? undefined : args[prop]));
+      box.set(prop, ((args[prop] === '' || (Array.isArray(args[prop]) && args[prop].length === 0)) ? undefined : args[prop]));
     }
   }
 
@@ -938,16 +938,20 @@ boxSchema.methods.getLocations = function getLocations ({ format, fromDate, toDa
 };
 
 const buildFindBoxesQuery = function buildFindBoxesQuery (opts = {}) {
-  const { phenomenon, fromDate, toDate, bbox, near, maxDistance } = opts,
+  const { phenomenon, fromDate, toDate, bbox, near, maxDistance, grouptag } = opts,
     query = {};
 
   // simple string parameters
-  for (const param of ['exposure', 'model', 'grouptag']) {
+  for (const param of ['exposure', 'model']) {
     if (opts[param]) {
       query[param] = { '$in': opts[param] };
     }
   }
 
+  if (grouptag) {
+    query['grouptag'] = { '$all': grouptag };
+  }
+
   // bbox search parameter
   if (bbox) {
     query['locations'] = { '$geoWithin': { '$geometry': bbox } };

packages/models/test/tests/1-box.js

@@ -43,7 +43,7 @@ describe('Box model', function () {
         .then(shouldBeABoxWithSecrets)
         .then(function (box) {
           expect(box.name).equal('testSensebox');
-          expect(box.grouptag).not.exist;
+          expect(box.grouptag).to.be.an('array').that.is.empty;
           expect(box.model).equal('homeEthernet');
 
           expect(box.integrations.mqtt.enabled).false;
@@ -60,7 +60,7 @@ describe('Box model', function () {
     it('should persist integrations and other properties upon creation', function () {
       const box = senseBox({
         name: 'integrationsbox',
-        grouptag: 'grouptagTest',
+        grouptag: ['grouptagTest'],
         exposure: 'outdoor',
         ttn: {
           dev_id: 'test_devid',
@@ -88,7 +88,8 @@ describe('Box model', function () {
         .then(function ({ integrations, name, grouptag, exposure }) {
           expect(name).equal('integrationsbox');
 
-          expect(grouptag).equal('grouptagTest');
+          // expect(grouptag).equal(['grouptagTest']);
+          expect(grouptag).to.be.an('array').that.include('grouptagTest');
 
           expect(exposure).equal('outdoor');
 
@@ -560,7 +561,7 @@ describe('Box model', function () {
         }) {
           expect(name).equal(updatePayload.name);
           expect(exposure).equal(updatePayload.exposure);
-          expect(grouptag).equal(updatePayload.grouptag);
+          expect(grouptag).to.be.an('array').that.include(updatePayload.grouptag);
           expect(weblink).equal(updatePayload.weblink);
           expect(description).equal(updatePayload.description);
           expect(model).equal(updatePayload.model);
@@ -616,11 +617,11 @@ describe('Box model', function () {
           return Box.findById(box._id);
         })
         .then(function (box) {
-          expect(box.grouptag).equal(updatePayload.grouptag);
+          expect(box.grouptag).to.be.an('array').that.include(updatePayload.grouptag);
           expect(box.weblink).equal(updatePayload.weblink);
           expect(box.description).equal(updatePayload.description);
 
-          updatePayload.grouptag = '';
+          updatePayload.grouptag = [];
           updatePayload.weblink = '';
           updatePayload.description = '';
 
@@ -630,7 +631,7 @@ describe('Box model', function () {
           return Box.findById(box._id);
         })
         .then(function ({ grouptag, weblink, description }) {
-          expect(grouptag).not.exist;
+          expect(grouptag).to.be.an('array').that.is.empty;
           expect(weblink).not.exist;
           expect(description).not.exist;
         });

tests/data/senseBoxSchema.js

@@ -17,7 +17,10 @@ module.exports = {
       'type': 'string'
     },
     'grouptag': {
-      'type': 'string'
+      'type': ['array', 'string'],
+      'items': {
+        'type': 'string'
+      }
     },
     'exposure': {
       'type': 'string'

tests/tests/002-location_tests.js

@@ -26,22 +26,25 @@ const minimalSensebox = function minimalSensebox (location = [123, 12, 34], expo
 describe('openSenseMap API locations tests', function () {
   let authHeader, authHeaderBox, csvAndAuthHeader, box, submitTimeLoc1;
 
-  before('add test user', function (done) {
+  before('add test user', function () {
     const user = { name: 'locationtestuser', email: '[email protected]', password: '12345678' };
 
-    chakram.post(`${process.env.OSEM_TEST_BASE_URL}/users/register`, user)
+    return chakram.post(`${process.env.OSEM_TEST_BASE_URL}/users/register`, user)
       .then(logResponseIfError)
       .then(function (response) {
         expect(response.body.token).to.exist;
         authHeader = { headers: { 'Authorization': `Bearer ${response.body.token}` } };
-        done();
+
+        return chakram.wait();
       });
   });
 
-  after('delete user', function (done) {
-    chakram.delete(`${process.env.OSEM_TEST_BASE_URL}/users/me`, { password: '12345678' }, authHeader)
+  after('delete user', function () {
+    return chakram.delete(`${process.env.OSEM_TEST_BASE_URL}/users/me`, { password: '12345678' }, authHeader)
       .then(logResponseIfError)
-      .then(() => done());
+      .then(() => {
+        return chakram.wait();
+      });
   });
 
   describe('location validation', function () {
@@ -115,6 +118,7 @@ describe('openSenseMap API locations tests', function () {
 
           return chakram.wait();
         });
+      // .then(done, done);
     });
 
     it('should allow to set the location for a new box as latLng object', function () {
@@ -217,15 +221,17 @@ describe('openSenseMap API locations tests', function () {
     let BASE_URL = `${process.env.OSEM_TEST_BASE_URL}/boxes`;
     let result;
 
-    before('get box', function (done) {
+    before('get box', function () {
       BASE_URL = `${BASE_URL}/${box._id}`; // need to append at test runtime, not at parsetime
 
-      chakram.get(BASE_URL)
+      return chakram.get(BASE_URL)
         .then(logResponseIfError)
         .then(function (response) {
           expect(response).to.have.status(200);
           result = response.body;
-          done();
+          // done();
+
+          return chakram.wait();
         });
     });
 

tests/tests/005-create-boxes-test.js

@@ -538,7 +538,7 @@ describe('openSenseMap API Routes: /boxes', function () {
         expect(response).to.have.status(200);
         expect(response).to.comprise.of.json('data.name', update_payload.name);
         expect(response).to.comprise.of.json('data.exposure', update_payload.exposure);
-        expect(response).to.comprise.of.json('data.grouptag', update_payload.grouptag);
+        expect(response.body.data.grouptag).to.be.an('array').that.include(update_payload.grouptag);
         expect(response).to.comprise.of.json('data.description', update_payload.description);
         expect(response).to.comprise.of.json('data.currentLocation', {
           type: 'Point',
@@ -676,7 +676,7 @@ describe('openSenseMap API Routes: /boxes', function () {
   });
 
   it('should allow to unset the grouptag, description and weblink of the box via PUT', function () {
-    const update_payload = { grouptag: '', description: '', weblink: '' };
+    const update_payload = { grouptag: [], description: '', weblink: '' };
 
     return chakram.put(`${BASE_URL}/boxes/${boxIds[1]}`, update_payload, { headers: { 'Authorization': `Bearer ${jwt2}` } })
       .then(function (response) {