@jongodb/memory-server 0.1.1

package/LICENSE

@@ -0,0 +1,179 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+

package/README.md

@@ -0,0 +1,270 @@
+# @jongodb/memory-server
+
+Node test runtime adapter for `jongodb`.
+
+It starts a local `jongodb` launcher process, exposes a MongoDB URI, and manages process lifecycle for test runners.
+
+## Scope
+
+- integration-test runtime only
+- launcher lifecycle management (start/stop/detach)
+- framework-agnostic base helper
+- Jest/Vitest/Nest Jest convenience helpers
+
+This package is not a production MongoDB server.
+
+## Why This vs Embedded MongoDB (`mongodb-memory-server`)
+
+`@jongodb/memory-server` can run in native binary mode instead of booting a full `mongod` test binary.
+
+Practical effects:
+
+- no `mongod` binary download/extract step in cold environments
+- lower launcher startup overhead in many integration-test loops
+- fewer environment issues tied to `mongod` binary provisioning
+
+Rough performance expectation (not a guarantee):
+
+- cold CI/dev machine: often much faster because there is no `mongod` artifact fetch/unpack
+- warm cache environment: startup-phase wins are usually smaller
+
+Observed benchmarks (NestJS integration suite subset, same machine):
+
+- Benchmark A: suite-scoped lifecycle (historical)
+  - workload: `9 suites / 102 tests` (`--runInBand`)
+  - server boots: `9` times per run (once per suite)
+  - `mongodb-memory-server` real:
+    - run1: `28.17s`
+    - run2: `27.19s`
+    - average: `27.68s`
+  - `jongodb` native real:
+    - run1: `12.35s`
+    - run2: `12.04s`
+    - average: `12.20s`
+  - delta: about `55.9%` faster (`15.48s` less wall clock)
+- Benchmark B: single-boot lifecycle (current)
+  - workload: `45 suites / 510 tests` (`--runInBand`)
+  - server boots: `1` time per run (shared for full Jest process)
+  - `mongodb-memory-server` real:
+    - run1: `92.40s`
+    - run2: `91.84s`
+    - average: `92.12s`
+  - `jongodb` native real:
+    - run1: `33.03s`
+    - run2: `32.90s`
+    - average: `32.97s`
+  - delta: about `64.2%` faster (`59.15s` less wall clock)
+
+Your actual delta depends on test shape, I/O, and query workload.
+
+## Requirements
+
+- Node.js 20+
+- one launcher runtime:
+  - native binary, or
+  - Java 17+ with `jongodb` classpath
+
+## Install
+
+```bash
+npm i -D @jongodb/memory-server
+```
+
+## Quick Start (Recommended)
+
+Use `createJongodbEnvRuntime` and keep one runtime per test process.
+
+```ts
+import { beforeAll, afterAll } from "@jest/globals";
+import { createJongodbEnvRuntime } from "@jongodb/memory-server/runtime";
+
+const runtime = createJongodbEnvRuntime({
+  databaseName: "test"
+});
+
+beforeAll(async () => {
+  await runtime.setup();
+});
+
+afterAll(async () => {
+  await runtime.teardown();
+});
+```
+
+Behavior:
+
+- `setup()` starts launcher and writes `process.env.MONGODB_URI` (default)
+- `teardown()` stops launcher and restores previous env value
+
+## Launcher Modes
+
+`launchMode` values:
+
+- `auto` (default): binary first, Java fallback
+- `binary`: binary only, fail fast if binary not resolvable
+- `java`: Java only, fail fast if classpath not configured
+
+In `auto` mode, launch failures are attempted in order and reported with source tags.
+
+## Binary Runtime
+
+Binary resolution order:
+
+1. `options.binaryPath`
+2. `JONGODB_BINARY_PATH`
+3. bundled platform package (if installed)
+
+Current bundled package targets:
+
+- `@jongodb/memory-server-bin-darwin-arm64`
+- `@jongodb/memory-server-bin-linux-x64-gnu`
+- `@jongodb/memory-server-bin-win32-x64`
+
+Version policy:
+
+- binary package versions are pinned to the core package version (`optionalDependencies`)
+- if a bundled binary is not installed/available for your version, `auto` mode can still run with Java fallback
+
+Binary-only example:
+
+```ts
+import { startJongodbMemoryServer } from "@jongodb/memory-server";
+
+const server = await startJongodbMemoryServer({
+  launchMode: "binary",
+  binaryPath: process.env.JONGODB_BINARY_PATH
+});
+```
+
+## Java Runtime
+
+Provide classpath by:
+
+1. `startJongodbMemoryServer({ classpath: "..." })`, or
+2. `JONGODB_CLASSPATH`
+
+Repository helper command (when using this repo launcher build):
+
+```bash
+./.tooling/gradle-8.10.2/bin/gradle -q printLauncherClasspath
+```
+
+## Standalone Launcher Contract
+
+Binary and Java launchers follow one contract:
+
+- readiness line on stdout: `JONGODB_URI=mongodb://...`
+- optional failure line on stderr: `JONGODB_START_FAILURE=...`
+- process remains alive until terminated by signal (`SIGTERM`/`SIGINT`)
+
+The adapter relies on this contract for deterministic startup/teardown handling.
+
+## Runner Helpers
+
+### Jest (per-file hooks)
+
+```ts
+import { beforeAll, afterAll } from "@jest/globals";
+import { registerJongodbForJest } from "@jongodb/memory-server/jest";
+
+registerJongodbForJest({ beforeAll, afterAll });
+```
+
+### Jest (global setup/teardown)
+
+`jest.global-setup.ts`:
+
+```ts
+import { createJestGlobalSetup } from "@jongodb/memory-server/jest";
+
+export default createJestGlobalSetup();
+```
+
+`jest.global-teardown.ts`:
+
+```ts
+import { createJestGlobalTeardown } from "@jongodb/memory-server/jest";
+
+export default createJestGlobalTeardown();
+```
+
+### Vitest
+
+```ts
+import { beforeAll, afterAll } from "vitest";
+import { registerJongodbForVitest } from "@jongodb/memory-server/vitest";
+
+registerJongodbForVitest({ beforeAll, afterAll });
+```
+
+### NestJS (Jest E2E)
+
+```ts
+import { beforeAll, afterAll } from "@jest/globals";
+import { registerJongodbForNestJest } from "@jongodb/memory-server/nestjs";
+
+registerJongodbForNestJest({ beforeAll, afterAll });
+```
+
+## Common Integration Patterns
+
+- NestJS + Mongoose: `MongooseModule.forRootAsync({ useFactory: () => ({ uri: process.env.MONGODB_URI }) })`
+- Express/Fastify: inject `process.env.MONGODB_URI` into DB bootstrap before app init
+- Prisma (Mongo): set `envVarName: "DATABASE_URL"` for runtime helper
+- TypeORM (Mongo): pass runtime URI as `url`
+
+## API Surface
+
+Main export (`@jongodb/memory-server`):
+
+- `startJongodbMemoryServer(options?)`
+
+Runtime export (`@jongodb/memory-server/runtime`):
+
+- `createJongodbEnvRuntime(options?)`
+
+Jest export (`@jongodb/memory-server/jest`):
+
+- `registerJongodbForJest(hooks, options?)`
+- `createJestGlobalSetup(options?)`
+- `createJestGlobalTeardown(options?)`
+- `readJestGlobalState(options?)`
+- `readJestGlobalUri(options?)`
+
+Nest export (`@jongodb/memory-server/nestjs`):
+
+- `registerJongodbForNestJest(hooks, options?)`
+
+Vitest export (`@jongodb/memory-server/vitest`):
+
+- `registerJongodbForVitest(hooks, options?)`
+
+## Options Reference
+
+Core options:
+
+- `launchMode`: `auto` | `binary` | `java` (default: `auto`)
+- `binaryPath`: binary executable path
+- `classpath`: Java classpath string or string array
+- `javaPath`: Java executable path (default: `java`)
+- `launcherClass`: Java launcher class (default: `org.jongodb.server.TcpMongoServerLauncher`)
+- `databaseName`: default DB in generated URI (default: `test`)
+- `host`: bind host (default: `127.0.0.1`)
+- `port`: bind port (`0` for ephemeral, default: `0`)
+- `startupTimeoutMs`: startup timeout (default: `15000`)
+- `stopTimeoutMs`: stop timeout before forced kill (default: `5000`)
+- `env`: additional child process env vars
+- `logLevel`: `silent` | `info` | `debug` (default: `silent`)
+- `envVarName` (runtime/jest/vitest helpers): target env key (default: `MONGODB_URI`)
+
+## Troubleshooting
+
+- `No launcher runtime configured`: set binary path/env or classpath/env
+- `Binary launch mode requested but no binary was found`: provide `binaryPath` or `JONGODB_BINARY_PATH`
+- `Java launch mode requested but Java classpath is not configured`: provide `classpath` or `JONGODB_CLASSPATH`
+- `spawn ... ENOENT`: missing binary/java executable path
+- startup timeout: launcher did not emit `JONGODB_URI=...`
+
+Parallel test tip:
+
+- use unique `databaseName` per worker/process to avoid data collisions

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+type LogLevel = "silent" | "info" | "debug";
+type LaunchMode = "auto" | "binary" | "java";
+export interface JongodbMemoryServerOptions {
+    host?: string;
+    port?: number;
+    databaseName?: string;
+    startupTimeoutMs?: number;
+    stopTimeoutMs?: number;
+    javaPath?: string;
+    launcherClass?: string;
+    classpath?: string | string[];
+    binaryPath?: string;
+    launchMode?: LaunchMode;
+    env?: Record<string, string>;
+    logLevel?: LogLevel;
+}
+export interface JongodbMemoryServer {
+    readonly uri: string;
+    readonly pid: number;
+    detach(): void;
+    stop(): Promise<void>;
+}
+export declare function startJongodbMemoryServer(options?: JongodbMemoryServerOptions): Promise<JongodbMemoryServer>;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAmBA,KAAK,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC;AAC5C,KAAK,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC;AAE7C,MAAM,WAAW,0BAA0B;IACzC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,MAAM,IAAI,IAAI,CAAC;IACf,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACvB;AAcD,wBAAsB,wBAAwB,CAC5C,OAAO,GAAE,0BAA+B,GACvC,OAAO,CAAC,mBAAmB,CAAC,CA6C9B"}