effect-mongodb - Db: wrap mongodb driver Db type into a TaggedClass (close #41)

Author: VenomAV

.changeset/lovely-ears-jog.md

@@ -0,0 +1,5 @@
+---
+"effect-mongodb": minor
+---
+
+Wrap mongodb driver Db type into a TaggedClass

packages/effect-mongodb/src/Db.ts

@@ -1,25 +1,28 @@
 /**
  * @since 0.0.1
  */
+import * as Data from "effect/Data"
 import * as Effect from "effect/Effect"
 import * as F from "effect/Function"
 import type * as Schema from "effect/Schema"
 import type { Document, DropCollectionOptions, ListCollectionsOptions } from "mongodb"
-import { Db } from "mongodb"
+import { Db as Db_ } from "mongodb"
 import type * as Collection from "./Collection.js"
 import * as DocumentCollection from "./DocumentCollection.js"
 import { mongoErrorOrDie } from "./internal/mongo-error.js"
 import * as ListCollectionsCursor from "./ListCollectionsCursor.js"
 import * as MongoError from "./MongoError.js"
 
+export class Db extends Data.TaggedClass("Db")<{ db: Db_ }> {}
+
 export const documentCollection: {
   (name: string): (db: Db) => DocumentCollection.DocumentCollection
   (db: Db, name: string): DocumentCollection.DocumentCollection
 } = F.dual(
   (args) => isDb(args[0]),
   (db: Db, name: string): DocumentCollection.DocumentCollection =>
     new DocumentCollection.DocumentCollectionImpl({
-      collection: db.collection(name)
+      collection: db.db.collection(name)
     })
 )
 
@@ -67,7 +70,7 @@ export const listCollections: {
 } = F.dual(
   (args) => isDb(args[0]),
   (db: Db, filter?: Document, options?: ListCollectionsOptions): ListCollectionsCursor.ListCollectionsCursor =>
-    new ListCollectionsCursor.ListCollectionsCursorImpl({ cursor: db.listCollections(filter, options) })
+    new ListCollectionsCursor.ListCollectionsCursorImpl({ cursor: db.db.listCollections(filter, options) })
 )
 
 export const dropCollection: {
@@ -79,12 +82,12 @@ export const dropCollection: {
   (args) => isDb(args[0]),
   (db: Db, name: string, options?: DropCollectionOptions): Effect.Effect<boolean, MongoError.MongoError> =>
     F.pipe(
-      Effect.promise(() => db.dropCollection(name, options)),
+      Effect.promise(() => db.db.dropCollection(name, options)),
       Effect.catchAllDefect(mongoErrorOrDie(errorSource(db, "dropCollection")))
     )
 )
 
-const isDb = (x: unknown) => x instanceof Db
+const isDb = (x: unknown) => x instanceof Db_
 
 const errorSource = (db: Db, functionName: string) =>
-  new MongoError.DbErrorSource({ module: "Db", functionName, db: db.databaseName })
+  new MongoError.DbErrorSource({ module: "Db", functionName, db: db.db.databaseName })

packages/effect-mongodb/src/MongoClient.ts

@@ -4,8 +4,9 @@
 import * as Effect from "effect/Effect"
 import * as F from "effect/Function"
 import type * as Scope from "effect/Scope"
-import type { Db, DbOptions, MongoClientOptions } from "mongodb"
+import type { DbOptions, MongoClientOptions } from "mongodb"
 import { MongoClient as MongoClient_ } from "mongodb"
+import * as Db from "./Db.js"
 import { mongoErrorOrDie } from "./internal/mongo-error.js"
 import * as MongoError from "./MongoError.js"
 
@@ -42,11 +43,11 @@ export const connectScoped = (
   )
 
 export const db: {
-  (dbName?: string, options?: DbOptions): (client: MongoClient) => Db
-  (client: MongoClient, dbName?: string, options?: DbOptions): Db
+  (dbName?: string, options?: DbOptions): (client: MongoClient) => Db.Db
+  (client: MongoClient, dbName?: string, options?: DbOptions): Db.Db
 } = F.dual(
   (args) => isMongoClient(args[0]),
-  (client: MongoClient, dbName?: string, options?: DbOptions): Db => client.db(dbName, options)
+  (client: MongoClient, dbName?: string, options?: DbOptions): Db.Db => new Db.Db({ db: client.db(dbName, options) })
 )
 
 const isMongoClient = (x: unknown) => x instanceof MongoClient_

packages/effect-mongodb/test/support/describe-mongo.ts

@@ -1,13 +1,14 @@
+import * as Db from "effect-mongodb/Db"
 import * as Effect from "effect/Effect"
-import type { Db } from "mongodb"
+import type { Db as Db_ } from "mongodb"
 import { MongoClient } from "mongodb"
 import { afterAll, beforeAll, describe, inject } from "vitest"
 
 type MongoContext = {
   client: Effect.Effect<MongoClient>
-  database: Effect.Effect<Db>
+  database: Effect.Effect<Db.Db>
   _client: () => MongoClient
-  _database: () => Db
+  _database: () => Db_
 }
 
 export const describeMongo = (
@@ -16,7 +17,7 @@ export const describeMongo = (
 ) => {
   describe(suiteName, () => {
     let client: MongoClient
-    let database: Db
+    let database: Db_
     let databaseName: string
 
     beforeAll(async () => {
@@ -41,7 +42,7 @@ export const describeMongo = (
       _client: () => client,
       _database: () => database,
       client: Effect.sync(() => client),
-      database: Effect.sync(() => database)
+      database: Effect.sync(() => new Db.Db({ db: database }))
     })
   })
 }

packages/services/src/DbService.ts

@@ -1,15 +1,16 @@
 /**
  * @since 0.0.1
  */
+import type * as Db from "effect-mongodb/Db"
 import * as MongoClient from "effect-mongodb/MongoClient"
 import type * as Brand from "effect/Brand"
 import * as Context from "effect/Context"
 import * as Effect from "effect/Effect"
 import * as Layer from "effect/Layer"
-import type { Db, DbOptions } from "mongodb"
+import type { DbOptions } from "mongodb"
 import type * as MongoClientService from "./MongoClientService.js"
 
-export type DbService<K extends string> = Db & Brand.Brand<K>
+export type DbService<K extends string> = Db.Db & Brand.Brand<K>
 
 export const Tag = <K extends string>(key: K) => Context.GenericTag<DbService<K>>(key)
 export type TagType<K extends string> = ReturnType<typeof Tag<K>>

packages/services/test/support/describe-mongo.ts

@@ -1,13 +1,14 @@
+import * as Db from "effect-mongodb/Db"
 import * as Effect from "effect/Effect"
-import type { Db } from "mongodb"
+import type { Db as Db_ } from "mongodb"
 import { MongoClient } from "mongodb"
 import { afterAll, beforeAll, describe, inject } from "vitest"
 
 type MongoContext = {
   client: Effect.Effect<MongoClient>
-  database: Effect.Effect<Db>
+  database: Effect.Effect<Db.Db>
   _client: () => MongoClient
-  _database: () => Db
+  _database: () => Db_
 }
 
 export const describeMongo = (
@@ -16,7 +17,7 @@ export const describeMongo = (
 ) => {
   describe(suiteName, () => {
     let client: MongoClient
-    let database: Db
+    let database: Db_
     let databaseName: string
 
     beforeAll(async () => {
@@ -41,7 +42,7 @@ export const describeMongo = (
       _client: () => client,
       _database: () => database,
       client: Effect.sync(() => client),
-      database: Effect.sync(() => database)
+      database: Effect.sync(() => new Db.Db({ db: database }))
     })
   })
 }