Simple pagination for embedded boxes on user object (#762)

mpfeil · web-flow · commit d14bbdd18656 · 2023-07-04T14:06:14.000+02:00
* Add simple pagination for embedded boxes on user object

* add boxes count to response

* Add endpoint to retireve single box of a logged in user

* Fix typoes in tests
diff --git a/.scripts/run-tests.sh b/.scripts/run-tests.sh
@@ -22,7 +22,7 @@ only_models_tests=${only_models_tests:-}
 git_branch=$(git rev-parse --abbrev-ref HEAD)
 
 function runComposeCommand() {
-  sudo docker-compose -p osemapitest -f ./tests/docker-compose.yml "$@"
+  docker-compose -p osemapitest -f ./tests/docker-compose.yml "$@"
 }
 
 function cleanup() {
diff --git a/packages/api/lib/controllers/usersController.js b/packages/api/lib/controllers/usersController.js
@@ -247,16 +247,42 @@ const confirmEmailAddress = async function confirmEmailAddress (req, res) {
  * @apiName getUserBoxes
  * @apiDescription List all boxes and sharedBoxes of the signed in user with secret fields
  * @apiGroup Users
+ * @apiParam {Integer} page the selected page for pagination
  * @apiSuccess {String} code `Ok`
  * @apiSuccess {String} data A json object with a single `boxes` array field
  */
 const getUserBoxes = async function getUserBoxes (req, res) {
+  const { page } = req._userParams;
   try {
-    const boxes = await req.user.getBoxes();
+    const boxes = await req.user.getBoxes(page);
     const sharedBoxes = await req.user.getSharedBoxes();
     res.send(200, {
       code: 'Ok',
-      data: { boxes: boxes, sharedBoxes: sharedBoxes },
+      data: { boxes: boxes, boxes_count: req.user.boxes.length, sharedBoxes: sharedBoxes },
+    });
+  } catch (err) {
+    return handleError(err);
+  }
+};
+
+/**
+ * @api {get} /users/me/boxes/:boxId get specific box of the signed in user
+ * @apiName getUserBox
+ * @apiDescription Get specific box of the signed in user with secret fields
+ * @apiGroup Users
+ * @apiParam {Integer} page the selected page for pagination
+ * @apiSuccess {String} code `Ok`
+ * @apiSuccess {String} data A json object with a single `box` object field
+ */
+const getUserBox = async function getUserBox (req, res) {
+  const { boxId } = req._userParams;
+  try {
+    const box = await req.user.getBox(boxId);
+    res.send(200, {
+      code: 'Ok',
+      data: {
+        box
+      },
     });
   } catch (err) {
     return handleError(err);
@@ -410,7 +436,18 @@ module.exports = {
     confirmEmailAddress,
   ],
   requestEmailConfirmation,
-  getUserBoxes,
+  getUserBox: [
+    retrieveParameters([
+      { predef: 'boxId', required: true }
+    ]),
+    getUserBox,
+  ],
+  getUserBoxes: [
+    retrieveParameters([
+      { name: 'page', dataType: 'Integer', defaultValue: 0, min: 0 },
+    ]),
+    getUserBoxes,
+  ],
   updateUser: [
     checkContentType,
     retrieveParameters([
diff --git a/packages/api/lib/routes.js b/packages/api/lib/routes.js
@@ -98,6 +98,7 @@ const routes = {
     { path: `${usersPath}/me`, method: 'get', handler: usersController.getUser, reference: 'api-Users-getUser' },
     { path: `${usersPath}/me`, method: 'put', handler: usersController.updateUser, reference: 'api-Users-updateUser' },
     { path: `${usersPath}/me/boxes`, method: 'get', handler: usersController.getUserBoxes, reference: 'api-Users-getUserBoxes' },
+    { path: `${usersPath}/me/boxes/:boxId`, method: 'get', handler: usersController.getUserBox, reference: 'api-Users-getUserBox' },
     { path: `${boxesPath}/:boxId/script`, method: 'get', handler: boxesController.getSketch, reference: 'api-Boxes-getSketch' },
     { path: `${boxesPath}`, method: 'post', handler: boxesController.postNewBox, reference: 'api-Boxes-postNewBox' },
     { path: `${boxesPath}/claim`, method: 'post', handler: boxesController.claimBox, reference: 'api-Boxes-claimBox' },
diff --git a/packages/models/src/user/user.js b/packages/models/src/user/user.js
@@ -549,19 +549,34 @@ userSchema.methods.updateUser = function updateUser ({ email, language, name, cu
     });
 };
 
-userSchema.methods.getBoxes = function getBoxes () {
+userSchema.methods.getBoxes = function getBoxes (page) {
   return Box.find({ _id: { $in: this.boxes } })
+    .limit(25)
+    .skip(page * 25)
     .populate(Box.BOX_SUB_PROPS_FOR_POPULATION)
     .then(function (boxes) {
       return boxes.map(b => b.toJSON({ includeSecrets: true }));
     });
 };
 
+userSchema.methods.getBox = function getBox (boxId) {
+  const user = this;
+
+  // checkBoxOwner throws ModelError
+  user.checkBoxOwner(boxId);
+
+  return Box.findOne({ _id: boxId })
+    .populate(Box.BOX_SUB_PROPS_FOR_POPULATION)
+    .then(function (box) {
+      return box.toJSON({ includeSecrets: true });
+    });
+};
+
 userSchema.methods.getSharedBoxes = function getSharedBoxes () {
   return Box.find({ _id: { $in: this.sharedBoxes } })
     .populate(Box.BOX_SUB_PROPS_FOR_POPULATION)
     .then(function (boxes) {
-      return boxes.map(b => b.toJSON({ includeSecrets: true }));
+      return boxes.map((b) => b.toJSON({ includeSecrets: true }));
     });
 };
 
diff --git a/tests/data/getUserBoxSchema.js b/tests/data/getUserBoxSchema.js
@@ -0,0 +1,177 @@
+'use strict';
+
+module.exports = {
+  $schema: 'http://json-schema.org/draft-04/schema#',
+  type: 'object',
+  properties: {
+    code: {
+      type: 'string',
+    },
+    data: {
+      type: 'object',
+      properties: {
+        box: {
+          type: 'object',
+          properties: {
+            createdAt: {
+              type: 'string',
+            },
+            exposure: {
+              type: 'string',
+            },
+            model: {
+              type: 'string',
+            },
+            name: {
+              type: 'string',
+            },
+            updatedAt: {
+              type: 'string',
+            },
+            useAuth: {
+              type: 'boolean',
+            },
+            access_token: {
+              type: 'string',
+            },
+            currentLocation: {
+              type: 'object',
+              properties: {
+                coordinates: {
+                  type: 'array',
+                  items: { type: 'number' },
+                },
+                timestamp: { type: 'string' },
+                type: { type: 'string' },
+              },
+              required: ['coordinates', 'timestamp', 'type'],
+            },
+            loc: {
+              type: 'array',
+              items: {
+                type: 'object',
+                properties: {
+                  geometry: {
+                    type: 'object',
+                    properties: {
+                      coordinates: {
+                        type: 'array',
+                        items: {
+                          type: 'number',
+                        },
+                      },
+                      type: {
+                        type: 'string',
+                      },
+                    },
+                    required: ['coordinates', 'type'],
+                  },
+                  type: {
+                    type: 'string',
+                  },
+                },
+                required: ['geometry', 'type'],
+              },
+            },
+            sensors: {
+              type: 'array',
+              items: {
+                type: 'object',
+                properties: {
+                  title: {
+                    type: 'string',
+                  },
+                  unit: {
+                    type: 'string',
+                  },
+                  sensorType: {
+                    type: 'string',
+                  },
+                  icon: {
+                    type: 'string',
+                  },
+                  _id: {
+                    type: 'string',
+                  },
+                  lastMeasurement: {
+                    type: 'object',
+                    properties: {
+                      value: {
+                        type: 'string',
+                      },
+                      createdAt: {
+                        type: 'string',
+                      },
+                    },
+                    required: ['value', 'createdAt'],
+                  },
+                },
+                required: ['title', 'unit', 'sensorType', '_id'],
+              },
+            },
+            _id: {
+              type: 'string',
+            },
+            integrations: {
+              type: 'object',
+              properties: {
+                mqtt: {
+                  type: 'object',
+                  properties: {
+                    url: {
+                      type: 'string',
+                    },
+                    topic: {
+                      type: 'string',
+                    },
+                    decodeOptions: {
+                      type: 'string',
+                    },
+                    connectionOptions: {
+                      type: 'string',
+                    },
+                    messageFormat: {
+                      type: 'string',
+                    },
+                    enabled: {
+                      type: 'boolean',
+                    },
+                  },
+                  required: ['enabled'],
+                },
+                ttn: {
+                  type: 'object',
+                  properties: {
+                    dev_id: {
+                      type: 'string',
+                    },
+                    app_id: {
+                      type: 'string',
+                    },
+                    profile: {
+                      type: 'string',
+                    },
+                  },
+                },
+              },
+              required: ['mqtt'],
+            },
+          },
+          required: [
+            'createdAt',
+            'exposure',
+            'name',
+            'updatedAt',
+            'currentLocation',
+            'loc',
+            'sensors',
+            '_id',
+            'integrations',
+          ],
+        },
+      },
+      required: ['box'],
+    },
+  },
+  required: ['code', 'data'],
+};
diff --git a/tests/tests/005-create-boxes-test.js b/tests/tests/005-create-boxes-test.js
@@ -12,6 +12,7 @@ const BASE_URL = process.env.OSEM_TEST_BASE_URL,
   senseBoxSchema = require('../data/senseBoxSchema'),
   getUserSchema = require('../data/getUserSchema'),
   getUserBoxesSchema = require('../data/getUserBoxesSchema'),
+  getUserBoxSchema = require('../data/getUserBoxSchema'),
   custom_valid_sensebox = require('../data/custom_valid_sensebox');
 
 describe('openSenseMap API Routes: /boxes', function () {
@@ -211,6 +212,32 @@ describe('openSenseMap API Routes: /boxes', function () {
       });
   });
 
+  it('should let users retrieve one of their boxes with all fields', function () {
+    let boxId;
+
+    return chakram
+      .get(`${BASE_URL}/users/me/boxes`, {
+        headers: { Authorization: `Bearer ${jwt}` },
+      })
+      .then(function (response) {
+        expect(response).to.have.status(200);
+        expect(response).to.have.schema(getUserBoxesSchema);
+
+        return response;
+      })
+      .then(function (response) {
+        boxId = response.body.data.boxes[0]._id;
+
+        return chakram.get(`${BASE_URL}/users/me/boxes/${boxId}`, {
+          headers: { Authorization: `Bearer ${jwt}` },
+        });
+      })
+      .then(function (response) {
+        expect(response).to.have.status(200);
+        expect(response).to.have.schema(getUserBoxSchema);
+      });
+  });
+
   it('should return a box as geojson', function () {
     return chakram.get(`${BASE_URL}/boxes/${boxId}?format=geojson`)
       .then(function (response) {
@@ -707,6 +734,46 @@ describe('openSenseMap API Routes: /boxes', function () {
       });
   });
 
+  it('should deny to retrieve a box of other user', function () {
+    let otherJwt, otherBoxId;
+
+    return chakram
+      .post(`${BASE_URL}/users/sign-in`, {
+        name: 'mrtest2',
+        email: 'tester3@test.test',
+        password: '12345678',
+      })
+      .then(function (response) {
+        expect(response).to.have.status(200);
+        expect(response).to.have.header(
+          'content-type',
+          'application/json; charset=utf-8'
+        );
+
+        expect(response.body.token).to.exist;
+
+        otherJwt = response.body.token;
+
+        return chakram.get(`${BASE_URL}/users/me/boxes`, {
+          headers: { Authorization: `Bearer ${otherJwt}` },
+        });
+      })
+      .then(function (response) {
+        otherBoxId = response.body.data.boxes[0]._id;
+
+        return chakram.get(`${BASE_URL}/users/me/boxes/${otherBoxId}`, {
+          headers: { Authorization: `Bearer ${jwt}` },
+        });
+      })
+      .then(function (response) {
+        expect(response).to.have.status(403);
+        expect(response).to.have.json({
+          code: 'Forbidden',
+          message: 'User does not own this senseBox',
+        });
+      });
+  });
+
   it('should allow to filter boxes by grouptag', function () {
     return chakram.get(`${BASE_URL}/boxes?grouptag=newgroup`)
       .then(function (response) {

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ only_models_tests=${only_models_tests:-}`
`22`	`22`	`git_branch=$(git rev-parse --abbrev-ref HEAD)`
`23`	`23`
`24`	`24`	`function runComposeCommand() {`
`25`		`- sudo docker-compose -p osemapitest -f ./tests/docker-compose.yml "$@"`
	`25`	`+ docker-compose -p osemapitest -f ./tests/docker-compose.yml "$@"`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`function cleanup() {`