#94

Author: etsuo

spec/helpers/sakuraapi.ts

@@ -15,6 +15,21 @@ export interface ITestSapiOptions {
   plugins?: SakuraApiPlugin[];
 }
 
+process.on('unhandledRejection', (r) => {
+
+  // tslint:disable:no-console
+  console.log('Unhandled Rejection'.red.underline);
+  console.log('-'.repeat(process.stdout.columns).red);
+  console.log('↓'.repeat(process.stdout.columns).zebra.red);
+  console.log('-'.repeat(process.stdout.columns).red);
+  console.log(r);
+  console.log('-'.repeat(process.stdout.columns).red);
+  console.log('↑'.repeat(process.stdout.columns).zebra.red);
+  console.log('-'.repeat(process.stdout.columns).red);
+  // tslint:enable:no-console
+
+});
+
 export function testSapi(options: ITestSapiOptions): SakuraApi {
 
   const sapi = new SakuraApi({
@@ -41,12 +56,14 @@ export function testSapi(options: ITestSapiOptions): SakuraApi {
   sapi.addLastErrorHandlers((err, req, res, next) => {
 
     // tslint:disable:no-console
-    console.log('------------------------------------------------'.red);
-    console.log('↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓'.zebra);
+    console.log('-'.repeat(process.stdout.columns).red);
+    console.log('↓'.repeat(process.stdout.columns).zebra.red);
+    console.log('-'.repeat(process.stdout.columns).red);
     console.log('An error bubbled up in an unexpected way during testing');
     console.log(err);
-    console.log('↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑'.zebra);
-    console.log('------------------------------------------------'.red);
+    console.log('-'.repeat(process.stdout.columns).red);
+    console.log('↑'.repeat(process.stdout.columns).zebra.red);
+    console.log('-'.repeat(process.stdout.columns).red);
     // tslint:enable:no-console
 
     next(err);

src/core/@model/db.spec.ts

@@ -91,17 +91,18 @@ describe('@Db', () => {
     });
 
     describe('maps db fields to deeply nested model properties', () => {
+      @Model()
       class Address {
-        @Db('st')
+        @Db('st') @Json()
         street = '1600 Pennsylvania Ave NW';
 
-        @Db('c')
+        @Db('c') @Json()
         city = 'Washington';
 
-        @Db('s')
+        @Db('s') @Json()
         state = 'DC';
 
-        @Db('z')
+        @Db('z') @Json()
         zip = '20500';
 
         @Db({field: 'gc', private: true})
@@ -262,6 +263,85 @@ describe('@Db', () => {
         expect(result.lastName).toBeUndefined();
       });
 
+      it('unmarshalls _id', (done) => {
+
+        @Model()
+        class Test extends SakuraApiModel {
+
+          @Db({field: 'ph'})
+          phone: string;
+        }
+
+        const data = {
+          _id: new ObjectID(),
+          ph: '1234567890'
+        };
+
+        const test = Test.fromDb(data);
+
+        expect((test._id || 'missing _id').toString()).toBe(data._id.toString());
+        expect((test.id || 'missing id').toString()).toBe(data._id.toString());
+        done();
+      });
+
+      it('model with default value will take default value if db returns field empty, issue #94', async (done) => {
+
+        @Model({
+          dbConfig: {
+            collection: 'users',
+            db: 'userDb'
+          }
+        })
+        class Test94 extends SakuraApiModel {
+          @Db({field: 'ad', model: Address}) @Json()
+          address = new Address();
+        }
+
+        try {
+          const sapi = testSapi({
+            models: [Address, Test94]
+          });
+          await sapi.listen({bootMessage: ''});
+          await Test94.removeAll({});
+
+          const createResult = await Test94.fromJson({
+            address: {
+              city: '2',
+              gateCode: '5',
+              state: '3',
+              street: '1',
+              zip: '4'
+            }
+          }).create();
+          const fullDoc = await Test94.getById(createResult.insertedId);
+
+          expect(fullDoc.address.street).toBe('1');
+          expect(fullDoc.address.city).toBe('2');
+          expect(fullDoc.address.state).toBe('3');
+          expect(fullDoc.address.zip).toBe('4');
+          expect(fullDoc.address.gateCode).toBe('5');
+
+          delete fullDoc.address;
+          await fullDoc.save({ad: undefined});
+
+          const updated = await Test94.getById(createResult.insertedId);
+          updated.address = updated.address || {} as Address;
+
+          const defaultAddress = new Address();
+
+          expect(updated.address.street).toBe(defaultAddress.street);
+          expect(updated.address.city).toBe(defaultAddress.city);
+          expect(updated.address.state).toBe(defaultAddress.state);
+          expect(updated.address.zip).toBe(defaultAddress.zip);
+          expect(updated.address.gateCode).toBe(defaultAddress.gateCode);
+
+          await sapi.close();
+          done();
+        } catch (err) {
+          done.fail(err);
+        }
+      });
+
       describe('with dbOptions.promiscuous mode', () => {
 
         @Model({
@@ -314,27 +394,6 @@ describe('@Db', () => {
           expect(result._id instanceof ObjectID).toBeTruthy('result._id should have been an instance of ObjectID');
         });
       });
-
-      it('unmarshalls _id', (done) => {
-
-        @Model()
-        class Test extends SakuraApiModel {
-
-          @Db({field: 'ph'})
-          phone: string;
-        }
-
-        const data = {
-          _id: new ObjectID(),
-          ph: '1234567890'
-        };
-
-        const test = Test.fromDb(data);
-
-        expect((test._id || 'missing _id').toString()).toBe(data._id.toString());
-        expect((test.id || 'missing id').toString()).toBe(data._id.toString());
-        done();
-      });
     });
 
     describe('prunes model fields missing from db document in strict mode', () => {

src/core/@model/db.ts

@@ -11,7 +11,9 @@ export const dbSymbols = {
 
 export interface IDbOptions {
   /**
-   * An optional constructor function (ES6 Class) that is used to instantiate the property.
+   * An optional `@`[[Model]] decorated class. If provided, the property will be instantiated as a sub document
+   * with its default values or the values from the database. `@`[[Json]] will utilize this same model
+   * if one is not set on that attribute.
    */
   model?: any;
 

src/core/@model/json.ts

@@ -11,7 +11,9 @@ export const jsonSymbols = {
 export interface IJsonOptions {
 
   /**
-   * An optional constructor function (ES6 Class) that is used to instantiate the property.
+   * An optional `@`[[Model]] decorated class. If provided, the property will be instantiated as a sub document
+   * with its default values or the values from the json object. `@`[[Json]] will utilize this same model
+   * as the one set in `@`[[Db]] if `model` is not set on this attribute.
    */
   model?: any;
 

src/core/@model/model.ts

@@ -408,25 +408,23 @@ function fromDb(json: any, options?: IFromDbOptions): object {
     const propertyNames = Object.getOwnPropertyNames(source);
     for (const key of propertyNames) {
 
-      if (shouldRecurse(source[key])) {
-
-        // convert the DB key name to the Model key name
-        const mapper = map(key, source[key], dbOptionsByFieldName);
+      // convert the DB key name to the Model key name
+      const mapper = map(key, source[key], dbOptionsByFieldName);
+      const model = mapper.model;
+
+      let nextTarget;
+      try {
+        nextTarget = (model)
+          ? Object.assign(new model(), target[mapper.newKey])
+          : target[mapper.newKey];
+      } catch (err) {
+        throw new Error(`Model '${modelName}' has a property '${key}' that defines its model with a value that`
+          + ` cannot be constructed`);
+      }
 
+      if (shouldRecurse(source[key])) {
         // if the key should be included, recurse into it
         if (mapper.newKey !== undefined) {
-          const model = mapper.model;
-
-          // if recurrsing into a model, set that up, otherwise just pass the target in
-          let nextTarget;
-          try {
-            nextTarget = (model)
-              ? Object.assign(new model(), target[mapper.newKey])
-              : target[mapper.newKey];
-          } catch (err) {
-            throw new Error(`Model '${modelName}' has a property '${key}' that defines its model with a value that`
-              + ` cannot be constructed`);
-          }
 
           let value = mapDbToModel(source[key], nextTarget, map, ++depth);
 
@@ -441,13 +439,13 @@ function fromDb(json: any, options?: IFromDbOptions): object {
           target[mapper.newKey] = value;
         }
 
-        continue;
-      }
-
-      // otherwise, map a property that has a primitive value or an ObjectID value
-      const mapper = map(key, source[key], dbOptionsByFieldName);
-      if (mapper.newKey !== undefined) {
-        target[mapper.newKey] = source[key];
+      } else {
+        // otherwise, map a property that has a primitive value or an ObjectID value
+        if (mapper.newKey !== undefined) {
+          target[mapper.newKey] = (source[key] !== undefined && source[key] !== null)
+            ? source[key]
+            : nextTarget; // resolves issue #94
+        }
       }
     }
 
@@ -470,12 +468,13 @@ function fromDb(json: any, options?: IFromDbOptions): object {
   function pruneNonDbProperties(source, target) {
     const dbOptionsByProperty: Map<string, IDbOptions> = Reflect.getMetadata(dbSymbols.dbByPropertyName, target);
 
-    for (const key of Object.getOwnPropertyNames(target)) {
+    const keys = Object.getOwnPropertyNames(target);
+    for (const key of keys) {
 
       const dbOptions = (dbOptionsByProperty) ? dbOptionsByProperty.get(key) || {} : null;
       const fieldName = (dbOptions) ? dbOptions.field || key : key;
 
-      if (!source.hasOwnProperty(fieldName)) {
+      if (!!source && !source.hasOwnProperty(fieldName)) {
         if (key === 'id' && source.hasOwnProperty('_id')) {
           continue;
         }
@@ -836,6 +835,14 @@ function getCursorById(id, project?: any): Cursor<any> {
 function getDb(): Db {
   // can be called as instance or static method, so get the appropriate context
   const constructor = this[modelSymbols.constructor] || this;
+
+  if (!constructor.sapi) {
+    const target = constructor.name || constructor.constructor.name;
+    throw new Error(`getDb called on model ${target} without an instance of ` +
+      `SakuraAPI. Make sure you pass ${target} into the Model injector when you're ` +
+      `instantiating SakuraApi`);
+  }
+
   const db = constructor[modelSymbols.sapi].dbConnections.getDb(constructor[modelSymbols.dbName]);
 
   debug.normal(`.getDb called, dbName: '${constructor[modelSymbols.dbName]}', found?: ${!!db}`);

tslint.json

@@ -26,7 +26,8 @@
     ],
     "interface-name": false,
     "prefer-object-spread": false,
-    "variable-name": false
+    "variable-name": false,
+    "no-object-literal-type-assertion": false
   },
   "jsRules": {
     "curly": true