- Removed File model and added ChallengeFile and SubmissionFile models.

gfzabarino · gfzabarino · commit 7838f145f34d · 2014-11-07T01:25:09.000-03:00
- Swagger: FileResource still exists and acts as entity of both ChallengeFile and SubmissionFile.
- Added tables creation and migration scripts.
- Changed getRefIdField (routeHelper.js) method to return 'fileId' for any mdel name that contains 'File' on its name.
- Fixed swaggerTestHelper to allow definitions without a required setting.
diff --git a/api/controllers/challenges.js b/api/controllers/challenges.js
@@ -12,7 +12,7 @@
 
 var datasource = require('./../../datasource').getDataSource();
 var Challenge = datasource.Challenge;
-var File = datasource.File;
+var ChallengeFile = datasource.ChallengeFile;
 var Participant = datasource.Participant;
 var Submission = datasource.Submission;
 var controllerHelper = require('./../../lib/controllerHelper');
@@ -27,8 +27,8 @@ var filteringOff = {
   filtering: false
 };
 
-// build controller for the nested files resource
-var fileController = controllerHelper.buildController(File, [Challenge], filteringOff);
+// build controller for the nested challenge files resource
+var challengeFileController = controllerHelper.buildController(ChallengeFile, [Challenge], filteringOff);
 
 // build controller for the nested participants resource
 var participantController = controllerHelper.buildController(Participant, [Challenge], {filtering: true});
