sebelga
diff --git a/‎.eslintrc.json
Copy file name to clipboard
+2-2Lines changed: 2 additions & 2 deletions b/‎.eslintrc.json
Copy file name to clipboard
+2-2Lines changed: 2 additions & 2 deletions
diff --git a/‎.travis.yml
Copy file name to clipboard
+17-5Lines changed: 17 additions & 5 deletions b/‎.travis.yml
Copy file name to clipboard
+17-5Lines changed: 17 additions & 5 deletions
diff --git a/‎lib/dataloader.js
Copy file name to clipboard
+7-2Lines changed: 7 additions & 2 deletions b/‎lib/dataloader.js
Copy file name to clipboard
+7-2Lines changed: 7 additions & 2 deletions
diff --git a/‎lib/entity.js
Copy file name to clipboard
+191-18Lines changed: 191 additions & 18 deletions b/‎lib/entity.js
Copy file name to clipboard
+191-18Lines changed: 191 additions & 18 deletions
diff --git a/‎lib/helpers/index.js
Copy file name to clipboard
+2Lines changed: 2 additions & 0 deletions b/‎lib/helpers/index.js
Copy file name to clipboard
+2Lines changed: 2 additions & 0 deletions
@@ -1,6 +1,6 @@
 {
     "parserOptions": {
-        "ecmaVersion": 6,
+        "ecmaVersion": 2018,
         "sourceType": "script"
     },
     "root": true,
@@ -43,7 +43,7 @@
             "error",
             120
         ],
