✨ Feat: Add warning message to seed command (#534)

* 🧹 Chore: Add Node version to package.json

* ✨ Feat: Add seed CLI command

* ✨ Feat: Add warning message to seed command

Author: claudiahdz

package.json

@@ -6,6 +6,9 @@
   "private": true,
   "browserslist": "last 2 Chrome versions",
   "main": "",
+  "engines": {
+    "node": ">=18.18.0"
+  },
   "lint-staged": {
     "**/*": "prettier --write --ignore-unknown"
   },

packages/core/src/util/test/ccal.event.factory.ts

@@ -1,7 +1,7 @@
 import dayjs from "dayjs";
 import timezone from "dayjs/plugin/timezone";
 import { ObjectId } from "mongodb";
-import { faker } from "@faker-js/faker/.";
+import { faker } from "@faker-js/faker";
 import { Origin, Priorities } from "@core/constants/core.constants";
 import {
   Schema_Event,

packages/scripts/src/cli.ts

@@ -6,6 +6,7 @@ import { CliValidator } from "./cli.validator";
 import { runBuild } from "./commands/build";
 import { startDeleteFlow } from "./commands/delete";
 import { inviteWaitlist } from "./commands/invite";
+import { runSeed } from "./commands/seed";
 import { ALL_PACKAGES, CATEGORY_VM } from "./common/cli.constants";
 
 class CompassCli {
@@ -38,6 +39,11 @@ class CompassCli {
         await inviteWaitlist();
         break;
       }
+      case cmd === "seed": {
+        this.validator.validateSeed(options);
+        await runSeed(user as string, force);
+        break;
+      }
       default:
         this.validator.exitHelpfully(
           "root",
@@ -76,6 +82,14 @@ class CompassCli {
       );
 
     program.command("invite").description("invite users from the waitlist");
+
+    program
+      .command("seed")
+      .description("seed the database with events")
+      .option(
+        "-u, --user [id | email]",
+        "specify which user to seed events for",
+      );
     return program;
   }
 }

packages/scripts/src/cli.validator.ts

@@ -17,7 +17,10 @@ export class CliValidator {
     this.program = program;
   }
 
-  public exitHelpfully(cmd: "root" | "build" | "delete", msg?: string) {
+  public exitHelpfully(
+    cmd: "root" | "build" | "delete" | "seed",
+    msg?: string,
+  ) {
     msg && log.error(msg);
 
     if (cmd === "root") {
@@ -62,6 +65,13 @@ export class CliValidator {
     }
   }
 
+  public validateSeed(options: Options_Cli) {
+    const { user } = options;
+    if (!user || typeof user !== "string") {
+      this.exitHelpfully("seed", "You must supply a user");
+    }
+  }
+
   private _getBuildOptions() {
     const buildOpts: Options_Cli_Build = {};
 
@@ -107,6 +117,20 @@ export class CliValidator {
     return deleteOpts;
   }
 
+  private _getSeedOptions() {
+    const seedOpts: Options_Cli_Delete = {};
+
+    const seedCmd = this.program.commands.find((cmd) => cmd.name() === "seed");
+    if (seedCmd) {
+      const user = seedCmd?.opts()["user"] as Options_Cli["user"];
+      if (user) {
+        seedOpts.user = user;
+      }
+    }
+
+    return seedOpts;
+  }
+
   private _mergeOptions = (): Options_Cli => {
     const _options = this.program.opts();
     let options: Options_Cli = {
@@ -130,6 +154,14 @@ export class CliValidator {
       };
     }
 
+    const seedOptions = this._getSeedOptions();
+    if (Object.keys(seedOptions).length > 0) {
+      options = {
+        ...options,
+        ...seedOptions,
+      };
+    }
+
     return options;
   };
 

packages/scripts/src/commands/seed.ts

@@ -0,0 +1,80 @@
+import pkg from "inquirer";
+import { log } from "@scripts/common/cli.utils";
+import mongoService from "@backend/common/services/mongo.service";
+import { findCompassUserBy } from "@backend/user/queries/user.queries";
+
+const { prompt } = pkg;
+
+async function seedEvents(userInput: string) {
+  try {
+    // Connect to MongoDB
+    await mongoService.waitUntilConnected();
+
+    // Determine if input is email or ID and get the user ID
+    const isEmail = userInput.includes("@");
+    const user = await findCompassUserBy(isEmail ? "email" : "_id", userInput);
+
+    if (!user) {
+      log.error(
+        `User not found with ${isEmail ? "email" : "ID"}: ${userInput}`,
+      );
+      process.exit(1);
+    }
+
+    const userId = user._id.toString();
+    log.info(`Running seed command for user: ${userId}...`);
+
+    // TODO: Add logic to create events
+
+    log.success(`Successfully created events for user: ${userInput}`);
+  } catch (error) {
+    log.error("Failed to seed events:");
+    console.error(error);
+  }
+
+  process.exit(0);
+}
+
+export async function runSeed(userInput: string, force = false) {
+  log.info("Connecting to db...");
+  await mongoService.waitUntilConnected();
+
+  if (force === true) {
+    await seedEvents(userInput);
+    return;
+  }
+
+  const warning = [
+    "⚠️  WARNING ⚠️",
+    "",
+    "This command will:",
+    "• Create multiple events in your Compass calendar database",
+    "• Create multiple events in your primary Google calendar",
+    "",
+    "🔔 RECOMMENDATION:",
+    "It's strongly recommended to use this command with a test account",
+    "rather than your personal account to avoid cluttering your calendar.",
+  ].join("\n");
+
+  log.warning(warning);
+
+  const questions = [
+    {
+      type: "confirm",
+      name: "proceed",
+      message: `Do you want to proceed with seeding events for: >> ${userInput} <<`,
+    },
+  ];
+
+  prompt(questions)
+    .then((answer: { proceed: boolean }) => {
+      if (answer.proceed) {
+        log.info("Starting event seeding process...");
+        seedEvents(userInput).catch((e) => console.log(e));
+      } else {
+        log.info("Operation cancelled. No events were created.");
+        process.exit(0);
+      }
+    })
+    .catch((err) => console.log(err));
+}