mirror of
				https://github.com/HabitRPG/habitica.git
				synced 2025-10-30 04:32:45 +01:00 
			
		
		
		
	
		
			
				
	
	
		
			269 lines
		
	
	
		
			9.0 KiB
		
	
	
	
		
			JavaScript
		
	
	
	
	
	
			
		
		
	
	
			269 lines
		
	
	
		
			9.0 KiB
		
	
	
	
		
			JavaScript
		
	
	
	
	
	
| // Migrate users collection to new schema
 | |
| // This should run AFTER challenges migration
 | |
| 
 | |
| // The console-stamp module must be installed (not included in package.json)
 | |
| 
 | |
| // It requires two environment variables: MONGODB_OLD and MONGODB_NEW
 | |
| 
 | |
| // Due to some big user profiles it needs more RAM than is allowed by default by v8 (arounf 1.7GB).
 | |
| // Run the script with --max-old-space-size=4096 to allow up to 4GB of RAM
 | |
| console.log('Starting migrations/api_v3/users.js.');
 | |
| 
 | |
| // IMPORTANT NOTE: this migration was written when we were using version 3 of lodash.
 | |
| // We've now upgraded to lodash v4 but the code used in this migration has not been
 | |
| // adapted to work with it. Before this migration is used again any lodash method should
 | |
| // be checked for compatibility against the v4 changelog and changed if necessary.
 | |
| // https://github.com/lodash/lodash/wiki/Changelog#v400
 | |
| 
 | |
| require('babel-register');
 | |
| require('babel-polyfill');
 | |
| 
 | |
| let Bluebird = require('bluebird');
 | |
| let MongoDB = require('mongodb');
 | |
| let nconf = require('nconf');
 | |
| let mongoose = require('mongoose');
 | |
| let _ = require('lodash');
 | |
| let uuid = require('uuid');
 | |
| let consoleStamp = require('console-stamp');
 | |
| let common = require('../../common');
 | |
| let moment = require('moment');
 | |
| 
 | |
| // Add timestamps to console messages
 | |
| consoleStamp(console);
 | |
| 
 | |
| // Initialize configuration
 | |
| require('../../website/server/libs/api-v3/setupNconf').default();
 | |
| 
 | |
| let MONGODB_OLD = nconf.get('MONGODB_OLD');
 | |
| let MONGODB_NEW = nconf.get('MONGODB_NEW');
 | |
| 
 | |
| let taskDefaults = common.taskDefaults;
 | |
| let MongoClient = MongoDB.MongoClient;
 | |
| 
 | |
| mongoose.Promise = Bluebird; // otherwise mongoose models won't work
 | |
| 
 | |
| // Load new models
 | |
| let NewUser = require('../../website/server/models/user').model;
 | |
| let NewTasks = require('../../website/server/models/task');
 | |
| 
 | |
| // To be defined later when MongoClient connects
 | |
| let mongoDbOldInstance;
 | |
| let oldUserCollection;
 | |
| 
 | |
| let mongoDbNewInstance;
 | |
| let newUserCollection;
 | |
| let newTaskCollection;
 | |
| 
 | |
| let BATCH_SIZE = 1000;
 | |
| 
 | |
| let processedUsers = 0;
 | |
| let totoalProcessedTasks = 0;
 | |
| 
 | |
| let challengeTaskWithMatchingId = 0;
 | |
| let challengeTaskNoMatchingId = 0;
 | |
| 
 | |
| // Load the new tasks ids for challenges tasks
 | |
| let newTasksIds = require('./newTasksIds.json');
 | |
| 
 | |
| // Only process users that fall in a interval ie up to -> 0000-4000-0000-0000
 | |
| let AFTER_USER_ID = nconf.get('AFTER_USER_ID');
 | |
| let BEFORE_USER_ID = nconf.get('BEFORE_USER_ID');
 | |
| 
 | |
