reactioncommerce · sujithvn · May 18, 2023 · Nov 4, 2022 · Oct 4, 2022 · Oct 6, 2022
diff --git a/packages/api-plugin-fulfillment/index.js b/packages/api-plugin-fulfillment/index.js
@@ -1,3 +1,5 @@
 import register from "./src/index.js";
 
+export { default as migrations } from "./migrations/index.js";
+
 export default register;
diff --git a/packages/api-plugin-fulfillment/migrations/2.js b/packages/api-plugin-fulfillment/migrations/2.js
@@ -0,0 +1,177 @@
+const COLL_FF_SOURCE = "Shipping";
+const COLL_FF_DEST = "Fulfillment";
+const COLL_FFR_SOURCE = "FlatRateFulfillmentRestrictions";
+const COLL_FFR_DEST = "FulfillmentRestrictions";
+const FF_TYPE = "shipping";
+const FF_METHOD = "flatRate";
+const COLL_DEST = "Fulfillment";
+
+const newGlobalPermissions = [
+  "reaction:legacy:fulfillmentTypes/update:settings",
+  "reaction:legacy:fulfillmentRestrictions/create",
+  "reaction:legacy:fulfillmentRestrictions/delete",
+  "reaction:legacy:fulfillmentRestrictions/read",
+  "reaction:legacy:fulfillmentRestrictions/update",
+  "reaction:legacy:fulfillmentTypes/create",
+  "reaction:legacy:fulfillmentTypes/delete",
+  "reaction:legacy:fulfillmentTypes/read",
+  "reaction:legacy:fulfillmentTypes/update",
+  "reaction:legacy:fulfillmentMethods/create",
+  "reaction:legacy:fulfillmentMethods/delete",
+  "reaction:legacy:fulfillmentMethods/read",
+  "reaction:legacy:fulfillmentMethods/update"
+];
+
+/**
+ * @summary migrates the database down one version
+ * @param {Object} context Migration context
+ * @param {Object} context.db MongoDB `Db` instance
+ * @param {Function} context.progress A function to report progress, takes percent
+ *   number as argument.
+ * @return {undefined}
+ */
+async function down({ db, progress }) {
+  progress(0);
+
+  const allGroups = await db.collection("Groups").find({}).toArray();
+  const affectedGlobalGroups = [];
+  allGroups.forEach((group) => {
+    const perms = group.permissions;
+    if (perms && Array.isArray(perms) && perms.length) {
+      const found = newGlobalPermissions.some((elem) => perms.includes(elem));
+      if (found) affectedGlobalGroups.push(group.slug);
+    }
+  });
+
+  await db.collection("Groups").updateMany({
+    slug: { $in: affectedGlobalGroups }
+  }, {
+    $pullAll: { permissions: newGlobalPermissions }
+  });
+  progress(10);
+
+  await db.collection(COLL_FF_DEST).drop();
+  progress(50);
+
+  await db.collection(COLL_FFR_DEST).drop();
+  progress(100);
+}
+
+/**
+ * @summary Performs migration up from previous data version
+ * @param {Object} context Migration context
+ * @param {Object} context.db MongoDB `Db` instance
+ * @param {Function} context.progress A function to report progress, takes percent
+ *   number as argument.
+ * @return {undefined}
+ */
+async function up({ db, progress }) {
+  progress(0);
+
+  const shippingCopyResp = await db.collection(COLL_FF_SOURCE).aggregate([{ $match: {} }, { $out: COLL_FF_DEST }]).next();
+  if (shippingCopyResp) throw new Error("Error in copying Shipping collection"); // above command returns null if successful
+  progress(20);
+
+  const flatRateRestCopyResp = await db.collection(COLL_FFR_SOURCE).aggregate([{ $match: {} }, { $out: COLL_FFR_DEST }]).next();
+  if (flatRateRestCopyResp) throw new Error("Error in copying FlatRateFulfillmentRestrictions collection"); // above command returns null if successful
+  progress(40);
+
+  const operations = [];
+
+  const ffTypeUpdate = {
+    updateMany: {
+      filter: { fulfillmentType: { $exists: false } },
+      update: {
+        $set: {
+          fulfillmentType: FF_TYPE
+        }
+      }
+    }
+  };
+
+  const ffMethodUpdate = {
+    updateMany: {
+      filter: { methods: { $exists: true } },
+      update: {
+        $set: {
+          "methods.$[eachMethod].fulfillmentMethod": FF_METHOD
+        }
+      },
+      arrayFilters: [
+        {
+          "eachMethod.fulfillmentMethod": { $exists: false }
+        }
+      ]
+    }
+  };
+
+  operations.push(ffTypeUpdate);
+  operations.push(ffMethodUpdate);
+
+  const bulkWriteResp = await db.collection(COLL_DEST).bulkWrite(operations);
+  if (bulkWriteResp.writeErrors && bulkWriteResp.writeErrors.length) throw new Error("Error while updating Fulfillment collection");
+  progress(50);
+
+  const oldPerms = [
+    "reaction:legacy:shippingMethods/create",
+    "reaction:legacy:shippingMethods/delete",
+    "reaction:legacy:shippingMethods/read",
+    "reaction:legacy:shippingMethods/update",
+    "reaction:legacy:shippingRestrictions/create",
+    "reaction:legacy:shippingRestrictions/delete",
+    "reaction:legacy:shippingRestrictions/read",
+    "reaction:legacy:shippingRestrictions/update"
+  ];
+
+  const mapperSetFFMethodsRestricts = {
+    "reaction:legacy:shippingMethods/create": "reaction:legacy:fulfillmentMethods/create",
+    "reaction:legacy:shippingMethods/delete": "reaction:legacy:fulfillmentMethods/delete",
+    "reaction:legacy:shippingMethods/read": "reaction:legacy:fulfillmentMethods/read",
+    "reaction:legacy:shippingMethods/update": "reaction:legacy:fulfillmentMethods/update",
+    "reaction:legacy:shippingRestrictions/create": "reaction:legacy:fulfillmentRestrictions/create",
+    "reaction:legacy:shippingRestrictions/delete": "reaction:legacy:fulfillmentRestrictions/delete",
+    "reaction:legacy:shippingRestrictions/read": "reaction:legacy:fulfillmentRestrictions/read",
+    "reaction:legacy:shippingRestrictions/update": "reaction:legacy:fulfillmentRestrictions/update"
+  };
+  const mapperSetFFTypes = {
+    "reaction:legacy:shippingMethods/create": "reaction:legacy:fulfillmentTypes/create",
+    "reaction:legacy:shippingMethods/delete": "reaction:legacy:fulfillmentTypes/delete",
+    "reaction:legacy:shippingMethods/read": "reaction:legacy:fulfillmentTypes/read",
+    "reaction:legacy:shippingMethods/update": "reaction:legacy:fulfillmentTypes/update"
+  };
+  const allGroups = await db.collection("Groups").find({}).toArray();
+
+  for (let index = 0; index < allGroups.length; index += 1) {
+    const currentGroup = allGroups[index];
+    const currentPerms = currentGroup.permissions;
+    const permsToAdd = [];
+
+    if (currentPerms && Array.isArray(currentPerms) && currentPerms.length) {
+      oldPerms.forEach((oldPerm) => {
+        if (currentPerms.includes(oldPerm)) {
+          permsToAdd.push(mapperSetFFMethodsRestricts[oldPerm]);
+          if (mapperSetFFTypes[oldPerm]) {
+            permsToAdd.push(mapperSetFFTypes[oldPerm]);
+          }
+        }
+      });
+    }
+    if (permsToAdd.length) {
+      permsToAdd.push("reaction:legacy:fulfillmentTypes/update:settings"); // add this setting to groups deailing with ff-types
+      // eslint-disable-next-line no-await-in-loop
+      await db.collection("Groups").updateOne(
+        { _id: currentGroup._id },
+        {
+          $addToSet: { permissions: { $each: permsToAdd } }
+        }
+      );
+    }
+  }
+
+  progress(100);
+}
+
+export default {
+  down,
+  up
+};
diff --git a/packages/api-plugin-fulfillment/migrations/index.js b/packages/api-plugin-fulfillment/migrations/index.js
@@ -0,0 +1,13 @@
+import { migrationsNamespace } from "./migrationsNamespace.js";
+import migration2 from "./2.js";
+
+export default {
+  tracks: [
+    {
+      namespace: migrationsNamespace,
+      migrations: {
+        2: migration2
+      }
+    }
+  ]
+};
diff --git a/packages/api-plugin-fulfillment/migrations/migrationsNamespace.js b/packages/api-plugin-fulfillment/migrations/migrationsNamespace.js
@@ -0,0 +1 @@
+export const migrationsNamespace = "fulfillment";
diff --git a/packages/api-plugin-fulfillment/package.json b/packages/api-plugin-fulfillment/package.json
@@ -32,6 +32,7 @@
     "@reactioncommerce/api-utils": "^1.16.9",
     "@reactioncommerce/reaction-error": "^1.0.1",
     "@reactioncommerce/random": "^1.0.2",