-        "mocha/no-exclusive-tests": "off",
+        "mocha/no-exclusive-tests": "error",
         "comma-dangle": [
             "error",
             {
 
@@ -1,24 +1,36 @@
 language: node_js
 node_js:
-  - "10"
+  - "lts/*"
   - "8"
-  - "6"
 
 branches:
   only:
   - master
 
-install: yarn install --ignore-engines
+install: yarn install
 
 script:
   - npm test
 
 after_success:
   - npm run coveralls
 
-sudo: false
+sudo: required
 before_install:
-  - curl -o- -L https://yarnpkg.com/install.sh | bash -s -- --version 1.12.3
+  - curl -o- -L https://yarnpkg.com/install.sh | bash -s -- --version 1.14.0
   - export PATH=$HOME/.yarn/bin:$PATH
+  - yarn global add node-gyp node-pre-gyp
+
+env:
+  - CXX=g++-5
+
+# https://stackoverflow.com/a/40802733/5642633
+addons:
+  apt:
+    sources:
+    - ubuntu-toolchain-r-test
+    packages:
+    - g++-5
 cache:
   yarn: true
+
@@ -4,6 +4,7 @@
 
 const optional = require('optional');
 const dsAdapter = require('nsql-cache-datastore')();
+const arrify = require('arrify');
 
 const DataLoader = optional('dataloader');
 const { keyToString } = dsAdapter;
@@ -20,8 +21,12 @@ function createDataLoader(ds) {
     }
 
     return new DataLoader(keys => (
-        ds.get(keys).then((res) => {
-            const entities = res[0];
+        ds.get(keys).then(([res]) => {
+            // When providing an Array with 1 Key item, google-datastore
+            // returns a single item.
+            // For predictable results in gstore, all responses from Datastore.get()
+            // calls return an Array
+            const entities = arrify(res);
             const entitiesByKey = {};
             entities.forEach((entity) => {
                 entitiesByKey[keyToString(entity[ds.KEY])] = entity;
 
@@ -5,10 +5,12 @@ const is = require('is');
 const hooks = require('promised-hooks');
 const arrify = require('arrify');
 
-const utils = require('./utils');
 const datastoreSerializer = require('./serializer').Datastore;
 const defaultValues = require('./helpers/defaultValues');
 const { errorCodes } = require('./errors');
+const { validation, populateHelpers } = require('./helpers');
+
+const { populateFactory } = populateHelpers;
 
 class Entity {
     constructor(data, id, ancestors, namespace, key) {
@@ -43,6 +45,176 @@ class Entity {
         registerHooksFromSchema(this);
     }
 
+    save(transaction, opts = {}) {
+        this.__hooksEnabled = true;
+        const _this = this;
+        const options = {
+            method: 'upsert',
+            ...opts,
+        };
+
+        let { error } = validateEntityData();
+
+        if (!error) {
+            ({ error } = validateMethod(options.method));
+        }
+
+        if (error) {
+            return Promise.reject(error);
+        }
+
+        this.entityData = prepareData.call(this);
+
+        const entity = datastoreSerializer.toDatastore(this);
+        entity.method = options.method;
+
+        if (!transaction) {
+            return this.gstore.ds.save(entity).then(onSuccess);
+        }
+
+        if (transaction.constructor.name !== 'Transaction') {
+            return Promise.reject(new Error('Transaction needs to be a gcloud Transaction'));
+        }
+
+        addPostHooksTransaction.call(this);
+        transaction.save(entity);
+
+        return Promise.resolve(this);
+
+        // --------------------------
+
+        function onSuccess() {
+            /**
+             * Make sure to clear the cache for this Entity Kind
+             */
+            if (_this.constructor.__hasCache(options)) {
+                return _this.constructor.clearCache()
+                    .then(() => _this)
+                    .catch((err) => {
+                        let msg = 'Error while clearing the cache after saving the entity.';
+                        msg += 'The entity has been saved successfully though. ';
+                        msg += 'Both the cache error and the entity saved have been attached.';
+                        const cacheError = new Error(msg);
+                        cacheError.__entity = _this;
+                        cacheError.__cacheError = err;
+                        throw cacheError;
+                    });
+            }
+
+            return _this;
+        }
+
+        function validateEntityData() {
+            if (_this.schema.options.validateBeforeSave) {
+                return _this.validate();
+            }
+
+            return {};
+        }
+
+        function validateMethod(method) {
+            const allowed = {
+                update: true,
+                insert: true,
+                upsert: true,
+            };
+
+            return !allowed[method]
+                ? { error: new Error('Method must be either "update", "insert" or "upsert"') }
+                : { error: null };
+        }
+
+        /**
+         * Process some basic formatting to the entity data before save
+         * - automatically set the modifiedOn property to current date (if exists on schema)
+         * - convert object with latitude/longitude to Datastore GeoPoint
+         */
+        function prepareData() {
+            updateModifiedOn.call(this);
+            convertGeoPoints.call(this);
+
+            return this.entityData;
+
+            //--------------------------
+
+            /**
+             * If the schema has a "modifiedOn" property we automatically
+             * update its value to the current dateTime
+            */
+            function updateModifiedOn() {
+                if ({}.hasOwnProperty.call(this.schema.paths, 'modifiedOn')) {
+                    this.entityData.modifiedOn = new Date();
+                }
+            }
+
+            /**
+             * If the entityData has some property of type 'geoPoint'
+             * and its value is an js object with "latitude" and "longitude"
+             * we convert it to a datastore GeoPoint.
+            */
+            function convertGeoPoints() {
+                if (!{}.hasOwnProperty.call(this.schema.__meta, 'geoPointsProps')) {
+                    return;
+                }
+
+                this.schema.__meta.geoPointsProps.forEach((property) => {
+                    if ({}.hasOwnProperty.call(_this.entityData, property)
+                        && _this.entityData[property] !== null
+                        && _this.entityData[property].constructor.name !== 'GeoPoint') {
+                        _this.entityData[property] = _this.gstore.ds.geoPoint(_this.entityData[property]);
+                    }
+                });
+            }
+        }
+
+        /**
+         * If it is a transaction, we create a hooks.post array that will be executed
+         * when transaction succeeds by calling transaction.execPostHooks() (returns a Promises)
+         */
+        function addPostHooksTransaction() {
+            // disable (post) hooks, we will only trigger them on transaction succceed
+            this.__hooksEnabled = false;
+            this.constructor.hooksTransaction.call(
+                _this,
+                transaction,
+                this.__posts
+                    ? this.__posts.save
+                    : undefined
+            );
+        }
+    }
+
+    validate() {
+        const { schema, entityKind } = this;
+        const { entityData } = this;
+        const key = this.entityData[this.gstore.ds.KEY]; // save the Key
+
+        /**
+         * If not a Joi schema, we sanitize the entityData.
+         * If it's a Joi, it will be done automatically when validating.
+         */
+        if (is.undef(schema._joi)) {
+            this.entityData = this.constructor.sanitize(entityData, { disabled: ['write'] });
+        }
+
+        const validationResult = validation.validate(
+            this.entityData,
+            schema,
+            entityKind,
+            this.gstore.ds
+        );
+
+        /**
+         * If it's a Joi schema, make sure to update the entityData object
+         */
+        if (is.defined(schema._joi)) {
+            this.entityData = validationResult.value;
+        }
+
+        this.entityData[this.gstore.ds.KEY] = key; // put the Key back
+        return validationResult;
+    }
+
     plain(options) {
         options = typeof options === 'undefined' ? {} : options;
 
@@ -91,17 +263,15 @@ class Entity {
      *
      * @param {Function} cb Callback
      */
-    datastoreEntity(...args) {
+    datastoreEntity(options = {}) {
         const _this = this;
-        const cb = args.pop();
-        const options = args[0] || {};
 
         if (this.constructor.__hasCache(options)) {
             return this.gstore.cache.keys
                 .read(this.entityKey, options)
-                .then(onSuccess, onError);
+                .then(onSuccess);
         }
-        return this.gstore.ds.get(this.entityKey).then(onSuccess, onError);
+        return this.gstore.ds.get(this.entityKey).then(onSuccess);
 
         // ------------------------
 
@@ -110,22 +280,28 @@ class Entity {
 
             if (!datastoreEntity) {
                 if (_this.gstore.config.errorOnEntityNotFound) {
-                    return cb({
-                        code: errorCodes.ERR_ENTITY_NOT_FOUND,
-                        message: 'Entity not found',
-                    });
+                    const error = new Error('Entity not found');
+                    error.code = errorCodes.ERR_ENTITY_NOT_FOUND;
+                    throw error;
                 }
 
-                return cb(null, null);
+                return null;
             }
 
             _this.entityData = datastoreEntity;
-            return cb(null, _this);
+            return _this;
         }
+    }
 
-        function onError(err) {
-            return cb(err);
-        }
+    populate(path, propsToSelect) {
+        const refsToPopulate = [];
+
+        const promise = Promise.resolve(this)
+            .then(this.constructor.populate(refsToPopulate));
+
+        promise.populate = populateFactory(refsToPopulate, promise, this.constructor);
+        promise.populate(path, propsToSelect);
+        return promise;
     }
 
     getEntityDataWithVirtuals() {
@@ -312,7 +488,4 @@ function registerHooksFromSchema(self) {
     return self;
 }
 
-// Promisify Entity methods
-Entity.prototype.datastoreEntity = utils.promisify(Entity.prototype.datastoreEntity);
-
 module.exports = Entity;
@@ -3,10 +3,12 @@
 
 const queryHelpers = require('./queryhelpers');
 const validation = require('./validation');
+const populateHelpers = require('./populateHelpers');
 // const googleCloud = require('./google-cloud');
 
 module.exports = {
     queryHelpers,
     validation,
+    populateHelpers,
     // googleCloud,
 };
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"parserOptions": {`
`3`		`- "ecmaVersion": 6,`
	`3`	`+ "ecmaVersion": 2018,`
`4`	`4`	`"sourceType": "script"`
`5`	`5`	`},`
`6`	`6`	`"root": true,`
`@@ -43,7 +43,7 @@`
`43`	`43`	`"error",`
`44`	`44`	`120`
`45`	`45`	`],`
`46`		`- "mocha/no-exclusive-tests": "off",`
	`46`	`+ "mocha/no-exclusive-tests": "error",`
`47`	`47`	`"comma-dangle": [`
`48`	`48`	`"error",`
`49`	`49`	`{`