| function processUsers (afterId) {
 | |
|   let processedTasks = 0;
 | |
|   let lastUser = null;
 | |
|   let oldUsers;
 | |
| 
 | |
|   let now = new Date();
 | |
| 
 | |
|   let query = {};
 | |
| 
 | |
|   if (BEFORE_USER_ID) {
 | |
|     query._id = {$lte: BEFORE_USER_ID};
 | |
|   }
 | |
| 
 | |
|   if ((afterId || AFTER_USER_ID) && !query._id) {
 | |
|     query._id = {};
 | |
|   }
 | |
| 
 | |
|   if (afterId) {
 | |
|     query._id.$gt = afterId;
 | |
|   } else if (AFTER_USER_ID) {
 | |
|     query._id.$gt = AFTER_USER_ID;
 | |
|   }
 | |
| 
 | |
|   let batchInsertTasks = newTaskCollection.initializeUnorderedBulkOp();
 | |
|   let batchInsertUsers = newUserCollection.initializeUnorderedBulkOp();
 | |
| 
 | |
|   console.log(`Executing users query.\nMatching users after ${afterId ? afterId : AFTER_USER_ID} and before ${BEFORE_USER_ID} (included).`);
 | |
| 
 | |
|   return oldUserCollection
 | |
|     .find(query)
 | |
|     .sort({_id: 1})
 | |
|     .limit(BATCH_SIZE)
 | |
|     .toArray()
 | |
|     .then(function (oldUsersR) {
 | |
|       oldUsers = oldUsersR;
 | |
| 
 | |
|       console.log(`Processing ${oldUsers.length} users. Already processed ${processedUsers} users and ${totoalProcessedTasks} tasks.`);
 | |
| 
 | |
|       if (oldUsers.length === BATCH_SIZE) {
 | |
|         lastUser = oldUsers[oldUsers.length - 1]._id;
 | |
|       }
 | |
| 
 | |
|       oldUsers.forEach(function (oldUser) {
 | |
|         let oldTasks = oldUser.habits.concat(oldUser.dailys).concat(oldUser.rewards).concat(oldUser.todos);
 | |
|         delete oldUser.habits;
 | |
|         delete oldUser.dailys;
 | |
|         delete oldUser.rewards;
 | |
|         delete oldUser.todos;
 | |
| 
 | |
|         delete oldUser.id;
 | |
| 
 | |
|         // spookDust -> spookySparkles
 | |
| 
 | |
|         if (oldUser.achievements && oldUser.achievements.spookDust) {
 | |
|           oldUser.achievements.spookySparkles = oldUser.achievements.spookDust;
 | |
|           delete oldUser.achievements.spookDust;
 | |
|         }
 | |
| 
 | |
|         if (oldUser.items && oldUser.items.special && oldUser.items.special.spookDust) {
 | |
|           oldUser.items.special.spookySparkles = oldUser.items.special.spookDust;
 | |
|           delete oldUser.items.special.spookDust;
 | |
|         }
 | |
| 
 | |
|         if (oldUser.stats && oldUser.stats.buffs && oldUser.stats.buffs.spookySparkles) {
 | |
|           oldUser.stats.buffs.spookySparkles = oldUser.stats.buffs.spookDust;
 | |
|           delete oldUser.stats.buffs.spookDust;
 | |
|         }
 | |
| 
 | |
|         // end spookDust -> spookySparkles
 | |
| 
 | |
|         oldUser.tags = oldUser.tags.map(function (tag) {
 | |
|           return {
 | |
|             id: tag.id,
 | |
|             name: tag.name || 'tag name',
 | |
|             challenge: tag.challenge,
 | |
|           };
 | |
|         });
 | |
| 
 | |
|         if (oldUser._id === '9') { // Tyler Renelle
 | |
|           oldUser._id = '00000000-0000-4000-9000-000000000000';
 | |
|         }
 | |
| 
 | |
|         let newUser = new NewUser(oldUser);
 | |
|         let isSubscribed = newUser.isSubscribed();
 | |
| 
 | |
|         oldTasks.forEach(function (oldTask) {
 | |
|           oldTask._id = uuid.v4(); // create a new unique uuid
 | |
|           oldTask.userId = newUser._id;
 | |
|           oldTask._legacyId = oldTask.id; // store the old task id
 | |
|           delete oldTask.id;
 | |
| 
 | |
|           oldTask.challenge = oldTask.challenge || {};
 | |
|           if (oldTask.challenge.id) {
 | |
|             if (oldTask.challenge.broken) {
 | |
|               oldTask.challenge.taskId = oldTask._legacyId;
 | |
|             } else {
 | |
|               let newId = newTasksIds[`${oldTask._legacyId  }-${  oldTask.challenge.id}`];
 | |
| 
 | |
|               // Challenges' tasks ids changed
 | |
|               if (!newId && !oldTask.challenge.broken) {
 | |
|                 challengeTaskNoMatchingId++;
 | |
|                 oldTask.challenge.taskId = oldTask._legacyId;
 | |
|                 oldTask.challenge.broken = 'CHALLENGE_TASK_NOT_FOUND';
 | |
|               } else {
 | |
|                 challengeTaskWithMatchingId++;
 | |
|                 oldTask.challenge.taskId = newId;
 | |
|               }
 | |
|             }
 | |
|           }
 | |
| 
 | |
|           // Delete old completed todos
 | |
|           if (oldTask.type === 'todo' && oldTask.completed && (!oldTask.challenge.id || oldTask.challenge.broken)) {
 | |
|             if (moment(now).subtract(isSubscribed ? 90 : 30, 'days').toDate() > moment(oldTask.dateCompleted).toDate()) {
 | |
|               return;
 | |
|             }
 | |
|           }
 | |
| 
 | |
|           oldTask.createdAt = oldTask.dateCreated;
 | |
| 
 | |
|           if (!oldTask.text) oldTask.text = 'task text'; // required
 | |
|           oldTask.tags = _.map(oldTask.tags, function (tagPresent, tagId) {
 | |
|             return tagPresent && tagId;
 | |
|           }).filter(function (tag) {
 | |
|             return tag !== false;
 | |
|           });
 | |
| 
 | |
|           if (oldTask.type !== 'todo' || oldTask.type === 'todo' && !oldTask.completed) {
 | |
|             newUser.tasksOrder[`${oldTask.type}s`].push(oldTask._id);
 | |
|           }
 | |
| 
 | |
|           let allTasksFields = ['_id', 'type', 'text', 'notes', 'tags', 'value', 'priority', 'attribute', 'challenge', 'reminders', 'userId', '_legacyId', 'createdAt'];
 | |
|           // using mongoose models is too slow
 | |
|           if (oldTask.type === 'habit') {
 | |
|             oldTask = _.pick(oldTask, allTasksFields.concat(['history', 'up', 'down']));
 | |
|           } else if (oldTask.type === 'daily') {
 | |
|             oldTask = _.pick(oldTask, allTasksFields.concat(['completed', 'collapseChecklist', 'checklist', 'history', 'frequency', 'everyX', 'startDate', 'repeat', 'streak']));
 | |
|           } else if (oldTask.type === 'todo') {
 | |
|             oldTask = _.pick(oldTask, allTasksFields.concat(['completed', 'collapseChecklist', 'checklist', 'date', 'dateCompleted']));
 | |
|           } else if (oldTask.type === 'reward') {
 | |
|             oldTask = _.pick(oldTask, allTasksFields);
 | |
|           } else {
 | |
|             throw new Error('Task with no or invalid type!');
 | |
|           }
 | |
| 
 | |
|           batchInsertTasks.insert(taskDefaults(oldTask));
 | |
|           processedTasks++;
 | |
|         });
 | |
| 
 | |
|         batchInsertUsers.insert(newUser.toObject());
 | |
|       });
 | |
| 
 | |
|       console.log(`Saving ${oldUsers.length} users and ${processedTasks} tasks.`);
 | |
| 
 | |
|       return Bluebird.all([
 | |
|         batchInsertUsers.execute(),
 | |
|         batchInsertTasks.execute(),
 | |
|       ]);
 | |
|     })
 | |
|     .then(function () {
 | |
|       totoalProcessedTasks += processedTasks;
 | |
|       processedUsers += oldUsers.length;
 | |
| 
 | |
|       console.log(`Saved ${oldUsers.length} users and their tasks.`);
 | |
|       console.log('Challenges\' tasks no matching id: ', challengeTaskNoMatchingId);
 | |
|       console.log('Challenges\' tasks with matching id: ', challengeTaskWithMatchingId);
 | |
| 
 | |
|       if (lastUser) {
 | |
|         return processUsers(lastUser);
 | |
|       } else {
 | |
|         return console.log('Done!');
 | |
|       }
 | |
|     });
 | |
| }
 | |
| 
 | |
| // Connect to the databases
 | |
| Bluebird.all([
 | |
|   MongoClient.connect(MONGODB_OLD),
 | |
|   MongoClient.connect(MONGODB_NEW),
 | |
| ])
 | |
|   .then(function (result) {
 | |
|     let oldInstance = result[0];
 | |
|     let newInstance = result[1];
 | |
| 
 | |
|     mongoDbOldInstance = oldInstance;
 | |
|     oldUserCollection = mongoDbOldInstance.collection('users');
 | |
| 
 | |
|     mongoDbNewInstance = newInstance;
 | |
|     newUserCollection = mongoDbNewInstance.collection('users');
 | |
|     newTaskCollection = mongoDbNewInstance.collection('tasks');
 | |
| 
 | |
|     console.log(`Connected with MongoClient to ${MONGODB_OLD} and ${MONGODB_NEW}.`);
 | |
| 
 | |
|     return processUsers();
 | |
|   })
 | |
|   .catch(function (err) {
 | |
|     console.error(err.stack || err);
 | |
|   });
 |