chore: Switches to unbuild and updates exports for proper tree shaking

Author: thecodedrift

CONTRIBUTING.md

@@ -46,7 +46,7 @@ Until [this ava issue](https://github.com/avajs/ava/issues/2979) is resolved, we
 
 ### 🏁 E2E Testing
 
-End to End tests are accepted. We use [mongo-memory-server](https://github.com/nodkz/mongodb-memory-server) in development to provide a MongoDB instance with working replication (which enables the oplog).
+End to End tests are accepted. Please use the `LokiAdapter` for any tests, as it does not mandate the external dependencies to be loaded.
 
 ## 📚 Updating Documentation
 
@@ -64,7 +64,7 @@ To help land your contribution, please make sure of the following:
 
 - Remember to be concise in your Conventional Commit. These will eventually be automatically rolled up into an auto-generated CHANGELOG file
 - If you modified anything in `src/`:
-  - You verified the transpiled TypeScript with `yarn build` in the directory of whichever package you modified.
+  - You verified the transpiled TypeScript with `yarn build` in the directory of whichever package you modified. This will also verify your CJS/ESM exports
   - Run `yarn test` to ensure all existing tests pass for that package, along with any new tests you would've written.
 
 Thank you! 💕

README.md

@@ -156,6 +156,9 @@ The `Queue` object has a large number of emitted events available through `queue
 DocMQ works with several drivers, many of which are included in the `/drivers` directory. For development or non-production scenarios, we recommend the `MemoryDriver`, an in-memory driver that supports all of DocMQ's apis. When transitioning to production, you can pass a production driver in and DocMQ will work with no additional changes.
 
 ```ts
+import { Queue, MemoryDriver } from "docmq";
+import { MongoDriver } from "docmq/driver/mongo";
+
 // for example, using the MongoDriver in production, while using
 // the less resource-intensive in-memory driver for development
 const driver =
@@ -166,12 +169,14 @@ const driver =
 const queue = new Queue(driver, "queueName");
 ```
 
-| Driver        | `import`       | Notes                                                                                                                                                                                                                                                                              |
-| :------------ | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **In Memory** | `MemoryDriver` | The default in-memory driver and (currently) a re-export of `LokiDriver`                                                                                                                                                                                                           |
-| LokiJS        | `LokiDriver`   | A fast in-memory driver designed for non-production instances.                                                                                                                                                                                                                     |
-| MongoDB       | `MongoDriver`  | Currently, DocMQ requires a Mongo Client >= 4.2 for transaction support, and the mongo instance must be running in a Replica Set. This is because MongoDriver uses the OpLog to reduce polling. Requires [mongodb](https://www.npmjs.com/package/mongodb) peer dependency if using |
-| Postgres      | `PGDriver`     | We are slowly expanding our PG Test Matrix based on what GitHub allows. `LISTEN`/`NOTIFY` support is not available, and the driver will fall back to polling. Requires [pg](https://www.npmjs.com/package/pg) as a peer dependency if using                                        |
+| Driver        | `import`                                           | Notes                                                                                                                                                                                                                                                                              |
+| :------------ | :------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **In Memory** | `import { MemoryDriver} from "docmq"`              | The default in-memory driver and (currently) a re-export of `LokiDriver`                                                                                                                                                                                                           |
+| LokiJS        | `import { LokiDriver } from "docmq/driver/loki"`   | A fast in-memory driver designed for non-production instances.                                                                                                                                                                                                                     |
+| MongoDB       | `import { MongoDriver } from "docmq/driver/mongo"` | Currently, DocMQ requires a Mongo Client >= 4.2 for transaction support, and the mongo instance must be running in a Replica Set. This is because MongoDriver uses the OpLog to reduce polling. Requires [mongodb](https://www.npmjs.com/package/mongodb) peer dependency if using |
+| Postgres      | `import { PGDriver } from "docmq/driver/postgres"` | We are slowly expanding our PG Test Matrix based on what GitHub allows. `LISTEN`/`NOTIFY` support is not available, and the driver will fall back to polling. Requires [pg](https://www.npmjs.com/package/pg) as a peer dependency if using                                        |
+
+If you need to write a custom driver, the core `BaseDriver` is available in the core `docmq` package.
 
 ## :pencil2: Contributing
 

RELEASING.md

@@ -2,6 +2,8 @@
 
 This repository releases code using [release-it](https://github.com/release-it/release-it). New releases can be triggered from the root package via `yarn rel` which offers a guided process.
 
+As part of our build command, we perform a local npm install and verify that our CJS/ESM imports are working as expected.
+
 ## Common Commands
 
 - Begin a new for the next version `next` with `yarn rel <major|minor|patch> --preRelease=next`

build.config.ts

@@ -0,0 +1,10 @@
+import { defineBuildConfig } from "unbuild";
+
+export default defineBuildConfig({
+  clean: true,
+  declaration: true,
+  rollup: {
+    cjsBridge: true,
+    emitCJS: true,
+  },
+});

package.json

@@ -9,18 +9,11 @@
   "repository": "jakobo/docmq.git",
   "scripts": {
     "bench": "node --loader=ts-node/esm ./scripts/run-benchmark.ts",
-    "build": "run-s clean 'build:all' 'pjson:all'",
-    "build:all": "run-p 'build:x:**'",
-    "build:x:cjs": "tsc -p tsconfig.cjs.json",
-    "build:x:esm": "tsc -p tsconfig.esm.json",
-    "build:x:types": "tsc -p tsconfig.types.json",
+    "build": "run-s unbuild 'verify:*'",
     "clean": "shx rm -rf dist && shx mkdir dist",
     "dev": "run-s watch",
     "lint": "eslint .",
     "lint-staged": "lint-staged",
-    "pjson:all": "run-p 'pjson:x:**'",
-    "pjson:x:cjs": "shx echo '{\"type\": \"commonjs\"}' > ./dist/cjs/package.json",
-    "pjson:x:esm": "shx echo '{\"type\": \"module\"}' > ./dist/esm/package.json",
     "postinstall": "husky install",
     "postpack": "pinst --enable",
     "prepack": "pinst --disable",
@@ -29,10 +22,9 @@
     "rev": "release-it --preRelease",
     "syncpack": "syncpack",
     "test": "ava",
-    "watch": "run-p 'watch:**'",
-    "watch:cjs": "tsc -p tsconfig.cjs.json -w --preserveWatchOutput",
-    "watch:esm": "tsc -p tsconfig.esm.json -w --preserveWatchOutput",
-    "watch:types": "tsc -p tsconfig.types.json -w --preserveWatchOutput"
+    "unbuild": "unbuild",
+    "verify:cjs": "cd verify/cjs && npm install && node cjs.verify.js",
+    "verify:esm": "cd verify/esm && npm install && node esm.verify.js"
   },
   "engines": {
     "node": ">=14.19.0"
@@ -84,7 +76,8 @@
     "testdouble": "^3.16.6",
     "ts-node": "^10.8.1",
     "tslib": "^2.4.0",
-    "typescript": "^4.7.3"
+    "typescript": "^4.7.3",
+    "unbuild": "latest"
   },
   "peerDependencies": {
     "mongodb": "^4.7.0",
@@ -99,15 +92,33 @@
     }
   },
   "type": "module",
-  "main": "dist/cjs/src/index.js",
-  "module": "dist/esm/src/index.js",
-  "types": "dist/types/src/index.d.ts",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
   "exports": {
-    "./package.json": "./package.json",
     ".": {
-      "types": "./dist/types/src/index.d.ts",
-      "import": "./dist/esm/src/index.js",
-      "require": "./dist/cjs/src/index.js"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "file": "./src/index.ts"
+    },
+    "./driver/mongo": {
+      "types": "./dist/mongo.d.ts",
+      "import": "./dist/mongo.mjs",
+      "require": "./dist/mongo.cjs",
+      "file": "./src/driver/mongo.ts"
+    },
+    "./driver/loki": {
+      "types": "./dist/loki.d.ts",
+      "import": "./dist/loki.mjs",
+      "require": "./dist/loki.cjs",
+      "file": "./src/driver/loki.ts"
+    },
+    "./driver/postgres": {
+      "types": "./dist/postgres.d.ts",
+      "import": "./dist/postgres.mjs",
+      "require": "./dist/postgres.cjs",
+      "file": "./src/driver/postgres.ts"
     }
   },
   "files": [

src/driver/loki.ts

@@ -1,6 +1,5 @@
 import { DateTime } from "luxon";
 import Loki from "lokijs";
-import { serializeError } from "serialize-error";
 import { v4 } from "uuid";
 import { MaxAttemptsExceededError } from "../error.js";
 import { QueueDoc } from "../types.js";
@@ -267,6 +266,9 @@ export class LokiDriver extends BaseDriver {
       `Exceeded the maximum number of retries (${doc.attempts.max}) for this job`
     );
 
+    // serialize-error is esm-only and must be await imported
+    const serializeError = (await import("serialize-error")).serializeError;
+
     const next = this._jobs
       .chain()
       .find({

src/driver/mongo.ts

@@ -9,7 +9,6 @@ import {
   type ObjectId,
   type WithId,
 } from "mongodb";
-import { serializeError } from "serialize-error";
 import { v4 } from "uuid";
 
 import {
@@ -398,6 +397,9 @@ export class MongoDriver extends BaseDriver {
       `Exceeded the maximum number of retries (${doc.attempts.max}) for this job`
     );
 
+    // serialize-error is esm-only and must be await imported
+    const serializeError = (await import("serialize-error")).serializeError;
+
     const next = await this._jobs.updateOne(
       {
         ack: ackVal,

src/driver/postrgres.ts renamed to src/driver/postgres.ts

@@ -1,7 +1,5 @@
 import { DateTime } from "luxon";
 import pg from "pg";
-import { serializeError } from "serialize-error";
-
 import { MaxAttemptsExceededError } from "../error.js";
 import { QueueDoc } from "../types.js";
 import { BaseDriver } from "./base.js";
@@ -584,6 +582,9 @@ export class PgDriver extends BaseDriver {
       `Exceeded the maximum number of retries (${doc.attempts.max}) for this job`
     );
 
+    // serialize-error is esm-only and must be await imported
+    const serializeError = (await import("serialize-error")).serializeError;
+
     const client = await this._pool.connect();
     try {
       const res = await client.query<QueueRow>(

src/driver/postgres/migrations/.empty

@@ -1,7 +1,5 @@
 export { Queue } from "./queue.js";
 export { BaseDriver } from "./driver/base.js";
-export { MongoDriver } from "./driver/mongo.js";
-export { LokiDriver } from "./driver/loki.js";
 export { LokiDriver as MemoryDriver } from "./driver/loki.js";
 
 export * from "./error.js";