feat: add new entrypoint for mongodb ReplicaSet

README.md

@@ -40,7 +40,6 @@ export default defineConfig({
       // optional configuration
       mongodbMemoryServer: {
         // these options are passed to MongoMemoryServer.create(), see https://typegoose.github.io/mongodb-memory-server/docs/guides/quick-start-guide#normal-server
-        // replSet: { count: 4 }
       },
     },
   },
@@ -90,7 +89,6 @@ export default defineConfig({
       // optional configuration
       mongodbMemoryServer: {
         // these options are passed to MongoMemoryServer.create(), see https://typegoose.github.io/mongodb-memory-server/docs/guides/quick-start-guide#normal-server
-        // replSet: { count: 4 }
       },
     },
   },
@@ -119,6 +117,28 @@ test("my test", async ({ connection }) => {
 
 - `connection` is the `Connection` instance returned by `mongoose.createConnection`. See https://mongoosejs.com/docs/api/connection.html
 
+## Using ReplSet
+
+See https://typegoose.github.io/mongodb-memory-server/docs/guides/quick-start-guide#replicaset
+
+`vitest.config.mjs`:
+
+```js
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    globalSetup: ["vitest-mms/globalSetupReplSet"],
+    setupFiles: ["vitest-mms/mongodb/setupFile"],
+    vitestMms: {
+      mongodbMemoryServer: {
+        replSet: { count: 4 },
+      },
+    },
+  },
+});
+```
+
 ## Alternative using a extended test context
 
 If you want to avoid the overhead of vitest-mms on every test and instead just want to use it for a subset of your tests, you can use `vitest-mms/*/test` instead:

package.json

@@ -9,6 +9,11 @@
       "require": "./dist/globalSetup.cjs",
       "import": "./dist/globalSetup.mjs"
     },
+    "./globalSetupReplSet": {
+      "types": "./dist/globalSetupReplSet.d.ts",
+      "require": "./dist/globalSetupReplSet.cjs",
+      "import": "./dist/globalSetupReplSet.mjs"
+    },
     "./mongodb/setupFile": {
       "types": "./dist/mongodb/setupFile.d.ts",
       "require": "./dist/mongodb/setupFile.cjs",

src/globalSetupReplSet.ts

@@ -0,0 +1,36 @@
+import type { GlobalSetupContext } from "vitest/node";
+
+import { MongoMemoryReplSet } from "mongodb-memory-server";
+
+export type { ProvidedContext } from "vitest";
+export type { ResolvedConfig } from "vitest/node";
+
+declare module "vitest" {
+  export interface ProvidedContext {
+    MONGO_URI: string;
+  }
+}
+
+type MongoMemoryServerOpts = Parameters<typeof MongoMemoryReplSet.create>[0];
+
+declare module "vitest/node" {
+  export interface ResolvedConfig {
+    vitestMms?: {
+      mongodbMemoryServerOptions: MongoMemoryServerOpts;
+    };
+  }
+}
+
+export default async function setup({ provide, config }: GlobalSetupContext) {
+  const mongod = await MongoMemoryReplSet.create(
+    config.vitestMms?.mongodbMemoryServerOptions,
+  );
+
+  const uri = mongod.getUri();
+
+  provide("MONGO_URI", uri);
+
+  return async () => {
+    await mongod.stop();
+  };
+}