@effect/sql-pg 4.0.0-beta.4 → 4.0.0-beta.41

package/dist/PgClient.js

@@ -10,23 +10,21 @@ import * as Effect from "effect/Effect";
 import * as Fiber from "effect/Fiber";
 import * as Layer from "effect/Layer";
 import * as Number from "effect/Number";
+import * as Option from "effect/Option";
 import * as Queue from "effect/Queue";
 import * as RcRef from "effect/RcRef";
 import * as Redacted from "effect/Redacted";
 import * as Scope from "effect/Scope";
+import * as Semaphore from "effect/Semaphore";
 import * as ServiceMap from "effect/ServiceMap";
 import * as Stream from "effect/Stream";
 import * as Reactivity from "effect/unstable/reactivity/Reactivity";
 import * as Client from "effect/unstable/sql/SqlClient";
-import { SqlError } from "effect/unstable/sql/SqlError";
+import { AuthenticationError, AuthorizationError, ConnectionError, ConstraintError, DeadlockError, LockTimeoutError, SerializationError, SqlError, SqlSyntaxError, StatementTimeoutError, UnknownError } from "effect/unstable/sql/SqlError";
 import * as Statement from "effect/unstable/sql/Statement";
 import * as Pg from "pg";
 import * as PgConnString from "pg-connection-string";
 import Cursor from "pg-cursor";