+    "@reactioncommerce/db-version-check": "^1.0.0",
     "lodash": "^4.17.21",
     "simpl-schema": "^1.12.2"
   },

diff --git a/packages/api-plugin-fulfillment/src/preStartup.js b/packages/api-plugin-fulfillment/src/preStartup.js
@@ -1,11 +1,45 @@
+import doesDatabaseVersionMatch from "@reactioncommerce/db-version-check";
+import { migrationsNamespace } from "../migrations/migrationsNamespace.js";
 import { extendFulfillmentSchemas } from "./simpleSchemas.js";
 
+const expectedVersion = 4;
+
+/**
+ * @summary Checks if the version of the database matches requirement
+ * @param {Object} context Startup context
+ * @returns {undefined}
+ */
+async function dbVersionCheck(context) {
+  const setToExpectedIfMissing = async () => {
+    const anyFulfillment = await context.collections.Fulfillment.findOne();
+    const anyRestriction = await context.collections.FulfillmentRestrictions.findOne();
+
+    return !anyFulfillment || !anyRestriction;
+  };
+
+  const ok = await doesDatabaseVersionMatch({
+    // `db` is a Db instance from the `mongodb` NPM package,
+    // such as what is returned when you do `client.db()`
+    db: context.app.db,
+    // These must match one of the namespaces and versions
+    // your package exports in the `migrations` named export
+    expectedVersion,
+    namespace: migrationsNamespace,
+    setToExpectedIfMissing
+  });
+
+  if (!ok) {
+    throw new Error(`Database needs migrating. The "${migrationsNamespace}" namespace must be at version ${expectedVersion}.`);
+  }
+}
+
 /**
  * @summary Called before startup to extend schemas
  * @param {Object} context Startup context
  * @returns {undefined}
  */
 export default async function fulfillmentPreStartup(context) {
+  await dbVersionCheck(context);
   const allFulfillmentTypesArray = context.fulfillment?.registeredFulfillmentTypes;
   extendFulfillmentSchemas(context.simpleSchemas, allFulfillmentTypesArray);
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		export const migrationsNamespace = "fulfillment";