services - DbInstance: add explicit return type on public code + type tests (#44)

Author: devmatteini

packages/services/dtslint/DbInstance.ts

@@ -0,0 +1,72 @@
+import * as DbInstance from "@effect-mongodb/services/DbInstance"
+import type * as DbService from "@effect-mongodb/services/DbService"
+import * as Config from "effect/Config"
+import type * as Context from "effect/Context"
+import * as Effect from "effect/Effect"
+import * as F from "effect/Function"
+import type { MongoClient as NativeMongoClient } from "mongodb"
+
+declare const db: DbService.Tag<"MyDb">
+
+type SomeService = { url: string; name: string }
+declare const SomeService: Context.Tag<SomeService, SomeService>
+
+// -------------------------------------------------------------------------------------
+// layerEffect
+// -------------------------------------------------------------------------------------
+
+// $ExpectType Layer<DbService<"MyDb">, MongoError, never>
+DbInstance.layerEffect(db, Effect.succeed({ database: { name: "mydb" }, client: { url: "mongodb://localhost:27017" } }))
+
+// $ExpectType Layer<DbService<"MyDb">, MongoError | ConfigError, never>
+DbInstance.layerEffect(
+  db,
+  Effect.gen(function*() {
+    const databaseName = yield* Config.string("MONGO_DATABASE_NAME")
+    const clientUrl = yield* Config.string("MONGO_CONNECTION_STRING")
+    return { database: { name: databaseName }, client: { url: clientUrl } }
+  })
+)
+
+const withRequirements = Effect.gen(function*() {
+  const { url } = yield* SomeService
+  const name = yield* Config.string("MONGO_DATABASE_NAME")
+  return { database: { name }, client: { url } }
+})
+// $ExpectType Layer<DbService<"MyDb">, MongoError | ConfigError, SomeService>
+DbInstance.layerEffect(db, withRequirements)
+
+// -------------------------------------------------------------------------------------
+// layer
+// -------------------------------------------------------------------------------------
+
+// $ExpectType Layer<DbService<"MyDb">, MongoError, never>
+DbInstance.layer(db, { database: { name: "mydb" }, client: { url: "mongodb://localhost:27017" } })
+
+// -------------------------------------------------------------------------------------
+// fromMongoClient
+// -------------------------------------------------------------------------------------
+
+declare const legacyClient: NativeMongoClient
+
+// $ExpectType Layer<DbService<"MyDb">, never, never>
+DbInstance.fromMongoClient(db, Effect.succeed({ database: { name: "mydb" }, client: legacyClient }))
+
+// $ExpectType Layer<DbService<"MyDb">, ConfigError, never>
+DbInstance.fromMongoClient(
+  db,
+  F.pipe(
+    Config.string("MONGO_DATABASE_NAME"),
+    Effect.map((name) => ({ database: { name }, client: legacyClient }))
+  )
+)
+
+// $ExpectType Layer<DbService<"MyDb">, ConfigError, SomeService>
+DbInstance.fromMongoClient(
+  db,
+  Effect.gen(function*() {
+    const { name: dbName } = yield* SomeService
+    const name = yield* Config.string(dbName)
+    return { database: { name }, client: legacyClient }
+  })
+)

packages/services/dtslint/MongoClientService.ts

@@ -23,11 +23,11 @@ MongoClientService.Tag("MyMongoClient")
 // $ExpectType Layer<MongoClientService<"MyMongoClient">, MongoError, never>
 MongoClientService.layerEffect(mongoClient, Effect.succeed("mongodb://localhost:27017"))
 
-// $ExpectType Layer<MongoClientService<"MyMongoClient">, ConfigError | MongoError, never>
+// $ExpectType Layer<MongoClientService<"MyMongoClient">, MongoError | ConfigError, never>
 MongoClientService.layerEffect(mongoClient, Config.string("DATABASE_NAME"))
 
 const withRequirements = SomeService.pipe(Effect.flatMap(({ url }) => Config.string(url)))
-// $ExpectType Layer<MongoClientService<"MyMongoClient">, ConfigError | MongoError, SomeService>
+// $ExpectType Layer<MongoClientService<"MyMongoClient">, MongoError | ConfigError, SomeService>
 MongoClientService.layerEffect(mongoClient, withRequirements)
 
 // -------------------------------------------------------------------------------------

packages/services/src/DbInstance.ts

@@ -2,6 +2,7 @@
  * @since 0.0.1
  */
 import * as MongoClient from "effect-mongodb/MongoClient"
+import type * as MongoError from "effect-mongodb/MongoError"
 import * as Effect from "effect/Effect"
 import * as F from "effect/Function"
 import * as Layer from "effect/Layer"
@@ -17,7 +18,7 @@ type DbInstanceOptions = {
 export const layerEffect = <DbK extends string, E = never, R = never>(
   dbTag: DbService.Tag<DbK>,
   options: Effect.Effect<DbInstanceOptions, E, R>
-) =>
+): Layer.Layer<DbService.DbService<DbK>, MongoError.MongoError | E, R> =>
   F.pipe(
     options,
     Effect.map((options) => layer(dbTag, options)),
@@ -27,7 +28,7 @@ export const layerEffect = <DbK extends string, E = never, R = never>(
 export const layer = <DbK extends string>(
   dbTag: DbService.Tag<DbK>,
   options: DbInstanceOptions
-) => {
+): Layer.Layer<DbService.DbService<DbK>, MongoError.MongoError> => {
   const { name: databaseName, ...databaseOptions } = options.database
   const { url: clientUrl, ...clientOptions } = options.client
 
@@ -41,7 +42,7 @@ type DbInstanceOptionsWithClient = Pick<DbInstanceOptions, "database"> & { clien
 export const fromMongoClient = <DbK extends string, E = never, R = never>(
   dbTag: DbService.Tag<DbK>,
   options: Effect.Effect<DbInstanceOptionsWithClient, E, R>
-) =>
+): Layer.Layer<DbService.DbService<DbK>, E, R> =>
   Layer.effect(
     dbTag,
     Effect.gen(function*() {