adapt-authoring-api 1.0.1 → 1.2.0

package/errors/errors.json

@@ -28,5 +28,14 @@
   "NO_SCHEMA_DEF": {
     "description": "No json schema has been defined",
     "statusCode": 404
+  },
+  "TOO_MANY_RESULTS": {
+    "data": {
+      "actual": "Number of actual results",
+      "expected": "Number of expected results",
+      "query": "The query"
+    },
+    "description": "Too many results were returned",
+    "statusCode": 500
   }
 }

package/lib/AbstractApiModule.js

@@ -37,6 +37,7 @@ class AbstractApiModule extends AbstractModule {
       }
     ]
   }
+
   /**
    * Returns the 'OK' status code to match the HTTP method
    * @param {String} httpMethod
@@ -355,8 +356,8 @@ class AbstractApiModule extends AbstractModule {
       let data
       try {
         await this.requestHook.invoke(req)
-        const preCheck = !req.auth.isSuper && method !== 'get' && method !== 'post'
-        const postCheck = !req.auth.isSuper && method === 'get'
+        const preCheck = method !== 'get' && method !== 'post'
+        const postCheck = method === 'get'
         if (preCheck) {
           await this.checkAccess(req, req.apiData.query)
         }
@@ -374,7 +375,7 @@ class AbstractApiModule extends AbstractModule {
         }
         data = data[0]
       }
-      if (method !== 'get') {        
+      if (method !== 'get') {
         const resource = Array.isArray(data) ? req.apiData.query : data._id.toString()
         this.log('debug', `API_${func.name.toUpperCase()}`, resource, 'by', req.auth.user._id.toString())
       }
@@ -561,9 +562,23 @@ class AbstractApiModule extends AbstractModule {
    */
   async find (query, options = {}, mongoOptions = {}) {
     this.setDefaultOptions(options)
-    const mongodb = await this.app.waitForModule('mongodb')
     const q = options.validate ? await this.parseQuery(options.schemaName, query, options, mongoOptions) : query
-    return mongodb.find(options.collectionName, q, mongoOptions)
+    return this.cache.get(q, options, mongoOptions)
+  }
+
+  /**
+   * Retrieves a single document from the DB. If multiple results are returned from the query, an error is thrown.
+   * @param {Object} query Attributes to use to filter DB documents
+   * @param {FindOptions} options Function options
+   * @param {external:MongoDBFindOptions} mongoOptions Options to be passed to the MongoDB function
+   * @return {Promise} Resolves with the single DB document
+   */
+  async findOne (query, options, mongoOptions) {
+    const results = await this.find(query, options, mongoOptions)
+    if (results.length > 1) {
+      throw this.app.errors.TOO_MANY_RESULTS.setData({ actual: results.length, expected: 1, query })
+    }
+    return results[0]
   }
 
   /**
@@ -596,7 +611,7 @@ class AbstractApiModule extends AbstractModule {
     if (options.invokePostHook !== false) await this.postUpdateHook.invoke(originalDoc, results)
     return results
   }
-  
+
   /**
    * Updates existing documents in the DB
    * @param {Object} query Attributes to use to filter DB documents

package/lib/DataCache.js

@@ -6,7 +6,7 @@ import { App } from 'adapt-authoring-core'
 class DataCache {
   /** @override */
   constructor ({ enable, lifespan }) {
-    this.isEnabled = enable !== false
+    this.isEnabled = enable === true
     this.lifespan = lifespan ?? App.instance.config.get('adapt-authoring-api.defaultCacheLifespan')
     this.cache = {}
   }