@@ -45,11 +45,11 @@ module.exports = {
   update: challengeController.update,
   delete: challengeController.delete,
 
-  getChallengeFiles: fileController.all,
-  addChallengeFile: fileController.create,
-  getChallengeFile: fileController.get,
-  updateChallengeFile: fileController.update,
-  deleteChallengeFile: fileController.delete,
+  getChallengeFiles: challengeFileController.all,
+  addChallengeFile: challengeFileController.create,
+  getChallengeFile: challengeFileController.get,
+  updateChallengeFile: challengeFileController.update,
+  deleteChallengeFile: challengeFileController.delete,
 
   getAllParticipants: participantController.all,
   addParticipant: participantController.create,
diff --git a/api/controllers/files.js b/api/controllers/files.js
@@ -11,20 +11,19 @@
 
 
 var datasource = require('./../../datasource').getDataSource();
-var Challenge = datasource.Challenge;
 var Submission = datasource.Submission;
-var File = datasource.File;
+var SubmissionFile = datasource.SubmissionFile;
 var controllerHelper = require('./../../lib/controllerHelper');
 
 
-// build controller for the nested files resource
-var fileController = controllerHelper.buildController(File, [Challenge, Submission], {filtering: false});
+// build controller for the nested submission files resource
+var submissionFileController = controllerHelper.buildController(SubmissionFile, [Submission], {filtering: false});
 
 
 module.exports = {
-  getFiles: fileController.all,
-  addFile: fileController.create,
-  getFile: fileController.get,
-  updateFile: fileController.update,
-  deleteFile: fileController.delete
+  getFiles: submissionFileController.all,
+  addFile: submissionFileController.create,
+  getFile: submissionFileController.get,
+  updateFile: submissionFileController.update,
+  deleteFile: submissionFileController.delete
 };
diff --git a/api/models/challenge.js b/api/models/challenge.js
@@ -55,7 +55,7 @@ module.exports = function(sequelize, DataTypes) {
   }, {
     tableName : 'challenges',
     associate : function(models) {
-      Challenge.hasMany(models.File);
+      Challenge.hasMany(models.ChallengeFile);
       Challenge.hasMany(models.Participant);
       Challenge.hasMany(models.Submission);
       Challenge.hasMany(models.Scorecard);
diff --git a/api/models/challengeFile.js b/api/models/challengeFile.js
@@ -0,0 +1,56 @@
+/**
+ * Copyright (c) 2014 TopCoder, Inc. All rights reserved.
+ */
+/**
+ * Represent File in the system.
+ *
+ * @author gfzabarino
+ */
+'use strict';
+
+/**
+ * Defining ChallengeFile model
+ */
+module.exports = function(sequelize, DataTypes) {
+  var ChallengeFile = sequelize.define('ChallengeFile', {
+    // primary key
+    id: {
+      type: DataTypes.BIGINT, primaryKey: true, autoIncrement: true,
+      get: function() {
+        return parseInt(this.getDataValue('id'));
+      }
+    },
+    challengeId: {
+      type: DataTypes.BIGINT, allowNull: false,
+      get: function() {
+        return parseInt(this.getDataValue('challengeId'));
+      }
+    },
+    title : {type: DataTypes.TEXT},
+    filePath : {type: DataTypes.TEXT, allowNull: false},
+    size : {
+      type: DataTypes.BIGINT, allowNull: false,
+      get: function() {
+        return parseInt(this.getDataValue('size'));
+      }
+    },
+    fileName : {type: DataTypes.TEXT, allowNull: false},
+    // file storage location
+    storageLocation : {
+      type: DataTypes.ENUM,
+      values: ['local', 's3'],
+      allowNull: false
+    },
+    createdBy: DataTypes.STRING(128),
+    updatedBy: DataTypes.STRING(128)
+
+  }, {
+    tableName : 'challenge_files',
+    associate : function(models) {
+      ChallengeFile.belongsTo(models.Challenge, {foreignKey : 'challengeId'});
+    }
+  });
+
+  return ChallengeFile;
+
+};
diff --git a/api/models/submission.js b/api/models/submission.js
@@ -39,7 +39,7 @@ module.exports = function(sequelize, DataTypes) {
   }, {
     tableName : 'submissions',
     associate : function(models) {
-      Submission.hasMany(models.File);
+      Submission.hasMany(models.SubmissionFile);
       Submission.hasMany(models.Scorecard);
       Submission.belongsTo(models.User, {foreignKey : 'submitterId'});
       Submission.belongsTo(models.Challenge, {foreignKey : 'challengeId'});
diff --git a/api/models/submissionFile.js b/api/models/submissionFile.js
@@ -4,29 +4,22 @@
 /**
  * Represent File in the system.
  *
- * @version 1.0
- * @author peakpado
+ * @author gfzabarino
  */
 'use strict';
 
 /**
-* Defining File model
-*/
+ * Defining SubmissionFile model
+ */
 module.exports = function(sequelize, DataTypes) {
-  var File = sequelize.define('File', {
+  var SubmissionFile = sequelize.define('SubmissionFile', {
     // primary key
     id: {
       type: DataTypes.BIGINT, primaryKey: true, autoIncrement: true,
       get: function() {
         return parseInt(this.getDataValue('id'));
       }
     },
-    challengeId: {
-      type: DataTypes.BIGINT, allowNull: false,
-      get: function() {
-        return parseInt(this.getDataValue('challengeId'));
-      }
-    },
     submissionId: {
       type: DataTypes.BIGINT, allowNull: false,
       get: function() {
@@ -52,14 +45,12 @@ module.exports = function(sequelize, DataTypes) {
     updatedBy: DataTypes.STRING(128)
 
   }, {
-    tableName : 'files',
+    tableName : 'submission_files',
     associate : function(models) {
-      File.belongsTo(models.Challenge, {foreignKey : 'challengeId'});
-      File.belongsTo(models.Submission, {foreignKey : 'submissionId'});
-
+      SubmissionFile.belongsTo(models.Submission, {foreignKey : 'submissionId'});
     }
   });
 
-  return File;
+  return SubmissionFile;
 
 };
diff --git a/api/swagger/swagger.yaml b/api/swagger/swagger.yaml
@@ -1496,6 +1496,14 @@ definitions:
       updatedBy:
         type: string
         description: The handle of the user last updated the row
+      challengeId:
+        type: integer
+        format: int64
+        description: The Challenge id for the file
+      submissionId:
+        type: integer
+        format: int64
+        description: The Submission id for the file
     required:
       - fileName
       - filePath
diff --git a/config/schema-migrations/20141010160840-tables.js b/config/schema-migrations/20141010160840-tables.js
@@ -28,24 +28,6 @@ exports.up = function (db, callback) {
       ');'),
     db.runSql.bind(db, 'ALTER TABLE ONLY challenges ADD CONSTRAINT challenges_pkey PRIMARY KEY (id);'),
 
-    // files table
-    db.runSql.bind(db,
-      'CREATE TABLE files ( ' +
-        'id bigserial NOT NULL, ' +
-        'title text, ' +
-        '"filePath" text NOT NULL, ' +
-        'size bigint NOT NULL, ' +
-        '"fileName" text NOT NULL, ' +
-        '"storageLocation" "enum_files_storageLocation" NOT NULL, ' +
-        '"createdAt" timestamp with time zone NOT NULL, ' +
-        '"updatedAt" timestamp with time zone NOT NULL, ' +
-        '"createdBy" character varying(128), ' +
-        '"updatedBy" character varying(128), ' +
-        '"submissionId" bigint, ' +
-        '"challengeId" bigint NOT NULL ' +
-      ');'),
-    db.runSql.bind(db, 'ALTER TABLE ONLY files ADD CONSTRAINT files_pkey PRIMARY KEY (id);'),
-
     // participants table
     db.runSql.bind(db,
       'CREATE TABLE participants ( ' +
@@ -143,7 +125,6 @@ exports.down = function (db, callback) {
     db.dropTable.bind(db, 'scorecards'),
     db.dropTable.bind(db, 'submissions'),
     db.dropTable.bind(db, 'participants'),
-    db.dropTable.bind(db, 'files'),
     db.dropTable.bind(db, 'challenges')
   ], callback);
 };
diff --git a/config/schema-migrations/20141106235712-files-tables.js b/config/schema-migrations/20141106235712-files-tables.js
@@ -0,0 +1,62 @@
+var dbm = require('db-migrate');
+var type = dbm.dataType;
+var async = require('async');
+
+exports.up = function(db, callback) {
+
+  async.series([
+    function (callback) {
+      // challenge files table
+      db.createTable('challenge_files', {
+        columns: {
+          id: {type: 'int', primaryKey: true, autoIncrement: true},
+          challengeId: {type: 'bigint', notNull: true},
+          title: {type: 'text'},
+          filePath: {type: 'text', notNull: true},
+          size: {type: 'bigint', notNull: true},
+          fileName: {type: 'text', notNull: true},
+          createdAt: {type: 'timestamp', notNull: true},
+          updatedAt: {type: 'timestamp', notNull: true},
+          createdBy: {type: 'string'},
+          updatedBy: {type: 'string'}
+        },
+        ifNotExists: true
+      }, callback);
+    }, function (callback) {
+      // submission files table
+      db.createTable('submission_files', {
+        columns: {
+          id: {type: 'int', primaryKey: true, autoIncrement: true},
+          submissionId: {type: 'bigint', notNull: true},
+          title: {type: 'text'},
+          filePath: {type: 'text', notNull: true},
+          size: {type: 'bigint', notNull: true},
+          fileName: {type: 'text', notNull: true},
+          createdAt: {type: 'timestamp', notNull: true},
+          updatedAt: {type: 'timestamp', notNull: true},
+          createdBy: {type: 'string'},
+          updatedBy: {type: 'string'}
+        },
+        ifNotExists: true
+      }, callback);
+    }, function (callback) {
+      db.runSql('ALTER TABLE challenge_files ADD CONSTRAINT challenge_fk FOREIGN KEY ("challengeId") REFERENCES challenges (id) ON UPDATE CASCADE ON DELETE CASCADE;', callback);
+    }, function (callback) {
+      db.runSql('ALTER TABLE challenge_files ADD COLUMN "storageLocation" "enum_files_storageLocation" NOT NULL;', callback);
+    }, function (callback) {
+      db.runSql('ALTER TABLE submission_files ADD CONSTRAINT submission_fk FOREIGN KEY ("submissionId") REFERENCES submissions (id) ON UPDATE CASCADE ON DELETE CASCADE;', callback);
+    }, function (callback) {
+      db.runSql('ALTER TABLE submission_files ADD COLUMN "storageLocation" "enum_files_storageLocation" NOT NULL;', callback);
+    }
+  ], callback);
+};
+
+exports.down = function(db, callback) {
+  async.series([
+    function (callback) {
+      db.dropTable('challenge_files', callback);
+    }, function (callback) {
+      db.dropTable('submission_files', callback);
+    }
+  ], callback);
+};
diff --git a/config/schema-migrations/20141107002604-files-migrate.js b/config/schema-migrations/20141107002604-files-migrate.js
@@ -0,0 +1,36 @@
+var dbm = require('db-migrate');
+var async = require('async');
+var type = dbm.dataType;
+
+exports.up = function(db, callback) {
+  db.all('SELECT EXISTS(' +
+  'SELECT * ' +
+  'FROM information_schema.tables ' +
+  'WHERE ' +
+  'table_name = \'files\')', function (err, results) {
+    if (err) {
+      return callback(err);
+    }
+    if (results[0].exists) {
+      async.series([
+        function (callback) {
+          db.runSql('INSERT INTO challenge_files (id, "challengeId", title, "filePath", size, "fileName", "storageLocation", "createdAt", "updatedAt", "createdBy", "updatedBy") ' +
+          'SELECT id, "challengeId", title, "filePath", size, "fileName", "storageLocation", "createdAt", "updatedAt", "createdBy", "updatedBy" ' +
+          'FROM files WHERE "challengeId" IS NOT NULL', callback);
+        }, function (callback) {
+          db.runSql('INSERT INTO submission_files (id, "submissionId", title, "filePath", size, "fileName", "storageLocation", "createdAt", "updatedAt", "createdBy", "updatedBy") ' +
+          'SELECT id, "submissionId", title, "filePath", size, "fileName", "storageLocation", "createdAt", "updatedAt", "createdBy", "updatedBy" ' +
+          'FROM files WHERE "submissionId" IS NOT NULL', callback);
+        }, function (callback) {
+          db.dropTable('files', callback);
+        }
+      ], callback);
+    } else {
+      callback();
+    }
+  });
+};
+
+exports.down = function(db, callback) {
+  callback();
+};
diff --git a/lib/routeHelper.js b/lib/routeHelper.js
@@ -85,7 +85,11 @@ exports.getSigninUser = function(req) {
  */
 exports.getRefIdField = function(refModel) {
   var name = refModel.name;
-  return name.charAt(0).toLowerCase() + name.slice(1) + 'Id';
+  if (name.indexOf('File') === -1) {
+    return name.charAt(0).toLowerCase() + name.slice(1) + 'Id';
+  } else {
+    return 'fileId';
+  }
 };
 
 
diff --git a/test/controllers/challenges.js b/test/controllers/challenges.js
@@ -27,7 +27,7 @@ var db = datasource.getDataSource();
 var sequelize = db.sequelize;
 sequelize.options.logging = false;    // turn of sequelize logging.
 var Challenge = db.Challenge;
-var File = db.File;
+var ChallengeFile = db.ChallengeFile;
 var Participant = db.Participant;
 var Submission = db.Submission;
 
@@ -527,6 +527,7 @@ describe('Challenges Controller', function() {
       var fileId;
       beforeEach(function(done) {
         reqData = _.clone(sampleData.challengeFileData, true);
+        reqData.challengeId = challenge.id;
         done();
       });
 
@@ -849,7 +850,7 @@ describe('Challenges Controller', function() {
 
   after(function(done) {
     // delete data created during test.
-    async.eachSeries([Submission, Participant, File, Challenge], function(model, callback) {
+    async.eachSeries([Submission, Participant, ChallengeFile, Challenge], function(model, callback) {
       model.findAll().success(function(entities) {
         async.each(entities, function(entity, cb) {
           entity.destroy().success(function() {
diff --git a/test/controllers/files.js b/test/controllers/files.js
diff --git a/test/models/file.js b/test/models/file.js
diff --git a/test/swaggerTestHelper.js b/test/swaggerTestHelper.js