-const ATTR_DB_SYSTEM_NAME = "db.system.name";
-const ATTR_DB_NAMESPACE = "db.namespace";
-const ATTR_SERVER_ADDRESS = "server.address";
-const ATTR_SERVER_PORT = "server.port";
 /**
  * @category type ids
  * @since 1.0.0
@@ -55,11 +53,11 @@ export const make = options => fromPool({
       ...(options.stream ? {
         stream: options.stream
       } : {}),
-      connectionTimeoutMillis: options.connectTimeout ? Duration.toMillis(Duration.fromDurationInputUnsafe(options.connectTimeout)) : undefined,
-      idleTimeoutMillis: options.idleTimeout ? Duration.toMillis(Duration.fromDurationInputUnsafe(options.idleTimeout)) : undefined,
+      connectionTimeoutMillis: options.connectTimeout ? Duration.toMillis(Duration.fromInputUnsafe(options.connectTimeout)) : undefined,
+      idleTimeoutMillis: options.idleTimeout ? Duration.toMillis(Duration.fromInputUnsafe(options.idleTimeout)) : undefined,
       max: options.maxConnections,
       min: options.minConnections,
-      maxLifetimeSeconds: options.connectionTTL ? Duration.toSeconds(Duration.fromDurationInputUnsafe(options.connectionTTL)) : undefined,
+      maxLifetimeSeconds: options.connectionTTL ? Duration.toSeconds(Duration.fromInputUnsafe(options.connectionTTL)) : undefined,
       application_name: options.applicationName ?? "@effect/sql-pg",
       types: options.types
     });
@@ -67,168 +65,123 @@ export const make = options => fromPool({
     yield* Effect.acquireRelease(Effect.tryPromise({
       try: () => pool.query("SELECT 1"),
       catch: cause => new SqlError({
-        cause,
-        message: "PgClient: Failed to connect"
+        reason: classifyError(cause, "PgClient: Failed to connect", "connect")
       })
     }), () => Effect.promise(() => pool.end()).pipe(Effect.timeoutOption(1000))).pipe(Effect.timeoutOrElse({
       duration: options.connectTimeout ?? Duration.seconds(5),
-      onTimeout: () => Effect.fail(new SqlError({
-        cause: new Error("Connection timed out"),
-        message: "PgClient: Connection timed out"
+      orElse: () => Effect.fail(new SqlError({
+        reason: new ConnectionError({
+          cause: new Error("Connection timed out"),
+          message: "PgClient: Connection timed out",
+          operation: "connect"
+        })
       }))
     }));
     return pool;
   })
 });
+/**
+ * @category constructors
+ * @since 1.0.0
+ */
+export const makeClient = options => fromClient({
+  ...options,
+  acquire: Effect.gen(function* () {
+    const client = new Pg.Client({
+      connectionString: options.url ? Redacted.value(options.url) : undefined,
+      user: options.username,
+      host: options.host,
+      database: options.database,
+      password: options.password ? Redacted.value(options.password) : undefined,
+      ssl: options.ssl,
+      port: options.port,
+      ...(options.stream ? {
+        stream: options.stream
+      } : {}),
+      application_name: options.applicationName ?? "@effect/sql-pg",
+      types: options.types
+    });
+    yield* Effect.acquireRelease(Effect.tryPromise({
+      try: () => client.query("SELECT 1"),
+      catch: cause => new SqlError({
+        reason: classifyError(cause, "PgClient: Failed to connect", "connect")
+      })
+    }), () => Effect.promise(() => client.end()).pipe(Effect.timeoutOption(1000))).pipe(Effect.timeoutOrElse({
+      duration: options.connectTimeout ?? Duration.seconds(5),
+      orElse: () => Effect.fail(new SqlError({
+        reason: new ConnectionError({
+          cause: new Error("Connection timed out"),
+          message: "PgClient: Connection timed out",
+          operation: "connect"
+        })
+      }))
+    }));
+    return client;
+  }),
+  acquireForStream: options.acquireForStream ?? false
+});
 /**
  * @category constructors
  * @since 1.0.0
  */
 export const fromPool = /*#__PURE__*/Effect.fnUntraced(function* (options) {
-  const compiler = makeCompiler(options.transformQueryNames, options.transformJson);
-  const transformRows = options.transformResultNames ? Statement.defaultTransforms(options.transformResultNames, options.transformJson).array : undefined;
   const pool = yield* options.acquire;
-  class ConnectionImpl {
-    pg;
-    constructor(pg) {
-      this.pg = pg;
+  const makeConection = client => new ConnectionImpl(function runWithClient(f) {
+    if (client !== undefined) {
+      return Effect.callback(resume => {
+        f(client, resume);
+        return makeCancel(pool, client);
+      });
     }
-    runWithClient(f) {
-      if (this.pg !== undefined) {
-        return Effect.callback(resume => {
-          f(this.pg, resume);
-          return makeCancel(pool, this.pg);
-        });
+    return Effect.callback(resume => {
+      let done = false;
+      let cancel = undefined;
+      let client = undefined;
+      function onError(cause) {
+        cleanup(cause);
+        resume(Effect.fail(new SqlError({
+          reason: classifyError(cause, "Connection error", "acquireConnection")
+        })));
       }
-      return Effect.callback(resume => {
-        let done = false;
-        let cancel = undefined;
-        let client = undefined;
-        function onError(cause) {
-          cleanup(cause);
-          resume(Effect.fail(new SqlError({
-            cause,
-            message: "Connection error"
+      function cleanup(cause) {
+        if (!done) client?.release(cause);
+        done = true;
+        client?.off("error", onError);
+      }
+      pool.connect((cause, client_) => {
+        if (cause) {
+          return resume(Effect.fail(new SqlError({
+            reason: classifyError(cause, "Failed to acquire connection", "acquireConnection")
           })));
-        }
-        function cleanup(cause) {
-          if (!done) client?.release(cause);
-          done = true;
-          client?.off("error", onError);
-        }
-        pool.connect((cause, client_) => {
-          if (cause) {
-            return resume(Effect.fail(new SqlError({
-              cause,
-              message: "Failed to acquire connection"
-            })));
-          } else if (!client_) {
-            return resume(Effect.fail(new SqlError({
+        } else if (!client_) {
+          return resume(Effect.fail(new SqlError({
+            reason: new ConnectionError({
               message: "Failed to acquire connection",
-              cause: new Error("No client returned")
-            })));
-          } else if (done) {
-            client_.release();
-            return;
-          }
-          client = client_;
-          client.once("error", onError);
-          cancel = makeCancel(pool, client);
-          f(client, eff => {
-            cleanup();
-            resume(eff);
-          });
-        });
-        return Effect.suspend(() => {
-          if (!cancel) {
-            cleanup();
-            return Effect.void;
-          }
-          return Effect.ensuring(cancel, Effect.sync(cleanup));
-        });
-      });
-    }
-    run(query, params) {
-      return this.runWithClient((client, resume) => {
-        client.query(query, params, (err, result) => {
-          if (err) {
-            resume(Effect.fail(new SqlError({
-              cause: err,
-              message: "Failed to execute statement"
-            })));
-          } else {
-            // Multi-statement queries return an array of results
-            resume(Effect.succeed(Array.isArray(result) ? result.map(r => r.rows ?? []) : result.rows ?? []));
-          }
-        });
-      });
-    }
-    execute(sql, params, transformRows) {
-      return transformRows ? Effect.map(this.run(sql, params), transformRows) : this.run(sql, params);
-    }
-    executeRaw(sql, params) {
-      return this.runWithClient((client, resume) => {
-        client.query(sql, params, (err, result) => {
-          if (err) {
-            resume(Effect.fail(new SqlError({
-              cause: err,
-              message: "Failed to execute statement"
-            })));
-          } else {
-            resume(Effect.succeed(result));
-          }
+              cause: new Error("No client returned"),
+              operation: "acquireConnection"
+            })
+          })));
+        } else if (done) {
+          client_.release();
+          return;
+        }
+        client = client_;
+        client.once("error", onError);
+        cancel = makeCancel(pool, client);
+        f(client, eff => {
+          cleanup();
+          resume(eff);
         });
       });
-    }
-    executeWithoutTransform(sql, params) {
-      return this.run(sql, params);
-    }
-    executeValues(sql, params) {
-      return this.runWithClient((client, resume) => {
-        client.query({
-          text: sql,
-          rowMode: "array",
-          values: params
-        }, (err, result) => {
-          if (err) {
-            resume(Effect.fail(new SqlError({
-              cause: err,
-              message: "Failed to execute statement"
-            })));
-          } else {
-            resume(Effect.succeed(result.rows));
-          }
-        });
+      return Effect.suspend(() => {
+        if (!cancel) {
+          cleanup();
+          return Effect.void;
+        }
+        return Effect.ensuring(cancel, Effect.sync(cleanup));
       });
-    }
-    executeUnprepared(sql, params, transformRows) {
-      return this.execute(sql, params, transformRows);
-    }
-    executeStream(sql, params, transformRows) {
-      // oxlint-disable-next-line @typescript-eslint/no-this-alias
-      const self = this;
-      return Stream.fromChannel(Channel.fromTransform(Effect.fnUntraced(function* (_, scope) {
-        const client = self.pg ?? (yield* Scope.provide(reserveRaw, scope));
-        yield* Scope.addFinalizer(scope, Effect.promise(() => cursor.close()));
-        const cursor = client.query(new Cursor(sql, params));
-        // @effect-diagnostics-next-line returnEffectInGen:off
-        return Effect.callback(resume => {
-          cursor.read(128, (err, rows) => {
-            if (err) {
-              resume(Effect.fail(new SqlError({
-                cause: err,
-                message: "Failed to execute statement"
-              })));
-            } else if (Arr.isArrayNonEmpty(rows)) {
-              resume(Effect.succeed(transformRows ? transformRows(rows) : rows));
-            } else {
-              resume(Cause.done());
-            }
-          });
-        });
-      })));
-    }
-  }
+    });
+  }, client ? Effect.succeed(client) : reserveRaw);
   const reserveRaw = Effect.callback(resume => {
     const fiber = Fiber.getCurrent();
     const scope = ServiceMap.getUnsafe(fiber.services, Scope.Scope);
@@ -236,8 +189,7 @@ export const fromPool = /*#__PURE__*/Effect.fnUntraced(function* (options) {
     pool.connect((err, client, release) => {
       if (err) {
         resume(Effect.fail(new SqlError({
-          cause: err,
-          message: "Failed to acquire connection for transaction"
+          reason: classifyError(err, "Failed to acquire connection for transaction", "acquireConnection")
         })));
       } else {
         resume(Effect.as(Scope.addFinalizer(scope, Effect.sync(() => {
@@ -251,9 +203,23 @@ export const fromPool = /*#__PURE__*/Effect.fnUntraced(function* (options) {
       client.on("error", onError);
     });
   });
-  const reserve = Effect.map(reserveRaw, client => new ConnectionImpl(client));
-  const listenClient = yield* RcRef.make({
-    acquire: reserveRaw
+  const reserve = Effect.map(reserveRaw, makeConection);
+  const onListenClientError = _ => {};
+  const listenAcquirer = yield* RcRef.make({
+    acquire: Effect.acquireRelease(Effect.tryPromise({
+      try: async () => {
+        const client = new Pg.Client(pool.options);
+        await client.connect();
+        client.on("error", onListenClientError);
+        return client;
+      },
+      catch: cause => new SqlError({
+        reason: classifyError(cause, "Failed to acquire connection for listen", "acquireConnection")
+      })
+    }), client => Effect.promise(() => {
+      client.off("error", onListenClientError);
+      return client.end();
+    }).pipe(Effect.timeoutOption(1000)))
   });
   let config = {
     url: pool.options.connectionString ? Redacted.make(pool.options.connectionString) : undefined,
@@ -273,7 +239,7 @@ export const fromPool = /*#__PURE__*/Effect.fnUntraced(function* (options) {
       config = {
         ...config,
         host: config.host ?? parsed.host ?? undefined,
-        port: config.port ?? (parsed.port ? Number.parse(parsed.port) : undefined),
+        port: config.port ?? (parsed.port ? Option.getOrUndefined(Number.parse(parsed.port)) : undefined),
         username: config.username ?? parsed.user ?? undefined,
         password: config.password ?? (parsed.password ? Redacted.make(parsed.password) : undefined),
         database: config.database ?? parsed.database ?? undefined
@@ -282,18 +248,80 @@ export const fromPool = /*#__PURE__*/Effect.fnUntraced(function* (options) {
       //
     }
   }
-  return Object.assign(yield* Client.make({
-    acquirer: Effect.succeed(new ConnectionImpl()),
+  return yield* makeWith({
+    acquirer: Effect.succeed(makeConection()),
     transactionAcquirer: reserve,
+    listenAcquirer: RcRef.get(listenAcquirer),
+    config,
+    spanAttributes: options.spanAttributes,
+    transformResultNames: options.transformResultNames,
+    transformQueryNames: options.transformQueryNames,
+    transformJson: options.transformJson
+  });
+});
+/**
+ * @category constructors
+ * @since 1.0.0
+ */
+export const fromClient = /*#__PURE__*/Effect.fnUntraced(function* (options) {
+  function onError() {}
+  const acquireWithErrorHandler = options.acquire.pipe(Effect.tap(client => {
+    client.on("error", onError);
+    return Effect.addFinalizer(() => {
+      client.off("error", onError);
+      return Effect.void;
+    });
+  }));
+  const client = yield* acquireWithErrorHandler;
+  const semaphore = Semaphore.makeUnsafe(1);
+  let streamClient = options.acquireForStream ? acquireWithErrorHandler : Effect.acquireRelease(Effect.as(semaphore.take(1), client), () => semaphore.release(1));
+  const makeConection = client => new ConnectionImpl(function runWithClient(f) {
+    return Effect.callback(resume => {
+      f(client, resume);
+    });
+  }, streamClient);
+  const connection = makeConection(client);
+  const acquirer = semaphore.withPermit(Effect.succeed(connection));
+  const config = {
+    ...options,
+    host: client.host,
+    port: client.port,
+    database: client.database,
+    username: client.user,
+    password: typeof client.password === "string" ? Redacted.make(client.password) : undefined,
+    ssl: client.ssl
+  };
+  return yield* makeWith({
+    acquirer,
+    transactionAcquirer: acquirer,
+    listenAcquirer: streamClient,
+    config,
+    spanAttributes: options.spanAttributes,
+    transformResultNames: options.transformResultNames,
+    transformQueryNames: options.transformQueryNames,
+    transformJson: options.transformJson
+  });
+});
+/**
+ * @category constructors
+ * @since 1.0.0
+ */
+export const makeWith = /*#__PURE__*/Effect.fnUntraced(function* (options) {
+  const compiler = makeCompiler(options.transformQueryNames, options.transformJson);
+  const transformRows = options.transformResultNames ? Statement.defaultTransforms(options.transformResultNames, options.transformJson).array : undefined;
+  const config = options.config;
+  return Object.assign(yield* Client.make({
+    acquirer: options.acquirer,
+    transactionAcquirer: options.transactionAcquirer,
     compiler,
     spanAttributes: [...(options.spanAttributes ? Object.entries(options.spanAttributes) : []), [ATTR_DB_SYSTEM_NAME, "postgresql"], [ATTR_DB_NAMESPACE, config.database ?? config.username ?? "postgres"], [ATTR_SERVER_ADDRESS, config.host ?? "localhost"], [ATTR_SERVER_PORT, config.port ?? 5432]],
     transformRows
   }), {
     [TypeId]: TypeId,
-    config,
+    config: options.config,
     json: _ => Statement.fragment([PgJson(_)]),
     listen: channel => Stream.callback(Effect.fnUntraced(function* (queue) {
-      const client = yield* RcRef.get(listenClient);
+      const client = yield* options.listenAcquirer;
       function onNotification(msg) {
         if (msg.channel === channel && msg.payload) {
           Queue.offerUnsafe(queue, msg.payload);
@@ -306,26 +334,98 @@ export const fromPool = /*#__PURE__*/Effect.fnUntraced(function* (options) {
       yield* Effect.tryPromise({
         try: () => client.query(`LISTEN ${Pg.escapeIdentifier(channel)}`),
         catch: cause => new SqlError({
-          cause,
-          message: "Failed to listen"
+          reason: classifyError(cause, "Failed to listen", "listen")
         })
       });
       client.on("notification", onNotification);
     })),
-    notify: (channel, payload) => Effect.callback(resume => {
-      pool.query(`NOTIFY ${Pg.escapeIdentifier(channel)}, $1`, [payload], err => {
+    notify: (channel, payload) => Effect.asVoid(Effect.scoped(Effect.flatMap(options.acquirer, conn => conn.executeRaw(`SELECT pg_notify($1, $2)`, [channel, payload]))))
+  });
+});
+class ConnectionImpl {
+  constructor(runWithClient, reserve) {
+    this.runWithClient = runWithClient;
+    this.reserve = reserve;
+  }
+  runWithClient;
+  reserve;
+  run(query, params) {
+    return this.runWithClient((client, resume) => {
+      client.query(query, params, (err, result) => {
         if (err) {
           resume(Effect.fail(new SqlError({
-            cause: err,
-            message: "Failed to notify"
+            reason: classifyError(err, "Failed to execute statement", "execute")
           })));
         } else {
-          resume(Effect.void);
+          // Multi-statement queries return an array of results
+          resume(Effect.succeed(Array.isArray(result) ? result.map(r => r.rows ?? []) : result.rows ?? []));
         }
       });
-    })
-  });
-});
+    });
+  }
+  execute(sql, params, transformRows) {
+    return transformRows ? Effect.map(this.run(sql, params), transformRows) : this.run(sql, params);
+  }
+  executeRaw(sql, params) {
+    return this.runWithClient((client, resume) => {
+      client.query(sql, params, (err, result) => {
+        if (err) {
+          resume(Effect.fail(new SqlError({
+            reason: classifyError(err, "Failed to execute statement", "execute")
+          })));
+        } else {
+          resume(Effect.succeed(result));
+        }
+      });
+    });
+  }
+  executeWithoutTransform(sql, params) {
+    return this.run(sql, params);
+  }
+  executeValues(sql, params) {
+    return this.runWithClient((client, resume) => {
+      client.query({
+        text: sql,
+        rowMode: "array",
+        values: params
+      }, (err, result) => {
+        if (err) {
+          resume(Effect.fail(new SqlError({
+            reason: classifyError(err, "Failed to execute statement", "execute")
+          })));
+        } else {
+          resume(Effect.succeed(result.rows));
+        }
+      });
+    });
+  }
+  executeUnprepared(sql, params, transformRows) {
+    return this.execute(sql, params, transformRows);
+  }
+  executeStream(sql, params, transformRows) {
+    // oxlint-disable-next-line @typescript-eslint/no-this-alias
+    const self = this;
+    return Stream.fromChannel(Channel.fromTransform(Effect.fnUntraced(function* (_, scope) {
+      const client = yield* Scope.provide(self.reserve, scope);
+      yield* Scope.addFinalizer(scope, Effect.promise(() => cursor.close()));
+      const cursor = client.query(new Cursor(sql, params));
+      // @effect-diagnostics-next-line returnEffectInGen:off
+      return Effect.callback(resume => {
+        cursor.read(128, (err, rows) => {
+          if (err) {
+            resume(Effect.fail(new SqlError({
+              reason: classifyError(err, "Failed to execute statement", "stream")
+            })));
+          } else if (Arr.isArrayNonEmpty(rows)) {
+            resume(Effect.succeed(transformRows ? transformRows(rows) : rows));
+          } else {
+            resume(Cause.done());
+          }
+        });
+      });
+    })));
+  }
+}
 const cancelEffects = /*#__PURE__*/new WeakMap();
 const makeCancel = (pool, client) => {
   if (cancelEffects.has(client)) {
@@ -347,17 +447,17 @@ const makeCancel = (pool, client) => {
  * @category layers
  * @since 1.0.0
  */
-export const layerConfig = config => Layer.effectServices(Config.unwrap(config).asEffect().pipe(Effect.flatMap(make), Effect.map(client => ServiceMap.make(PgClient, client).pipe(ServiceMap.add(Client.SqlClient, client))))).pipe(Layer.provide(Reactivity.layer));
+export const layerFrom = acquire => Layer.effectServices(Effect.map(acquire, client => ServiceMap.make(PgClient, client).pipe(ServiceMap.add(Client.SqlClient, client)))).pipe(Layer.provide(Reactivity.layer));
 /**
  * @category layers
  * @since 1.0.0
  */
-export const layer = config => Layer.effectServices(Effect.map(make(config), client => ServiceMap.make(PgClient, client).pipe(ServiceMap.add(Client.SqlClient, client)))).pipe(Layer.provide(Reactivity.layer));
+export const layerConfig = config => layerFrom(Effect.flatMap(Config.unwrap(config).asEffect(), make));
 /**
  * @category layers
  * @since 1.0.0
  */
-export const layerFromPool = options => Layer.effectServices(Effect.map(fromPool(options), client => ServiceMap.make(PgClient, client).pipe(ServiceMap.add(Client.SqlClient, client)))).pipe(Layer.provide(Reactivity.layer));
+export const layer = config => layerFrom(make(config));
 /**
  * @category constructor
  * @since 1.0.0
@@ -391,4 +491,53 @@ const escape = /*#__PURE__*/Statement.defaultEscape("\"");
  * @since 1.0.0
  */
 const PgJson = /*#__PURE__*/Statement.custom("PgJson");
+const ATTR_DB_SYSTEM_NAME = "db.system.name";
+const ATTR_DB_NAMESPACE = "db.namespace";
+const ATTR_SERVER_ADDRESS = "server.address";
+const ATTR_SERVER_PORT = "server.port";
+const pgCodeFromCause = cause => {
+  if (typeof cause !== "object" || cause === null || !("code" in cause)) {
+    return undefined;
+  }
+  const code = cause.code;
+  return typeof code === "string" ? code : undefined;
+};
+const classifyError = (cause, message, operation) => {
+  const props = {
+    cause,
+    message,
+    operation
+  };
+  const code = pgCodeFromCause(cause);
+  if (code !== undefined) {
+    if (code.startsWith("08")) {
+      return new ConnectionError(props);
+    }
+    if (code.startsWith("28")) {
+      return new AuthenticationError(props);
+    }
+    if (code === "42501") {
+      return new AuthorizationError(props);
+    }
+    if (code.startsWith("42")) {
+      return new SqlSyntaxError(props);
+    }
+    if (code.startsWith("23")) {
+      return new ConstraintError(props);
+    }
+    if (code === "40P01") {
+      return new DeadlockError(props);
+    }
+    if (code === "40001") {
+      return new SerializationError(props);
+    }
+    if (code === "55P03") {
+      return new LockTimeoutError(props);
+    }
+    if (code === "57014") {
+      return new StatementTimeoutError(props);
+    }
+  }
+  return new UnknownError(props);
+};
 //# sourceMappingURL=PgClient.js.map