initial commit

Author: vkarpov15

.npmrc

@@ -0,0 +1 @@
+package-lock=false

index.js

@@ -0,0 +1,75 @@
+'use strict';
+
+const migrationSchema = require('./src/schemas/migrationSchema');
+const mongoose = require('mongoose');
+
+let Migration = null;
+let migration = null;
+
+const mongooseObjToOp = new WeakMap();
+
+exports._initMigrationFramework = function _initMigrationFramework(conn) {
+  conn = conn || mongoose.connection;
+
+  if (conn.models._Migration) {
+    return;
+  }
+
+  Migration = Migration || conn.model('_Migration', migrationSchema, '_migrations');
+
+  mongoose.plugin(function(schema) {
+    schema.pre(['updateOne', 'updateMany', 'replaceOne'], async function() {
+      migration.operations.push({
+        modelName: this.model.modelName,
+        opName: this.op,
+        parameters: {
+          filter: this.getFilter(),
+          update: this.getUpdate()
+        }
+      });
+      mongooseObjToOp.set(this, migration.operations[migration.operations.length - 1]);
+
+      await migration.save();
+    });
+
+    schema.post(['updateOne', 'updateMany', 'replaceOne'], async function(res) {
+      const op = mongooseObjToOp.get(this);
+      console.log('X', op, res);
+      if (op == null) {
+        return;
+      }
+      op.endedAt = new Date();
+      op.status = 'complete';
+      op.result = res;
+
+      await migration.save();
+    });
+  });
+};
+
+exports.startMigration = async function startMigration() {
+  migration = await Migration.create({});
+
+  return migration;
+};
+
+exports.endMigration = async function endMigration(error) {
+  if (error) {
+    migration.status = 'error';
+    migration.error.message = error.message;
+    migration.error.stack = error.stack;
+  } else {
+    migration.status = 'complete';
+  }
+  migration.endedAt = new Date();
+  await migration.save();
+
+  migration = null;
+};
+
+exports.eachAsync = async function eachAsync(model, options, fn) {
+  if (typeof options === 'function') {
+    fn = options;
+    options = null;
+  }
+};

package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@mongoosejs/migrations",
+  "version": "0.0.1",
+  "scripts": {
+    "test": "mocha test/*.test.js"
+  },
+  "peerDependencies": {
+    "mongoose": "6.x"
+  },
+  "devDependencies": {
+    "mocha": "9.2.1",
+    "mongoose": "6.x"
+  }
+}

src/schemas/migrationSchema.js

@@ -0,0 +1,52 @@
+'use strict';
+
+const mongoose = require('mongoose');
+
+module.exports = new mongoose.Schema({
+  status: {
+    type: String,
+    required: true,
+    enum: ['not_started', 'in_progress', 'error', 'complete'],
+    default: 'in_progress'
+  },
+  runId: {
+    type: 'ObjectId',
+    required: true,
+    default: () => new mongoose.Types.ObjectId()
+  },
+  operations: [{
+    modelName: {
+      type: String,
+      required: true
+    },
+    opName: {
+      type: String,
+      required: true
+    },
+    userFunctionName: {
+      type: String
+    },
+    status: {
+      type: String,
+      required: true,
+      enum: ['not_started', 'in_progress', 'error', 'complete'],
+      default: 'in_progress'
+    },
+    error: {
+      message: String,
+      stack: String
+    },
+    startedAt: {
+      type: Date,
+      required: true,
+      default: () => Date.now()
+    },
+    endedAt: {
+      type: Date
+    },
+    firstSeenSortKey: 'Mixed',
+    lastSeenSortKey: 'Mixed',
+    parameters: 'Mixed',
+    result: 'Mixed'
+  }]
+}, { timestamps: true });

test/setup.test.js

@@ -0,0 +1,16 @@
+'use strict';
+
+const { before } = require('mocha');
+const migrations = require('../');
+const mongoose = require('mongoose');
+
+console.log('Init?');
+migrations._initMigrationFramework();
+
+before(async function() {
+  await mongoose.connect('mongodb://localhost:27017/test_migrations');
+});
+
+after(async function() {
+  await mongoose.disconnect();
+});

test/updates.test.js

@@ -0,0 +1,39 @@
+'use strict';
+
+const assert = require('assert');
+const { before, describe, it, afterEach, beforeEach } = require('mocha');
+const mongoose = require('mongoose');
+const migrations = require('../');
+
+describe('updates', function() {
+  let TestModel;
+  let migration;
+
+  before(function() {
+    console.log('Create new model');
+    TestModel = mongoose.model('Test', mongoose.Schema({
+      name: String,
+      email: String
+    }));
+  });
+
+  beforeEach(async function() {
+    migration = await migrations.startMigration();
+  });
+
+  afterEach(() => migrations.endMigration());
+
+  it('stores the update result if succeeded', async function() {
+    await TestModel.collection.insertOne({ name: 'John Smith' });
+    await TestModel.updateOne({ name: 'John Smith' }, { name: 'John Smythe' });
+
+    assert.equal(migration.operations.length, 1);
+    assert.deepEqual(migration.operations[0].result, {
+      acknowledged: true,
+      matchedCount: 1,
+      modifiedCount: 1,
+      upsertedCount: 0,
+      upsertedId: null
+    });
+  });
+});