Merge pull request #212 from strongloop/refactor-discovery

Refactor discovery models

Author: loay

lib/discovery.js

@@ -11,7 +11,7 @@ module.exports = mixinDiscovery;
 function mixinDiscovery(PostgreSQL) {
   var async = require('async');
 
-  function paginateSQL(sql, orderBy, options) {
+  PostgreSQL.prototype.paginateSQL = function(sql, orderBy, options) {
     options = options || {};
     var limit = '';
     if (options.offset || options.skip || options.limit) {
@@ -24,102 +24,72 @@ function mixinDiscovery(PostgreSQL) {
       sql += ' ORDER BY ' + orderBy;
     }
     return sql + limit;
-  }
+  };
 
   /*!
    * Build sql for listing tables
    * @param options {all: for all owners, owner: for a given owner}
    * @returns {string} The sql statement
    */
-  function queryTables(options) {
+  PostgreSQL.prototype.buildQueryTables = function(options) {
     var sqlTables = null;
     var owner = options.owner || options.schema;
 
     if (options.all && !owner) {
-      sqlTables = paginateSQL('SELECT \'table\' AS "type", table_name AS "name", table_schema AS "owner"'
+      sqlTables = this.paginateSQL('SELECT \'table\' AS "type", table_name AS "name", table_schema AS "owner"'
         + ' FROM information_schema.tables', 'table_schema, table_name', options);
     } else if (owner) {
-      sqlTables = paginateSQL('SELECT \'table\' AS "type", table_name AS "name", table_schema AS "owner"'
+      sqlTables = this.paginateSQL('SELECT \'table\' AS "type", table_name AS "name", table_schema AS "owner"'
         + ' FROM information_schema.tables WHERE table_schema=\'' + owner + '\'', 'table_schema, table_name', options);
     } else {
-      sqlTables = paginateSQL('SELECT \'table\' AS "type", table_name AS "name",'
+      sqlTables = this.paginateSQL('SELECT \'table\' AS "type", table_name AS "name",'
           + ' table_schema AS "owner" FROM information_schema.tables WHERE table_schema=current_schema()',
         'table_name', options);
     }
     return sqlTables;
-  }
+  };
 
   /*!
    * Build sql for listing views
    * @param options {all: for all owners, owner: for a given owner}
    * @returns {string} The sql statement
    */
-  function queryViews(options) {
+  PostgreSQL.prototype.buildQueryViews = function(options) {
     var sqlViews = null;
     if (options.views) {
       var owner = options.owner || options.schema;
 
       if (options.all && !owner) {
-        sqlViews = paginateSQL('SELECT \'view\' AS "type", table_name AS "name",'
+        sqlViews = this.paginateSQL('SELECT \'view\' AS "type", table_name AS "name",'
             + ' table_schema AS "owner" FROM information_schema.views',
           'table_schema, table_name', options);
       } else if (owner) {
-        sqlViews = paginateSQL('SELECT \'view\' AS "type", table_name AS "name",'
+        sqlViews = this.paginateSQL('SELECT \'view\' AS "type", table_name AS "name",'
             + ' table_schema AS "owner" FROM information_schema.views WHERE table_schema=\'' + owner + '\'',
           'table_schema, table_name', options);
       } else {
-        sqlViews = paginateSQL('SELECT \'view\' AS "type", table_name AS "name",'
+        sqlViews = this.paginateSQL('SELECT \'view\' AS "type", table_name AS "name",'
             + ' current_schema() AS "owner" FROM information_schema.views',
           'table_name', options);
       }
     }
     return sqlViews;
-  }
+  };
 
   /**
    * Discover model definitions
    *
    * @param {Object} options Options for discovery
    * @param {Function} [cb] The callback function
    */
-  PostgreSQL.prototype.discoverModelDefinitions = function(options, cb) {
-    if (!cb && typeof options === 'function') {
-      cb = options;
-      options = {};
-    }
-    options = options || {};
-
-    var self = this;
-    var calls = [function(callback) {
-      self.execute(queryTables(options), callback);
-    }];
-
-    if (options.views) {
-      calls.push(function(callback) {
-        self.execute(queryViews(options), callback);
-      });
-    }
-    async.parallel(calls, function(err, data) {
-      if (err) {
-        cb(err, data);
-      } else {
-        var merged = [];
-        merged = merged.concat(data.shift());
-        if (data.length) {
-          merged = merged.concat(data.shift());
-        }
-        cb(err, merged);
-      }
-    });
-  };
 
   /*!
    * Normalize the arguments
    * @param table string, required
    * @param options object, optional
    * @param cb function, optional
    */
-  function getArgs(table, options, cb) {
+  PostgreSQL.prototype.getArgs = function(table, options, cb) {
     if ('string' !== typeof table || !table) {
       throw new Error(g.f('{{table}} is a required string argument: %s' + table));
     }
@@ -133,38 +103,40 @@ function mixinDiscovery(PostgreSQL) {
     }
     return {
       owner: options.owner || options.schema,
+      schema: options.owner || options.schema,
       table: table,
       options: options,
       cb: cb,
     };
-  }
+  };
 
   /*!
    * Build the sql statement to query columns for a given table
    * @param owner
    * @param table
    * @returns {String} The sql statement
    */
-  function queryColumns(owner, table) {
+  PostgreSQL.prototype.buildQueryColumns = function(owner, table) {
     var sql = null;
     if (owner) {
-      sql = paginateSQL('SELECT table_schema AS "owner", table_name AS "tableName", column_name AS "columnName",'
+      sql = this.paginateSQL('SELECT table_schema AS "owner", table_name AS "tableName", column_name AS "columnName",'
           + 'data_type AS "dataType", character_maximum_length AS "dataLength", numeric_precision AS "dataPrecision",'
           + ' numeric_scale AS "dataScale", is_nullable AS "nullable"'
           + ' FROM information_schema.columns'
           + ' WHERE table_schema=\'' + owner + '\''
           + (table ? ' AND table_name=\'' + table + '\'' : ''),
         'table_name, ordinal_position', {});
     } else {
-      sql = paginateSQL('SELECT current_schema() AS "owner", table_name AS "tableName", column_name AS "columnName",'
+      sql = this.paginateSQL('SELECT current_schema() AS "owner", table_name AS "tableName",'
+          + ' column_name AS "columnName",'
           + ' data_type AS "dataType", character_maximum_length AS "dataLength", numeric_precision AS "dataPrecision",'
           + ' numeric_scale AS "dataScale", is_nullable AS "nullable"'
           + ' FROM information_schema.columns'
           + (table ? ' WHERE table_name=\'' + table + '\'' : ''),
         'table_name, ordinal_position', {});
     }
     return sql;
-  }
+  };
 
   /**
    * Discover model properties from a table
@@ -173,26 +145,6 @@ function mixinDiscovery(PostgreSQL) {
    * @param {Function} [cb] The callback function
    *
    */
-  PostgreSQL.prototype.discoverModelProperties = function(table, options, cb) {
-    var args = getArgs(table, options, cb);
-    var owner = args.owner;
-    table = args.table;
-    options = args.options;
-    cb = args.cb;
-
-    var sql = queryColumns(owner, table);
-    var callback = function(err, results) {
-      if (err) {
-        cb(err, results);
-      } else {
-        results.map(function(r) {
-          r.type = mysqlDataTypeToJSONType(r.dataType, r.dataLength);
-        });
-        cb(err, results);
-      }
-    };
-    this.execute(sql, callback);
-  };
 
 // http://docs.oracle.com/javase/6/docs/api/java/sql/DatabaseMetaData.html#getPrimaryKeys(java.lang.String, java.lang.String, java.lang.String)
 
@@ -212,7 +164,7 @@ function mixinDiscovery(PostgreSQL) {
    * @param table
    * @returns {string}
    */
-  function queryForPrimaryKeys(owner, table) {
+  PostgreSQL.prototype.buildQueryPrimaryKeys = function(owner, table) {
     var sql = 'SELECT kc.table_schema AS "owner", '
       + 'kc.table_name AS "tableName", kc.column_name AS "columnName",'
       + ' kc.ordinal_position AS "keySeq",'
@@ -231,24 +183,14 @@ function mixinDiscovery(PostgreSQL) {
     }
     sql += ' ORDER BY kc.table_schema, kc.table_name, kc.ordinal_position';
     return sql;
-  }
+  };
 
   /**
    * Discover primary keys for a given table
    * @param {String} table The table name
    * @param {Object} options The options for discovery
    * @param {Function} [cb] The callback function
    */
-  PostgreSQL.prototype.discoverPrimaryKeys = function(table, options, cb) {
-    var args = getArgs(table, options, cb);
-    var owner = args.owner;
-    table = args.table;
-    options = args.options;
-    cb = args.cb;
-
-    var sql = queryForPrimaryKeys(owner, table);
-    this.execute(sql, cb);
-  };
 
   /*
    SELECT
@@ -270,7 +212,7 @@ function mixinDiscovery(PostgreSQL) {
    * @param table
    * @returns {string}
    */
-  function queryForeignKeys(owner, table) {
+  PostgreSQL.prototype.buildQueryForeignKeys = function(owner, table) {
     var sql =
       'SELECT tc.table_schema AS "fkOwner", tc.constraint_name AS "fkName", tc.table_name AS "fkTableName",'
       + ' kcu.column_name AS "fkColumnName", kcu.ordinal_position AS "keySeq",'
@@ -289,24 +231,14 @@ function mixinDiscovery(PostgreSQL) {
       sql += ' AND tc.table_name=\'' + table + '\'';
     }
     return sql;
-  }
+  };
 
   /**
    * Discover foreign keys for a given table
    * @param {String} table The table name
    * @param {Object} options The options for discovery
    * @param {Function} [cb] The callback function
    */
-  PostgreSQL.prototype.discoverForeignKeys = function(table, options, cb) {
-    var args = getArgs(table, options, cb);
-    var owner = args.owner;
-    table = args.table;
-    options = args.options;
-    cb = args.cb;
-
-    var sql = queryForeignKeys(owner, table);
-    this.execute(sql, cb);
-  };
 
   /*!
    * Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table).
@@ -315,7 +247,7 @@ function mixinDiscovery(PostgreSQL) {
    * @param table
    * @returns {string}
    */
-  function queryExportedForeignKeys(owner, table) {
+  PostgreSQL.prototype.buildQueryExportedForeignKeys = function(owner, table) {
     var sql = 'SELECT kcu.constraint_name AS "fkName", kcu.table_schema AS "fkOwner", kcu.table_name AS "fkTableName",'
       + ' kcu.column_name AS "fkColumnName", kcu.ordinal_position AS "keySeq",'
       + ' \'PK\' AS "pkName", ccu.table_schema AS "pkOwner",'
@@ -334,26 +266,17 @@ function mixinDiscovery(PostgreSQL) {
     sql += ' order by kcu.table_schema, kcu.table_name, kcu.ordinal_position';
 
     return sql;
-  }
+  };
 
   /**
    * Discover foreign keys that reference to the primary key of this table
    * @param {String} table The table name
    * @param {Object} options The options for discovery
    * @param {Function} [cb] The callback function
    */
-  PostgreSQL.prototype.discoverExportedForeignKeys = function(table, options, cb) {
-    var args = getArgs(table, options, cb);
-    var owner = args.owner;
-    table = args.table;
-    options = args.options;
-    cb = args.cb;
 
-    var sql = queryExportedForeignKeys(owner, table);
-    this.execute(sql, cb);
-  };
-
-  function mysqlDataTypeToJSONType(mysqlType, dataLength) {
+  PostgreSQL.prototype.buildPropertyType = function(columnDefinition, dataLength) {
+    var mysqlType = columnDefinition.dataType;
     var type = mysqlType.toUpperCase();
     switch (type) {
       case 'BOOLEAN':
@@ -384,7 +307,7 @@ function mixinDiscovery(PostgreSQL) {
       default:
         return 'String';
     }
-  }
+  };
 
   /**
    * Discover database indexes for the specified table
@@ -401,4 +324,14 @@ function mixinDiscovery(PostgreSQL) {
       cb(err, indexData);
     });
   };
+
+  PostgreSQL.prototype.setDefaultOptions = function(options) {
+  };
+
+  PostgreSQL.prototype.setNullableProperty = function(property) {
+  };
+
+  PostgreSQL.prototype.getDefaultSchema = function() {
+    return '';
+  };
 }

test/postgresql.discover.test.js

@@ -19,6 +19,17 @@ before(function() {
 });
 
 describe('discoverModels', function() {
+  describe('Discover database schemas', function() {
+    it('should return an array of db schemas', function(done) {
+      db.connector.discoverDatabaseSchemas(function(err, schemas) {
+        if (err) return done(err);
+        schemas.should.be.an.array;
+        schemas.length.should.be.above(0);
+        done();
+      });
+    });
+  });
+
   describe('Discover models including views', function() {
     it('should return an array of tables and views', function(done) {
       db.discoverModelDefinitions({
@@ -181,6 +192,8 @@ describe('Discover model foreign keys', function() {
 describe('Discover LDL schema from a table', function() {
   it('should return an LDL schema for inventory', function(done) {
     db.discoverSchema('inventory', {owner: 'strongloop'}, function(err, schema) {
+      console.log('This is our err: ', err);
+      console.log('This is our schema: ', schema);
       assert(schema.name === 'Inventory');
       assert(schema.options.postgresql.schema === 'strongloop');
       assert(schema.options.postgresql.table === 'inventory');
@@ -203,6 +216,7 @@ describe('Discover and build models', function() {
   it('should build a model from discovery', function(done) {
     db.discoverAndBuildModels('GeoPoint', {schema: 'strongloop'}, function(err, schema) {
       schema.Geopoint.find(function(err, data) {
+        console.log('This is our err: ', err);
         assert(!err);
         assert(Array.isArray(data));
         assert(data[0].location);