@@ -21,7 +21,7 @@ class DataCache {
   async get (query, options, mongoOptions) {
     const key = JSON.stringify(query) + JSON.stringify(options) + JSON.stringify(mongoOptions)
     this.prune()
-    if (this.cache[key]) {
+    if (this.isEnabled && this.cache[key]) {
       return this.cache[key].data
     }
     const mongodb = await App.instance.waitForModule('mongodb')
@@ -35,8 +35,7 @@ class DataCache {
    */
   prune () {
     Object.keys(this.cache).forEach(k => {
-      const cache = this.cache[k]
-      if (Date.now() > (cache.timestamp + this.lifespan)) {
+      if (Date.now() > (this.cache[k].timestamp + this.lifespan)) {
         delete this.cache[k]
       }
     })

package/lib/typedefs.js

@@ -64,4 +64,4 @@
  * @typedef {Object} DeleteOptions
  * @property {String} collectionName DB collection to remove document from
  * @property {String} invokePostHook Whether the function should invoke the 'post' action hook on success
- */
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-api",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "Abstract module for creating APIs",
   "homepage": "https://github.com/adapt-security/adapt-authoring-api",
   "license": "GPL-3.0",

package/tests/abstractApiModule.spec.js

@@ -1,84 +0,0 @@
-const { App } = require('adapt-authoring-core');
-const should = require('should');
-const TestApiModule = require('./data/testApiModule');
-
-describe('Abstract API module', function() {
-  before(function(done) {
-    const loadModule = (mod, done) => {
-      const m = this.app.getModule(mod);
-      m.preload (this.app, () => m.boot(this.app, done, done), done);
-    };
-    this.app = App.instance;
-
-    loadModule('server', () => loadModule('mongodb', done));
-
-    this.tmi = new TestApiModule(this.app, {});
-    this.tmi.router.should.not.be.undefined();
-  });
-  describe('#requestHandler()', function() {
-    it('should customise the request object', function() {
-      const req = { method: 'GET' };
-      TestApiModule.requestHandler()(req, {}, () => {});
-      should.exist(req.type);
-      should.exist(req.dsquery);
-    });
-    it('should correctly map HTTP methods to MongoDBModule functions', function() {
-      const m1 = this.app.getModule('mongodb');
-      const m2 = {
-        retrieve: () => {
-          return new Promise((resolve, reject) => { correctlyMapped = true; })
-        }
-      };
-      let correctlyMapped = false;
-      this.app.dependencyloader.modules['adapt-authoring-mongodb'] = m2;
-      TestApiModule.requestHandler()({ method: 'GET' }, {}, () => {});
-      this.app.dependencyloader.modules['adapt-authoring-mongodb'] = m1;
-      correctlyMapped.should.be.true();
-    });
-  });
-  describe('#preload()', function() {
-    it('should create a child Router with the correct route', function(done) {
-      this.tmi.preload(this.app, () => {
-        this.tmi.router.constructor.name.should.equal('Router');
-        done();
-      }, done);
-    });
-  });
-  describe('#initSchemas()', function() {
-    it('should add specified schemas to the DB', function(done) {
-      this.tmi.boot(this.app, () => {
-        should.exist(this.app.getModule('mongodb').connection.models.test);
-        done();
-      }, done);
-    });
-    it('should ignore badly configured data', function() {
-      const mongoModels = this.app.getModule('mongodb').connection.models;
-      Object.keys(mongoModels).length.should.equal(1);
-    });
-  });
-  describe('#initMiddleware()', function() {
-    it('should add middleware to the API router', function() {
-      const middleware = this.tmi.router.middleware;
-      middleware.length.should.equal(1);
-      middleware[0].name.should.equal('testMiddleware');
-    });
-  });
-  describe('#initRoutes()', function() {
-    it('should add routes defined as an object', function() {
-      const routes = this.tmi.router.routes.map(r => r.route);
-      routes.should.containEql('/objectroute');
-    });
-    it('should add routes defined as an array', function() {
-      const routes = this.tmi.router.routes.map(r => r.route);
-      routes.should.containEql('/arrayroute');
-    });
-    it('should set custom permissions scopes if specified', function() {
-      const postScopes = this.app.auth.routes.secure['/api/arrayroute'].post;
-      postScopes.should.containEql('testscope');
-    });
-    it('should set generic permissions scopes if not specified', function() {
-      const scopes = this.app.auth.routes.secure['/api/objectroute'];
-      scopes.should.not.be.undefined();
-    });
-  });
-});

package/tests/abstractApiUtils.spec.js

@@ -1,49 +0,0 @@
-const should = require('should');
-
-describe('Abstract API utilities', function() {
-  describe('#callDbFunction()', function() {
-    it('should fail if request parameter doesn\'t specify a type', function() {
-      false.should.be.true();
-    });
-    it('should fail if attempting to call an unknown DB function', function() {
-      false.should.be.true();
-    });
-    it('should return data in response', function() {
-      false.should.be.true();
-    });
-    it('should set response HTTP status', function() {
-      false.should.be.true();
-    });
-  });
-  describe('#httpMethodToAction()', function() {
-    it('should return a string', function() {
-      false.should.be.true();
-    });
-    it('should return action string for known action', function() {
-      false.should.be.true();
-    });
-    it('should return empty string for unknown action', function() {
-      false.should.be.true();
-    });
-  });
-  describe('#validateSchemaDef()', function() {
-    it('should fail if def isn\'t an object', function() {
-      false.should.be.true();
-    });
-    it('should fail if def has no name', function() {
-      false.should.be.true();
-    });
-    it('should fail if def has no model', function() {
-      false.should.be.true();
-    });
-    it('should fail if schemas isn\'t an array', function() {
-      false.should.be.true();
-    });
-    it('should fail if def has no routes', function() {
-      false.should.be.true();
-    });
-    it('should validate routes', function() {
-      false.should.be.true();
-    });
-  });
-});

package/tests/data/testApiModule.js

@@ -1,50 +0,0 @@
-const AbstractAPIModule = require('../../lib/AbstractApiModule');
-
-const TestSchema = {
-  name: 'test',
-  definition: {
-    isTest: {
-      type: "boolean", default: true
-    }
-  }
-};
-
-class TestApiModule extends AbstractAPIModule {
-  static get def() {
-    return {
-      name: 'test',
-      model: 'test',
-      schemas: [
-        TestSchema,
-        { name: 't2' },
-        { definition: {} }
-      ],
-      middleware: [testMiddleware],
-      routes: [
-        {
-          route: '/arrayroute',
-          handlers: ['post','get','put','delete'],
-          scopes: { post: 'testscope' }
-        },
-        {
-          route: '/objectroute',
-          handlers: {
-            post: testRouteHandler,
-            get: testRouteHandler,
-            put: testRouteHandler,
-            delete: testRouteHandler
-          }
-        }
-      ]
-    };
-  }
-}
-
-function testMiddleware(req, res, next) {
-  console.log('Test middleware called');
-}
-function testRouteHandler(req, res, next) {
-  console.log('Test handler called');
-}
-
-module.exports = TestApiModule;