Merge pull request #39 from trailsjs/v3

migrate to v3

Author: jaumard

.travis.yml

@@ -1,9 +1,7 @@
 language: node_js
 node_js:
-- 4
-- 5
-- 6
-- 7
+- 8
+- 9
 
 notifications:
   email: false
@@ -21,4 +19,4 @@ deploy:
   on:
     tags: true
     repo: trailsjs/trailpack-sequelize
-    node: 7
+    node: 8

api/services/FootprintService.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const _ = require('lodash')
-const Service = require('trails/service')
+const Service = require('trails/lib/Service')
 const ModelError = require('../../lib').ModelError
 
 const manageError = err => {
@@ -39,7 +39,7 @@ module.exports = class FootprintService extends Service {
    */
   create(modelName, values, options) {
     const Model = this._getModel(modelName)
-    const modelOptions = _.defaultsDeep({}, options, _.get(this.app.config, 'footprints.models.options'))
+    const modelOptions = _.defaultsDeep({}, options, this.app.config.get('footprints.models.options'))
     if (!Model) {
       return Promise.reject(new ModelError('E_NOT_FOUND', `${modelName} can't be found`))
     }

api/services/SchemaMigrationService.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Service = require('trails/service')
+const Service = require('trails/lib/Service')
 
 /**
  * @module SchemaMigrationService

archetype/config/database.js

@@ -0,0 +1,2 @@
+exports.stores = require('./stores')
+exports.models = require('./models')

archetype/config/index.js

@@ -0,0 +1,29 @@
+/**
+ * Models Configuration
+ *
+ * @see {@link http://trailsjs.io/doc/trailpack/config
+ */
+module.exports = {
+  /**
+   * The default store if not defined by model
+   */
+  defaultStore: 'sqlitedev',
+  /**
+   * The default migration strategy if not defined by the store or model
+   * ENUM: none, safe, drop, alter,
+   */
+  migrate: 'drop'
+
+  /**
+   * You can also define model by model which store, migration, etc it will use.
+   * A la carte model definitions
+   * eg:
+   *
+   * Test: {
+   *   store: 'sqlitedev',
+   *   migrate: 'drop',
+   *   tableName: 'test',
+   *   options: {}
+   * }
+   */
+}

archetype/config/models.js

@@ -0,0 +1,29 @@
+/**
+ * Stores Configuration
+ *
+ * @see {@link http://trailsjs.io/doc/trailpack/config
+ */
+module.exports = {
+  /**
+   * Define the database stores. A store is typically a single database.
+   *
+   * Use the SQLite3 by default for development purposes.
+   *
+   * Set production connection info in config/env/production.js
+   */
+
+
+  /**
+   * Define a store called "sqlitedev" which uses SQLite3 to persist data.
+   */
+  sqlitedev: {
+    database: 'dev',
+    storage: './.tmp/dev.sqlite',
+    host: '127.0.0.1',
+    dialect: 'sqlite'
+    /**
+     * The default migration strategy for this store.
+     migrate: 'drop'
+    */
+  }
+}

archetype/config/stores.js

@@ -1,2 +1 @@
 exports.trailpack = require('./trailpack')
-exports.database = require('./database')

config/database.js

@@ -1,3 +1,4 @@
+/* eslint no-console: [0] */
 'use strict'
 
 const Trailpack = require('trailpack/datastore')
@@ -9,21 +10,25 @@ module.exports = class SequelizeTrailpack extends Trailpack {
   /**
    * Validate the database config, and api.model definitions
    */
-  validate() {
-    const stores = _.get(this.app.config, 'database.stores')
+  async validate() {
+    const stores = this.app.config.get('stores')
+    const models = this.app.config.get('models')
+
     if (stores && Object.keys(stores).length === 0) {
-      this.app.config.log.logger.warn('No store configured at config.database.stores, models will be ignored')
+      this.app.config.log.logger.warn('No store configured at config.stores, models will be ignored')
     }
+
     return Promise.all([
-      lib.Validator.validateDatabaseConfig(this.app.config.database)
+      lib.Validator.validateStoresConfig(stores),
+      lib.Validator.validateModelsConfig(models)
     ])
   }
 
   /**
    * Merge configuration into models, load Sequelize collections.
    */
   configure() {
-    this.app.config.database.orm = 'sequelize'
+    this.app.config.set('stores.orm', 'sequelize')
     _.merge(this.app.config, lib.FailsafeConfig)
   }
 
@@ -36,40 +41,55 @@ module.exports = class SequelizeTrailpack extends Trailpack {
 
     this.orm = this.orm || {}
     this.app.orm = {}
-    this.connections = lib.Transformer.transformStores(this.app)
-    this.models = lib.Transformer.transformModels(this.app)
-
-    _.each(this.models, (model, modelName) => {
-      _.each(this.connections, (connection, name) => {
-        if (model.connection == name) {
-          const Model = connection.define(modelName, model.schema, model.config)
-
-          if (model.config) {
-            if (model.config.classMethods) {
-              for (const methodName in model.config.classMethods) {
-                Model[methodName] = model.config.classMethods[methodName]
-              }
-            }
+    this.connections = lib.Transformer.transformStoreConnections(this.app)
+    this.app.models = lib.Transformer.transformModels(this.app)
+
+    this.stores = _.mapValues(this.app.config.get('stores'), (store, storeName) => {
+      return {
+        models: _.pickBy(this.app.models, { store: storeName }),
+        connection: this.connections[storeName],
+        migrate: store.migrate || this.app.config.get('models.migrate')
+      }
+    })
 
-            if (model.config.instanceMethods) {
-              for (const methodName in model.config.instanceMethods) {
-                Model.prototype[methodName] = model.config.instanceMethods[methodName]
-              }
+    // Loop through store models and define them in Sequelize
+    _.each(this.stores, (store, storeName) => {
+      _.each(store.models, (model, modelName) => {
+        const Model = store.connection.define(modelName, model.schema, model.options)
+
+        if (model.options) {
+          if (model.options.classMethods) {
+            for (const methodName in model.options.classMethods) {
+              Model[methodName] = model.options.classMethods[methodName]
             }
           }
 
-          this.app.orm[model.globalId] = Model
+          if (model.options.instanceMethods) {
+            for (const methodName in model.options.instanceMethods) {
+              Model.prototype[methodName] = model.options.instanceMethods[methodName]
+            }
+          }
         }
+        this.app.orm[model.globalId] = Model
       })
     })
 
-    _.each(this.models, (model, modelName) => {
-      if (!this.app.orm[model.globalId]) return //ignore model if not configured
-
-      if (this.app.orm[model.globalId].associate)
-        this.app.orm[model.globalId].associate(this.app.orm)
+    // Loop through store models and associate
+    _.each(this.stores, (store, storeName) => {
+      // Run Associate on the Models
+      _.each(store.models, (model, modelName) => {
+        // ignore model if not configured
+        if (!this.app.orm[model.globalId]) {
+          return
+        }
+        // Associate models if method defined
+        if (this.app.orm[model.globalId].associate) {
+          this.app.orm[model.globalId].associate(this.app.orm)
+        }
 
-      this.orm[model.globalId.toLowerCase()] = this.app.orm[model.globalId]
+        // Reset the orm Model
+        this.orm[model.globalId.toLowerCase()] = this.app.orm[model.globalId]
+      })
     })
 
     return this.migrate()
@@ -78,31 +98,33 @@ module.exports = class SequelizeTrailpack extends Trailpack {
   /**
    * Close all database connections
    */
-  unload() {
+  async unload() {
     return Promise.all(
-      _.map(this.connections, connection => {
+      _.map(this.stores, store => {
         return new Promise((resolve, reject) => {
-          connection.close()
+          store.connection.close()
           resolve()
         })
       })
     )
   }
 
-  migrate() {
+  async migrate() {
     const SchemaMigrationService = this.app.services.SchemaMigrationService
-    const database = this.app.config.database
-
-    if (database.models.migrate == 'none') return
 
     return Promise.all(
-      _.map(this.connections, connection => {
-
-        if (database.models.migrate == 'drop') {
-          return SchemaMigrationService.dropDB(connection)
+      _.map(this.stores, store => {
+        if (store.migrate === 'drop') {
+          return SchemaMigrationService.dropDB(store.connection)
+        }
+        else if (store.migrate === 'alter') {
+          return SchemaMigrationService.alterDB(store.connection)
+        }
+        else if (store.migrate === 'none') {
+          return
         }
-        else if (database.models.migrate == 'alter') {
-          return SchemaMigrationService.alterDB(connection)
+        else {
+          return
         }
       })
     )