@saltcorn/postgres 1.1.4-alpha.0 → 1.1.4-alpha.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saltcorn/postgres",
-  "version": "1.1.4-alpha.0",
+  "version": "1.1.4-alpha.2",
   "description": "Postgres structures for Saltcorn, open-source no-code platform",
   "homepage": "https://saltcorn.com",
   "scripts": {
@@ -12,7 +12,7 @@
   "license": "MIT",
   "main": "index.js",
   "dependencies": {
-    "@saltcorn/db-common": "1.1.4-alpha.0",
+    "@saltcorn/db-common": "1.1.4-alpha.2",
     "pg": "^8.13.1",
     "pg-copy-streams": "^6.0.6",
     "replacestream": "4.0.3"

package/postgres.js

@@ -17,9 +17,9 @@ const {
 } = require("@saltcorn/db-common/internal");
 
 let getTenantSchema;
+let getRequestContext;
 let getConnectObject = null;
 let pool = null;
-let client = null;
 
 let log_sql_enabled = false;
 
@@ -74,20 +74,20 @@ const changeConnection = async (connObj = Object.create(null)) => {
 };
 
 const begin = async () => {
-  client = await getClient();
-  await client.query("BEGIN");
+  //client = await getClient();
+  await query("BEGIN");
 };
 
 const commit = async () => {
-  await client.query("COMMIT");
-  client.release(true);
-  client = null;
+  await query("COMMIT");
 };
 
 const rollback = async () => {
-  await client.query("ROLLBACK");
-  client.release(true);
-  client = null;
+  await query("ROLLBACK");
+};
+
+const getMyClient = (selopts) => {
+  return selopts?.client || getRequestContext()?.client || pool;
 };
 
 /**
@@ -108,7 +108,7 @@ const select = async (tbl, whereObj, selectopts = Object.create(null)) => {
     false
   )}`;
   sql_log(sql, values);
-  const tq = await (client || selectopts.client || pool).query(sql, values);
+  const tq = await getMyClient(selectopts).query(sql, values);
 
   return tq.rows;
 };
@@ -127,7 +127,7 @@ const drop_reset_schema = async (schema) => {
   COMMENT ON SCHEMA "${schema}" IS 'standard public schema';`;
   sql_log(sql);
 
-  await pool.query(sql);
+  await getMyClient().query(sql);
 };
 
 /**
@@ -152,7 +152,7 @@ const count = async (tbl, whereObj) => {
 FROM   pg_catalog.pg_class c
 WHERE  c.oid = '"${getTenantSchema()}"."${sqlsanitize(tbl)}"'::regclass`;
       sql_log(sql);
-      const tq = await (client || pool).query(sql, []);
+      const tq = await getMyClient().query(sql, []);
       const n = +tq.rows[0].int8;
       if (n && n > 10000) return n;
     } catch {
@@ -164,7 +164,7 @@ WHERE  c.oid = '"${getTenantSchema()}"."${sqlsanitize(tbl)}"'::regclass`;
     tbl
   )}" ${where}`;
   sql_log(sql, values);
-  const tq = await (client || pool).query(sql, values);
+  const tq = await getMyClient().query(sql, values);
 
   return parseInt(tq.rows[0].count);
 };
@@ -177,7 +177,7 @@ WHERE  c.oid = '"${getTenantSchema()}"."${sqlsanitize(tbl)}"'::regclass`;
 const getVersion = async (short) => {
   const sql = `SELECT version();`;
   sql_log(sql);
-  const tq = await pool.query(sql);
+  const tq = await getMyClient().query(sql);
   const v = tq.rows[0].version;
   if (short) {
     const ws = v.split(" ");
@@ -200,7 +200,7 @@ const deleteWhere = async (tbl, whereObj, opts = Object.create(null)) => {
   )}" ${where}`;
   sql_log(sql, values);
 
-  const tq = await (client || opts.client || pool).query(sql, values);
+  const tq = await getMyClient(opts).query(sql, values);
 
   return tq.rows;
 };
@@ -209,7 +209,7 @@ const truncate = async (tbl) => {
   const sql = `truncate "${getTenantSchema()}"."${sqlsanitize(tbl)}"`;
   sql_log(sql, []);
 
-  const tq = await (client || pool).query(sql, []);
+  const tq = await getMyClient().query(sql, []);
 
   return tq.rows;
 };
@@ -252,7 +252,7 @@ const insert = async (tbl, obj, opts = Object.create(null)) => {
           tbl
         )}" DEFAULT VALUES returning ${opts.noid ? "*" : ppPK(opts.pk_name)}`;
   sql_log(sql, valList);
-  const { rows } = await (client || opts.client || pool).query(sql, valList);
+  const { rows } = await getMyClient(opts).query(sql, valList);
   if (opts.noid) return;
   else if (conflict && rows.length === 0) return;
   else return rows[0][opts.pk_name || "id"];
@@ -280,7 +280,7 @@ const update = async (tbl, obj, id, opts = Object.create(null)) => {
     tbl
   )}" set ${assigns} where ${ppPK(opts.pk_name)}=$${kvs.length + 1}`;
   sql_log(q, valList);
-  await (client || opts.client || pool).query(q, valList);
+  await getMyClient(opts).query(q, valList);
 };
 
 /**
@@ -304,7 +304,7 @@ const updateWhere = async (tbl, obj, whereObj, opts = Object.create(null)) => {
     tbl
   )}" set ${assigns} ${where}`;
   sql_log(q, valList);
-  await (client || opts.client || pool).query(q, valList);
+  await getMyClient().query(q, valList);
 };
 
 /**
@@ -356,7 +356,7 @@ const reset_sequence = async (tblname, pkname = "id") => {
   )}"', '${pkname}'), coalesce(max("${pkname}"),0) + 1, false) FROM "${getTenantSchema()}"."${sqlsanitize(
     tblname
   )}";`;
-  await (client || pool).query(sql);
+  await getMyClient().query(sql);
 };
 
 /**
@@ -375,7 +375,7 @@ const add_unique_constraint = async (table_name, field_names) => {
     .map((f) => `"${sqlsanitize(f)}"`)
     .join(",")});`;
   sql_log(sql);
-  await pool.query(sql);
+  await getMyClient().query(sql);
 };
 
 /**
@@ -392,7 +392,7 @@ const drop_unique_constraint = async (table_name, field_names) => {
     .map((f) => sqlsanitize(f))
     .join("_")}_unique";`;
   sql_log(sql);
-  await pool.query(sql);
+  await getMyClient().query(sql);
 };
 
 /**
@@ -409,7 +409,7 @@ const add_index = async (table_name, field_name) => {
     table_name
   )}" ("${sqlsanitize(field_name)}");`;
   sql_log(sql);
-  await pool.query(sql);
+  await getMyClient().query(sql);
 };
 
 /**
@@ -428,7 +428,7 @@ const add_fts_index = async (table_name, field_expression, language) => {
     language || "english"
   }', ${field_expression}));`;
   sql_log(sql);
-  await pool.query(sql);
+  await getMyClient().query(sql);
 };
 const drop_fts_index = async (table_name) => {
   // TBD check that there are no problems with lenght of constraint name
@@ -436,7 +436,7 @@ const drop_fts_index = async (table_name) => {
     table_name
   )}_fts_index";`;
   sql_log(sql);
-  await pool.query(sql);
+  await getMyClient().query(sql);
 };
 
 /**
@@ -451,7 +451,7 @@ const drop_index = async (table_name, field_name) => {
     table_name
   )}_${sqlsanitize(field_name)}_index";`;
   sql_log(sql);
-  await pool.query(sql);
+  await getMyClient().query(sql);
 };
 
 /**
@@ -477,7 +477,7 @@ const copyToJson = async (fileStream, tableName, client) => {
   const sql = `COPY (SELECT (row_to_json("${sqlsanitize(tableName)}".*) || ',')
   FROM "${getTenantSchema()}"."${sqlsanitize(tableName)}") TO STDOUT`;
   sql_log(sql);
-  const stream = (client || pool).query(copyStreams.to(sql));
+  const stream = (client || getMyClient()).query(copyStreams.to(sql));
 
   return await pipeline(stream, replace("\\\\", "\\"), fileStream);
 };
@@ -489,7 +489,7 @@ const slugify = (s) =>
     .replace(/[^\w-]/g, "");
 
 const time = async () => {
-  const result = await (client || pool).query("select now()");
+  const result = await getMyClient().query("select now()");
   const row = result.rows[0];
   return new Date(row.now);
 };
@@ -499,7 +499,7 @@ const time = async () => {
  * @returns
  */
 const listTables = async () => {
-  const tq = await pool.query(
+  const tq = await getMyClient().query(
     `SELECT table_name FROM information_schema.tables WHERE table_schema = '${getTenantSchema()}'`
   );
   return tq.rows.map((row) => {
@@ -512,7 +512,7 @@ const listTables = async () => {
  * @returns
  */
 const listUserDefinedTables = async () => {
-  const tq = await pool.query(
+  const tq = await getMyClient().query(
     `SELECT table_name FROM information_schema.tables WHERE table_schema = '${getTenantSchema()}' AND table_name NOT LIKE '_sc_%'`
   );
   return tq.rows.map((row) => {
@@ -525,7 +525,7 @@ const listUserDefinedTables = async () => {
  * @returns
  */
 const listScTables = async () => {
-  const tq = await pool.query(
+  const tq = await getMyClient().query(
     `SELECT table_name FROM information_schema.tables WHERE table_schema = '${getTenantSchema()}' AND table_name LIKE '_sc_%'`
   );
   return tq.rows.map((row) => {
@@ -533,6 +533,37 @@ const listScTables = async () => {
   });
 };
 
+/* rules of using this:
+
+- no try catch inside unless you rethrow: wouldnt roll back
+- no res.json, res.redirect etc inside (client is released on res finish event)
+- no state.refresh_*() inside: other works wouldnt see updates as they are in transactioon
+     - you can use state.refresh_*(true) for update on own worker only
+
+*/
+const withTransaction = async (f, onError) => {
+  await query("BEGIN;");
+  let aborted = false;
+  const rollback = async () => {
+    aborted = true;
+    await query("ROLLBACK;");
+  };
+  try {
+    const result = await f(rollback);
+    if (!aborted) await query("COMMIT;");
+    return result;
+  } catch (error) {
+    if (!aborted) await query("ROLLBACK;");
+    if (onError) return onError(error);
+    else throw error;
+  }
+};
+
+const query = (text, params) => {
+  sql_log(text, params);
+  return getMyClient().query(text, params);
+};
+
 const postgresExports = {
   pool,
   /**
@@ -540,10 +571,7 @@ const postgresExports = {
    * @param {object} params
    * @returns {object}
    */
-  query: (text, params) => {
-    sql_log(text, params);
-    return (client || pool).query(text, params);
-  },
+  query,
   begin,
   commit,
   rollback,
@@ -579,6 +607,7 @@ const postgresExports = {
   listScTables,
   listUserDefinedTables,
   truncate,
+  withTransaction,
 };
 
 module.exports = (getConnectObjectPara) => {
@@ -590,6 +619,9 @@ module.exports = (getConnectObjectPara) => {
       getTenantSchema = require("@saltcorn/db-common/tenants")(
         connectObj
       ).getTenantSchema;
+      getRequestContext = require("@saltcorn/db-common/tenants")(
+        connectObj
+      ).getRequestContext;
       postgresExports.pool = pool;
     } else {
       throw new Error("Unable to retrieve a database connection object.");