API v4 (WIP) (#10453)

API v4

test/api/unit/libs/baseModel.test.js

@@ -0,0 +1,97 @@
+import baseModel from '../../../../website/server/libs/baseModel';
+import mongoose from 'mongoose';
+
+describe('Base model plugin', () => {
+  let schema;
+
+  beforeEach(() => {
+    schema = new mongoose.Schema();
+    sandbox.stub(schema, 'add');
+  });
+
+  it('adds a _id field to the schema', () => {
+    schema.plugin(baseModel);
+
+    expect(schema.add).to.be.calledWith(sinon.match({
+      _id: sinon.match.object,
+    }));
+  });
+
+  it('can add timestamps fields', () => {
+    schema.plugin(baseModel, {timestamps: true});
+
+    expect(schema.add).to.be.calledTwice;
+  });
+
+  it('can sanitize input objects', () => {
+    schema.plugin(baseModel, {
+      noSet: ['noUpdateForMe'],
+    });
+
+    expect(schema.statics.sanitize).to.exist;
+    let sanitized = schema.statics.sanitize({ok: true, noUpdateForMe: true});
+
+    expect(sanitized).to.have.property('ok');
+    expect(sanitized).not.to.have.property('noUpdateForMe');
+    expect(sanitized.noUpdateForMe).to.equal(undefined);
+  });
+
+  it('accepts an array of additional fields to sanitize at runtime', () => {
+    schema.plugin(baseModel, {
+      noSet: ['noUpdateForMe'],
+    });
+
+    expect(schema.statics.sanitize).to.exist;
+    let sanitized = schema.statics.sanitize({ok: true, noUpdateForMe: true, usuallySettable: true}, ['usuallySettable']);
+
+    expect(sanitized).to.have.property('ok');
+    expect(sanitized).not.to.have.property('noUpdateForMe');
+    expect(sanitized).not.to.have.property('usuallySettable');
+  });
+
+
+  it('can make fields private', () => {
+    schema.plugin(baseModel, {
+      private: ['amPrivate'],
+    });
+
+    expect(schema.options.toJSON.transform).to.exist;
+    let objToTransform = {ok: true, amPrivate: true};
+    let privatized = schema.options.toJSON.transform({}, objToTransform);
+
+    expect(privatized).to.have.property('ok');
+    expect(privatized).not.to.have.property('amPrivate');
+  });
+
+  it('accepts a further transform function for toJSON', () => {
+    let options = {
+      private: ['amPrivate'],
+      toJSONTransform: sandbox.stub().returns(true),
+    };
+
+    schema.plugin(baseModel, options);
+
+    let objToTransform = {ok: true, amPrivate: true};
+    let doc = {doc: true};
+    let privatized = schema.options.toJSON.transform(doc, objToTransform);
+
+    expect(privatized).to.equals(true);
+    expect(options.toJSONTransform).to.be.calledWith(objToTransform, doc);
+  });
+
+  it('accepts a transform function for sanitize', () => {
+    let options = {
+      private: ['amPrivate'],
+      sanitizeTransform: sandbox.stub().returns(true),
+    };
+
+    schema.plugin(baseModel, options);
+
+    expect(schema.options.toJSON.transform).to.exist;
+    let objToSanitize = {ok: true, noUpdateForMe: true};
+    let sanitized = schema.statics.sanitize(objToSanitize);
+
+    expect(sanitized).to.equals(true);
+    expect(options.sanitizeTransform).to.be.calledWith(objToSanitize);
+  });
+});