Merge pull request #105 from r-spacex/limits

Add limit query string option

Author: jakewmeyer

package.json

@@ -50,6 +50,7 @@
   "jest": {
     "coverageDirectory": "./coverage/",
     "collectCoverage": true,
+    "setupTestFrameworkScriptFile": "./test/jest.setup.js",
     "collectCoverageFrom": [
       "src/**",
       "!**/node_modules/**",

src/builders/limit-query.js

@@ -0,0 +1,18 @@
+
+/**
+ * Returns number to limit documents in query
+ * @param {Object} req The Koa context object to access querystrings
+ * @return {number} Number of documents to limit
+ */
+
+module.exports = (req) => {
+  let limit = null;
+
+  if (req.query.limit) {
+    limit = parseInt(req.query.limit, 10);
+  } else {
+    limit = 0;
+  }
+
+  return limit;
+};

src/controllers/capsules.js

@@ -1,4 +1,6 @@
 
+const limitQuery = require('../builders/limit-query');
+
 module.exports = {
 
   /**
@@ -9,6 +11,7 @@ module.exports = {
       .collection('dragon')
       .find({})
       .project({ _id: 0 })
+      .limit(limitQuery(ctx.request))
       .toArray();
     ctx.body = data;
   },

src/controllers/history.js

@@ -1,6 +1,7 @@
 
 const historySort = require('../builders/history-sort');
 const historyQuery = require('../builders/history-query');
+const limitQuery = require('../builders/limit-query');
 
 module.exports = {
 
@@ -13,6 +14,7 @@ module.exports = {
       .find(historyQuery(ctx.request))
       .project({ _id: 0 })
       .sort(historySort(ctx.request))
+      .limit(limitQuery(ctx.request))
       .toArray();
     ctx.body = data;
   },

src/controllers/launches.js

@@ -2,6 +2,7 @@
 const launchQuery = require('../builders/launch-query');
 const sortQuery = require('../builders/launch-sort');
 const projectQuery = require('../builders/project-query');
+const limitQuery = require('../builders/limit-query');
 
 module.exports = {
 
@@ -42,12 +43,14 @@ module.exports = {
       .find(launchQuery(ctx.request))
       .project(projectQuery(ctx.request))
       .sort(sortQuery(ctx.request))
+      .limit(limitQuery(ctx.request))
       .toArray();
     const upcoming = await global.db
       .collection('upcoming_v2')
       .find(launchQuery(ctx.request))
       .project(projectQuery(ctx.request))
       .sort(sortQuery(ctx.request))
+      .limit(limitQuery(ctx.request))
       .toArray();
     const data = past.concat(upcoming);
     ctx.body = data;
@@ -62,6 +65,7 @@ module.exports = {
       .find(launchQuery(ctx.request))
       .project(projectQuery(ctx.request))
       .sort(sortQuery(ctx.request))
+      .limit(limitQuery(ctx.request))
       .toArray();
     ctx.body = data;
   },
@@ -75,6 +79,7 @@ module.exports = {
       .find(launchQuery(ctx.request))
       .project(projectQuery(ctx.request))
       .sort(sortQuery(ctx.request))
+      .limit(limitQuery(ctx.request))
       .toArray();
     ctx.body = data;
   },

src/controllers/launchpads.js

@@ -1,4 +1,6 @@
 
+const limitQuery = require('../builders/limit-query');
+
 module.exports = {
 
   /**
@@ -9,6 +11,7 @@ module.exports = {
       .collection('launchpad')
       .find({})
       .project({ _id: 0 })
+      .limit(limitQuery(ctx.request))
       .toArray();
     ctx.body = data;
   },

src/controllers/parts.js

@@ -1,6 +1,7 @@
 
 const coreQuery = require('../builders/core-query');
 const capQuery = require('../builders/capsule-query');
+const limitQuery = require('../builders/limit-query');
 
 module.exports = {
 
@@ -13,6 +14,7 @@ module.exports = {
       .find(capQuery(ctx.request))
       .project({ _id: 0 })
       .sort({ original_launch: 1, capsule_serial: 1 })
+      .limit(limitQuery(ctx.request))
       .toArray();
     ctx.body = data;
   },
@@ -38,6 +40,7 @@ module.exports = {
       .find(coreQuery(ctx.request))
       .project({ _id: 0 })
       .sort({ original_launch: 1, core_serial: 1 })
+      .limit(limitQuery(ctx.request))
       .toArray();
     ctx.body = data;
   },

src/controllers/rockets.js

@@ -1,4 +1,6 @@
 
+const limitQuery = require('../builders/limit-query');
+
 module.exports = {
 
   /**
@@ -10,6 +12,7 @@ module.exports = {
       .find({})
       .project({ _id: 0 })
       .sort({ first_flight: 1 })
+      .limit(limitQuery(ctx.request))
       .toArray();
     ctx.body = data;
   },

test/builders/limit-query.test.js

@@ -0,0 +1,25 @@
+
+const request = require('supertest');
+const app = require('../../src/app');
+
+beforeAll((done) => {
+  app.on('ready', () => {
+    done();
+  });
+});
+
+//------------------------------------------------------------
+//                     Limit Query Test
+//------------------------------------------------------------
+
+test('It should return all launches with a limit of zero', async () => {
+  const response = await request(app.callback()).get('/v2/launches?limit=0');
+  expect(response.statusCode).toBe(200);
+  expect(response.body.length).toBeGreaterThan(0);
+});
+
+test('It should return only the first five launches', async () => {
+  const response = await request(app.callback()).get('/v2/launches?limit=5');
+  expect(response.statusCode).toBe(200);
+  expect(response.body.length).toBe(5);
+});

test/jest.setup.js

@@ -0,0 +1 @@
+jest.setTimeout(10000);